doc: add readme

Signed-off-by: Florian Bauer <florian@fsrv.xyz>
This commit is contained in:
Florian Bauer
2025-04-21 18:11:06 +02:00
parent a3bdfc1a9c
commit e5351bd313

11
README.md Normal file
View File

@@ -0,0 +1,11 @@
# OCSPCRL
OCSPCRL is a minimal implementation of both a OCSP and CRL server in Golang. It provides the following http endpoints:
- `/ocsp` - OCSP responder
- `/crl` - CRL responder
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.
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.