cert-utils


Namecert-utils JSON
Version 0.1.6 PyPI version JSON
download
home_pagehttps://github.com/aptise/cert_utils
SummaryTLS/SSL Certiicate Utilities
upload_time2024-06-26 19:52:10
maintainerNone
docs_urlNone
authorJonathan Vanasco
requires_python>=3.6
licenseMIT
keywords web
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Python package](https://github.com/jvanasco/cert_utils/workflows/Python%20package/badge.svg)

cert_utils
==========

**cert_utils** offers support for common operations when dealing with SSL
Certificates within the LetsEncrypt ecosystem.

This library was originally developed as a toolkit for bugfixing and
troubleshooting large ACME installations.

**cert_utils** will attempt to process operations with Python when possible.
If the required Python libraries are not installed, it will fallback to using
OpenSSL commandline via subprocesses.  **cert_utils** does a bit of work to
standardize certificate operations across versions of Python and OpenSSL that
do not share the same inputs, outputs or invocations.

**cert_utils** was formerly part of the
**[peter_sslers](https://github.com/aptise/peter_sslers)** ACME Client and
Certificate Management System, and has been descoped into it's own library.

This library *does not* process Certificates and Certificate Data itself.
Instead, it offers a simplified API to invoke other libraries and extract data
from Certificates.  It was designed for developers and system administrators to
more easily use the various libraries to accomplish specific tasks on the
commandline or as part of other projects.

Examples:
---------

For example, `cert_utils.parse_cert` returns a Python dict of key fields in a
certificate.  This can make writing a script to analyze large directories of
certificates fairly simple.


### Parse a Leaf/End-Entity

Example Script:

```!python
import cert_utils
import pprint

cert_path = "./tests/test_data/unit_tests/cert_001/cert.pem"
cert_pem = open(cert_path, 'r').read()
data = cert_utils.parse_cert(cert_pem)
pprint.pprint(data)
```

Result:

    {'SubjectAlternativeName': ['a.example.com',
                                'b.example.com',
                                'c.example.com',
                                'd.example.com'],
     'authority_key_identifier': 'D159010094B0A62ADBABE54B2321CA1B6EBA93E7',
     'enddate': datetime.datetime(2025, 6, 16, 20, 19, 30),
     'fingerprint_sha1': 'F63C5C66B52551EEDADF7CE44301D646680B8F5D',
     'issuer': 'CN=Pebble Intermediate CA 601ea1',
     'issuer_uri': None,
     'key_technology': 'RSA',
     'spki_sha256': '34E67CC615761CBADAF430B2E02E0EC39C99EEFC73CCE469B18AE54A37EF6942',
     'startdate': datetime.datetime(2020, 6, 16, 20, 19, 30),
     'subject': 'CN=a.example.com'}

The payload contains `SubjectAlternativeName` listing all the domains, along
with `enddate` and `startdate` in Python datetime objects for easy comparison.

### Parse a Trusted Root

Example Script:

```!python
import cert_utils
import pprint

cert_path = "./src/cert_utils/letsencrypt-certs/isrgrootx1.pem"
cert_pem = open(cert_path, 'r').read()
data = cert_utils.parse_cert(cert_pem)
pprint.pprint(data)
```

Result:

    {'SubjectAlternativeName': None,
     'authority_key_identifier': None,
     'enddate': datetime.datetime(2035, 6, 4, 11, 4, 38),
     'fingerprint_sha1': 'CABD2A79A1076A31F21D253635CB039D4329A5E8',
     'issuer': 'C=US\nO=Internet Security Research Group\nCN=ISRG Root X1',
     'issuer_uri': None,
     'key_technology': 'RSA',
     'spki_sha256': '0B9FA5A59EED715C26C1020C711B4F6EC42D58B0015E14337A39DAD301C5AFC3',
     'startdate': datetime.datetime(2015, 6, 4, 11, 4, 38),
     'subject': 'C=US\nO=Internet Security Research Group\nCN=ISRG Root X1'}

The payload on Trusted Roots is identical.


Why does this exist?
--------------------

The [peter_sslers](https://github.com/aptise/peter_sslers) project was designed
to deploy on a wide variety of production servers that did not share common
Python and OpenSSL installations.  Earlier versions of the library
(within peter_sslers) supported both Python2.7 and Python3, as it was common to
encounter a machine that did not have Python3 installed.  Although it is still
common to find these machines, Python2.7 was dropped to take advantage of
typing.  Depending on the version of OpenSSL installed on a system,
**cert_utils** will invoke the binary or regex the output to bridge support
through a unified interface.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/aptise/cert_utils",
    "name": "cert-utils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "web",
    "author": "Jonathan Vanasco",
    "author_email": "jonathan@findmeon.com",
    "download_url": "https://files.pythonhosted.org/packages/e2/fd/e3f41e52e630513a38f684944623d856fff3033358d3a8aeb87bf52e6275/cert_utils-0.1.6.tar.gz",
    "platform": null,
    "description": "![Python package](https://github.com/jvanasco/cert_utils/workflows/Python%20package/badge.svg)\n\ncert_utils\n==========\n\n**cert_utils** offers support for common operations when dealing with SSL\nCertificates within the LetsEncrypt ecosystem.\n\nThis library was originally developed as a toolkit for bugfixing and\ntroubleshooting large ACME installations.\n\n**cert_utils** will attempt to process operations with Python when possible.\nIf the required Python libraries are not installed, it will fallback to using\nOpenSSL commandline via subprocesses.  **cert_utils** does a bit of work to\nstandardize certificate operations across versions of Python and OpenSSL that\ndo not share the same inputs, outputs or invocations.\n\n**cert_utils** was formerly part of the\n**[peter_sslers](https://github.com/aptise/peter_sslers)** ACME Client and\nCertificate Management System, and has been descoped into it's own library.\n\nThis library *does not* process Certificates and Certificate Data itself.\nInstead, it offers a simplified API to invoke other libraries and extract data\nfrom Certificates.  It was designed for developers and system administrators to\nmore easily use the various libraries to accomplish specific tasks on the\ncommandline or as part of other projects.\n\nExamples:\n---------\n\nFor example, `cert_utils.parse_cert` returns a Python dict of key fields in a\ncertificate.  This can make writing a script to analyze large directories of\ncertificates fairly simple.\n\n\n### Parse a Leaf/End-Entity\n\nExample Script:\n\n```!python\nimport cert_utils\nimport pprint\n\ncert_path = \"./tests/test_data/unit_tests/cert_001/cert.pem\"\ncert_pem = open(cert_path, 'r').read()\ndata = cert_utils.parse_cert(cert_pem)\npprint.pprint(data)\n```\n\nResult:\n\n    {'SubjectAlternativeName': ['a.example.com',\n                                'b.example.com',\n                                'c.example.com',\n                                'd.example.com'],\n     'authority_key_identifier': 'D159010094B0A62ADBABE54B2321CA1B6EBA93E7',\n     'enddate': datetime.datetime(2025, 6, 16, 20, 19, 30),\n     'fingerprint_sha1': 'F63C5C66B52551EEDADF7CE44301D646680B8F5D',\n     'issuer': 'CN=Pebble Intermediate CA 601ea1',\n     'issuer_uri': None,\n     'key_technology': 'RSA',\n     'spki_sha256': '34E67CC615761CBADAF430B2E02E0EC39C99EEFC73CCE469B18AE54A37EF6942',\n     'startdate': datetime.datetime(2020, 6, 16, 20, 19, 30),\n     'subject': 'CN=a.example.com'}\n\nThe payload contains `SubjectAlternativeName` listing all the domains, along\nwith `enddate` and `startdate` in Python datetime objects for easy comparison.\n\n### Parse a Trusted Root\n\nExample Script:\n\n```!python\nimport cert_utils\nimport pprint\n\ncert_path = \"./src/cert_utils/letsencrypt-certs/isrgrootx1.pem\"\ncert_pem = open(cert_path, 'r').read()\ndata = cert_utils.parse_cert(cert_pem)\npprint.pprint(data)\n```\n\nResult:\n\n    {'SubjectAlternativeName': None,\n     'authority_key_identifier': None,\n     'enddate': datetime.datetime(2035, 6, 4, 11, 4, 38),\n     'fingerprint_sha1': 'CABD2A79A1076A31F21D253635CB039D4329A5E8',\n     'issuer': 'C=US\\nO=Internet Security Research Group\\nCN=ISRG Root X1',\n     'issuer_uri': None,\n     'key_technology': 'RSA',\n     'spki_sha256': '0B9FA5A59EED715C26C1020C711B4F6EC42D58B0015E14337A39DAD301C5AFC3',\n     'startdate': datetime.datetime(2015, 6, 4, 11, 4, 38),\n     'subject': 'C=US\\nO=Internet Security Research Group\\nCN=ISRG Root X1'}\n\nThe payload on Trusted Roots is identical.\n\n\nWhy does this exist?\n--------------------\n\nThe [peter_sslers](https://github.com/aptise/peter_sslers) project was designed\nto deploy on a wide variety of production servers that did not share common\nPython and OpenSSL installations.  Earlier versions of the library\n(within peter_sslers) supported both Python2.7 and Python3, as it was common to\nencounter a machine that did not have Python3 installed.  Although it is still\ncommon to find these machines, Python2.7 was dropped to take advantage of\ntyping.  Depending on the version of OpenSSL installed on a system,\n**cert_utils** will invoke the binary or regex the output to bridge support\nthrough a unified interface.",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "TLS/SSL Certiicate Utilities",
    "version": "0.1.6",
    "project_urls": {
        "Homepage": "https://github.com/aptise/cert_utils"
    },
    "split_keywords": [
        "web"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e2fde3f41e52e630513a38f684944623d856fff3033358d3a8aeb87bf52e6275",
                "md5": "a6af1ef3d88691366166ce32300fced6",
                "sha256": "47aec3e545517c2ef955cf1e01377f908777e57153f25c1567fc04185a4496d9"
            },
            "downloads": -1,
            "filename": "cert_utils-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "a6af1ef3d88691366166ce32300fced6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 180541,
            "upload_time": "2024-06-26T19:52:10",
            "upload_time_iso_8601": "2024-06-26T19:52:10.270036Z",
            "url": "https://files.pythonhosted.org/packages/e2/fd/e3f41e52e630513a38f684944623d856fff3033358d3a8aeb87bf52e6275/cert_utils-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-26 19:52:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aptise",
    "github_project": "cert_utils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "cert-utils"
}
        
Elapsed time: 0.34358s