hashsigs-py README

The project's README from github.com/QuipNetwork/hashsigs-py. As one markdown file: README.md.

hashsigs (Python)

Python package for WOTS+ with optional Rust acceleration from hashsigs-rs.

Installation

pip install hashsigs

For best performance, ensure you have Rust installed (the package will automatically build the Rust extension if available):

# Install Rust toolchain (optional, for better performance)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Then install hashsigs
pip install hashsigs

Quick Usage

import hashsigs

# Create a WOTS+ instance
wots = hashsigs.WOTSPlus()

# Generate a key pair
private_key, public_key = wots.generate_key_pair()

# Sign a message
message = b"Hello, world!"
signature = wots.sign(private_key, message)

# Verify the signature
is_valid = wots.verify(public_key, message, signature)
print(f"Signature valid: {is_valid}")  # True

# Check if Rust acceleration is available
try:
    import hashsigs._rust
    print("Using Rust acceleration")
except ImportError:
    print("Using pure Python implementation")

Development Setup

For contributors and advanced users who want to build from source:

# from the repo root
python3 -m venv .hashsigs
source .hashsigs/bin/activate
python -m pip install -U pip pytest pytest-cov

# Ensure Rust toolchain (required to build the optional extension)
# macOS: also ensure Xcode CLT: xcode-select --install
rustup --version || brew install rust
cargo --version

# Install dev deps and try to build rust extension (quote extras in zsh)
pip install -v -e '.[rust,dev]'
# Install keccak provider (required for vectors when falling back to Python)
pip install pycryptodome
# or: pip install pysha3

# Quick check the extension is present (optional)
python -c "import hashsigs._rust as m; print('rust ext ok:', m)"

# Lint + type + tests with coverage; this is the full suite
pytest -q --cov=hashsigs --cov-report=term-missing

If the Rust toolchain is not available, the above will fail on the rust-backed vector tests. See the “Test options” section for alternatives.

Test options

You can choose between three categories:

Troubleshooting

Usage example

from hashsigs import WOTSPlus

# Prefer the Rust backend if available; falls back to Python keccak provider if not
wots = WOTSPlus.keccak256(prefer_rust=True)

# Derive a keypair from a 32-byte seed
seed = bytes([1]) * 32
pk, sk = wots.generate_key_pair(seed)

# Sign and verify a 32-byte message
msg = bytes([2]) * 32
sig = wots.sign(sk, msg)
assert wots.verify(pk, msg, sig)
print("Signature verifies!")

Quick self-check (from shell)

Run a one-liner to confirm the package imports, the Rust extension is available (optional), and basic operations work:

python - <<'PY'
from hashsigs import WOTSPlus
try:
    import hashsigs._rust as _
    print('Rust extension: available')
except Exception:
    print('Rust extension: not available (falling back to Python)')

wots = WOTSPlus.keccak256(prefer_rust=True)
seed = bytes([1]) * 32
pk, sk = wots.generate_key_pair(seed)
msg = bytes([2]) * 32
sig = wots.sign(sk, msg)
print('verify:', wots.verify(pk, msg, sig))
PY

Rust backend

We now depend on the public crate and repository:

The Python bindings (PyO3) will attempt to build against the published crate during installation. If the build fails, the package still installs and falls back to pure Python.

License

AGPL-3.0-or-later; see COPYING

hashsigs-py (QuipNetwork/hashsigs-py)

Searching Database…

11.2K ·GitHub
Hashsigs-py
Что это?Это Python-пакет, реализующий WOTS+ (Winternitz One-Time Signature Plus) — основанную на хешах постквантовую схему цифровой подписи, с опциональным ускорением на Rust через hashsigs-rs.
Это самостоятельное приложение или библиотека, которую я импортирую в свой код?Это Python-библиотека, которую вы устанавливаете в проект и вызываете из своего кода; у неё есть опциональное расширение на Rust для производительности, но при его недоступности происходит откат на чистый Python.
Как установить и попробовать?Установите его как редактируемый пакет через pip и выполните быструю самопроверку одной командой из шелла, чтобы убедиться, что импорт и базовые операции работают; полная dev-настройка использует pip install -e с дополнениями rust и dev плюс pycryptodome.
Нужен ли установленный Rust, чтобы пользоваться им?Нет, Rust опционален — ради максимальной производительности; пакет автоматически собирает Rust-расширение, если Rust доступен, иначе работает в режиме чистого Python.
Есть ли подводные камни установки, о которых стоит знать?На Python 3.13/macOS зависимость pysha3 может не собраться с ошибкой про отсутствующий pystrhex.h; решение — установить вместо неё pycryptodome или использовать Python 3.11/3.12.
Что такое WOTS+?WOTS+ (Winternitz One-Time Signature Plus) — это основанная на хешах схема цифровой подписи, считающаяся устойчивой к атакам квантовых компьютеров и часто используемая как строительный блок в постквантовых схемах подписи.
Как запустить тесты?Есть три уровня тестов: полные тесты (векторы плюс на Rust плюс lint/type/coverage), требующие keccak и Rust-расширения; базовый уровень, требующий только провайдера keccak без Rust (HASHSIGSBUILDRUST=0 pytest -q -m \'not requiresrust\'); и минимальный уровень без зависимости от keccak, использующий hashlib.sha3_256 (pytest -q -m \'not vectors\').
Что будет, если Rust-расширение не соберётся?Установка всё равно завершится успешно, а пакет прозрачно откатится на реализацию на чистом Python.
От чего зависит Rust-бэкенд?Он зависит от опубликованного крейта hashsigs-rs (версия 0.0.2), против которого Python-биндинги PyO3 пытаются собраться при установке.
What are similar projects?hashsigs-rs, hashsigs-ts, cpp-sdk, fhevm, ethereum-sdk, hashsigs-solidity, Ciphey, bounty-program
Which topics is it in?post-quantum, cryptography, agpl, rust, security, library, python, open-source
Creator
QuipNetwork
Size
0.1 MB
Stars
11.2K
Updated
CommitAug 27
Age
1y
Commits · 90 Days