diff options
author | Andrej Shadura <andrew.shadura@collabora.co.uk> | 2019-06-21 08:25:22 -0500 |
---|---|---|
committer | Andrej Shadura <andrew.shadura@collabora.co.uk> | 2019-06-21 08:25:22 -0500 |
commit | 073892d8d76ae764dd60bc6aeee65c9ef18dce07 (patch) | |
tree | 60eb0fafc0e5c12daf2c8639ae3258688cdbb0ae /docs/api.rst | |
parent | 7530acd1cd1f26d9c548de40c7e394ae7c751776 (diff) | |
parent | f836f2af1d9ec6af5188950bfb5624fa04888586 (diff) |
Update upstream source from tag 'upstream/18.1.0'
Update to upstream version '18.1.0'
with Debian dir 5e43d82f641e28f8e75ad47d77be606ff379e9b1
Diffstat (limited to 'docs/api.rst')
-rw-r--r-- | docs/api.rst | 29 |
1 files changed, 21 insertions, 8 deletions
diff --git a/docs/api.rst b/docs/api.rst index f80ea7f..91b1c23 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,16 +4,17 @@ API .. note:: - The APIs for RFC 6125 verification beyond DNS-IDs (i.e. hostnames) aren't public yet. - They are in place and used by the documented high-level APIs though. - Eventually they will become public. + So far, public APIs are only available for hostnames (RFC 6125) and IP addresses (RFC 2818). + All IDs specified by RFC 6125 are already implemented though. If you'd like to play with them and provide feedback have a look at the ``verify_service_identity`` function in the `_common module <https://github.com/pyca/service_identity/blob/master/src/service_identity/_common.py>`_. -.. currentmodule:: service_identity.pyopenssl +pyOpenSSL +========= +.. currentmodule:: service_identity.pyopenssl -.. autofunction:: verify_hostname(connection, hostname) +.. autofunction:: verify_hostname In practice, this may look like the following:: @@ -46,11 +47,23 @@ API conn.shutdown() conn.close() +.. autofunction:: verify_ip_address + + +PyCA cryptography +================= + +.. currentmodule:: service_identity.cryptography + +.. autofunction:: verify_certificate_hostname +.. autofunction:: verify_certificate_ip_address + + +Universal Errors and Warnings +============================= .. currentmodule:: service_identity .. autoexception:: VerificationError - .. autoexception:: CertificateError - -.. autoexception:: SubjectAltNameWarning
\ No newline at end of file +.. autoexception:: SubjectAltNameWarning |