]> Cypherpunks.ru repositories - pygost.git/blob - README
Unify quotes
[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-94 based PBKDF2 function
10 * GOST R 34.11-2012 Стрибог (Streebog) hash function (RFC 6986)
11 * GOST R 34.11-2012 based PBKDF2 function (Р 50.1.111-2016)
12 * GOST R 34.10-2001 (RFC 5832) public key signature function
13 * GOST R 34.10-2012 (RFC 7091) public key signature function
14 * various 34.10 curve parameters included
15 * Coordinates conversion from twisted Edwards to Weierstrass form and
16   vice versa
17 * VKO GOST R 34.10-2001 key agreement function (RFC 4357)
18 * VKO GOST R 34.10-2012 key agreement function (RFC 7836)
19 * 28147-89 and CryptoPro key wrapping (RFC 4357)
20 * 28147-89 CryptoPro key meshing for CFB and CBC modes (RFC 4357)
21 * RFC 4491 (using GOST algorithms with X.509) compatibility helpers
22 * GOST R 34.12-2015 128-bit block cipher Кузнечик (Kuznechik) (RFC 7801)
23 * GOST R 34.12-2015 64-bit block cipher Магма (Magma)
24 * GOST R 34.13-2015 padding methods and block cipher modes of operation
25   (ECB, CTR, OFB, CBC, CFB, MAC)
26 * MGM AEAD mode for 64 and 128 bit ciphers (Р 1323565.1.026–2019)
27 * CTR-ACPKM, OMAC-ACPKM-Master modes of operation (Р 1323565.1.017-2018)
28 * KExp15/KImp15 key export/import functions (Р 1323565.1.017-2018)
29 * KDF_GOSTR3411_2012_256, KDF_TREE_GOSTR3411_2012_256 (Р 50.1.113-2016)
30 * KEG export key generation function (Р 1323565.1.020-2018)
31 * PEP247-compatible hash/MAC functions
32
33 Known problems: low performance and non time-constant calculations.
34
35 Example 34.10-2012 keypair generation, signing and verifying:
36
37     >>> from pygost.gost3410 import CURVES
38     >>> curve = CURVES["id-tc26-gost-3410-12-512-paramSetA"]
39     >>> from os import urandom
40     >>> prv_raw = urandom(32)
41     >>> from pygost.gost3410 import prv_unmarshal
42     >>> prv = prv_unmarshal(prv_raw)
43     >>> from pygost.gost3410 import public_key
44     >>> pub = public_key(curve, prv)
45     >>> from pygost.gost3410 import pub_marshal
46     >>> from pygost.utils import hexenc
47     >>> print "Public key is:", hexenc(pub_marshal(pub))
48     >>> from pygost import gost34112012256
49     >>> data_for_signing = b"some data"
50     >>> dgst = gost34112012256.new(data_for_signing).digest()
51     >>> from pygost.gost3410 import sign
52     >>> signature = sign(curve, prv, dgst, mode=2012)
53     >>> from pygost.gost3410 import verify
54     >>> verify(curve, pub, dgst, signature, mode=2012)
55     True
56
57 Other examples can be found in docstrings and unittests.
58 Example self-signed X.509 certificate creation can be found in
59 pygost/asn1schemas/cert-selfsigned-example.py.
60
61 PyGOST is free software: see the file COPYING for copying conditions.
62
63 PyGOST'es home page is: http://www.pygost.cypherpunks.ru/
64 You can read about GOST algorithms more: http://www.gost.cypherpunks.ru/
65
66 Please send questions, bug reports and patches to
67 https://lists.cypherpunks.ru/mailman/listinfo/gost
68 mailing list. Announcements also go to this mailing list.
69
70 Development Git source code repository currently is located here:
71 http://git.cypherpunks.ru/cgit.cgi/pygost.git/