Hynek Schlawack | 65e4def | 2016-03-13 15:07:52 +0100 | [diff] [blame] | 1 | ======================================================== |
Hynek Schlawack | 5bc17cb | 2015-04-30 19:21:40 +0200 | [diff] [blame] | 2 | pyOpenSSL -- A Python wrapper around the OpenSSL library |
Hynek Schlawack | 65e4def | 2016-03-13 15:07:52 +0100 | [diff] [blame] | 3 | ======================================================== |
Paul Kehrer | 158f569 | 2015-04-15 10:31:36 -0400 | [diff] [blame] | 4 | |
Hynek Schlawack | ac7fbb8 | 2016-03-19 07:42:15 +0100 | [diff] [blame] | 5 | .. image:: https://readthedocs.org/projects/pyopenssl/badge/?version=stable |
Hynek Schlawack | 8102128 | 2017-07-20 10:32:37 +0200 | [diff] [blame] | 6 | :target: https://pyopenssl.org/en/stable/ |
Hynek Schlawack | ac7fbb8 | 2016-03-19 07:42:15 +0100 | [diff] [blame] | 7 | :alt: Stable Docs |
Paul Kehrer | 158f569 | 2015-04-15 10:31:36 -0400 | [diff] [blame] | 8 | |
Paul Kehrer | ffab488 | 2020-08-18 23:12:58 -0500 | [diff] [blame] | 9 | .. image:: https://travis-ci.com/pyca/pyopenssl.svg?branch=master |
| 10 | :target: https://travis-ci.com/pyca/pyopenssl |
Hynek Schlawack | b3b2765 | 2015-07-03 16:50:27 +0200 | [diff] [blame] | 11 | :alt: Build status |
| 12 | |
Hynek Schlawack | f6c96af | 2017-04-20 12:34:58 +0200 | [diff] [blame] | 13 | .. image:: https://codecov.io/github/pyca/pyopenssl/branch/master/graph/badge.svg |
Hynek Schlawack | b3b2765 | 2015-07-03 16:50:27 +0200 | [diff] [blame] | 14 | :target: https://codecov.io/github/pyca/pyopenssl |
| 15 | :alt: Test coverage |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 16 | |
Paul Kehrer | 959a031 | 2018-05-16 14:14:31 -0400 | [diff] [blame] | 17 | **Note:** The Python Cryptographic Authority **strongly suggests** the use of `pyca/cryptography`_ |
| 18 | where possible. If you are using pyOpenSSL for anything other than making a TLS connection |
| 19 | **you should move to cryptography and drop your pyOpenSSL dependency**. |
Hynek Schlawack | 5bc17cb | 2015-04-30 19:21:40 +0200 | [diff] [blame] | 20 | |
Paul Kehrer | 959a031 | 2018-05-16 14:14:31 -0400 | [diff] [blame] | 21 | High-level wrapper around a subset of the OpenSSL library. Includes |
Hynek Schlawack | 5bc17cb | 2015-04-30 19:21:40 +0200 | [diff] [blame] | 22 | |
Hynek Schlawack | ac7fbb8 | 2016-03-19 07:42:15 +0100 | [diff] [blame] | 23 | * ``SSL.Connection`` objects, wrapping the methods of Python's portable sockets |
Hynek Schlawack | 5bc17cb | 2015-04-30 19:21:40 +0200 | [diff] [blame] | 24 | * Callbacks written in Python |
| 25 | * Extensive error-handling mechanism, mirroring OpenSSL's error codes |
| 26 | |
| 27 | ... and much more. |
| 28 | |
Hynek Schlawack | ac7fbb8 | 2016-03-19 07:42:15 +0100 | [diff] [blame] | 29 | You can find more information in the documentation_. |
| 30 | Development takes place on GitHub_. |
Jean-Paul Calderone | 2691849 | 2014-02-02 15:59:19 -0500 | [diff] [blame] | 31 | |
Ewoud Kohl van Wijngaarden | 99d1f9b | 2014-06-16 10:45:25 +0200 | [diff] [blame] | 32 | |
Hynek Schlawack | ac7fbb8 | 2016-03-19 07:42:15 +0100 | [diff] [blame] | 33 | Discussion |
| 34 | ========== |
Jean-Paul Calderone | 2691849 | 2014-02-02 15:59:19 -0500 | [diff] [blame] | 35 | |
Hynek Schlawack | ac7fbb8 | 2016-03-19 07:42:15 +0100 | [diff] [blame] | 36 | If you run into bugs, you can file them in our `issue tracker`_. |
| 37 | |
| 38 | We maintain a cryptography-dev_ mailing list for both user and development discussions. |
| 39 | |
| 40 | You can also join ``#cryptography-dev`` on Freenode to ask questions or get involved. |
| 41 | |
| 42 | |
Hynek Schlawack | 8102128 | 2017-07-20 10:32:37 +0200 | [diff] [blame] | 43 | .. _documentation: https://pyopenssl.org/ |
Hynek Schlawack | ac7fbb8 | 2016-03-19 07:42:15 +0100 | [diff] [blame] | 44 | .. _`issue tracker`: https://github.com/pyca/pyopenssl/issues |
| 45 | .. _cryptography-dev: https://mail.python.org/mailman/listinfo/cryptography-dev |
| 46 | .. _GitHub: https://github.com/pyca/pyopenssl |
Paul Kehrer | 959a031 | 2018-05-16 14:14:31 -0400 | [diff] [blame] | 47 | .. _`pyca/cryptography`: https://github.com/pyca/cryptography |