]> Cypherpunks.ru repositories - pygost.git/blob - README
Preparing for 3.0 release
[pygost.git] / README
1 Pure Python 2.7/3.x GOST cryptographic functions library.
2
3 GOST is GOvernment STandard of Russian Federation (and Soviet Union).
4
5 * GOST 28147-89 (RFC 5830) block cipher with ECB, CNT (CTR), CFB, MAC,
6   CBC (RFC 4357) modes of operation
7 * various 28147-89-related S-boxes included
8 * GOST R 34.11-94 hash function (RFC 5831)
9 * GOST R 34.11-2012 Стрибог (Streebog) hash function (RFC 6986)
10 * GOST R 34.10-2001 (RFC 5832) public key signature function
11 * GOST R 34.10-2012 (RFC 7091) public key signature function
12 * various 34.10 curve parameters included
13 * VKO 34.10-2001 Diffie-Hellman function (RFC 4357)
14 * VKO 34.10-2012 Diffie-Hellman function
15 * 28147-89 and CryptoPro key wrapping (RFC 4357)
16 * 28147-89 CryptoPro key meshing for CFB mode (RFC 4357)
17 * RFC 4491 (using GOST algorithms with X.509) compatibility helpers
18 * GOST R 34.12-2015 128-bit block cipher Кузнечик (Kuznechik) (RFC 7801)
19 * GOST R 34.13-2015 padding methods
20 * PEP247-compatible hash/MAC functions
21
22 Known problems: low performance and non time-constant calculations.
23
24 Example 34.10-2012 keypair generation, signing and verifying:
25
26     >>> from pygost.gost3410 import CURVE_PARAMS
27     >>> from pygost.gost3410 import GOST3410Curve
28     >>> curve = GOST3410Curve(*CURVE_PARAMS["GostR3410_2012_TC26_ParamSetA"])
29     >>> from os import urandom
30     >>> prv_raw = urandom(32)
31     >>> from pygost.gost3410 import prv_unmarshal
32     >>> prv = prv_unmarshal(prv_raw)
33     >>> from pygost.gost3410 import public_key
34     >>> pub = public_key(curve, prv)
35     >>> from pygost.gost3410 import pub_marshal
36     >>> from pygost.utils import hexenc
37     >>> print "Public key is:", hexenc(pub_marshal(pub))
38     >>> from pygost import gost34112012256
39     >>> data_for_signing = b"some data"
40     >>> dgst = gost34112012256.new(data_for_signing).digest()
41     >>> from pygost.gost3410 import sign
42     >>> signature = sign(curve, prv, dgst, mode=2012)
43     >>> from pygost.gost3410 import verify
44     >>> verify(curve, pub, dgst, signature, mode=2012)
45     True
46
47 Other examples can be found in docstrings.
48
49 PyGOST is free software: see the file COPYING for copying conditions.
50
51 PyGOST'es home page is: http://www.cypherpunks.ru/pygost/
52 You can read about GOST algorithms more: http://www.cypherpunks.ru/gost/
53
54 Please send questions, bug reports and patches to
55 https://lists.cypherpunks.ru/mailman/listinfo/gost
56 mailing list. Announcements also go to this mailing list.
57
58 Development Git source code repository currently is located here:
59 http://git.cypherpunks.ru/cgit.cgi/pygost.git/