Skip to content

Commit ffc765e

Browse files
committed
docs: 📝 update readme to include motivation
1 parent 5ca53a2 commit ffc765e

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,24 @@
33
# test-certs
44
A simple tool to generate a root certificate authority (CA), intermediate, client, and server certificates for testing purposes.
55

6-
This tool is not intended for production use. Instead use tools like [`step-ca`](https://smallstep.com/docs/step-ca/) or similar.
6+
> This tool is not intended for production use. Please use a dedicated certificate infrastructure!
77
8+
## Motivation
9+
10+
You want to have an easy and fast way to test TLS or even mTLS connections with x509 certificates but your infrastructure lags the processes or ways to get them?
11+
Or you have a testing environment that you deploy via ansible and want to create your on certificates to test TLS connections reliably?
12+
13+
This project could be the answer then!
14+
15+
Write your certificate chain configuration once and create all necessary certificates when ever you need new ones!
816

917
## Example
1018

11-
An example on how to create an intermediate ca with a server and a client certificate.
19+
An example configuration file on how to create a root certificate that issues an intermediate ca which again issues a server and a client certificate.
20+
21+
[Intermediate CA](./test-certs/tests/examples/intermediate_ca.yaml)
22+
23+
## Other Tools
1224

13-
[Intermediate CA](./test-certs/tests/examples/intermediate_ca.yaml)
25+
- [`step-ca`](https://smallstep.com/docs/step-ca/): A complete Public-Key-Infrastructure (PKI) that has a lot of features!
26+
- openssl: The good old way to create any certificate you need.

0 commit comments

Comments
 (0)