www.texi

   1 \input texinfo
   2 @documentencoding UTF-8
   3 @settitle PyGOST
   4
   5 @copying
   6 Copyright @copyright{} 2015-2018 @email{stargrave@@stargrave.org, Sergey Matveev}
   7 @end copying
   8
   9 @node Top
  10 @top PyGOST
  11
  12 PyGOST is pure Python 2.7/3.x GOST cryptographic functions library.
  13 GOST is GOvernment STandard of Russian Federation (and Soviet Union).
  14 It is
  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}.
  19
  20 Currently supported algorithms are:
  21
  22 @itemize
  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})
  26     modes of operation
  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
  57 @end itemize
  58
  59 Example 34.10-2012 keypair generation, signing and verifying:
  60
  61 @verbatim
  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)
  81 True
  82 @end verbatim
  83
  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.
  87
  88 @insertcopying
  89
  90 @node News
  91 @unnumbered News
  92
  93 @table @strong
  94 @item 3.10
  95 Additional missing 34.11-* typing stubs.
  96
  97 @item 3.9
  98 Add missing 34.11-2012 PBKDF2 typing stub.
  99
 100 @item 3.8
 101     @itemize
 102     @item 34.11-2012 based PBKDF2 function added
 103     @item 34.13-2015 does not require double blocksized IVs
 104     @end itemize
 105
 106 @item 3.7
 107 Fixed 34.13-2015 OFB bug with IVs longer than 2 blocks.
 108
 109 @item 3.6
 110 Fixed source files installation during @command{setup.py install} invocation.
 111
 112 @item 3.5
 113 Dummy release: added long description in package metadata.
 114
 115 @item 3.4
 116 Small mypy stubs related fixes.
 117
 118 @item 3.3
 119     @itemize
 120     @item @code{GOST3412Kuz} renamed to @code{GOST3412Kuznechik}
 121     @item @code{GOST3412Magma} implements GOST R 34.12-2015 Magma 64-bit
 122         block cipher
 123     @end itemize
 124
 125 @item 3.2
 126 34.13-2015 block cipher modes of operation implementations.
 127
 128 @item 3.1
 129 Fixed mypy stubs related to PEP247-successors.
 130
 131 @item 3.0
 132     @itemize
 133     @item @code{gost3411_94} renamed to @code{gost341194}
 134     @item @code{gost3411_2012} renamed and split to
 135         @code{gost34112012256}, @code{gost34112012512}
 136     @item @code{GOST34112012} split to
 137         @code{GOST34112012256}, @code{GOST34112012512}
 138     @item @code{gost3410.kek} moved to separate
 139         @code{gost3410_vko.kek_34102001}
 140     @item VKO GOST R 34.10-2012 appeared in @code{gost3410_vko},
 141         with test vectors
 142     @item 34.11-94 digest is reversed, to be compatible with HMAC and
 143         PBKDF2 test vectors describe in TC26 documents
 144     @item 34.11-94 PBKDF2 test vectors added
 145     @item @code{gost3410.prv_unmarshal},
 146         @code{gost3410.pub_marshal},
 147         @code{gost3410.pub_unmarshal}
 148         helpers added, removing the need of @code{x509} module at all
 149     @item @code{gost3410.verify} requires @code{(pubX, pubY)} tuple,
 150         instead of two separate @code{pubX}, @code{pubY} arguments
 151     @item 34.11-94 based PBKDF2 function added
 152     @end itemize
 153
 154 @item 2.4
 155 Fixed 34.13 mypy stub.
 156
 157 @item 2.3
 158 Typo and pylint fixes.
 159
 160 @item 2.2
 161 GOST R 34.13-2015 padding methods
 162
 163 @item 2.1
 164 Documentation and supplementary files refactoring.
 165
 166 @item 2.0
 167 PEP-0247 compatible hashers and MAC.
 168
 169 @item 1.0
 170     @itemize
 171     @item Ability to specify curve in pygost.x509 module
 172     @item Ability to use 34.10-2012 in pygost.x509 functions
 173     @end itemize
 174
 175     Renamed classes and modules:
 176
 177     @itemize
 178     @item pygost.gost3410.SIZE_34100 -> pygost.gost3410.SIZE_3410_2001
 179     @item pygost.gost3410.SIZE_34112 -> pygost.gost3410.SIZE_3410_2012
 180     @item pygost.gost3411_12.GOST341112 -> pygost.gost3411_2012.GOST34112012
 181     @end itemize
 182
 183 @item 0.16
 184 34.10-2012 TC26 curve parameters.
 185
 186 @item 0.15
 187 PEP-0484 static typing hints.
 188
 189 @item 0.14
 190 34.10-2012 workability fix.
 191
 192 @item 0.13
 193 Python3 compatibility.
 194
 195 @item 0.11
 196 GOST R 34.12-2015 Кузнечик (Kuznechik) implementation.
 197
 198 @item 0.10
 199 CryptoPro and GOST key wrapping, CryptoPro key meshing.
 200 @end table
 201
 202 @node Download
 203 @unnumbered Download
 204
 205 No additional dependencies except Python 2.7/3.x interpreter are required.
 206
 207 Preferable way is to download tarball with the signature:
 208
 209 @verbatim
 210 % wget http://pygost.cypherpunks.ru/pygost-3.8.tar.xz
 211 % wget http://pygost.cypherpunks.ru/pygost-3.8.tar.xz.sig
 212 % gpg --verify pygost-3.8.tar.xz.sig pygost-3.8.tar.xz
 213 % xz -d < pygost-3.8.tar.xz | tar xf -
 214 % cd pygost-3.8
 215 % python setup.py install
 216 @end verbatim
 217
 218 @multitable {XXXXX} {XXXX KiB} {link sign} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}
 219 @headitem Version @tab Size @tab Tarball @tab SHA256 checksum @tab Streebog-256 checksum
 220
 221 @item 3.9 @tab 44 KiB
 222 @tab @url{pygost-3.9.tar.xz, link} @url{pygost-3.9.tar.xz.sig, sign}
 223 @tab @code{EA734025 6A892D4C 6272E577 B773CADA 6D5DEAB5 651D82D0 4721F92C 068CCC10}
 224 @tab @code{4302d934b9ccfbd63da4e3587eff322cbf6712fa45ffeb917fb831121a673dc9}
 225
 226 @item 3.8 @tab 44 KiB
 227 @tab @url{pygost-3.8.tar.xz, link} @url{pygost-3.8.tar.xz.sig, sign}
 228 @tab @code{C8219F12 900B15D6 DA479157 BC48EE08 8BDF7FD0 548E02E4 16B44B6A 4A2FFDD3}
 229 @tab @code{0ad60ab474171cb72aa7282a77e5a87a3b8c6f958a0d781504dde2f82e7b839a}
 230
 231 @item 3.7 @tab 43 KiB
 232 @tab @url{pygost-3.7.tar.xz, link} @url{pygost-3.7.tar.xz.sig, sign}
 233 @tab @code{2BE1647A 2ED7C794 7B80EBFA 32EB71B1 2AA95711 71CAA0CE E8319BF7 17361E28}
 234 @tab @code{b76ba4964a61b15a65be60c19d85063b88222fff881d9a9a8ff7dd8a07b2fc67}
 235
 236 @item 3.6 @tab 43 KiB
 237 @tab @url{pygost-3.6.tar.xz, link} @url{pygost-3.6.tar.xz.sig, sign}
 238 @tab @code{37EA8A31 B308DBC6 B3229922 ABA0355F 46008BEC 2649BF98 11F62091 17BD94B3}
 239 @tab @code{47495afde7218e5d01160800daa0f9c786f5c95579686b0ce5a37fb7550bc735}
 240
 241 @item 3.5 @tab 43 KiB
 242 @tab @url{pygost-3.5.tar.xz, link} @url{pygost-3.5.tar.xz.sig, sign}
 243 @tab @code{14E504AE 81E74DDD 122E5BF1 0B9E25D7 82D51AB6 5ED43533 0BF276A4 8A7C7AA4}
 244 @tab @code{eb2106523cf8ed1b462d7a0a57f771f94759047a7e0e5a0b96ee35b24293e264}
 245
 246 @item 3.4 @tab 43 KiB
 247 @tab @url{pygost-3.4.tar.xz, link} @url{pygost-3.4.tar.xz.sig, sign}
 248 @tab @code{89715612 8A197071 AD7689FA 96F89304 19E42F76 87632309 B47E5FDE 1AD6126D}
 249 @tab @code{e590ddc7485e6f99658f26ac23cd2266648f27efa584a33f93abec8b80e1771d}
 250
 251 @item 3.3 @tab 41 KiB
 252 @tab @url{pygost-3.3.tar.xz, link} @url{pygost-3.3.tar.xz.sig, sign}
 253 @tab @code{D118F539 537CCD5D 9CCE850E DD8EFD8E ACDA9D6E 0C113A0F C575574A F4BD452A}
 254 @tab @code{8400a3714b70dddfef03f6fe96325e73ac25db814d052a44dbd8f2ce5ddb05bb}
 255
 256 @item 3.2 @tab 41 KiB
 257 @tab @url{pygost-3.2.tar.xz, link} @url{pygost-3.2.tar.xz.sig, sign}
 258 @tab @code{6779D1B1 A4E2B1C3 49CA39F8 425FC962 AF2ED133 BB495343 0F83764B E2624087}
 259 @tab @code{0a39880ad00ca11d112fef096b81a42a85ce4e5b25c48d1f643858b1e0c520d6}
 260
 261 @item 3.1 @tab 39 KiB
 262 @tab @url{pygost-3.1.tar.xz, link} @url{pygost-3.1.tar.xz.sig, sign}
 263 @tab @code{ACCCF1A9 F4B345FF 01595248 5B793DAC FCF71D1F 32A6ABCF 32042DDB 20897BC5}
 264 @tab @code{823961b6c2a1abe83f6d828397002e68d711a08ce115f21ddff81a294882cd46}
 265
 266 @item 3.0 @tab 39 KiB
 267 @tab @url{pygost-3.0.tar.xz, link} @url{pygost-3.0.tar.xz.sig, sign}
 268 @tab @code{0AB10703 6960962D 30BD1646 ACC8D44B E9CBD8A8 4F25DF25 91F26383 DE28875F}
 269 @tab @code{ef4729df62b4f615a154a9c35ccffaf6bb614a23067f4dd49d2993ec93bb6665}
 270
 271 @item 2.4 @tab 37 KiB
 272 @tab @url{pygost-2.4.tar.xz, link} @url{pygost-2.4.tar.xz.sig, sign}
 273 @tab @code{94D14E99 3CF63973 6C8E78D0 5EBD0838 09A47624 C05A9878 11136301 C0A07264}
 274 @tab @code{b107b5ba043a2e4c30d9348e222b92218b8dff9d672964ffd04259c5261bc5a7}
 275
 276 @item 2.3 @tab 37 KiB
 277 @tab @url{pygost-2.3.tar.xz, link} @url{pygost-2.3.tar.xz.sig, sign}
 278 @tab @code{FF2C7E78 F3677B45 EB472DC6 1837C72C 0BD72387 AB0A9DC7 AD88AD11 59589732}
 279 @tab @code{42cfd0cdf357997a909a9114ca14391b4c5e8b62e298675f899b80a8a26d690f}
 280
 281 @end multitable
 282
 283 But also you can use PIP (@strong{no} authentication is performed!):
 284
 285 @verbatim
 286 % pip install pygost==3.7
 287 @end verbatim
 288
 289 You @strong{have to} verify downloaded tarballs integrity and
 290 authenticity to be sure that you retrieved trusted and untampered
 291 software. @url{https://www.gnupg.org/, The GNU Privacy Guard} is used
 292 for that purpose.
 293
 294 For the very first time it is necessary to get signing public key and
 295 import it. It is provided below, but you should check alternative
 296 resources.
 297
 298 @verbatim
 299 pub   rsa2048/0xE6FD1269CD0C009E 2016-09-13
 300       F55A 7619 3A0C 323A A031  0E6B E6FD 1269 CD0C 009E
 301 uid   PyGOST releases <pygost at cypherpunks dot ru>
 302 @end verbatim
 303
 304 @itemize
 305
 306 @item @url{https://lists.cypherpunks.ru/mailman/listinfo/gost, gost} maillist
 307
 308 @item
 309 @verbatim
 310 % gpg --keyserver hkp://keys.gnupg.net/ --recv-keys 0xE6FD1269CD0C009E
 311 % gpg --auto-key-locate dane --locate-keys pygost at cypherpunks dot ru
 312 % gpg --auto-key-locate wkd --locate-keys pygost at cypherpunks dot ru
 313 % gpg --auto-key-locate pka --locate-keys pygost at cypherpunks dot ru
 314 @end verbatim
 315
 316 @item
 317 @verbatiminclude PUBKEY.asc
 318
 319 @end itemize
 320
 321 You can obtain development source code by cloning
 322 @url{http://git-scm.com/, Git}
 323 @url{https://git.cypherpunks.ru/cgit.cgi/pygost.git/}.
 324
 325 @bye