python-pkcs11 0.7.0__tar.gz → 0.8.0__tar.gz

python_pkcs11-0.8.0/.github/actions/install-softhsm/action.yml

@@ -0,0 +1,54 @@
+name: install-softhsm
+author: Matthias Valvekens
+description: Install SoftHSM and configure an empty token
+inputs:
+  os:
+    description: OS to target
+    required: true
+  token-label:
+    description: Label assigned to the token
+    required: false
+    default: TEST
+  token-user-pin:
+    description: User PIN to configure on the token
+    required: false
+    default: "1234"
+  token-so-pin:
+    description: Security officer PIN to configure on the token
+    required: false
+    default: "5678"
+runs:
+  using: "composite"
+  steps:
+    - name: Install SoftHSM
+      shell: bash
+      run: |
+        if [[ "${OS_NAME:0:6}" == 'ubuntu' ]]; then
+          sudo apt-get install softhsm2
+          mkdir softhsm_tokens
+          echo "directories.tokendir = $(pwd)/softhsm_tokens" > /tmp/softhsm2.conf
+          echo "SOFTHSM2_CONF=/tmp/softhsm2.conf" >> "$GITHUB_ENV"
+          echo "PKCS11_MODULE=/usr/lib/softhsm/libsofthsm2.so" >> "$GITHUB_ENV"
+        elif [[ "${OS_NAME:0:5}" == 'macos' ]]; then
+          brew install softhsm
+          echo "PKCS11_MODULE=/opt/homebrew/lib/softhsm/libsofthsm2.so" >> "$GITHUB_ENV"
+        elif [[ "${OS_NAME:0:7}" == 'windows' ]]; then
+          choco install softhsm.install
+          echo "SOFTHSM2_CONF=D:/SoftHSM2/etc/softhsm2.conf" >> "$GITHUB_ENV"
+          echo "PKCS11_MODULE=D:/SoftHSM2/lib/softhsm2-x64.dll" >> "$GITHUB_ENV"
+          echo "D:/SoftHSM2/bin" >> "$GITHUB_PATH"
+          echo "D:/SoftHSM2/lib" >> "$GITHUB_PATH"
+        else
+          echo "$OS_NAME is not a supported target system"
+          exit 1
+        fi
+      env:
+        OS_NAME: ${{ inputs.os }}
+    - name: Initialize SoftHSM token
+      shell: bash
+      run: |
+        softhsm2-util --init-token --free --label "${{ inputs.token-label }}" \
+          --pin "${{ inputs.token-user-pin }}" --so-pin "${{ inputs.token-so-pin }}"
+        echo "PKCS11_TOKEN_LABEL=${{ inputs.token-label }}" >> "$GITHUB_ENV"
+        echo "PKCS11_TOKEN_PIN=${{ inputs.token-user-pin }}" >> "$GITHUB_ENV"
+        echo "PKCS11_TOKEN_SO_PIN=${{ inputs.token-so-pin }}" >> "$GITHUB_ENV"

python_pkcs11-0.8.0/.github/release-template.md

