Merge branch 'master' into fix-keytype-for-eddsa-test

Author: mathiasertl

.github/workflows/quality.yml

@@ -0,0 +1,36 @@
+name: Code quality
+on:
+  push:
+  pull_request:
+
+jobs:
+
+  run:
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Acquire sources
+        uses: actions/[email protected]
+
+      - name: Setup Python
+        uses: actions/[email protected]
+        with:
+          python-version: "3.12"
+          architecture: x64
+
+      - name: Apply caching of dependencies
+        uses: actions/[email protected]
+        with:
+          path: ~/.cache/pip
+          key: pip-${{ hashFiles('**/requirements-*.txt') }}
+
+      - name: Install dependencies
+        run: |
+          pip install -U pip setuptools wheel
+          pip install -r requirements.txt -r dev-requirements.txt
+
+      - name: Run ruff
+        run: |
+          ruff format --diff .
+          ruff check --diff .

dev-requirements.in

@@ -1,47 +1,10 @@
-#
-# This file is autogenerated by pip-compile
-# To update, run:
-#
-#    pip-compile dev-requirements.in
-#
-alabaster==0.7.12         # via sphinx
-asn1crypto==1.3.0         # via oscrypto
-babel==2.8.0              # via sphinx
-certifi==2019.11.28       # via requests
-cffi==1.14.0              # via cryptography
-chardet==3.0.4            # via requests
-cryptography==3.2         # via -r dev-requirements.in
-cython==0.29.15           # via -r dev-requirements.in
-docutils==0.16            # via sphinx
-entrypoints==0.3          # via flake8
-flake8==3.7.9             # via -r dev-requirements.in
-idna==2.9                 # via requests
-imagesize==1.2.0          # via sphinx
-jinja2==2.11.1            # via sphinx
-markupsafe==1.1.1         # via jinja2
-mccabe==0.6.1             # via flake8
-oscrypto==1.2.0           # via -r dev-requirements.in
-packaging==20.1           # via sphinx
-parameterized==0.7.4      # via -r dev-requirements.in
-pycodestyle==2.5.0        # via flake8
-pycparser==2.19           # via cffi
-pyflakes==2.1.1           # via flake8
-pygments==2.5.2           # via sphinx
-pyparsing==2.4.6          # via packaging
-pytz==2019.3              # via babel
-requests==2.23.0          # via sphinx
-setuptools-scm==3.5.0     # via -r dev-requirements.in
-six==1.14.0               # via cryptography, packaging
-snowballstemmer==2.0.0    # via sphinx
-sphinx-rtd-theme==0.4.3   # via -r dev-requirements.in
-sphinx==2.4.3             # via -r dev-requirements.in, sphinx-rtd-theme
-sphinxcontrib-applehelp==1.0.1  # via sphinx
-sphinxcontrib-devhelp==1.0.1  # via sphinx
-sphinxcontrib-htmlhelp==1.0.3  # via sphinx
-sphinxcontrib-jsmath==1.0.1  # via sphinx
-sphinxcontrib-qthelp==1.0.2  # via sphinx
-sphinxcontrib-serializinghtml==1.1.3  # via sphinx
-urllib3==1.25.8           # via requests
+Cython
+setuptools_scm
 
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools
+# Used for tests
+oscrypto
+cryptography
+parameterized
+ruff==0.8.2
+sphinx
+sphinx-rtd-theme

dev-requirements.txt

@@ -19,9 +19,10 @@
 #
 import os
 import sys
+
 import sphinx_rtd_theme
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 
 # -- General configuration ------------------------------------------------
@@ -34,40 +35,40 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.intersphinx',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.intersphinx",
 ]
 
