DESCRIPTION.rst 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. =============================
  2. Service Identity Verification
  3. =============================
  4. .. image:: https://readthedocs.org/projects/service-identity/badge/?version=stable
  5. :target: https://service-identity.readthedocs.io/en/stable/?badge=stable
  6. :alt: Documentation Status
  7. .. image:: https://travis-ci.org/pyca/service_identity.svg?branch=master
  8. :target: https://travis-ci.org/pyca/service_identity
  9. :alt: CI status
  10. .. image:: https://codecov.io/github/pyca/service_identity/branch/master/graph/badge.svg
  11. :target: https://codecov.io/github/pyca/service_identity
  12. :alt: Test Coverage
  13. .. image:: https://www.irccloud.com/invite-svg?channel=%23cryptography-dev&hostname=irc.freenode.net&port=6697&ssl=1
  14. :target: https://www.irccloud.com/invite?channel=%23cryptography-dev&hostname=irc.freenode.net&port=6697&ssl=1
  15. .. begin
  16. Use this package if:
  17. - you use pyOpenSSL_ and don’t want to be MITM_\ ed or
  18. - if you want to verify that a `PyCA cryptography`_ certificate is valid for a certain hostname.
  19. ``service_identity`` aspires to give you all the tools you need for verifying whether a certificate is valid for the intended purposes.
  20. In the simplest case, this means *host name verification*.
  21. However, ``service_identity`` implements `RFC 6125`_ fully and plans to add other relevant RFCs too.
  22. ``service_identity``\ ’s documentation lives at `Read the Docs <https://service-identity.readthedocs.io/>`_, the code on `GitHub <https://github.com/pyca/service_identity>`_.
  23. .. _Twisted: https://twistedmatrix.com/
  24. .. _pyOpenSSL: https://pypi.python.org/pypi/pyOpenSSL/
  25. .. _MITM: https://en.wikipedia.org/wiki/Man-in-the-middle_attack
  26. .. _RFC 6125: http://www.rfc-editor.org/info/rfc6125
  27. .. _PyCA cryptography: https://cryptography.io/
  28. Release Information
  29. ===================
  30. 17.0.0 (2017-05-23)
  31. -------------------
  32. Deprecations:
  33. ^^^^^^^^^^^^^
  34. - Since Chrome 58 and Firefox 48 both don't accept certificates that contain only a Common Name, its usage is hereby deprecated in ``service_identity`` too.
  35. We have been raising a warning since 16.0.0 and the support will be removed in mid-2018 for good.
  36. Changes:
  37. ^^^^^^^^
  38. - When ``service_identity.SubjectAltNameWarning`` is raised, the Common Name of the certificate is now included in the warning message.
  39. `#17 <https://github.com/pyca/service_identity/pull/17>`_
  40. - Added ``cryptography.x509`` backend for verifying certificates.
  41. `#18 <https://github.com/pyca/service_identity/pull/18>`_
  42. - Wildcards (``*``) are now only allowed if they are the leftmost label in a certificate.
  43. This is common practice by all major browsers.
  44. `#19 <https://github.com/pyca/service_identity/pull/19>`_
  45. `Full changelog <https://service-identity.readthedocs.io/en/stable/changelog.html>`_.
  46. Authors
  47. =======
  48. ``service_identity`` is written and maintained by `Hynek Schlawack <https://hynek.me/>`_.
  49. The development is kindly supported by `Variomedia AG <https://www.variomedia.de/>`_.
  50. Other contributors can be found in `GitHub's overview <https://github.com/pyca/service_identity/graphs/contributors>`_.