Missing copyright and module docstring in gost3410_vko

[pygost.git] / pygost / gost3410_vko.py

diff --git a/pygost/gost3410_vko.py b/pygost/gost3410_vko.py
index affe819fcdc0d50337a29be871b6809c121c7988..35cc06f103293625449dfddbdea59814c37685fe 100644 (file)
--- a/pygost/gost3410_vko.py
+++ b/pygost/gost3410_vko.py
@@ -1,3 +1,22 @@
+# coding: utf-8
+# PyGOST -- Pure Python GOST cryptographic functions library
+# Copyright (C) 2015-2016 Sergey Matveev <stargrave@stargrave.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Diffie-Hellman functions, VKO GOST R 34.10-2001/2012
+"""
+
 from pygost.gost3410 import pub_marshal
 from pygost.gost34112012256 import GOST34112012256
 from pygost.gost34112012512 import GOST34112012512
@@ -10,15 +29,15 @@ def vko_34102001(curve, prv, pubkey, ukm):
 
     :param GOST3410Curve curve: curve to use
     :param long prv: private key
+    :param pubkey: public key
+    :type pubkey: (long, long)
     :param ukm: UKM value (VKO-factor)
     :type ukm: bytes, 8 bytes
-    :param pubkey: public key's part
-    :type pubkey: (long, long)
-    :return: Key Encryption Key (shared key)
+    :returns: Key Encryption Key (shared key)
     :rtype: bytes, 32 bytes
 
     Shared Key Encryption Key computation is based on
-    :rfc:`4357` VKO GOST 34.10-2001 with little-endian
+    :rfc:`4357` VKO GOST R 34.10-2001 with little-endian
     hash output.
     """
     key = curve.exp(prv, pubkey[0], pubkey[1])
@@ -31,11 +50,11 @@ def vko_34102012256(curve, prv, pubkey, ukm=b"\x00\x00\x00\x00\x00\x00\x00\01"):
 
     :param GOST3410Curve curve: curve to use
     :param long prv: private key
+    :param pubkey: public key
+    :type pubkey: (long, long)
     :param ukm: UKM value (VKO-factor)
     :type ukm: bytes, 8 bytes
-    :param pubkey: public key's part
-    :type pubkey: (long, long)
-    :return: Key Encryption Key (shared key)
+    :returns: Key Encryption Key (shared key)
     :rtype: bytes, 32 bytes
     """
     key = curve.exp(prv, pubkey[0], pubkey[1])
@@ -48,11 +67,11 @@ def vko_34102012512(curve, prv, pubkey, ukm=b"\x00\x00\x00\x00\x00\x00\x00\01"):
 
     :param GOST3410Curve curve: curve to use
     :param long prv: private key
+    :param pubkey: public key
+    :type pubkey: (long, long)
     :param ukm: UKM value (VKO-factor)
     :type ukm: bytes, 8 bytes
-    :param pubkey: public key's part
-    :type pubkey: (long, long)
-    :return: Key Encryption Key (shared key)
+    :returns: Key Encryption Key (shared key)
     :rtype: bytes, 32 bytes
     """
     key = curve.exp(prv, pubkey[0], pubkey[1])