-autodoc_member_order = 'bysource'
+autodoc_member_order = "bysource"
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Python PKCS#11'
-copyright = '2017, Danielle Madeley'
-author = 'Danielle Madeley'
+project = "Python PKCS#11"
+copyright = "2017, Danielle Madeley"
+author = "Danielle Madeley"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags.
-release = ''
+release = ""
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -79,10 +80,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -93,7 +94,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -105,13 +106,13 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PythonPKCS11doc'
+htmlhelp_basename = "PythonPKCS11doc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -120,15 +121,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -138,19 +136,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'PythonPKCS11.tex', 'Python PKCS\\#11 Documentation',
-     'Danielle Madeley', 'manual'),
+    (
+        master_doc,
+        "PythonPKCS11.tex",
+        "Python PKCS\\#11 Documentation",
+        "Danielle Madeley",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pythonpkcs11', 'Python PKCS#11 Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "pythonpkcs11", "Python PKCS#11 Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -159,10 +159,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'PythonPKCS11', 'Python PKCS#11 Documentation',
-     author, 'PythonPKCS11', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "PythonPKCS11",
+        "Python PKCS#11 Documentation",
+        author,
+        "PythonPKCS11",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
-
-
-

docs/conf.py

@@ -175,7 +175,7 @@ Smartcard-HSM can generate a shared key via ECDH key exchange.
 
     # Bob generates a keypair, with their public key encoded for
     # interchange
-    bob_priv = ec.generate_private_key(ec.SECP256R1,
+    bob_priv = ec.generate_private_key(ec.SECP256R1(),
                                         default_backend())
     bob_pub = bob_priv.public_key().public_bytes(
         Encoding.DER,

docs/opensc.rst

@@ -6,7 +6,11 @@
 from .exceptions import *  # noqa: F403
 from .mechanisms import *  # noqa: F403
 from .types import *  # noqa: F403
-
+from .util import dh # noqa: F403
+from .util import dsa # noqa: F403
+from .util import ec # noqa: F403
+from .util import rsa # noqa: F403
+from .util import x509 # noqa: F403
 
 _so = None
 _lib = None
@@ -23,7 +27,8 @@ def lib(so):
     if _lib:
         if _so != so:
             raise AlreadyInitialized(  # noqa: F405
-                "Already initialized with %s" % so)
+                "Already initialized with %s" % so
+            )
         else:
             return _lib
 

pkcs11/__init__.py

@@ -377,7 +377,7 @@ class Session(types.Session):
     """Extend Session with implementation."""
 
     def close(self):
-        cdef CK_OBJECT_HANDLE handle = self._handle
+        cdef CK_SESSION_HANDLE handle = self._handle
 
         if self.user_type != UserType.NOBODY:
             with nogil:

pkcs11/_pkcs11.pyx

@@ -40,6 +40,7 @@ class ObjectClass(IntEnum):
 
     This is the type of object we have.
     """
+
     DATA = 0x00000000
     CERTIFICATE = 0x00000001
     """See :class:`pkcs11.Certificate`."""
@@ -58,7 +59,7 @@ class ObjectClass(IntEnum):
     _VENDOR_DEFINED = 0x80000000
 
     def __repr__(self):
-        return '<ObjectClass.%s>' % self.name
+        return "<ObjectClass.%s>" % self.name
 
 
 _ARRAY_ATTRIBUTE = 0x40000000
@@ -298,9 +299,9 @@ class Attribute(IntEnum):
 
     WRAP_WITH_TRUSTED = 0x00000210
     """Key can only be wrapped with a `TRUSTED` key."""
-    WRAP_TEMPLATE = (_ARRAY_ATTRIBUTE | 0x00000211)
-    UNWRAP_TEMPLATE = (_ARRAY_ATTRIBUTE | 0x00000212)
-    DERIVE_TEMPLATE = (_ARRAY_ATTRIBUTE | 0x00000213)
+    WRAP_TEMPLATE = _ARRAY_ATTRIBUTE | 0x00000211
+    UNWRAP_TEMPLATE = _ARRAY_ATTRIBUTE | 0x00000212
+    DERIVE_TEMPLATE = _ARRAY_ATTRIBUTE | 0x00000213
 
     OTP_FORMAT = 0x00000220
     OTP_LENGTH = 0x00000221
@@ -339,18 +340,19 @@ class Attribute(IntEnum):
     REQUIRED_CMS_ATTRIBUTES = 0x00000501
     DEFAULT_CMS_ATTRIBUTES = 0x00000502
     SUPPORTED_CMS_ATTRIBUTES = 0x00000503
-    ALLOWED_MECHANISMS = (_ARRAY_ATTRIBUTE | 0x00000600)
+    ALLOWED_MECHANISMS = _ARRAY_ATTRIBUTE | 0x00000600
 
     _VENDOR_DEFINED = 0x80000000
 
     def __repr__(self):
-        return '<Attribute.%s>' % self.name
+        return "<Attribute.%s>" % self.name
 
 
 class CertificateType(IntEnum):
     """
     Certificate type of a :class:`pkcs11.Certificate`.
     """
+
     X_509 = 0x00000000
     X_509_ATTR_CERT = 0x00000001
     WTLS = 0x00000002
@@ -366,6 +368,7 @@ class MechanismFlag(IntFlag):
     Some objects and mechanisms are symmetric (i.e. can be used for encryption
     and decryption), some are asymmetric (e.g. public key cryptography).
     """
+
     HW = 0x00000001
     """Mechanism is performed in hardware."""