managex-xml-sdk 1.0.2

A comprehensive Python SDK for digital certificate management and XML digital signing

ManageX XML Signing SDK

A comprehensive Python SDK for digital certificate management and XML digital signing with enterprise-grade security and multi-platform support.

📋 Latest Updates

• ✅ Complete OCSP Implementation: Full OCSP certificate validation with real-time revocation checking
• ✅ Enhanced Security: Comprehensive certificate chain validation and revocation checking via CRL and OCSP
• 🔒 Enterprise-Grade: Production-ready security implementation for enterprise applications

🚀 Features

• ✅ Multi-platform Support: Windows, Linux, macOS
• ✅ Multiple Certificate Sources: Windows Store, PFX files, HSM tokens
• ✅ Enterprise Security: Cryptographic verification against trusted root CAs
• ✅ XML Digital Signing: Full XML-DSig standard (RFC 3275) compliance
• ✅ Advanced Certificate Validation: AKI/SKI matching, CRL/OCSP checking
• ✅ Flexible Certificate Filtering: By CN, Organization, Email, Serial Number, CA
• ✅ HSM Token Support: PKCS#11 compatible hardware security modules
• ✅ User-Friendly: Windows certificate selection dialog integration
• ✅ Production Ready: Comprehensive error handling and logging

📦 Installation

1. Create and Activate Virtual Environment

Windows:

python -m venv ocsp
pdf\Scripts\activate

macOS/Linux:

python3 -m venv ocsp
source pdf/bin/activate

pip install -r requirements.txt

# SDK
managex-xml-sdk

# Core dependencies
cryptography>=3.4.8
lxml>=4.6.3
requests>=2.25.1

# Windows-specific dependencies
pywin32>=228; sys_platform == "win32"

# HSM token support (optional)
PyKCS11>=1.5.12

# Development dependencies (optional)
pytest>=6.2.5
pytest-cov>=2.12.1
black>=21.9b0
flake8>=3.9.2
mypy>=0.910

# Documentation (optional)
sphinx>=4.2.0
sphinx-rtd-theme>=1.0.0

# Build tools
setuptools>=57.4.0
wheel>=0.37.0
twine>=3.4.2

🏃 Quick Start

Basic XML Signing with Windows Certificate Store

from managex_xml_sdk.core.xml_signer import XMLSigner

# Create signer with automatic certificate selection dialog
signer = XMLSigner.create(
    method="store",
    store="MY",
    trusted_roots_folder="root_certificates"
)

# Sign XML file - Windows dialog will appear for certificate selection
success = signer.sign_file("document.xml", "signed_document.xml")
print(f"Signing successful: {success}")

Advanced Configuration

from managex_xml_sdk import (
    XMLSigner,
    WindowsStoreConfig,
    CertificateFilter,
    ValidationConfig,
    SignatureEnvelopeParameters
)

# Configure certificate filtering
cert_filter = CertificateFilter(
    cn="Aniket Chaturvedi",           # Common Name
    o="ManageX",                      # Organization
    email="[e-mail]",         # Email from SAN
    ca="Capricorn CA"                 # Issuing CA
)

# Configure validation with trusted root certificates
validation = ValidationConfig(
    check_validity=True,              # Check certificate expiration
    check_revocation_crl=True,        # Check CRL revocation
    check_revocation_ocsp=False,      # Check OCSP revocation
    trusted_roots_folder="root_certificates"  # Folder with trusted root CAs
)

# Create Windows Store configuration
config = WindowsStoreConfig(
    store="MY",
    certificate_filter=cert_filter,
    validation_config=validation
)

# Create XML signer
signer = XMLSigner(config)

# Sign with custom signature parameters
signature_params = SignatureEnvelopeParameters.create_default("ManageX-Signature")
signer.sign_file("document.xml", "signed_document.xml")

🔧 Command Line Usage

The SDK includes a comprehensive command-line tool compatible with existing workflows:

# Basic signing with Windows Store (shows certificate selection dialog)
python managex_xml_signing_example.py --use-store --file document.xml

# Sign with specific certificate criteria
python managex_xml_signing_example.py --cn "Aniket" --o "ManageX" --file document.xml

