[rs-commit] r41 - /redwax-tool/trunk/README

[rs-commit at redwax.eu]

Author: minfrin at redwax.eu
Date: Thu Nov 18 23:10:40 2021
New Revision: 41

Log:
Add readme.

Modified:
    redwax-tool/trunk/README

Modified: redwax-tool/trunk/README
==============================================================================
--- redwax-tool/trunk/README	(original)
+++ redwax-tool/trunk/README	Thu Nov 18 23:10:40 2021
@@ -0,0 +1,42 @@
+#The Redwax Tool.
+
+This tool reads in certificates and keys from various formats and origins,
+searches through the certificates and keys for those of interest, and
+writes the results to destinations of your choice.
+
+The tool tries to support as many databases and certificate formats as
+possible out of the box, so that certificate and key conversion is a one
+line command.
+
+##Simple example:
+
+redwax-tool --pem-in ~/in/*.pem --filter search --hostname example.com \
+  --cert-out --chain-out --pem-out ~/out.pem
+
+##Sources:
+
+Certificates and keys can be read from:
+
+- PEM files.
+- PKCS11 URLs (smartcards)
+
+##Filters:
+
+Certificates can be filtered as follows:
+
+- passthrough: all certificates and keys are passed through as is
+- search: certificates are searched for, and matched up with their intermediates
+  roots and keys.
+- verify: certificates are searched for, and then full verification is
+  performed on the certificates and resulting chain.
+
+##Destinations:
+
+Certificates and keys can be written to:
+
+- PEM files
+- PKCS11 URLs (snamrtcards)
+- PKCS12 files
+- NSS databases
+
+