taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #267 from nats-io/ocsp-config

Browse Source 
Add docs on configuration of OCSP
This commit is contained in:
Ginger Collison 2021-06-23 16:54:01 -05:00 committed by GitHub
commit e767366360
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 87 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
SUMMARY.md
View File

@ -100,6 +100,7 @@
* [Monitoring](nats-server/configuration/monitoring.md)
* [MQTT](nats-server/configuration/mqtt/README.md)
* [Configuration](nats-server/configuration/mqtt/mqtt_config.md)
* [OCSP Stapling](nats-server/configuration/ocsp.md)
* [Subject Mapping and Traffic Shaping](nats-server/configuration/subject_mapping.md)
* [System Events](nats-server/configuration/sys_accounts/README.md)
* [System Events & Decentralized JWT Tutorial](nats-server/configuration/sys_accounts/sys_accounts.md)

86
nats-server/configuration/ocsp.md Normal file
View File

@ -0,0 +1,86 @@
# OCSP Stapling
_Supported since NATS Server version 2.3_
[OCSP Stapling](https://en.wikipedia.org/wiki/OCSP_stapling) is honored by default for certificates that have
the [status_request Must-Staple flag](https://datatracker.ietf.org/doc/html/rfc6961).
When a certificate is configured with OCSP Must-Staple, the NATS Server will fetch staples from the configured OCSP responder URL
that is present in a certificate. For example, given a certificate with the following configuration:
```
[ ext_ca ]
...
authorityInfoAccess = OCSP;URI:http://ocsp.example.net:80
tlsfeature = status_request
...
```
The NATS server will make a request to the OCSP responder to fetch a new staple which will then be presented to
any TLS connection that is accepted by the server during the TLS handshake.
OCSP Stapling can be explicitly enabled or disabled in the NATS Server by setting the following flag in the NATS configuration file at the top-level:
```hcl
ocsp: false
```
**Note**: When OCSP Stapling is disabled, the NATS Server will not request staples even if the certificate has
the Must-Staple flag.
## Advanced Configuration
By default, the NATS Server will be running in OCSP `auto` mode. In this mode the server will only fetch
staples when the Must-Staple flag is configured in the certificate.
There are other OCSP modes that control the behavior as to whether OCSP should be enforced and the server
should shutdown if the certificate runs with a revoked staple:
| Mode | Description | Server shutdowns when revoked |
| --------- | ---- | ----- |
| auto | Enables OCSP Stapling when the certificate has the must staple/status_request flag | No |
| must | Enables OCSP Staping when the certificate has the must staple/status_request flag | Yes |
| always | Enables OCSP Stapling for all certificates | Yes |
| never | Disables OCSP Stapling even if must staple flag is present (same as `ocsp: false`) | No |
For example, in the following OCSP configuration, the mode is set to `must`. This means that staples will be fetched only for certificates
that have the Must-Staple flag enabled as well, but in case of revocation the server will shutdown rather than run with a revoked staple.
In this configuration, the `url` will also override the OCSP responder URL that may have been configured in
the certificate.
```hcl
ocsp {
mode: must
url: "http://ocsp.example.net"
}
```
If staples are always required, regardless of the configuration of the certificate, you can enforce the behavior as follows:
```hcl
ocsp {
mode: always
url: "http://ocsp.example.net"
}
```
## Caching of Staples
When a `store_dir` is configured in the NATS Server, the directory will be used to cache staples on disk
to allow the server to resume in case of restarts without having to make another request to the OCSP responder
if the staple is still valid.
```hcl
ocsp: true
store_dir: "/path/to/store/dir"
tls {
cert_file: "configs/certs/ocsp/server-status-request-url.pem"
key_file: "configs/certs/ocsp/server-status-request-url-key.pem"
ca_file: "configs/certs/ocsp/ca-cert.pem"
timeout: 5
}
```
If JetStream is enabled, then the same `store_dir` will be reused and disk caching will be automatically enabled.