Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rnag committed Oct 17, 2023
1 parent 0868d4e commit fb326ff
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Python Stand-alone Library to Download the SSL Certificate for *Any Host™*
**Why Use?**

* This library *always* returns the SSL certificate, if a server has one. This works for expired
and `self-signed certificate`_, whereas the builtin `ssl`_ library returns an empty ``dict`` if verification fails
and `self-signed certificate`_, whereas the builtin ``ssl`` library returns an empty ``dict`` if verification fails
for any reason (source_).

* The *only* dependency is `asn1crypto`_ (with over 300 stars on GitHub), which is ~94% more lightweight and robust
than a solution with `pyOpenSSL`_.
than a solution with `pyOpenSSL`_ (chart_).

* If a host *redirects* to another URL, this info is captured in ``Location`` and ``Status``.

Expand All @@ -46,6 +46,7 @@ Python Stand-alone Library to Download the SSL Certificate for *Any Host™*
* `certs_please`_ - Retrieve (concurrently) the SSL certificate(s) for a list of hostnames.
* `set_expired`_ - Helper function to check (at runtime) if a cert is expired or not.

.. _chart: https://github.com/rnag/cert-hero/blob/main/images/SizeComparison.png
.. _ssl: https://docs.python.org/3/library/ssl.html
.. _asn1crypto: https://pypi.org/project/asn1crypto
.. _pyOpenSSL: https://pypi.org/project/pyOpenSSL/
Expand Down

0 comments on commit fb326ff

Please sign in to comment.