]> Cypherpunks.ru repositories - pygost.git/blob - README
Fix imports sorting
[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
27 * PEP247-compatible hash/MAC functions
28
29 Known problems: low performance and non time-constant calculations.
30
31 Example 34.10-2012 keypair generation, signing and verifying:
32
33     >>> from pygost.gost3410 import CURVES
34     >>> curve = CURVES["id-tc26-gost-3410-12-512-paramSetA"]
35     >>> from os import urandom
36     >>> prv_raw = urandom(32)
37     >>> from pygost.gost3410 import prv_unmarshal
38     >>> prv = prv_unmarshal(prv_raw)
39     >>> from pygost.gost3410 import public_key
40     >>> pub = public_key(curve, prv)
41     >>> from pygost.gost3410 import pub_marshal
42     >>> from pygost.utils import hexenc
43     >>> print "Public key is:", hexenc(pub_marshal(pub))
44     >>> from pygost import gost34112012256
45     >>> data_for_signing = b"some data"
46     >>> dgst = gost34112012256.new(data_for_signing).digest()
47     >>> from pygost.gost3410 import sign
48     >>> signature = sign(curve, prv, dgst, mode=2012)
49     >>> from pygost.gost3410 import verify
50     >>> verify(curve, pub, dgst, signature, mode=2012)
51     True
52
53 Other examples can be found in docstrings and unittests.
54 Example self-signed X.509 certificate creation can be found in
55 pygost/asn1schemas/cert-selfsigned-example.py.
56
57 PyGOST is free software: see the file COPYING for copying conditions.
58
59 PyGOST'es home page is: http://www.pygost.cypherpunks.ru/
60 You can read about GOST algorithms more: http://www.gost.cypherpunks.ru/
61
62 Please send questions, bug reports and patches to
63 https://lists.cypherpunks.ru/mailman/listinfo/gost
64 mailing list. Announcements also go to this mailing list.
65
66 Development Git source code repository currently is located here:
67 http://git.cypherpunks.ru/cgit.cgi/pygost.git/