certparser/README.md
2018-12-18 07:27:27 -05:00

1.7 KiB

Certparser

NOTE: CURRENTLY THIS IS NON-FUNCTIONAL. It is being restructured for packaging in PyPI. If you need it, the standalone version remains in OpTools for now.

What is it?

Certparser is a fairly small module that will parse an X.509 certificate. These are commonly referred to as "HTTPS certificates", "SSL certificates" (even though proper modern implementations should be using TLS), etc.

Certparser can operate on either a local file (or input stream, etc.) or remote (across a small subset of protocols which will expand with time).

X.509 is a complex thing, so if I missed part of it please let me know! (RFC numbers and sections very welcome.)

Quickstart

It can be invoked directly as a command:

./certparser.py 

(See ./certparser.py --help for more information on usage.)

Or as a python module:

import certparser

parser = certparser.CertParse('square-r00t.net')
print(parser.cert)      # prints the fetched certificate
print(parser.certinfo)  # prints the parsed certificate information

(See pydoc certparser for more information on usage.)

Requirements

Currently, only the following non-stdlib modules are required:

As parsing work continues and features/protocols are added, the following will probably be used (but are NOT currently):

And the following will be required optionally (but recommended):