Skip to content

Commit ac8fc5f

Browse files
committed
updated trusted certificate page to reflect DSF 2 changes
1 parent 07a5c4e commit ac8fc5f

File tree

1 file changed

+56
-18
lines changed

1 file changed

+56
-18
lines changed

docs/src/operations/v2.0.0-RC2/root-certificates.md

Lines changed: 56 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Default Root Certificates
2+
title: Trusted Certificates
33
icon: safe
44
---
55

@@ -10,55 +10,82 @@ Please ensure that you are using an organization-validated certificate (OV). We
1010
:::
1111

1212
## Extending or Replacing Trusted Certificate Authorities
13-
X.509 certificates of default trusted CAs are stored as .pem files containing multiple certificates in the docker images and can be replaced by either using docker [bind mounts](https://docs.docker.com/engine/storage/bind-mounts) or configuring appropriate environment variables with different targets.
13+
X.509 certificates of default trusted CAs are stored as individual .pem files containing one certificate each in the docker images and can be replaced by either using docker [bind mounts](https://docs.docker.com/engine/storage/bind-mounts) or configuring appropriate environment variables with different targets.
1414

1515
### FHIR Reverse Proxy
1616
Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates (Apache httpd mod_ssl configuration option [SSLCACertificateFile](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcacertificatefile)) as well as the CA Certificates for defining acceptable CA names (option [SSLCADNRequestFile](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcadnrequestfile)).
1717
Use the following environment variable to configure non default .pem files or override the existing files using docker bind mounts:
18-
* [SSL_CA_CERTIFICATE_FILE](fhir-reverse-proxy/configuration.html#ssl-ca-certificate-file)
18+
* [SSL_CA_CERTIFICATE_PATH](fhir-reverse-proxy/configuration.html#ssl-ca-certificate-path)
1919
Default Value: [ca/client_cert_ca_chains.pem](/download/1.9.0/client_cert_ca_chains.pem)
20-
* [SSL_CA_DN_REQUEST_FILE](fhir-reverse-proxy/configuration.html#ssl-ca-dn-request-file)
20+
* [SSL_CA_DN_REQUEST_PATH](fhir-reverse-proxy/configuration.html#ssl-ca-dn-request-path)
2121
Default Value: [ca/client_cert_issuing_cas.pem](/download/1.9.0/client_cert_issuing_cas.pem)
2222

2323
**Note:** Default file location are relative to the docker image work directory `/usr/local/apache2`.
2424
**Also Note:** Using non default .pem files for the environment variables above may require also modifying the default values of the environment variables [SSL_EXPECTED_CLIENT_S_DN_C_VALUES](fhir-reverse-proxy/configuration.html#ssl-expected-client-s-dn-c-values) and [SSL_EXPECTED_CLIENT_I_DN_CN_VALUES](fhir-reverse-proxy/configuration.html#ssl-expected-client-i-dn-cn-values).
2525

2626
### FHIR Server
2727
Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates as well as root CAs used for validating server certificates of remote DSF FHIR servers and the OIDC provider when using [OpenID Connect](fhir/oidc.html) for authenticating local users.
28-
Use the following environment variable to configure non default .pem files or override the existing files using docker bind mounts:
28+
29+
**Note:** Default file location are relative to the docker image work directory `/opt/fhir`.
30+
31+
You can add an additional certificate authority (e.g., your hospital CA) for
32+
33+
- server certificates by creating a bind-mount of the CA file into the `/opt/fhir/ca/server_root_cas/` directory
34+
- client certificates by creating bind-mounts of the intermediate CA files and their root CA file into the `/opt/fhir/ca/client_ca_chains/` directory.
35+
36+
See the [BPE Server configuration](#bpe-server) for an example.
37+
38+
If you can't override the default configuration with bind-mounts, you can use the following environment variables to configure non default .pem file directories or .pem file:
2939
* [DEV_DSF_SERVER_AUTH_TRUST_CLIENT_CERTIFICATE_CAS](fhir/configuration.html#dev-dsf-server-auth-trust-client-certificate-cas)
30-
Default Value: [ca/client_cert_ca_chains.pem](/download/1.9.0/client_cert_ca_chains.pem)
40+
Default Value: [ca/client_ca_chains](/download/1.9.0/client_cert_ca_chains.pem)
3141
* [DEV_DSF_FHIR_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](fhir/configuration.html#dev-dsf-fhir-client-trust-server-certificate-cas)
32-
Default Value: [ca/server_cert_root_cas.pem](/download/1.9.0/server_cert_root_cas.pem)
42+
Default Value: [ca/server_root_cas](/download/1.9.0/server_cert_root_cas.pem)
3343
* [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](fhir/configuration.html#dev-dsf-server-auth-oidc-provider-client-trust-server-certificate-cas)
34-
Default Value: [ca/server_cert_root_cas.pem](/download/1.9.0/server_cert_root_cas.pem)
35-
36-
**Note:** Default file location are relative to the docker image work directory `/opt/fhir`.
44+
Default Value: [ca/server_root_cas](/download/1.9.0/server_cert_root_cas.pem)
3745

3846
### BPE Reverse Proxy
3947
Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates (Apache httpd mod_ssl configuration option [SSLCACertificateFile](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcacertificatefile)) as well as the CA Certificates for defining acceptable CA names (option [SSLCADNRequestFile](https://httpd.apache.org/docs/2.4/mod/mod_ssl.html#sslcadnrequestfile)).
4048
Use the following environment variable to configure non default .pem files or override the existing files using docker bind mounts:
41-
* [SSL_CA_CERTIFICATE_FILE](bpe-reverse-proxy/configuration.html#ssl-ca-certificate-file)
49+
* [SSL_CA_CERTIFICATE_PATH](bpe-reverse-proxy/configuration.html#ssl-ca-certificate-path)
4250
Default Value: [ca/client_cert_ca_chains.pem](/download/1.9.0/client_cert_ca_chains.pem)
43-
* [SSL_CA_DN_REQUEST_FILE](bpe-reverse-proxy/configuration.html#ssl-ca-dn-request-file)
51+
* [SSL_CA_DN_REQUEST_PATH](bpe-reverse-proxy/configuration.html#ssl-ca-dn-request-path)
4452
Default Value: [ca/client_cert_issuing_cas.pem](/download/1.9.0/client_cert_issuing_cas.pem)
4553

4654
**Note:** Default file location are relative to the docker image work directory `/usr/local/apache2`.
4755
**Also Note:** Using non default .pem files for the environment variables above may require also modifying the default values of the environment variables [SSL_EXPECTED_CLIENT_S_DN_C_VALUES](bpe-reverse-proxy/configuration.html#ssl-expected-client-s-dn-c-values) and [SSL_EXPECTED_CLIENT_I_DN_CN_VALUES](bpe-reverse-proxy/configuration.html#ssl-expected-client-i-dn-cn-values).
4856

4957
### BPE Server
5058
Defaults are configured for the list of issuing, intermediate and root CAs used for validating client certificates as well as root CAs used for validating server certificates of local and remote DSF FHIR servers, the local mail server (if configured and SMTP over TLS required) and the OIDC provider when using [OpenID Connect](fhir/oidc.html) for authenticating local users.
59+
60+
**Note:** Default file location are relative to the docker image work directory `/opt/bpe`.
61+
62+
You can add an additional certificate authority (e.g., your hospital CA) for
63+
64+
- server certificates by creating a bind-mount of the CA file into the `/opt/bpe/ca/server_root_cas/` directory
65+
- client certificates by creating bind-mounts of the intermediate CA files and their root CA file into the `/opt/bpe/ca/client_ca_chains/` directory.
66+
67+
If you have an additional certificate authority (e.g., your hospital CA) as `hospital-root-ca.pem` in your `/opt/bpe/secrets` directory, you can add it by adding the following entry in your docker-compose.yml file:
68+
69+
```diff
70+
services:
71+
app:
72+
...
73+
volumes:
74+
+ - type: bind
75+
+ source: ./secrets/hospital-root-ca.pem
76+
+ target: /opt/bpe/ca/server_root_cas/hospital-root-ca.pem
77+
+ read_only: true
78+
```
79+
5180
Use the following environment variable to configure non default .pem files or override the existing files using docker bind mounts:
5281
* [DEV_DSF_SERVER_AUTH_TRUST_CLIENT_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-server-auth-trust-client-certificate-cas)
53-
Default Value: [ca/client_cert_ca_chains.pem](/download/1.9.0/client_cert_ca_chains.pem)
82+
Default Value: [ca/client_ca_chains](/download/1.9.0/client_cert_ca_chains.pem)
5483
* [DEV_DSF_BPE_FHIR_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-bpe-fhir-client-trust-server-certificate-cas)
55-
Default Value: [ca/server_cert_root_cas.pem](/download/1.9.0/server_cert_root_cas.pem)
84+
Default Value: [ca/server_root_cas](/download/1.9.0/server_cert_root_cas.pem)
5685
[DEV_DSF_BPE_MAIL_TRUST_SERVER_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-bpe-mail-trust-server-certificate-cas)
57-
Default Value: [ca/server_cert_root_cas.pem](/download/1.9.0/server_cert_root_cas.pem)
86+
Default Value: [ca/server_root_cas](/download/1.9.0/server_cert_root_cas.pem)
5887
* [DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_CLIENT_TRUST_SERVER_CERTIFICATE_CAS](bpe/configuration.html#dev-dsf-server-auth-oidc-provider-client-trust-server-certificate-cas)
59-
Default Value: [ca/server_cert_root_cas.pem](/download/1.9.0/server_cert_root_cas.pem)
60-
61-
**Note:** Default file location are relative to the docker image work directory `/opt/bpe`.
88+
Default Value: [ca/server_root_cas](/download/1.9.0/server_cert_root_cas.pem)
6289

6390
## List of Default Trusted Certificate Authorities
6491
If not mentioned explicitly, issuing CAs listed will sign X.509 certificates with [Extended Key Usage](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12) entries `TLS WWW server authentication` and `TLS WWW client authentication`.
@@ -143,6 +170,15 @@ If not mentioned explicitly, issuing CAs listed will sign X.509 certificates wit
143170
Info: https://crt.sh/?caid=713
144171
X509 Certificate: https://crt.sh/?id=133227
145172
Not after: Nov 5 08:35:58 2029 GMT
173+
* Root CA: **D-TRUST BR Root CA 1 2020 (ECC)**, optionally crosssigned by D-TRUST Root Class 3 CA 2 2009 [server only]
174+
Info: https://crt.sh/?caid=192951
175+
X509 Certificate: https://crt.sh/?id=3699642382 and https://crt.sh/?id=19754747817
176+
Not after: Feb 11 09:44:59 2035
177+
* Root CA: **D-TRUST BR Root CA 2 2023 (RSA)**, optionally crosssigned by D-TRUST Root Class 3 CA 2 2009 [server only]
178+
Info: https://crt.sh/?caid=266681
179+
X509 Certificate: https://crt.sh/?id=9609658147 and https://crt.sh/?id=19754898942
180+
Not after: May 9 08:56:30 2038 GMT
181+
146182
* Root CA: **USERTrust ECC Certification Authority** [will be removed in a future release, incl. derived CAs]
147183
Info: https://crt.sh/?caid=1390
148184
X509 Certificate: https://crt.sh/?id=2841410
@@ -192,3 +228,5 @@ If not mentioned explicitly, issuing CAs listed will sign X.509 certificates wit
192228
X509 Certificate: https://www.d-trust.net/cgi-bin/D-TRUST_Limited_Basic_CA_1-3_2019.crt
193229
Not after: Jun 19 08:15:51 2034 GMT
194230

231+
232+

0 commit comments

Comments
 (0)