2 @documentencoding UTF-8
6 Copyright @copyright{} 2015-2018 @email{stargrave@@stargrave.org, Sergey Matveev}
12 PyGOST is pure Python 2.7/3.x GOST cryptographic functions library.
13 GOST is GOvernment STandard of Russian Federation (and Soviet Union).
15 @url{https://www.gnu.org/philosophy/pragmatic.html, copylefted}
16 @url{https://www.gnu.org/philosophy/free-sw.html, free software}:
17 licenced under @url{https://www.gnu.org/licenses/gpl-3.0.html, GPLv3+}.
18 You can read about GOST algorithms @url{http://gost.cypherpunks.ru/, more}.
20 Currently supported algorithms are:
23 @item GOST 28147-89 (@url{https://tools.ietf.org/html/rfc5830.html, RFC 5830})
24 block cipher with ECB, CNT (CTR), CFB, MAC,
25 CBC (@url{https://tools.ietf.org/html/rfc4357.html, RFC 4357})
27 @item various 28147-89-related S-boxes included
28 @item GOST R 34.11-94 hash function
29 (@url{https://tools.ietf.org/html/rfc5831.html, RFC 5831})
30 @item GOST R 34.11-94 based @url{https://en.wikipedia.org/wiki/PBKDF2, PBKDF2} function
31 @item GOST R 34.11-2012 Стрибог (Streebog) hash function
32 (@url{https://tools.ietf.org/html/rfc6986.html, RFC 6986})
33 @item GOST R 34.11-2012 based PBKDF2 function (Р 50.1.111-2016)
34 @item GOST R 34.10-2001
35 (@url{https://tools.ietf.org/html/rfc5832.html, RFC 5832})
36 public key signature function
37 @item GOST R 34.10-2012
38 (@url{https://tools.ietf.org/html/rfc7091.html, RFC 7091})
39 public key signature function
40 @item various 34.10 curve parameters included
41 @item VKO GOST R 34.10-2001 key agreement function
42 (@url{https://tools.ietf.org/html/rfc4357.html, RFC 4357})
43 @item VKO GOST R 34.10-2012 key agreement function
44 (@url{https://tools.ietf.org/html/rfc7836.html, RFC 7836})
45 @item 28147-89 and CryptoPro key wrapping
46 (@url{https://tools.ietf.org/html/rfc4357.html, RFC 4357})
47 @item 28147-89 CryptoPro key meshing for CFB mode
48 (@url{https://tools.ietf.org/html/rfc4357.html, RFC 4357})
49 @item @url{https://tools.ietf.org/html/rfc4491.html, RFC 4491}
50 (using GOST algorithms with X.509) compatibility helpers
51 @item GOST R 34.12-2015 128-bit block cipher Кузнечик (Kuznechik)
52 (@url{https://tools.ietf.org/html/rfc7801.html, RFC 7801})
53 @item GOST R 34.12-2015 64-bit block cipher Магма (Magma)
54 @item GOST R 34.13-2015 padding methods and block cipher modes of operation
55 (ECB, CTR, OFB, CBC, CFB, MAC)
56 @item PEP247-compatible hash/MAC functions
59 Example 34.10-2012 keypair generation, signing and verifying:
62 >>> from pygost.gost3410 import CURVE_PARAMS
63 >>> from pygost.gost3410 import GOST3410Curve
64 >>> curve = GOST3410Curve(*CURVE_PARAMS["GostR3410_2012_TC26_ParamSetA"])
65 >>> from os import urandom
66 >>> prv_raw = urandom(32)
67 >>> from pygost.gost3410 import prv_unmarshal
68 >>> prv = prv_unmarshal(prv_raw)
69 >>> from pygost.gost3410 import public_key
70 >>> pub = public_key(curve, prv)
71 >>> from pygost.gost3410 import pub_marshal
72 >>> from pygost.utils import hexenc
73 >>> print "Public key is:", hexenc(pub_marshal(pub))
74 >>> from pygost import gost34112012256
75 >>> data_for_signing = b"some data"
76 >>> dgst = gost34112012256.new(data_for_signing).digest()
77 >>> from pygost.gost3410 import sign
78 >>> signature = sign(curve, prv, dgst, mode=2012)
79 >>> from pygost.gost3410 import verify
80 >>> verify(curve, pub, dgst, signature, mode=2012)
84 Please send questions, bug reports and patches to
85 @url{https://lists.cypherpunks.ru/mailman/listinfo/gost, gost}
86 mailing list. Announcements also go to this mailing list.
96 @item 34.11-2012 based PBKDF2 function added
97 @item 34.13-2015 does not require double blocksized IVs
101 Fixed 34.13-2015 OFB bug with IVs longer than 2 blocks.
104 Fixed source files installation during @command{setup.py install} invocation.
107 Dummy release: added long description in package metadata.
110 Small mypy stubs related fixes.
114 @item @code{GOST3412Kuz} renamed to @code{GOST3412Kuznechik}
115 @item @code{GOST3412Magma} implements GOST R 34.12-2015 Magma 64-bit
120 34.13-2015 block cipher modes of operation implementations.
123 Fixed mypy stubs related to PEP247-successors.
127 @item @code{gost3411_94} renamed to @code{gost341194}
128 @item @code{gost3411_2012} renamed and split to
129 @code{gost34112012256}, @code{gost34112012512}
130 @item @code{GOST34112012} split to
131 @code{GOST34112012256}, @code{GOST34112012512}
132 @item @code{gost3410.kek} moved to separate
133 @code{gost3410_vko.kek_34102001}
134 @item VKO GOST R 34.10-2012 appeared in @code{gost3410_vko},
136 @item 34.11-94 digest is reversed, to be compatible with HMAC and
137 PBKDF2 test vectors describe in TC26 documents
138 @item 34.11-94 PBKDF2 test vectors added
139 @item @code{gost3410.prv_unmarshal},
140 @code{gost3410.pub_marshal},
141 @code{gost3410.pub_unmarshal}
142 helpers added, removing the need of @code{x509} module at all
143 @item @code{gost3410.verify} requires @code{(pubX, pubY)} tuple,
144 instead of two separate @code{pubX}, @code{pubY} arguments
145 @item 34.11-94 based PBKDF2 function added
149 Fixed 34.13 mypy stub.
152 Typo and pylint fixes.
155 GOST R 34.13-2015 padding methods
158 Documentation and supplementary files refactoring.
161 PEP-0247 compatible hashers and MAC.
165 @item Ability to specify curve in pygost.x509 module
166 @item Ability to use 34.10-2012 in pygost.x509 functions
169 Renamed classes and modules:
172 @item pygost.gost3410.SIZE_34100 -> pygost.gost3410.SIZE_3410_2001
173 @item pygost.gost3410.SIZE_34112 -> pygost.gost3410.SIZE_3410_2012
174 @item pygost.gost3411_12.GOST341112 -> pygost.gost3411_2012.GOST34112012
178 34.10-2012 TC26 curve parameters.
181 PEP-0484 static typing hints.
184 34.10-2012 workability fix.
187 Python3 compatibility.
190 GOST R 34.12-2015 Кузнечик (Kuznechik) implementation.
193 CryptoPro and GOST key wrapping, CryptoPro key meshing.
199 No additional dependencies except Python 2.7/3.x interpreter are required.
201 Preferable way is to download tarball with the signature:
204 % wget http://pygost.cypherpunks.ru/pygost-3.8.tar.xz
205 % wget http://pygost.cypherpunks.ru/pygost-3.8.tar.xz.sig
206 % gpg --verify pygost-3.8.tar.xz.sig pygost-3.8.tar.xz
207 % xz -d < pygost-3.8.tar.xz | tar xf -
209 % python setup.py install
212 @multitable {XXXXX} {XXXX KiB} {link sign} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}
213 @headitem Version @tab Size @tab Tarball @tab SHA256 checksum @tab Streebog-256 checksum
215 @item 3.8 @tab 44 KiB
216 @tab @url{pygost-3.8.tar.xz, link} @url{pygost-3.8.tar.xz.sig, sign}
217 @tab @code{C8219F12 900B15D6 DA479157 BC48EE08 8BDF7FD0 548E02E4 16B44B6A 4A2FFDD3}
218 @tab @code{0ad60ab474171cb72aa7282a77e5a87a3b8c6f958a0d781504dde2f82e7b839a}
220 @item 3.7 @tab 43 KiB
221 @tab @url{pygost-3.7.tar.xz, link} @url{pygost-3.7.tar.xz.sig, sign}
222 @tab @code{2BE1647A 2ED7C794 7B80EBFA 32EB71B1 2AA95711 71CAA0CE E8319BF7 17361E28}
223 @tab @code{b76ba4964a61b15a65be60c19d85063b88222fff881d9a9a8ff7dd8a07b2fc67}
225 @item 3.6 @tab 43 KiB
226 @tab @url{pygost-3.6.tar.xz, link} @url{pygost-3.6.tar.xz.sig, sign}
227 @tab @code{37EA8A31 B308DBC6 B3229922 ABA0355F 46008BEC 2649BF98 11F62091 17BD94B3}
228 @tab @code{47495afde7218e5d01160800daa0f9c786f5c95579686b0ce5a37fb7550bc735}
230 @item 3.5 @tab 43 KiB
231 @tab @url{pygost-3.5.tar.xz, link} @url{pygost-3.5.tar.xz.sig, sign}
232 @tab @code{14E504AE 81E74DDD 122E5BF1 0B9E25D7 82D51AB6 5ED43533 0BF276A4 8A7C7AA4}
233 @tab @code{eb2106523cf8ed1b462d7a0a57f771f94759047a7e0e5a0b96ee35b24293e264}
235 @item 3.4 @tab 43 KiB
236 @tab @url{pygost-3.4.tar.xz, link} @url{pygost-3.4.tar.xz.sig, sign}
237 @tab @code{89715612 8A197071 AD7689FA 96F89304 19E42F76 87632309 B47E5FDE 1AD6126D}
238 @tab @code{e590ddc7485e6f99658f26ac23cd2266648f27efa584a33f93abec8b80e1771d}
240 @item 3.3 @tab 41 KiB
241 @tab @url{pygost-3.3.tar.xz, link} @url{pygost-3.3.tar.xz.sig, sign}
242 @tab @code{D118F539 537CCD5D 9CCE850E DD8EFD8E ACDA9D6E 0C113A0F C575574A F4BD452A}
243 @tab @code{8400a3714b70dddfef03f6fe96325e73ac25db814d052a44dbd8f2ce5ddb05bb}
245 @item 3.2 @tab 41 KiB
246 @tab @url{pygost-3.2.tar.xz, link} @url{pygost-3.2.tar.xz.sig, sign}
247 @tab @code{6779D1B1 A4E2B1C3 49CA39F8 425FC962 AF2ED133 BB495343 0F83764B E2624087}
248 @tab @code{0a39880ad00ca11d112fef096b81a42a85ce4e5b25c48d1f643858b1e0c520d6}
250 @item 3.1 @tab 39 KiB
251 @tab @url{pygost-3.1.tar.xz, link} @url{pygost-3.1.tar.xz.sig, sign}
252 @tab @code{ACCCF1A9 F4B345FF 01595248 5B793DAC FCF71D1F 32A6ABCF 32042DDB 20897BC5}
253 @tab @code{823961b6c2a1abe83f6d828397002e68d711a08ce115f21ddff81a294882cd46}
255 @item 3.0 @tab 39 KiB
256 @tab @url{pygost-3.0.tar.xz, link} @url{pygost-3.0.tar.xz.sig, sign}
257 @tab @code{0AB10703 6960962D 30BD1646 ACC8D44B E9CBD8A8 4F25DF25 91F26383 DE28875F}
258 @tab @code{ef4729df62b4f615a154a9c35ccffaf6bb614a23067f4dd49d2993ec93bb6665}
260 @item 2.4 @tab 37 KiB
261 @tab @url{pygost-2.4.tar.xz, link} @url{pygost-2.4.tar.xz.sig, sign}
262 @tab @code{94D14E99 3CF63973 6C8E78D0 5EBD0838 09A47624 C05A9878 11136301 C0A07264}
263 @tab @code{b107b5ba043a2e4c30d9348e222b92218b8dff9d672964ffd04259c5261bc5a7}
265 @item 2.3 @tab 37 KiB
266 @tab @url{pygost-2.3.tar.xz, link} @url{pygost-2.3.tar.xz.sig, sign}
267 @tab @code{FF2C7E78 F3677B45 EB472DC6 1837C72C 0BD72387 AB0A9DC7 AD88AD11 59589732}
268 @tab @code{42cfd0cdf357997a909a9114ca14391b4c5e8b62e298675f899b80a8a26d690f}
272 But also you can use PIP (@strong{no} authentication is performed!):
275 % pip install pygost==3.7
278 You @strong{have to} verify downloaded tarballs integrity and
279 authenticity to be sure that you retrieved trusted and untampered
280 software. @url{https://www.gnupg.org/, The GNU Privacy Guard} is used
283 For the very first time it is necessary to get signing public key and
284 import it. It is provided below, but you should check alternative
288 pub rsa2048/0xE6FD1269CD0C009E 2016-09-13
289 F55A 7619 3A0C 323A A031 0E6B E6FD 1269 CD0C 009E
290 uid PyGOST releases <pygost at cypherpunks dot ru>
295 @item @url{https://lists.cypherpunks.ru/mailman/listinfo/gost, gost} maillist
299 % gpg --keyserver hkp://keys.gnupg.net/ --recv-keys 0xE6FD1269CD0C009E
300 % gpg --auto-key-locate dane --locate-keys pygost at cypherpunks dot ru
301 % gpg --auto-key-locate wkd --locate-keys pygost at cypherpunks dot ru
302 % gpg --auto-key-locate pka --locate-keys pygost at cypherpunks dot ru
306 @verbatiminclude PUBKEY.asc
310 You can obtain development source code by cloning
311 @url{http://git-scm.com/, Git}
312 @url{https://git.cypherpunks.ru/cgit.cgi/pygost.git/}.