Skip to content

Commit

Permalink
Merge pull request #10 from certifaction/Update-README
Browse files Browse the repository at this point in the history 
Update README.md
  • Loading branch information
@stephalba
stephalba committed Oct 27, 2023
2 parents 3c5a13f + b1a2161 commit 1d98b61
Showing 1 changed file with 19 additions and 41 deletions.
60 changes: 19 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -344,13 +344,9 @@ For the various actions of the E-prescription Switzerland service, there are dif
<tr valign="top">
<td>Revoke
</td>
<td>- Personal HIN eID with hardening 20
<p>
- Team HIN eID
<td>Personal HIN eID with hardening 20
</td>
<td>- Auth-Service (based on SAML)
<p>
- OAuth via HIN ACS
<td>Auth-Service (based on SAML)
</td>
<td>HIN membership
</td>
Expand Down Expand Up @@ -394,7 +390,7 @@ For the various actions of the E-prescription Switzerland service, there are dif
</tr>
</table>

Note on the authentication with “Personal HIN eID with hardening 20”: <br>
<i>Note on the authentication with “Personal HIN eID with hardening 20”:</i> <br>
This authentication is done via the HIN/ADSwiss Auth-Service, which ensures that the user was a correctly identified and recently authenticated. HIN Sign also uses the person code 10 to ensure that the person is a doctor.

**EPD authentication**<br>
Expand Down Expand Up @@ -428,31 +424,22 @@ The Certifaction CLI command generates e-prescriptions signatures for e-prescrip

#### 4.1.4. General usage

The Certifaction CLI can be used either as a command line tool as follows, or as HTTP REST API in its server mode.

```
certifaction [certifaction flags] <command> [arguments]
```


Use certifaction help &lt;command> for more information about the command.

