pyrsca 0.4.0

Python bindings for rsca library

PyRSCA

Python bindings for the RSCA (Rust Signature and Certificate Authority) library.

Development with uv

This project is managed using uv, a fast Python package manager.

Prerequisites

1. Install uv:

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

2. Install Rust (if not already installed):

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   

Quick Start

1. Setup development environment:

   cd pyrsca
   uv sync --dev
   

2. Activate virtual environment:

   source .venv/bin/activate
   

3. Build the extension:

   uv run maturin develop
   

4. Run tests:

   uv run pytest
   

Development Workflow

1. Install dependencies:

   uv add --dev <package-name>
   

2. Build for development:

   uv run maturin develop --release
   

3. Build wheels:

   uv run maturin build --release
   

4. Publish (when ready):

   uv run maturin publish
   

Project Structure

• src/lib.rs - Rust source code with Python bindings
• pyrsca/ - Python package source
• tests/ - Python tests
• pyproject.toml - Project configuration and dependencies
• Cargo.toml - Rust dependencies and build configuration

Available Commands

Using uv directly:

• uv sync - Install all dependencies
• uv run pytest - Run tests
• uv run maturin develop - Build and install in development mode
• uv run maturin build - Build distribution wheels
• uv add <package> - Add a new dependency
• uv remove <package> - Remove a dependency

Using the development script (recommended):

The dev.sh script handles environment conflicts and provides convenient commands:

• ./dev.sh sync - Install/update dependencies
• ./dev.sh dev - Build in development mode
• ./dev.sh build - Build release mode
• ./dev.sh test - Run tests
• ./dev.sh clean - Clean build artifacts
• ./dev.sh install - Install package in editable mode
• ./dev.sh help - Show help

Note: The development script automatically handles conda/uv environment conflicts.

Python Version Management

This project supports Python 3.7+ and uses Python 3.11 by default. You can change this by:

1. Update .python-version:

   echo "3.12" > .python-version
   

2. Recreate virtual environment:

   uv sync --reinstall
   

Features

• PyTWCA: Python wrapper for TWCA certificate operations
• uni_sign: Unified signature function supporting both PKCS1 and PKCS7 formats
• PKCS7 Signature: PKCS7 signature with unified output format
• PKCS1 Signature: PKCS1 signature with base64 encoded data and certificate
• PySignType: Enum for selecting signature type (Pkcs1, Pkcs7)
• Certificate operations: Extract certificate information and base64 encoding

Signature Output Format

Both PKCS1 and PKCS7 signatures use a unified output format:

{type}.{signature_base64}.{data_base64}.{cert_base64}

• PKCS1: pkcs1.{signature_base64}.{data_base64}.{cert_base64}
• PKCS7: pkcs7.{signature_base64}.{data_base64}.{cert_base64}

Usage Example

from pyrsca import PyTWCA, PySignType

# Initialize TWCA instance
twca = PyTWCA("/path/to/cert.pfx", "password", "192.168.1.1")

# Get certificate person ID
person_id = twca.get_cert_person_id()
print(f"Certificate Person ID: {person_id}")

# Unified signature function (recommended)
pkcs1_result = twca.uni_sign("data to sign", PySignType.Pkcs1)
pkcs7_result = twca.uni_sign("data to sign", PySignType.Pkcs7)
print(f"PKCS1 Result: {pkcs1_result}")
print(f"PKCS7 Result: {pkcs7_result}")

# Direct signature methods
pkcs1_result = twca.sign_pkcs1("data to sign")
pkcs7_result = twca.sign_pkcs7("data to sign")

# Legacy PKCS7 signature (URL encoded, different format)
legacy_signature = twca.sign("data to sign")

# Get base64 encoded certificate
cert_base64 = twca.get_cert_base64()
print(f"Certificate Base64: {cert_base64}")

# Check expiration
expire_timestamp = twca.get_expire_timestamp()
print(f"Certificate expires at: {expire_timestamp}")