X-Git-Url: http://wagner.pp.ru/gitweb/?a=blobdiff_plain;f=README.md;h=2054f7bc5730d733c3f3b3d202797e3a503a3a3a;hb=8afcf4f352ef2f967adbe84837d4abc5e9b6ee0c;hp=b3f660203b53f86f93e42c6c2db4df157028fe7e;hpb=7b229d0dba6fc42eddf3c359c3d9510330a1eeaf;p=oss%2Fctypescrypto.git

diff --git a/README.md b/README.md
index b3f6602..2054f7b 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,53 @@ ctypescrypto
 ============
 
 Python interface to some openssl function based on ctypes module
+
+This module is based on works from
+
+http://code.google.com/p/ctypescrypto/
+
+It is aimed to provide Python interface to OpenSSL libcrypto function
+
+Now supported:
+
+bio.py - interfase to OpenSSL stream abstraction BIO. Now supports
+	memory BIOs this module intended to use for parsing/serializing
+	various ASN.1 based formats like private keys or certificates
+	Status: bare minimum functionality is implemented and covered by
+	rests
+
+oid.py - interface to OpenSSL ASN.1 Object Identifier databsase.
+	Allows to convert numeric identifier (NIDs) returned by various
+	OpenSSL function to readable names or dotted-decimal OIDs and back
+	Status: Fully implemented and covered by tests.
+
+engine.py - interface to loadable modules with alternate implementations
+    of cryptoalgorithms.
+	Status: Bare minumum, neccessary to use GOST algorithms is
+	implemented.
+
+rand.py - interface to pseudo-random number generator.
+	Status: Implemented. Tests now only ensure that no segfault occurs
+	if arugments are passed correctly
+
+digests.py  - Interface  to EVP\_Digest\* family of functions. 
+	Really does almost same as hashlib, which even is able to take
+	advantage of loaded engines if compiled against dynamic libcrypto
+	Status: fully implemented and covered by tests
+
+ciphers.py - Interface to EVP\_Cipher family of function. 
+	Status: Needs test coverage
+
+pkey.py - Low-level private key operations (like pkey, genpkey and p
+    keyutl command line ops), all via algorithm-agnostic EVP interface.
+	Status: Designed and started to implement but most functionality 
+	not yet covered by tests
+
+exception.py OpenSSL error stack to python exception conversion
+	Implemented.
+
+x509 X509 certificates. Support parsing of X509 certificates,
+	verification and extracting of field values. Possible extnesion -
+	support creattion of PKCS10 certificate requests.
+	Status: Interface designed and partially implemented
+