@@ -0,0 +1 @@
+A source distribution and wheels for common platforms have been published to [PyPI](https://pypi.org/project/python-pkcs11/:VERSION).

python_pkcs11-0.8.0/.github/workflows/quality.yml

@@ -0,0 +1,33 @@
+name: Code quality
+on:
+  push: {}
+  pull_request: {}
+env:
+  UV_PYTHON_PREFERENCE: only-system
+  UV_NO_SYNC: "1"
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Acquire sources
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          architecture: x64
+
+      - name: Install lint dependencies
+        run: uv sync --no-dev --exact --group lint
+
+      - name: ruff format
+        run: uv run ruff format --diff .
+
+      - name: ruff check
+        run: uv run ruff check --diff .

python_pkcs11-0.8.0/.github/workflows/release.yml

@@ -0,0 +1,144 @@
+name: Publish release to PyPI
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+  workflow_dispatch:
+    inputs:
+      environment:
+        type: environment
+        description: "Environment in which to execute the release process"
+env:
+  UV_PYTHON_PREFERENCE: only-system
+  # we do all UV syncing explicitly
+  UV_NO_SYNC: "1"
+jobs:
+  extract-params:
+    name: Determine release parameters
+    runs-on: ubuntu-latest
+    permissions: {}
+    outputs:
+      publish-env: ${{ steps.setenv.outputs.envname }}
+      version: ${{ steps.getrelease.outputs.version }}
+    steps:
+      - id: setenv
+        run: |
+          if [[ $GITHUB_EVENT_NAME == 'workflow_dispatch' ]]; then
+              echo "envname=${{ inputs.environment }}" >> "$GITHUB_OUTPUT"
+          elif [[ $GITHUB_EVENT_NAME == 'push' ]]; then
+              echo "envname=pypi" >> "$GITHUB_OUTPUT"
+          else
+              echo "Cannot run release workflow for trigger event $GITHUB_EVENT_NAME"
+              exit 1
+          fi
+          cat "$GITHUB_OUTPUT"
+      - name: Get version information
+        id: getrelease
+        run: |
+          set -eo pipefail
+
+          VER_REGEX="v[0-9]\+\.[0-9]\+\..\+"
+          if [[ "${GITHUB_REF:0:11}" != 'refs/tags/v' ]]; then
+              echo "Cannot run release workflow for ref $GITHUB_REF, must be a tag starting with 'v'"
+              exit 1
+          fi
+          VERSION=${GITHUB_REF:10}
+
+          if echo $VERSION | grep -q "$VER_REGEX"; then
+            echo "version=${VERSION:1}" >> "$GITHUB_OUTPUT"
+          else
+            echo "Tag $VERSION does not follow v<version> naming scheme"
+            exit 1
+          fi
+      - uses: actions/checkout@v4
+      - name: Generate release body
+        run: |
+          sed "s/:VERSION/$VERSION/g" < .github/release-template.md > release.md
+          cat release.md
+        env:
+          VERSION: ${{ steps.getrelease.outputs.version }}
+      - name: Upload release body
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-body
+          path: release.md
+  build-wheels:
+    runs-on: ${{ matrix.os }}
+    needs: [extract-params]
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - ubuntu-24.04-arm
+          - windows-latest
+          - macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.0.0
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+  build-sdist:
+    runs-on: ubuntu-latest
+    needs: [extract-params]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - name: Build source distribution
+        run: uv build --sdist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: ./dist/*.tar.gz
+  publish:
+    name: Publish release artifacts
+    needs: [extract-params, build-sdist, build-wheels]
+    runs-on: ubuntu-latest
+    environment: ${{ needs.extract-params.outputs.publish-env }}
+    permissions:
+      # we use PyPI's trusted publisher model -> expose identity token
+      id-token: write
+      # Needed to create GitHub releases
+      contents: write
+    steps:
+      - name: Download wheels
+        uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          path: dist/
+          merge-multiple: 'true'
+      - name: Download source distribution
+        uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist/
+      - name: Download release body
+        uses: actions/download-artifact@v4
+        with:
+          name: release-body
+          path: release-body
+      - name: Upload to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: ${{ vars.REPOSITORY_URL }}
+      - name: Create GitHub release
+        if: needs.extract-params.outputs.publish-env == 'pypi' && startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+          body_path: release-body/release.md
+          fail_on_unmatched_files: true
+          name: python-pkcs11 ${{ needs.extract-params.outputs.version }}

python_pkcs11-0.8.0/.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+name: Tests
+on:
+  push:
+    branches: ["**"]
+  pull_request: {}
+  workflow_dispatch: {}
+env:
+  UV_PYTHON_PREFERENCE: only-system
+  UV_NO_SYNC: "1"
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          # 3.13.4 has a regression in C extension builds,
+          # need to stick to 3.13.3 until 3.13.5 is available on runners
+          - "3.13.3"
+
+    steps:
+      - name: Acquire sources
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: ./.github/actions/install-softhsm
+        with:
+          os: ${{ matrix.os }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - name: Install testing dependencies
+        run: uv sync --no-dev --exact --group testing
+      - name: Run tests
+        run: uv run pytest -v

{python-pkcs11-0.7.0 → python_pkcs11-0.8.0}/.gitignore

@@ -1,7 +1,7 @@
 *.so
 *.c
 __pycache__
-
+.idea/
 /build
 /dist/
 /docs/_build

python_pkcs11-0.8.0/.python-version

@@ -0,0 +1 @@
+3.13

python_pkcs11-0.8.0/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+  # readthedocs does not support [dependency-groups] directly
+  jobs:
+    create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+    build:
+      html:
+        - make -C docs html BUILDDIR=$READTHEDOCS_OUTPUT
+formats: all

python_pkcs11-0.8.0/Dockerfile

@@ -0,0 +1,27 @@
+ARG IMAGE=debian:stable
+FROM $IMAGE
+
+RUN apt-get update && \
+    DEBIAN_FRONTEND="noninteractive" apt-get install -y gcc python3 python3-dev softhsm2 openssl && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+WORKDIR /test
+
+ADD uv.lock pyproject.toml setup.py .
+ADD pkcs11/ pkcs11/
+ADD extern/ extern/
+
+ENV UV_LINK_MODE=copy
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --all-extras
+
+ENV PKCS11_MODULE=/usr/lib/softhsm/libsofthsm2.so
+ENV PKCS11_TOKEN_LABEL=TEST
+ENV PKCS11_TOKEN_PIN=1234
+ENV PKCS11_TOKEN_SO_PIN=5678
+RUN softhsm2-util --init-token --free --label TEST --pin 1234 --so-pin 5678
+
+ADD tests/ tests/
+CMD ["uv", "run", "pytest", "-v"]

python_pkcs11-0.8.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Danielle Madeley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_pkcs11-0.8.0/MANIFEST.in

@@ -0,0 +1,2 @@
+graft extern/
+include pkcs11/*.pxd