Please refer to the main documentation for the list of all available global flags and about the [CLI HTTP server mode](https://github.com/certifaction/cli#http-server-mode).
Please refer to [E-prescription endpoints](#42-e-prescription-endpoints) for the list of all available endpoints.

#### 4.1.5. Authentication

Please see chapter [Authentication and Authorisation](#32-authentication-and-authorisation).<br>

When indicated, the requests must be authenticated using the Authorization header as following (an environment is provided for testing that does not enforce authentication):
When indicated, the requests must be authenticated as following (an environment is provided for testing that does not enforce authentication):

HTTP Server Mode:
HTTP Server Mode (OAuth via HIN ACS):
```
Authorization: Bearer <AccessToken>
Authorization: Bearer acs:<token>
```

CLI Mode:
HTTP Server Mode (Auth-Service):
```
--token
Authorization: Bearer epdg:<token>
```

If the request is not authenticated a HTTP 401 Unauthorized or a HTTP 403 Forbidden response is returned.
Expand All @@ -463,8 +450,6 @@ For the creation of e-prescription the elevated EPD-Level Authentication based o

This section describes the additional endpoints available when the e-prescription mode is enabled.

Please refer to the main documentation for more information about the [CLI HTTP server mode](https://github.com/certifaction/cli#http-server-mode).

When the e-prescription mode is enabled, the following new endpoints are enabled:

<table>
Expand Down Expand Up @@ -493,7 +478,7 @@ When the e-prescription mode is enabled, the following new endpoints are enabled
</td>
</tr>
<tr>
<td>POST /ePrescription/cancel/&lt;id>/&lt;eventid>
<td>POST /ePrescription/cancel/&lt;id>/event/&lt;eventid>
</td>
<td>Registers a cancelation of an event (revoke, dispense, cancel).
</td>
Expand Down Expand Up @@ -915,13 +900,6 @@ none
**Test data**<br>
Create a valid-chmed16a1.json file containing a valid CHMED16A1 data set.

**Command line**<br>
Here is the command to generate the signed e-prescription QR code:

```
ENABLE_EPRESCRIPTION=true ./certifaction ePrescription --api https://oauth2.sign.hin.ch/api --token <access token> -o test-chmed16a1.pdf -f png test-ePrescription.png
```

**Server mode**<br>
First start the server using the following command:

Expand All @@ -932,7 +910,7 @@ ENABLE_EPRESCRIPTION=true ./certifaction server --api https://oauth2.sign.hin.c
Then post the e-prescription data to the /ePrescription/create endpoint as following to get the signed e-prescription QR code as response:

```
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <access token>" --data @valid-chmed16a1.json http://localhost:8082/ePrescription/create?type=qrcode > test-ePrescription.png
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer epdg:<token>" --data @valid-chmed16a1.json http://localhost:8082/ePrescription/create?type=qrcode > test-ePrescription.png
```

A complete example commands incl. authentication can be found in [Appendix A](#a-e-prescription-authentication-and-use-case-commands).
Expand Down Expand Up @@ -969,17 +947,17 @@ ENABLE_EPRESCRIPTION=true certifaction server --api https://api.testnet.certifac
1. Get Login URL

```
curl --request POST --url "https://oauth2.ci-prep.adswiss.hin.ch/authService/EPDAuth?targetUrl=http%3A%2F%2Flocalhost%2Fsuccess&style=redirect" --header "accept: application/json" --header "Authorization: Bearer <oauth_token_for_auth_service>"
curl --request POST --url "https://oauth2.ci-prep.adswiss.hin.ch/authService/EPDAuth?targetUrl=http%3A%2F%2Flocalhost%2Fsuccess&style=redirect" --header "accept: application/json" --header "Authorization: Bearer <token>"
```

2. Resolve Code to Handle

```
curl --request POST --url "https://oauth2.ci-prep.adswiss.hin.ch/authService/EPDAuth/auth_handle" -d "{\"authCode\":\"<auth_code>\"}" --header "accept: application/json" --header "Content-Type: application/json" --header "Authorization: Bearer <oauth_token_for_auth_service>"
curl --request POST --url "https://oauth2.ci-prep.adswiss.hin.ch/authService/EPDAuth/auth_handle" -d "{\"authCode\":\"<auth_code>\"}" --header "accept: application/json" --header "Content-Type: application/json" --header "Authorization: Bearer <token>"
```


3. Use handle as token in `Authorization: Bearer <token>` header for calls to CLI
3. Use handle as token in `Authorization: Bearer epdg:<token>` header for calls to CLI


#### ACS Authentication
Expand All @@ -1001,7 +979,7 @@ ENABLE_EPRESCRIPTION=true certifaction server --api https://api.testnet.certifac
curl -H 'Content-Type: application/x-www-form-urlencoded' --data 'grant_type=authorization_code&redirect_uri=&code=<AUTHORIZATION CODE>&client_id=<client_id>&client_secret=<client_secret>' https://oauth2.hin.ch/REST/v1/OAuth/GetAccessToken
```

3. Use token in `Authorization: Bearer <token>` header for calls to CLI
3. Use token in `Authorization: Bearer acs:<token>` header for calls to CLI


#### Input Data
Expand All @@ -1018,15 +996,15 @@ CHMED16A1H4sIAAAAAAAACr1WzW7bOBC+71MQvK6t8kd/9mnrdZINULdBkiZAFznQ9tgSJFMGRQVNs74
Option 1: Output as Data/URL

```
$ curl -X POST -H "Content-Type: application/json" --data @testCHMED16A1.txt -H "authorization: Bearer <epd_token>" http://localhost:8082/ePrescription/create?output-format=data
$ curl -X POST -H "Content-Type: application/json" --data @testCHMED16A1.txt -H "authorization: Bearer epdg:<token>" http://localhost:8082/ePrescription/create?output-format=data

HTTP/200 OK
{"SignedPrescriptionData":"https://eprescription.hin.ch/#CHMED16A1H4sIAA…lXGtoKAAA&i=Dr.+Test+Test+1&t=1642529665&s=70cd59558926868ca5dbf18e671eb44caffa6d0be491cf736ed39159ba25c4413177c83088a5f29bf7d5b6d78dc8daa4ab609d0a384dbc2834e00dbea4487db101"}
```

Option 2: Output as PNG QR Code
```
$ curl -X POST -H "Content-Type: application/json" --data @testCHMED16A1.txt -H “authorization: Bearer &lt;epd_token>” http://localhost:8082/ePrescription/create?output-format=qrcode > testQrCode.png
$ curl -X POST -H "Content-Type: application/json" --data @testCHMED16A1.txt -H “authorization: Bearer epdg:<token>” http://localhost:8082/ePrescription/create?output-format=qrcode > testQrCode.png

HTTP/200 OK
```
Expand All @@ -1050,7 +1028,7 @@ CHMED16A1H4sIAAAAAAAACr1WzW7bOBC+71MQvK6t8kd/9mnrdZINULdBkiZAFznQ9tgSJFMGRQVNs74
3. Dispense e-prescription fully

```
$ curl -X POST -H "Content-Type: application/json" -H "authorization: Bearer <hin_acs_oauth_token>" http://localhost:8082/ePrescription/dispense/00000000-0000-0000-0000-000000000000
$ curl -X POST -H "Content-Type: application/json" -H "authorization: Bearer acs:<token>" http://localhost:8082/ePrescription/dispense/00000000-0000-0000-0000-000000000000

HTTP/200 OK
```
Expand Down Expand Up @@ -1179,7 +1157,7 @@ Blister 30 Stk)
<tr valign="top">
<td>Pharmacy 2
</td>
<td>Verifies e-prescription and sees that one dispensation has already been made -> Dispenses medicament according to prescription
<td>Verifies e-prescription and sees that one dispensation has already been made -> Dispenses medicament according to e-prescription
</td>
<td>
</td>
Expand Down

0 comments on commit 1d98b61

Please sign in to comment.