Unify ValueErrors string capitalizing

[pygost.git] / README

diff --git a/README b/README
index 1594ebfa5e34237d12ac7b2a5cd2a1045530c9ae..eeb0ece3446c76c206f64d414ea62d5dce346ffd 100644 (file)
--- a/README
+++ b/README
@@ -12,24 +12,30 @@ GOST is GOvernment STandard of Russian Federation (and Soviet Union).
 * 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
+* 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.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 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 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
@@ -43,21 +49,23 @@ Example 34.10-2012 keypair generation, signing and verifying:
     >>> 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)
+    >>> signature = sign(curve, prv, dgst)
     >>> from pygost.gost3410 import verify
-    >>> verify(curve, pub, dgst, signature, mode=2012)
+    >>> verify(curve, pub, dgst, signature)
     True
 
 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://pygost.cypherpunks.ru/
-You can read about GOST algorithms more: http://gost.cypherpunks.ru/
+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
 mailing list. Announcements also go to this mailing list.
 
 Development Git source code repository currently is located here:
-https://git.cypherpunks.ru/cgit.cgi/pygost.git/
+http://git.cypherpunks.ru/cgit.cgi/pygost.git/