Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add list-expiring-certs to README.md #15

Merged
merged 1 commit into from
Feb 26, 2024
Merged

Add list-expiring-certs to README.md #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,20 @@ A suite of bash scripts for automating very basic OpenSSL Certificate Authority

#### Scripts:

| Name | Description |
| ----------------- | ----------------------------------------------------------------- |
| create-client | Create a client certificate |
| create-codesign | Create a code signing certificate |
| create-root-ca | Create a root signing CA |
| create-server | Create a server certificate |
| create-signing-ca | Create an intermediate signing CA inside a root CA |
| gen-html | Create a shareable html directory structure for publishing the CA |
| revoke-cert | Revoke a (client\|server) certificate |
| show-status | Show the infos about the current CA (signed certificates...) |
| sign-csr | Sign an imported client certificate |
| create-csr | Create a client certificate |
| update-crl | Updates the CRL |
| Name | Description |
| ------------------- | ----------------------------------------------------------------- |
| create-client | Create a client certificate |
| create-codesign | Create a code signing certificate |
| create-root-ca | Create a root signing CA |
| create-server | Create a server certificate |
| create-signing-ca | Create an intermediate signing CA inside a root CA |
| gen-html | Create a shareable html directory structure for publishing the CA |
| revoke-cert | Revoke a (client\|server) certificate |
| show-status | Show the infos about the current CA (signed certificates...) |
| sign-csr | Sign an imported client certificate |
| create-csr | Create a client certificate |
| update-crl | Updates the CRL |
| list-expiring-certs | List certificates that are about to expire |

#### Important files:

Expand Down Expand Up @@ -152,6 +153,18 @@ $CA_DIR/bin/revoke-cert -c $CA_DIR/certs/server/FQDN-Description/FQDN-Descriptio
$CA_DIR/ca/ca.crl
```

### Monitor certificates using a cron job

Running **list-expiring-certs** from within a CA installation will list all
certificates that will expire within a set time. If you have cron jobs set up
to email you on non-zero exits, a job like this would email you a list of
certificates with two weeks left every weekday morning:

```
[email protected]
0 4 * * 1-5 $CA_DIR/bin/list-expiring-certs -c -t '2 weeks'
```

## Caveats

These scripts are very simple, and make some hard-coded assumptions about behavior and configuration:
Expand Down
Loading