]> Cypherpunks.ru repositories - pygost.git/blobdiff - README
Unify quotes
[pygost.git] / README
diff --git a/README b/README
index 42b3c2e37718383f3eb1a65609d5b997f89a2e04..b82dfaf6db795224a628d824dca4da10e94a66e1 100644 (file)
--- a/README
+++ b/README
@@ -6,37 +6,62 @@ GOST is GOvernment STandard of Russian Federation (and Soviet Union).
   CBC (RFC 4357) modes of operation
 * various 28147-89-related S-boxes included
 * GOST R 34.11-94 hash function (RFC 5831)
+* GOST R 34.11-94 based PBKDF2 function
 * GOST R 34.11-2012 Стрибог (Streebog) hash function (RFC 6986)
+* GOST R 34.11-2012 based PBKDF2 function (Р 50.1.111-2016)
 * GOST R 34.10-2001 (RFC 5832) public key signature function
 * GOST R 34.10-2012 (RFC 7091) public key signature function
 * various 34.10 curve parameters included
-* VKO 34.10-2001 Diffie-Hellman function (RFC 4357)
-* VKO 34.10-2012 Diffie-Hellman function
+* Coordinates conversion from twisted Edwards to Weierstrass form and
+  vice versa
+* VKO GOST R 34.10-2001 key agreement function (RFC 4357)
+* VKO GOST R 34.10-2012 key agreement function (RFC 7836)
 * 28147-89 and CryptoPro key wrapping (RFC 4357)
-* 28147-89 CryptoPro key meshing for CFB mode (RFC 4357)
+* 28147-89 CryptoPro key meshing for CFB and CBC modes (RFC 4357)
 * RFC 4491 (using GOST algorithms with X.509) compatibility helpers
 * GOST R 34.12-2015 128-bit block cipher Кузнечик (Kuznechik) (RFC 7801)
-* GOST R 34.13-2015 padding methods
+* GOST R 34.12-2015 64-bit block cipher Магма (Magma)
+* GOST R 34.13-2015 padding methods and block cipher modes of operation
+  (ECB, CTR, OFB, CBC, CFB, MAC)
+* MGM AEAD mode for 64 and 128 bit ciphers (Р 1323565.1.026–2019)
+* CTR-ACPKM, OMAC-ACPKM-Master modes of operation (Р 1323565.1.017-2018)
+* KExp15/KImp15 key export/import functions (Р 1323565.1.017-2018)
+* KDF_GOSTR3411_2012_256, KDF_TREE_GOSTR3411_2012_256 (Р 50.1.113-2016)
+* KEG export key generation function (Р 1323565.1.020-2018)
 * PEP247-compatible hash/MAC functions
 
 Known problems: low performance and non time-constant calculations.
 
-Example X.509 compatible 34.10-2012 keypair generation, signing and
-verifying its signature:
+Example 34.10-2012 keypair generation, signing and verifying:
 
-    >>> from pygost import x509
-    >>> prv, pub = x509.keypair_gen(urandom(64), mode=2012)
-    >>> data = b'some data'
-    >>> signature = x509.sign(prv, data, mode=2012)
-    >>> x509.verify(pub, data, signature, mode=2012)
+    >>> from pygost.gost3410 import CURVES
+    >>> curve = CURVES["id-tc26-gost-3410-12-512-paramSetA"]
+    >>> from os import urandom
+    >>> prv_raw = urandom(32)
+    >>> from pygost.gost3410 import prv_unmarshal
+    >>> prv = prv_unmarshal(prv_raw)
+    >>> from pygost.gost3410 import public_key
+    >>> pub = public_key(curve, prv)
+    >>> from pygost.gost3410 import pub_marshal
+    >>> from pygost.utils import hexenc
+    >>> print "Public key is:", hexenc(pub_marshal(pub))
+    >>> from pygost import gost34112012256
+    >>> data_for_signing = b"some data"
+    >>> dgst = gost34112012256.new(data_for_signing).digest()
+    >>> from pygost.gost3410 import sign
+    >>> signature = sign(curve, prv, dgst, mode=2012)
+    >>> from pygost.gost3410 import verify
+    >>> verify(curve, pub, dgst, signature, mode=2012)
     True
 
-Other examples can be found in docstrings.
+Other examples can be found in docstrings and unittests.
+Example self-signed X.509 certificate creation can be found in
+pygost/asn1schemas/cert-selfsigned-example.py.
 
 PyGOST is free software: see the file COPYING for copying conditions.
 
-PyGOST'es home page is: http://www.cypherpunks.ru/pygost/
-You can read about GOST algorithms more: http://www.cypherpunks.ru/gost/
+PyGOST'es home page is: http://www.pygost.cypherpunks.ru/
+You can read about GOST algorithms more: http://www.gost.cypherpunks.ru/
 
 Please send questions, bug reports and patches to
 https://lists.cypherpunks.ru/mailman/listinfo/gost