diff --git a/README.md b/README.md index a645fd4..500ec87 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# OCSPCRL +# OCSP Server -OCSPCRL is a minimal implementation of both a OCSP and CRL server in Golang. It provides the following http endpoints: +OCSP Server is a minimal implementation of both a OCSP and CRL server in Golang, using a single CRL as the source for both interfaces. +Originally created by Florian Bauer and now adapted for Spacebar. It provides the following http endpoints: | Endpoint | Description | |------------|----------------------------------------------------------| @@ -10,7 +11,7 @@ OCSPCRL is a minimal implementation of both a OCSP and CRL server in Golang. It | `/ca` | Issuer CA certificate in DER format | | `/ca.pem` | Issuer CA certificate in PEM format | -All what you need is to provide a CRL file, the root certificate and cert/key with extendedKeyUsage `OCSPSigning` to allow the OCSP server to sign the OCSP responses. +You need to provide a CRL file, the root certificate and cert/key with extendedKeyUsage `OCSPSigning` to allow the OCSP server to sign the OCSP responses. When using OCSP, the certificate is checked against the CRL for validity. Synchronization of the CAs CRL is out of scope of this project. You can use any mechanism to update the CRL file. Just notify the ocspcrl server process via `SIGHUP` signal to reload the CRL file.