Use more correct "key agreement" term instead of Diffie-Hellman

[pygost.git] / README

diff --git a/README b/README
index 42b3c2e37718383f3eb1a65609d5b997f89a2e04..ebb91c291ded1f02e2cb93fab5066ff262d104df 100644 (file)
--- a/README
+++ b/README
@@ -6,12 +6,13 @@ 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.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
+* 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)
 * RFC 4491 (using GOST algorithms with X.509) compatibility helpers
@@ -21,14 +22,27 @@ GOST is GOvernment STandard of Russian Federation (and Soviet Union).
 
 Known problems: low performance and non time-constant calculations.
 
-Example X.509 compatible 34.10-2012 keypair generation, signing and
-verifying its signature:
-
-    >>> 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)
+Example 34.10-2012 keypair generation, signing and verifying:
+
+    >>> from pygost.gost3410 import CURVE_PARAMS
+    >>> from pygost.gost3410 import GOST3410Curve
+    >>> curve = GOST3410Curve(*CURVE_PARAMS["GostR3410_2012_TC26_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.