HealthCardAuthentication

Library for HealthCard Authentication

License

License

GroupId

GroupId

de.gematik.ti.epa
ArtifactId

ArtifactId

fdv.healthcard.authentication
Last Version

Last Version

1.0.0
Release Date

Release Date

Type

Type

jar
Description

Description

HealthCardAuthentication
Library for HealthCard Authentication
Project URL

Project URL

https://github.com/gematik/ref-ePA-HealthCardAuthentication
Project Organization

Project Organization

de.gematik
Source Code Management

Source Code Management

https://github.com/gematik/ref-ePA-HealthCardAuthentication

Download fdv.healthcard.authentication

How to add to project

<!-- https://jarcasting.com/artifacts/de.gematik.ti.epa/fdv.healthcard.authentication/ -->
<dependency>
    <groupId>de.gematik.ti.epa</groupId>
    <artifactId>fdv.healthcard.authentication</artifactId>
    <version>1.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/de.gematik.ti.epa/fdv.healthcard.authentication/
implementation 'de.gematik.ti.epa:fdv.healthcard.authentication:1.0.0'
// https://jarcasting.com/artifacts/de.gematik.ti.epa/fdv.healthcard.authentication/
implementation ("de.gematik.ti.epa:fdv.healthcard.authentication:1.0.0")
'de.gematik.ti.epa:fdv.healthcard.authentication:jar:1.0.0'
<dependency org="de.gematik.ti.epa" name="fdv.healthcard.authentication" rev="1.0.0">
  <artifact name="fdv.healthcard.authentication" type="jar" />
</dependency>
@Grapes(
@Grab(group='de.gematik.ti.epa', module='fdv.healthcard.authentication', version='1.0.0')
)
libraryDependencies += "de.gematik.ti.epa" % "fdv.healthcard.authentication" % "1.0.0"
[de.gematik.ti.epa/fdv.healthcard.authentication "1.0.0"]

Dependencies

runtime (8)

Group / Artifact Type Version
de.gematik.ti : healthcard.access jar 1.2.2
de.gematik.ti : utils jar 1.2.1
de.gematik.ti : cardreader.provider.api jar 1.2.1
de.gematik.ti.epa : fdv.authentication.service.provider jar 1.0.3
de.gematik.ti : healthcard.control.common jar 1.0.0
de.gematik.ti : openhealthcard.events jar 1.2.0
org.greenrobot : eventbus jar 3.1.1
org.slf4j : slf4j-api jar 1.7.25

test (6)

Group / Artifact Type Version
org.mockito : mockito-core jar 2.7.13
junit : junit jar 4.12
org.hamcrest : hamcrest-all jar 1.3
com.madgag.spongycastle : prov jar 1.58.0.0
com.madgag.spongycastle : core jar 1.58.0.0
de.gematik.ti : test.utils jar 1.1.1

Project Modules

There are no modules declared in this project.

HealthCardAuthentication Java Library

This part describes the HealthCardAuthentication functionalities and structure.

API Documentation

Generated API docs are available at https://gematik.github.io/ref-ePA-HealthCardAuthentication.

License

Licensed under the Apache License, Version 2.0.

Overview

This library provides methods for authenticating the insured using his health card (eGK).

HealthCardAuthentication Overview

Authenticator

The Authenticator class implements the IAuthenticator<T> interface which provides functionalities 'getCertificateValue' and 'signData'. Owner of the certificate (certificate holder) is in this case the health card (eGK). The certificate as a byte array can be achieved with 'getCertificateValue' from the health card. A hashValue of byte-array can be signed by 'signData' which result will be returned back as 'AuthenticationResult'.

AuthenticationController

The AuthenticationController class handles card events and returns the recognized health card as the certificate holder.

Solution with health card (eGK)

A eGK of generation 2.0 or 2.1 should be used in this solution. The certificate for eGK G2.0 is 'C_CH_AUT_R2048', whereas for eGK G2.1 it is then 'C_CH_AUT_E256'. Details about signing are available in "gemSpec_Frontend_Vers" of ePA.

Getting Started

Build setup

To use HealthCard Authentication in a project, you need just to include following dependency:

Gradle dependency settings to use HealthCard Authentication.

dependencies {
    implementation group: 'de.gematik.ti.epa', name: 'fdv.healthcard.authentication', version: '1.0.0'
}

Maven dependency settings to use HealthCard Authentication.

<dependencies>
    <dependency>
        <groupId>de.gematik.ti.epa</groupId>
        <artifactId>fdv.healthcard.authentication</artifactId>
        <version>1.0.0</version>
    </dependency>
</dependencies>
de.gematik.ti.epa

Gematik

Versions

Version
1.0.0