1=============================
2Service Identity Verification
3=============================
4
5.. image:: https://readthedocs.org/projects/service-identity/badge/?version=stable
6   :target: https://service-identity.readthedocs.io/en/stable/?badge=stable
7   :alt: Documentation Status
8
9.. image:: https://travis-ci.org/pyca/service_identity.svg?branch=master
10   :target: https://travis-ci.org/pyca/service_identity
11   :alt: CI status
12
13.. image:: https://codecov.io/github/pyca/service_identity/branch/master/graph/badge.svg
14   :target: https://codecov.io/github/pyca/service_identity
15   :alt: Test Coverage
16
17.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
18   :target: https://github.com/ambv/black
19   :alt: Code style: black
20
21.. image:: https://www.irccloud.com/invite-svg?channel=%23cryptography-dev&hostname=irc.freenode.net&port=6697&ssl=1
22    :target: https://www.irccloud.com/invite?channel=%23cryptography-dev&hostname=irc.freenode.net&port=6697&ssl=1
23
24.. begin
25
26Use this package if:
27
28- you use pyOpenSSL_ and don’t want to be MITM_\ ed or
29- if you want to verify that a `PyCA cryptography`_ certificate is valid for a certain hostname or IP address.
30
31``service_identity`` aspires to give you all the tools you need for verifying whether a certificate is valid for the intended purposes.
32
33In the simplest case, this means *host name verification*.
34However, ``service_identity`` implements `RFC 6125`_ fully and plans to add other relevant RFCs too.
35
36``service_identity``\ ’s documentation lives at `Read the Docs <https://service-identity.readthedocs.io/>`_, the code on `GitHub <https://github.com/pyca/service_identity>`_.
37
38
39.. _Twisted: https://twistedmatrix.com/
40.. _pyOpenSSL: https://pypi.org/project/pyOpenSSL/
41.. _MITM: https://en.wikipedia.org/wiki/Man-in-the-middle_attack
42.. _RFC 6125: https://www.rfc-editor.org/info/rfc6125
43.. _PyCA cryptography: https://cryptography.io/
44