diff --git a/README.md b/README.md index 4d019c4..e229e9d 100644 --- a/README.md +++ b/README.md @@ -24,16 +24,41 @@ We use [glide][1] for managing vendored dependencies. Certigo can read certificates/keystores in various formats and dump them to stdout. -Currently supported formats are DER, PEM, JCEKS and PKCS12. It's a one-stop shop for debugging/analyzing certs. +Currently supported formats are DER, PEM, JCEKS/JKS and PKCS12. Certigo will display information in a human-readable way, and print warnings for common mistakes (such as small key sizes or weak signatures/hash functions). Certigo can also convert any input to a series of PEM blocks, which is useful if you want to e.g. dump the contents of PKCS12/JCEKS keystores into something more useful. -For example (from stdin): +``` +usage: certigo [] [ ...] + +A command line certificate examination utility. + +Flags: + --help Show context-sensitive help (also try --help-long and --help-man). + --version Show application version. + +Commands: + help [...] + Show help. + + dump [] [...] + Display information about a certificate. + + connect [] [] + Connect to a server and print its certificate. + + pem [] [...] + Convert input to PEM-formatted blocks. +``` + +### Examples + +Display information about a certificate (from stdin): -Or from a file: +Display information about a certificate (from a file): -You can dump a cert chain from a TLS server. Unlike `openssl x509 -text`, certigo will dump the entire chain, not just the first certificate: +Display information about a certificate from a remote server: diff --git a/examples/example_1_245953.svg b/examples/example_1_245953.svg index 9cff3c4..e19344c 100644 --- a/examples/example_1_245953.svg +++ b/examples/example_1_245953.svg @@ -6,7 +6,7 @@ viewBox="0 0 60 51.4"> - $ cat certs/cert.pem | ./certigo dump + $ certigo dump < cert.pem ** CERTIFICATE 1 ** Serial: 11578389349061131131 Not Before: 2016-05-27 21:15:31 +0000 UTC diff --git a/examples/example_2_d848d5.svg b/examples/example_2_d848d5.svg index 8bae2ab..0ed71ca 100644 --- a/examples/example_2_d848d5.svg +++ b/examples/example_2_d848d5.svg @@ -6,7 +6,7 @@ viewBox="0 0 60 55"> - $ ./certigo dump certs/cert.jks + $ certigo dump keystore.jceks Enter password: ** CERTIFICATE 1 ** Alias: second-key diff --git a/examples/example_3_ffafad.svg b/examples/example_3_ffafad.svg index 1ca716c..9d45ce7 100644 --- a/examples/example_3_ffafad.svg +++ b/examples/example_3_ffafad.svg @@ -9,7 +9,7 @@ - $ ./certigo connect squareup.com:443 + $ certigo connect squareup.com:443 ** CERTIFICATE 1 ** Serial: 1413474646 Not Before: 2014-12-22 20:28:37 +0000 UTC