Skip to content

Commit fad0beb

Browse files
authored
Merge pull request #159 from HarperDB/separate-ca
Separate certificate settings for client and server in certificate di…
2 parents 735615f + 7cfd523 commit fad0beb

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

docs/developers/security/certificate-management.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@ To replace the certificates, either replace the contents of the existing certifi
2424

2525
```yaml
2626
tls:
27-
certificate: ~/hdb/keys/certificate.pem
28-
certificateAuthority: ~/hdb/keys/ca.pem
29-
privateKey: ~/hdb/keys/privateKey.pem
27+
certificate: ~/hdb/keys/certificate.pem
28+
privateKey: ~/hdb/keys/privateKey.pem
3029
```
3130
3231
`operationsApi.tls` configuration is optional. If it is not set Harper will default to the values in the `tls` section.
@@ -35,10 +34,23 @@ tls:
3534
operationsApi:
3635
tls:
3736
certificate: ~/hdb/keys/certificate.pem
38-
certificateAuthority: ~/hdb/keys/ca.pem
3937
privateKey: ~/hdb/keys/privateKey.pem
4038
```
4139

40+
### mTLS
41+
42+
Mutual TLS (mTLS) is a security protocol that requires both the client and the server to present certificates to each other. Requiring a client certificate can be useful for authenticating clients and ensuring that only authorized clients can access your Harper instance. This can be enabled by setting the `http.mtls` configuration in `harperdb-config.yaml` to `true` and providing a certificate authority in the TLS section:
43+
44+
```yaml
45+
46+
http:
47+
mtls: true
48+
...
49+
tls:
50+
certificateAuthority: ~/hdb/keys/ca.pem
51+
...
52+
```
53+
4254
### Option: Nginx Reverse Proxy
4355

4456
Instead of enabling HTTPS for Harper, Nginx can be used as a reverse proxy for Harper.

0 commit comments

Comments
 (0)