pqcreader 1.0.0

TLS Post-Quantum Cryptography tracer for Python HTTP requests

PQC Reader

TLS Post-Quantum Cryptography tracer for Python HTTP requests.

⚠️ WARNING: Linux Only

⚠️ IMPORTANT: This library is Linux-only. It will NOT work on Windows, macOS, or any other operating system. The library uses Linux-specific OpenSSL library loading and relies on system-level integration that is not available on other platforms. Please ensure you are running on a Linux system before attempting to use this library.

Overview

pqcreader is a Python library that wraps HTTP requests to capture TLS handshake metadata, with a focus on post-quantum cryptography (PQC) key exchange groups like ML-KEM (formerly Kyber).

Features

• 🔐 Capture TLS negotiated groups (including PQC algorithms like X25519MLKEM768)
• 🔍 Extract cipher suite information
• 🐍 Simple wrapper API for requests library
• 🐧 Linux-focused with OpenSSL integration
• 📦 Zero-configuration for basic usage

Installation

pip install pqcreader

Requirements

• Python 3.10+
• Linux operating system (required for OpenSSL tracing)
• OpenSSL 3.x

Quick Start

Basic Usage

import requests
from pqcreader import pqcreader_request

# Wrap any requests call
response, tls_trace = pqcreader_request(
    lambda: requests.get("https://www.google.com", timeout=10)
)

print(f"Status: {response.status_code}")
print(f"Negotiated Group: {tls_trace.group}")
print(f"Cipher Suite: {tls_trace.cipher_suite}")

Convenience Methods

from pqcreader import pqcreader_get, pqcreader_post

# GET request
response, trace = pqcreader_get("https://example.com", timeout=10)

# POST request
response, trace = pqcreader_post(
    "https://api.example.com/data",
    json={"key": "value"},
    timeout=10
)

How It Works

pqcreader uses monkey-patching to intercept urllib3 HTTPS connections and extract the underlying OpenSSL SSL socket. It then uses ctypes to call OpenSSL functions directly to query TLS handshake metadata that isn't normally exposed by Python's ssl module.

Limitations

• Linux only: Uses Linux-specific OpenSSL library loading
• CPython only: Relies on CPython internals for pointer extraction
• Experimental: May not work across all Python versions or OpenSSL configurations

API Reference

pqcreader_request(request_callback, extract_trace=True)

Execute an HTTP request with TLS tracing.

Parameters:

• request_callback (Callable): Function that performs the HTTP request
• extract_trace (bool): Whether to extract TLS trace (default: True)

Returns:

• Tuple[Any, Optional[TlsTrace]]: Response and TLS trace

pqcreader_get(url, **kwargs)

Convenience wrapper for GET requests.

pqcreader_post(url, **kwargs)

Convenience wrapper for POST requests.

TlsTrace

Data class containing:

• group (str): Negotiated key exchange group
• cipher_suite (str): Negotiated cipher suite

Examples

See the examples/ directory for more usage examples.

License

This project is licensed under the GNU General Public License v3.0 or later - see the LICENSE file for details.

Contributing

We warmly welcome contributions to this open source project! Whether you're fixing bugs, adding features, improving documentation, or sharing ideas, your contributions help advance post-quantum cryptography adoption.

🌟 How to Contribute:

• Visit our GitHub repository: https://github.com/ConnectingApps/PyPqcReader
• Fork the repository and create a feature branch
• Submit a Pull Request with your improvements
• Report issues or suggest enhancements in the Issues section

🔍 Test Your Infrastructure:

Want to check if your webserver and browser are ready for post-quantum cryptography? Visit quantumsafeaudit.com to analyze your infrastructure for PQC readiness.

Professional Services

Need expert guidance on post-quantum cryptography implementation?

💼 Hire a PQC Expert:

I'm available as a freelance post-quantum cryptography consultant. Connect with me on LinkedIn to discuss your PQC security needs:

👉 https://www.linkedin.com/in/daanacohen

Acknowledgments

This library is designed to help developers understand and test post-quantum cryptography deployment in TLS connections.