# HSM token signing with PIN protection
python managex_xml_signing_example.py --use-hsm --file document.xml

# PFX file signing
python managex_xml_signing_example.py --use-pfx mycert.pfx --file document.xml

# List available certificates
python managex_xml_signing_example.py --list-certs

# List HSM tokens
python managex_xml_signing_example.py --list-tokens

📁 Certificate Sources

1. Windows Certificate Store

config = WindowsStoreConfig(
    store="MY",  # Personal certificate store
    certificate_filter=CertificateFilter(cn="Your Name"),
    validation_config=ValidationConfig.basic_validation("root_certificates")
)

2. PFX Files (PKCS#12)

config = PFXConfig(
    pfx_file="certificate.pfx",
    password="your_password",
    certificate_filter=CertificateFilter(cn="Your Name"),
    validation_config=ValidationConfig.basic_validation("root_certificates")
)

3. HSM Tokens (PKCS#11)

config = HSMConfig(
    dll_path="C:\\Windows\\System32\\eToken.dll",  # Auto-detected if None
    pin="123456",  # Will prompt if not provided
    certificate_filter=CertificateFilter(cn="Your Name"),
    validation_config=ValidationConfig.basic_validation("root_certificates")
)

🔐 Security Features

Trusted Root Certificate Validation

Place your trusted root CA certificates in PEM format:

root_certificates/
├── CCA_India/
│   └── CCA_India_2022.pem
├── Capricorn/
│   ├── Capricorn_CA_2022.pem
│   └── Capricorn_Sub_CA_Individual_2022.pem
├── eMudhra/
│   └── eMudhra_Root_CA.pem
└── Other_CAs/
    └── custom_ca.pem

Certificate Chain Validation

• AKI/SKI Matching: Authority Key Identifier to Subject Key Identifier validation
• Cryptographic Verification: Digital signature verification against root CAs
• Key Usage Validation: Ensures certificates have proper key usage for signing
• Revocation Checking: CRL and OCSP support

HSM Token Protection

• PIN Retry Limits: Prevents token locking with multiple failed attempts
• Token Status Monitoring: Checks remaining PIN attempts before proceeding
• Graceful Abort: User can cancel operations to prevent token lock

📖 API Reference

Core Classes

XMLSigner

Main class for XML signing operations.

signer = XMLSigner(config, signature_params)
signer.sign_file(input_file, output_file)  # Sign file
signed_content = signer.sign_content(xml_bytes)  # Sign content

Configuration Classes

• WindowsStoreConfig: Windows Certificate Store configuration
• PFXConfig: PFX file configuration
• HSMConfig: HSM token configuration

Filter and Validation

• CertificateFilter: Certificate selection criteria
• ValidationConfig: Certificate validation rules
• SignatureEnvelopeParameters: XML signature customization

Utility Functions

Certificate Discovery

from managex_xml_sdk.signers.windows_store_signer import WindowsStoreSigner

signer = WindowsStoreSigner(config)
certificates = signer.get_all_certificates_from_store()
valid_certs = signer.filter_valid_signing_certificates(certificates)

HSM Token Discovery

from managex_xml_sdk.signers.hsm_signer import HSMSigner

tokens = HSMSigner.get_all_available_tokens()
for token in tokens:
    print(f"Token: {token['label']} - {token['manufacturer']}")

🛠️ Development

Prerequisites

• Python 3.8+
• Windows: pywin32, PyKCS11 (for HSM support)
• Linux/macOS: PyKCS11 (for HSM support)

👨‍💻 Author & Support

Aniket Chaturvedi

• 📧 Email: [e-mail]
• 🐙 GitHub: @Aniketc068
• 🏢 Organization: ManageX

Support

• 📧 Email Support: [e-mail]

🙏 Acknowledgments

• Thanks to all contributors and the open-source community
• Built with ❤️ for the digital certificate and XML signing ecosystem
• Special thanks to collaborators and early adopters

📊 Project Status

• ✅ Stable: Production ready
• 🔄 Active Development: Regular updates and improvements
• 🌍 Community Driven: Open to contributions and feedback

---

Made with ❤️ by Aniket Chaturvedi for ManageX