Add tests for transip.utils.*

Signed-off-by: Roald Nefs <info@roaldnefs.com>

Author: roaldnefs

tests/test_utils.py

@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2021 Roald Nefs <info@roaldnefs.com>
+#
+# This file is part of python-transip.
+#
+# python-transip is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# python-transip 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with python-transip.  If not, see <https://www.gnu.org/licenses/>.
+
+import unittest
+import string
+
+from cryptography.hazmat.primitives.asymmetric.rsa import RSAPrivateKey
+
+from transip.utils import (
+    load_rsa_private_key, generate_message_signature, generate_nonce
+)
+
+
+class UtilsTest(unittest.TestCase):
+    """Test the transip.utils functions."""
+
+    privkey: str
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        cls.privkey: str = (  # type: ignore
+            "-----BEGIN RSA PRIVATE KEY-----\n"
+            "MIIEpAIBAAKCAQEAsUSEHsMuB380OUZQWDyyND4q8lEuJAgNnMkO8s5NGwzP8XSi\n"
+            "2DdFglLGLe9kjpADs3XqZFsk8ZFFn7x0idFydGyh9tbJ2WkR9E+kNUJV5iQDzPOB\n"
+            "wvyygEREqnl/o1h3c1q8tD2HZKBcjChn9JbMzdWwAaIs3ppcGWrEI0jZFFfSAyIZ\n"
+            "GkC3k3umOykWIKflQcT/soAfdqW+2P9/KD/wb3AZCer2i6B2hiITiDbHh5q84Hgk\n"
+            "D/Zg1M4yrYDyxDeGkAJHkGKNaE0tgUPoz3XTGP7uFYIx00qJyhmnzQcyV/Xcw3ZQ\n"
+            "7DFUj1HQ5wG/kEF9a4F1+AAiO5C5QbGTFYSwBwIDAQABAoIBABbtIZlI7P8TOJHf\n"
+            "wixnTTTshWlpjmoikIAikMheXiKNeadkylrkaxz7z53JRFwbzB69tV7dWt3TSAns\n"
+            "ubXJXOAp3JisFtcDe8r5MeeheLKXHda396RcQknMioTxycw6eNh2d8ln28br5oxJ\n"
+            "/YfoqPxGEsljTCJOHHM9F7johwrWSQ6f+gmiOkABvIHKgTBLa++v0D+vNrUjM6rx\n"
+            "IE+dBrx8yIgkF4qSg4Dqnr7D0KqCZUGLZ/3K8ShQUtiQYzyHIWKUId3NUecIQcrT\n"
+            "2Ri2TITKuER0fa7Mr+3LMSh/3+HtP2AoM34ouxr9H98LFz/UXxuFIRFTx7UVRt4N\n"
+            "3zqhsEECgYEA+TnXanBJmFz3sNYtlQixtKrh496GB0NheuK4xeNEj9/3gJ6J/rtL\n"
+            "ZHI7VH8r6aqoqw7sO/WJdxkwZTBOz2fe1QJ5BN0HBI5S6jIBQv9Nfqar0TDvNLB+\n"
+            "pH6eYJZ/IEFIMObv9YmsPohXpGeXynecrpl8SazEIWLb8IzgLY0HpokCgYEAthX5\n"
+            "1th4Re0P9rzXp21bbEwcvOKcg5dcpSaTtA1eQEILl6qqT3FP7w8/Ed7NRRY9Gcs+\n"
+            "inAc96YRNAgIGgfT3R1BmxOMWfdFBT1zlCheS6egKKLzVPzKPiMoMP4zu4hy6uH5\n"
+            "YVqpDLu0YQu1J2L0VYdZ9xAC0//Rx8KRcs6m/g8CgYEA41VDja+HMhf7R67WPU+E\n"
+            "6YvGKRjdoNpxnKoaaUd5TtO46/WxYk5t4t3gCJ9H6wjkecRO8BJ0pdKwNlzuRno0\n"
+            "5JAw26LRt/Iq571dMUO36IMXzuWYDLPBkUJ+LRSaOU3TD+hXkd1W5GNxrmFgMCsT\n"
+            "HKCcooeZD+shPDcEdghipiECgYARBTDbYlSrxKMPX0uRPOmkz+CHz27t5gIk9dws\n"
+            "omtC+ml2/d75mg/surIci4UIhjGj7Zmk+yHaDE3jXTTUqhKlwoxVYJhn+HMdMEdT\n"
+            "fAqEa+DOq5yvPwnwkPy6x6gySWjkh8b10LGonQsZXyzJx7grHoHMVFTPWERVtdw+\n"
+            "rQ5zBQKBgQC0Iwx4eeQYx60OCZpioNEQ3QPaFgqoWYEexmcMlpgQ9ycdnHx3SkE8\n"
+            "SlMokcPIEJDhdF3632kIAHOOJeA4Tmshf+ol/O2U2PDgbJZL6W6FJlT28sZVUU8j\n"
+            "IjFmiAiW6IIEqkJxuR1diAjppEiMmSkjPavo7oQs0TZMMUkli1N9dw==\n"
+            "-----END RSA PRIVATE KEY-----"
+        )
+
+    def test_load_rsa_private_key(self) -> None:
+        """
+        Test the content of a RSA private key can be converted to a
+        RSAPrivateKey instance.
+        """
+        self.assertTrue(isinstance(load_rsa_private_key(self.privkey), RSAPrivateKey))
+
+    def test_generate_message_signature(self) -> None:
+        """
+        Test message signature generation using the defined RSA private key.
+
+        Example message encoded using:
+        https://8gwifi.org/rsasignverifyfunctions.jsp
+        """
+        message: str = "A message for signing"
+        encoded: str = ("NFi2v07lhYmyTarOtIfpw50W25ukKWjtqsVzti/Y2RiGKPEzJQtFZ"
+                        "QaYJCFfIn8HfYjdbzOTK5DIFxwL8NCJK3Mb+wxZOkO4NDJC7mVgdO"
+                        "I6VuET4F3Er4ZjO4pkMLSaV6B0Mcm/yj8Wom1lfeRZxItDXPAbkMj"
+                        "47Ywsx7enAEXfrZrYwHy+rWLPN6WWCrCDWAJGu7lz5+YIy7rpLyRx"
+                        "Ff57QkMMJal0VCWyQUx+JBMdoW7rGVN1u+AxRY0yFj+QxWRB1z0JC"
+                        "E0Xmur+gQ+4+rgIEDE6VU2VY0A8+SY7hyRb2JN8yoLAeI+21ODwo5"
+                        "h/x1zw3Bstyzuvzo0QmHp7Mw==")
+
+        self.assertTrue(
+            generate_message_signature(message, self.privkey) == encoded
+        )
+
+    def test_generate_nonce_length(self) -> None:
+        """
+        Test the length of the generated nonce and whether or not an
+        exception is thrown for invalid lengths.
+        """
+        # Test valid lengths
+        for length in [1, 2, 32]:
+            self.assertTrue(len(generate_nonce(length)) == length)
+
+        # Test invalid lengths
+        for length in [0, -1]:
+            self.assertRaises(ValueError, generate_nonce, length)
+
+    def test_generate_nonce_alphabet(self) -> None:
+        """
+        Test if the generated nonce only contains characters from the alphabet.
+        """
+        alphabet: str = 'a'
+        self.assertTrue(generate_nonce(3, alphabet) == 'aaa')

transip/utils.py

@@ -75,15 +75,22 @@ def generate_message_signature(
     return b64_bytes.decode('ascii')
 
 
-def generate_nonce(length: int) -> str:
+def generate_nonce(length: int, alphabet: str = None) -> str:
     """
     Generate a nonce.
 
     Args:
         length (int): The number of characters to return.
+        alphabet (str): The alphabet to choose characters from, defaults to
+            ascii leters and digits.
 
     Returns:
         str: The nonce of specified characters.
     """
-    alphabet: str = string.ascii_letters + string.digits
+    if not length >= 1:
+        raise ValueError(
+            "The specified nonce length must greater or equal to 1"
+        )
+
+    alphabet = alphabet or (string.ascii_letters + string.digits)
     return ''.join(secrets.choice(alphabet) for i in range(length))