Version 0.9.0 (#67)

Author: vsoftco

CHANGES.txt

@@ -1,5 +1,14 @@
+Version 0.9.0 - October 30, 2023
+    - This is a maintenance release, minor deprecation fixes
+    - Python minimum required version is enforced to Python 3.8 in pyproject.toml
+    - To follow Python conventions, renamed in "oqs/oqs.py"
+        is_KEM_enabled()               -> is_kem_enabled()
+        get_enabled_KEM_mechanisms()   -> get_enabled_kem_mechanisms()
+        get_supported_KEM_mechanisms() -> get_supported_kem_mechanisms()
+
 Version 0.8.0 - July 5, 2023
     - This is a maintenance release, minor fixes
+    - Minimalistic Docker support
     - Migrated installation method to pyproject.toml
     - Removed AppVeyor and CircleCI, all continuous integration is now done
       via GitHub actions

RELEASE.md

@@ -1,4 +1,4 @@
-# liboqs-python version 0.8.0
+# liboqs-python version 0.9.0
 
 ---
 
@@ -21,12 +21,12 @@ intended use.
 
 ## Release notes
 
-This release of liboqs-python was released on July 5, 2023. Its release page on GitHub
-is https://github.com/open-quantum-safe/liboqs-python/releases/tag/0.8.0.
+This release of liboqs-python was released on October 30, 2023. Its release page on GitHub
+is https://github.com/open-quantum-safe/liboqs-python/releases/tag/0.9.0.
 
 ---
 
 ## What's New
 
-This is the 8th release of liboqs-python. For a list of changes
+This is the 9th release of liboqs-python. For a list of changes
 see [CHANGES.txt](https://github.com/open-quantum-safe/liboqs-python/blob/main/CHANGES.txt).

examples/kem.py

@@ -10,7 +10,7 @@
 print("liboqs version:", oqs.oqs_version())
 print("liboqs-python version:", oqs.oqs_python_version())
 print("Enabled KEM mechanisms:")
-kems = oqs.get_enabled_KEM_mechanisms()
+kems = oqs.get_enabled_kem_mechanisms()
 pprint(kems, compact=True)
 
 # create client and server with sample KEM mechanisms

oqs/oqs.py

@@ -9,7 +9,7 @@
 
 import ctypes as ct  # to call native
 import ctypes.util as ctu
-import pkg_resources  # to determine the module's version
+import importlib.metadata  # to determine module version at runtime
 import platform  # to learn the OS we're on
 import sys
 import warnings
@@ -24,16 +24,16 @@ def _load_shared_obj(name):
     paths = []
 
     # search typical locations
-    paths += [ctu.find_library("oqs")]
-    paths += [ctu.find_library("liboqs")]
+    paths += [ctu.find_library(name)]
+    paths += [ctu.find_library("lib" + name)]
     dll = ct.windll if platform.system() == "Windows" else ct.cdll
 
     for path in paths:
         if path:
             lib = dll.LoadLibrary(path)
             return lib
 
-    raise RuntimeError("No liboqs shared libraries found")
+    raise RuntimeError("No " + name + " shared libraries found")
 
 
 try:
@@ -63,9 +63,9 @@ def oqs_version():
 def oqs_python_version():
     """liboqs-python version string."""
     try:
-        result = pkg_resources.require("liboqs-python")[0].version
-    except pkg_resources.DistributionNotFound:
-        warnings.warn("Please install liboqs-python using setup.py")
+        result = importlib.metadata.version("liboqs-python")
+    except importlib.metadata.PackageNotFoundError:
+        warnings.warn("Please install liboqs-python using pip install")
         return None
     return result
 
@@ -133,6 +133,7 @@ def __init__(self, alg_name, secret_key=None):
         get_enabled_KEM_mechanisms().
         :param secret_key: optional if generating by generate_keypair() later.
         """
+        super().__init__()
         self.alg_name = alg_name
         if alg_name not in _enabled_KEMs:
             # perhaps it's a supported but not enabled alg
@@ -214,7 +215,7 @@ def __repr__(self):
 native().OQS_KEM_alg_identifier.restype = ct.c_char_p
 
 
-def is_KEM_enabled(alg_name):
+def is_kem_enabled(alg_name):
     """
     Returns True if the KEM algorithm is enabled.
 
@@ -225,15 +226,15 @@ def is_KEM_enabled(alg_name):
 
 _KEM_alg_ids = [native().OQS_KEM_alg_identifier(i) for i in range(native().OQS_KEM_alg_count())]
 _supported_KEMs = [i.decode() for i in _KEM_alg_ids]
-_enabled_KEMs = [i for i in _supported_KEMs if is_KEM_enabled(i)]
+_enabled_KEMs = [i for i in _supported_KEMs if is_kem_enabled(i)]
 
 
-def get_enabled_KEM_mechanisms():
+def get_enabled_kem_mechanisms():
     """Returns the list of enabled KEM mechanisms."""
     return _enabled_KEMs
 
 
-def get_supported_KEM_mechanisms():
+def get_supported_kem_mechanisms():
     """Returns the list of supported KEM mechanisms."""
     return _supported_KEMs
 
@@ -273,6 +274,7 @@ def __init__(self, alg_name, secret_key=None):
         get_enabled_sig_mechanisms().
         :param secret_key: optional, if generated by generate_keypair().
         """
+        super().__init__()
         if alg_name not in _enabled_sigs:
             # perhaps it's a supported but not enabled alg
             if alg_name in _supported_sigs:

pyproject.toml

@@ -7,7 +7,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "liboqs-python"
-version = "0.8.0"
+requires-python = ">=3.8"
+version = "0.9.0"
 description = "Python wrapper for liboqs, providing post-quantum public key cryptography algorithms"
 authors = [
     { name = "Open Quantum Safe project", email = "[email protected]" },

tests/test_kem.py

@@ -10,7 +10,7 @@
 
 
 def test_correctness():
-    for alg_name in oqs.get_enabled_KEM_mechanisms():
+    for alg_name in oqs.get_enabled_kem_mechanisms():
         if any(item in alg_name for item in disabled_KEM_patterns):
             continue
         yield check_correctness, alg_name
@@ -25,7 +25,7 @@ def check_correctness(alg_name):
 
 
 def test_wrong_ciphertext():
-    for alg_name in oqs.get_enabled_KEM_mechanisms():
+    for alg_name in oqs.get_enabled_kem_mechanisms():
         if any(item in alg_name for item in disabled_KEM_patterns):
             continue
         yield check_wrong_ciphertext, alg_name
@@ -52,8 +52,8 @@ def test_not_supported():
 
 def test_not_enabled():
     # TODO: test broken as the compiled lib determines which algorithms are supported and enabled
-    for alg_name in oqs.get_supported_KEM_mechanisms():
-        if alg_name not in oqs.get_enabled_KEM_mechanisms():
+    for alg_name in oqs.get_supported_kem_mechanisms():
+        if alg_name not in oqs.get_enabled_kem_mechanisms():
             # found a non-enabled but supported alg
             try:
                 with oqs.KeyEncapsulation(alg_name) as kem: