pycdoc 0.1.0__tar.gz

pycdoc-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,205 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+    tags: ["v*"]
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build wheel
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Clone libcdoc
+        run: git clone https://github.com/open-eid/libcdoc.git
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libssl-dev libxml2-dev zlib1g-dev flatbuffers-compiler libflatbuffers-dev
+
+      - name: Build wheel
+        run: uv build --wheel
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel
+          path: dist/*.whl
+
+  test:
+    name: Test
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Download wheel
+        uses: actions/download-artifact@v4
+        with:
+          name: wheel
+          path: dist
+
+      - name: Install wheel and test
+        run: |
+          uv venv
+          uv pip install dist/*.whl pytest cryptography
+          uv run --no-project pytest tests/ -v
+
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    if: startsWith(github.ref, 'refs/tags/v')
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Clone libcdoc
+        run: git clone https://github.com/open-eid/libcdoc.git
+
+      - name: Install dependencies (Ubuntu)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libssl-dev libxml2-dev zlib1g-dev
+
+      - name: Install dependencies (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          brew install openssl@3 libxml2 flatbuffers cmake swig
+
+      - name: Install dependencies (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          vcpkg install openssl:x64-windows zlib:x64-windows libxml2:x64-windows flatbuffers:x64-windows
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.22.0
+        env:
+          # Use uv for faster builds
+          CIBW_BUILD_FRONTEND: "build[uv]"
+          # Build for Python 3.9-3.13
+          CIBW_BUILD: "cp39-* cp310-* cp311-* cp312-* cp313-*"
+          # Skip 32-bit builds and musllinux
+          CIBW_SKIP: "*-win32 *-manylinux_i686 *-musllinux_*"
+          # Use manylinux_2_28 for GCC 13 (C++23 support)
+          CIBW_MANYLINUX_X86_64_IMAGE: manylinux_2_28
+          CIBW_MANYLINUX_AARCH64_IMAGE: manylinux_2_28
+          # Install build dependencies in the container (need GCC 13 for C++23, OpenSSL 3.x)
+          CIBW_BEFORE_ALL_LINUX: >
+            dnf install -y gcc-toolset-13 perl-IPC-Cmd libxml2-devel zlib-devel &&
+            curl -L https://www.openssl.org/source/openssl-3.0.13.tar.gz | tar xz &&
+            cd openssl-3.0.13 &&
+            source /opt/rh/gcc-toolset-13/enable &&
+            ./config --prefix=/usr/local/openssl3 --openssldir=/usr/local/openssl3 &&
+            make -j$(nproc) &&
+            make install_sw install_ssldirs
+          CIBW_ENVIRONMENT_LINUX: >
+            OPENSSL_ROOT_DIR=/usr/local/openssl3
+            PKG_CONFIG_PATH=/usr/local/openssl3/lib64/pkgconfig
+            PATH=/opt/rh/gcc-toolset-13/root/usr/bin:$PATH
+            LD_LIBRARY_PATH=/usr/local/openssl3/lib64:/usr/local/openssl3/lib:/opt/rh/gcc-toolset-13/root/usr/lib64:$LD_LIBRARY_PATH
+          # Install flatbuffers from source on Linux
+          CIBW_BEFORE_BUILD_LINUX: >
+            uv pip install --system cmake swig &&
+            if ! command -v flatc; then
+              cd /tmp &&
+              curl -L https://github.com/google/flatbuffers/archive/refs/tags/v24.3.25.tar.gz | tar xz &&
+              cd flatbuffers-24.3.25 &&
+              cmake -B build -DCMAKE_BUILD_TYPE=Release -DFLATBUFFERS_BUILD_TESTS=OFF &&
+              cmake --build build --target install;
+            fi
+          # cmake and swig installed via brew in Install dependencies step
+          CIBW_BEFORE_BUILD_WINDOWS: uv pip install --system cmake swig delvewheel
+          # Set vcpkg toolchain for Windows
+          CIBW_ENVIRONMENT_WINDOWS: >
+            CMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
+          # Set OpenSSL path on macOS; Homebrew OpenSSL requires macOS 15+
+          CIBW_ENVIRONMENT_MACOS: >
+            OPENSSL_ROOT_DIR=/opt/homebrew/opt/openssl@3
+            CMAKE_PREFIX_PATH=/opt/homebrew
+            MACOSX_DEPLOYMENT_TARGET=15.0
+          # Repair wheels (bundle native dependencies)
+          CIBW_REPAIR_WHEEL_COMMAND_LINUX: auditwheel repair -w {dest_dir} {wheel}
+          CIBW_REPAIR_WHEEL_COMMAND_MACOS: delocate-wheel -w {dest_dir} {wheel}
+          CIBW_REPAIR_WHEEL_COMMAND_WINDOWS: delvewheel repair --add-path C:/vcpkg/installed/x64-windows/bin -w {dest_dir} {wheel}
+          # Test the wheel
+          CIBW_TEST_REQUIRES: pytest
+          CIBW_TEST_COMMAND: pytest {project}/tests -v
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Clone libcdoc
+        run: git clone https://github.com/open-eid/libcdoc.git
+
+      - name: Build sdist
+        run: uv build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish:
+    name: Publish to PyPI
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pycdoc
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          path: dist
+          merge-multiple: true
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pycdoc-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Build directories
+build/
+dist/
+*.egg-info/
+wheelhouse/
+
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+.venv/
+venv/
+env/
+test-env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Upstream library (clone separately with: git clone https://github.com/open-eid/libcdoc.git)
+libcdoc/
+
+# Claude Code
+.claude/
+
+# Test artifacts
+*.cdoc
+
+# Lock files (library - not committed)
+uv.lock

pycdoc-0.1.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-02-09
+
+### Added
+- Initial release
+- Python bindings for libcdoc using SWIG
+- Support for reading and writing CDOC 1.0 and CDOC 2.0 containers
+- High-level `encrypt()` function for encrypting files by Estonian personal ID code
+- Automatic certificate lookup from SK LDAP (`esteid.ldap.sk.ee`)
+- Support for encrypting single files, multiple files, or raw bytes
+- Optional `ldap` extra for certificate lookup (`pip install pycdoc[ldap]`)
+- `CDocReader` and `CDocWriter` classes
+- Configuration classes: `Configuration`, `JSONConfiguration`
+- Backend classes: `CryptoBackend`, `NetworkBackend`, `PKCS11Backend`
+- Data types: `Recipient`, `Lock`, `FileInfo`, `DataSource`, `DataConsumer`
+- Error codes and `get_error_str()` function
+- Example scripts for creating CDOC containers
+- CI/CD workflow with cibuildwheel for multi-platform builds
+- macOS arm64 wheel support

pycdoc-0.1.0/CMakeLists.txt

@@ -0,0 +1,109 @@
+cmake_minimum_required(VERSION 3.18)
+project(pycdoc VERSION 0.1.0 LANGUAGES C CXX)
+
+set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD_REQUIRED YES)
+
+# Apply Python SWIG bindings patch to libcdoc
+# This adds Python-specific typemaps and fixes LockVector template ordering
+find_program(PATCH_EXECUTABLE patch)
+if(PATCH_EXECUTABLE)
+    execute_process(
+        COMMAND ${PATCH_EXECUTABLE} -p1 --forward -i ${CMAKE_CURRENT_SOURCE_DIR}/patches/libcdoc-python.patch
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/libcdoc
+        RESULT_VARIABLE PATCH_RESULT
+        OUTPUT_QUIET
+        ERROR_QUIET
+    )
+    # Result 0 = success, 1 = already applied (which is fine)
+    if(PATCH_RESULT GREATER 1)
+        message(WARNING "Failed to apply libcdoc-python.patch (error ${PATCH_RESULT})")
+    endif()
+else()
+    message(FATAL_ERROR "patch executable not found - required to build Python bindings")
+endif()
+
+# Find required packages
+find_package(Python3 REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(SWIG 4.0 REQUIRED)
+include(${SWIG_USE_FILE})
+
+# Configure libcdoc build options - disable SWIG in libcdoc, we build it ourselves
+set(BUILD_SHARED_LIBS OFF CACHE BOOL "Build static library" FORCE)
+set(FRAMEWORK OFF CACHE BOOL "Disable framework build" FORCE)
+set(BUILD_TOOLS OFF CACHE BOOL "Don't build cdoc-tool" FORCE)
+set(LIBCDOC_WITH_DOCS OFF CACHE BOOL "Don't build docs" FORCE)
+
+# Prevent libcdoc from finding SWIG - we handle SWIG bindings ourselves
+set(CMAKE_DISABLE_FIND_PACKAGE_SWIG TRUE)
+
+# Add libcdoc as subdirectory
+add_subdirectory(libcdoc)
+
+set(CMAKE_DISABLE_FIND_PACKAGE_SWIG FALSE)
+
+# Set up SWIG for Python using our custom wrapper that adds Python-specific
+# template instantiations (ByteVector, StringVector, etc.) and director support
+set(PYCDOC_SWIG_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/swig/pycdoc.i)
+set(CMAKE_SWIG_FLAGS "")
+set_property(SOURCE ${PYCDOC_SWIG_SOURCE} PROPERTY CPLUSPLUS ON)
+set_property(SOURCE ${PYCDOC_SWIG_SOURCE} PROPERTY SWIG_MODULE_NAME libcdoc)
+# Set SWIG include directories - need both libcdoc/ (for libcdoc.i) and libcdoc/cdoc/ (for headers)
+set_property(SOURCE ${PYCDOC_SWIG_SOURCE}
+    PROPERTY INCLUDE_DIRECTORIES
+    ${CMAKE_CURRENT_SOURCE_DIR}/libcdoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/libcdoc/cdoc)
+
+# Create the Python extension
+swig_add_library(pycdoc_swig
+    TYPE MODULE
+    LANGUAGE python
+    OUTPUT_DIR ${CMAKE_BINARY_DIR}/pycdoc
+    SOURCES ${PYCDOC_SWIG_SOURCE}
+)
+
+# Include directories for C++ compilation
+target_include_directories(pycdoc_swig PRIVATE
+    ${CMAKE_CURRENT_SOURCE_DIR}/libcdoc/cdoc
+    ${Python3_INCLUDE_DIRS}
+)
+
+# Set output name to _libcdoc (SWIG convention: _<module_name>)
+set_target_properties(pycdoc_swig PROPERTIES
+    OUTPUT_NAME "_libcdoc"
+    PREFIX ""
+    LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/pycdoc
+    SWIG_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_SOURCE_DIR}/libcdoc;${CMAKE_CURRENT_SOURCE_DIR}/libcdoc/cdoc"
+)
+
+# Link against cdoc and Python
+target_link_libraries(pycdoc_swig PRIVATE
+    cdoc
+    Python3::Module
+)
+
+# On macOS, handle rpath for finding libraries
+if(APPLE)
+    set_target_properties(pycdoc_swig PROPERTIES
+        INSTALL_RPATH "@loader_path"
+        BUILD_WITH_INSTALL_RPATH TRUE
+    )
+endif()
+
+# Install targets for scikit-build-core
+# The wheel.install-dir in pyproject.toml is set to "pycdoc"
+# so we install relative to that
+install(TARGETS pycdoc_swig
+    LIBRARY DESTINATION .
+    RUNTIME DESTINATION .
+)
+
+# Install the SWIG-generated Python wrapper (libcdoc.py)
+install(FILES ${CMAKE_BINARY_DIR}/pycdoc/libcdoc.py
+    DESTINATION .
+)
+
+# Install the package __init__.py
+install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/src/pycdoc/__init__.py
+    DESTINATION .
+)