diff options
author | Matěj Cepl <mcepl@redhat.com> | 2013-10-14 13:16:21 +0200 |
---|---|---|
committer | Matěj Cepl <mcepl@cepl.eu> | 2016-05-20 21:39:29 +0200 |
commit | bb724f7a4c7d44599cea33af2bd757d425b2a786 (patch) | |
tree | 26d3f2b731aecca3aba41a17e547d3d2398ead29 | |
parent | 35af51de572383c317a8e1e94ef09a00e7c369eb (diff) | |
download | m2crypto-bb724f7a4c7d44599cea33af2bd757d425b2a786.tar.gz |
Change extension of README to .rst.
-rw-r--r-- | README.rst | 52 |
1 files changed, 28 insertions, 24 deletions
@@ -6,7 +6,7 @@ M2Crypto :Web-Site: https://gitlab.com/m2crypto/m2crypto M2Crypto = Python + OpenSSL + SWIG ----------------------------------- +------------------------------------ M2Crypto is a crypto and SSL toolkit for Python. @@ -14,24 +14,25 @@ M2 stands for "me, too!" M2Crypto comes with the following: -- **RSA**, **DSA**, **DH**, **HMACs**, **message digests**, **symmetric - ciphers** including **AES**, +- **RSA**, **DSA**, **DH**, **HMACs**, **message digests**, + **symmetric ciphers** including **AES**, -- **SSL/TLS** functionality to implement **clients and servers**. +- **TLS** functionality to implement **clients and servers**. -- **Example SSL/TLS client and server programs**, which are variously - **threading**, **forking** or based on **non-blocking socket IO**. +- **Example SSL client and server programs**, which are variously + **threading**, **forking** or based on **non-blocking socket IO**. -- **HTTPS** extensions to Python's **httplib, urllib and xmlrpclib**. +- **HTTPS** extensions to Python's **httplib, urllib and xmlrpclib**. -- Unforgeable HMAC'ing **AuthCookies** for **web session management**. +- Unforgeable HMAC'ing **AuthCookies** for **web session management**. -- **S/MIME v2**. +- **FTP/TLS** client and server. -- And much more. +- **S/MIME v2**. -- Project with demo applications using M2Crypto is now in the separate - project available at https://gitlab.com/m2crypto/m2crypto_demo +- **ZServerSSL**: A **HTTPS server for Zope**. + +- **ZSmime**: An S/MIME messenger for **Zope**. We care a lot about stable API and all Python methods should be preserved, note however that ``m2.`` namespace is considered internal to @@ -39,24 +40,27 @@ the library and it doesn't have to be preserved. If however some change to it breaks your app, let us know and we will try to make things working for you. -M2Crypto is released under a very liberal BSD-style licence. See LICENCE -for details. +- And much more. + +M2Crypto is released under a very liberal BSD-style licence. See +LICENCE for details. To install, see the file INSTALL. Look at the tests and demos for example use. Recommended reading before -deploying in production is "Network Security with OpenSSL" by John -Viega, Matt Messier and Pravir Chandra, ISBN 059600270X. +deploying in production is "Network Security with OpenSSL" by John Viega, +Matt Messier and Pravir Chandra, ISBN 059600270X. Note these caveats: -- Possible memory leaks, because some objects need to be freed on the - Python side and other objects on the C side, and these may change - between OpenSSL versions. (Multiple free's lead to crashes very - quickly, so these should be relatively rare.) - -- No memory locking/clearing for keys, passphrases, etc. because AFAIK - Python does not provide the features needed. On the C (OpenSSL) side - things are cleared when the Python objects are deleted. +- Possible memory leaks, because some objects need to be freed on the + Python side and other objects on the C side, and these may change + between OpenSSL versions. (Multiple free's lead to crashes very + quickly, so these should be relatively rare.) + +- No memory locking/clearing for keys, passphrases, etc. because AFAIK + Python does not provide the features needed. On the C (OpenSSL) side + things are cleared when the Python objects are deleted. + Have fun! Your feedback is welcome. |