synta 0.2.3

ASN.1 parser, decoder, and encoder library with DER/BER support and C FFI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# Installation and Building


## Prerequisites

- Rust toolchain (1.70 or later)
- Python 3.8 or later (abi3 stable ABI; compatible with CPython 3.8–3.14+)
- maturin 1.x

## Build Instructions

The `synta` package consists of three native extension modules.  The primary
module (`_synta`) is built by maturin; the subsystem modules (`_krb5`, `_mtc`)
are built with cargo and copied alongside it.

```bash
# Install maturin
pip install maturin

# Build _synta.abi3.so (release mode) — maturin reads pyproject.toml automatically
maturin build --release

# Build the subsystem extension modules
cargo build --release -p synta-python-krb5 --features openssl
cargo build --release -p synta-python-mtc  --features openssl
```

The maturin wheel is created in `target/wheels/`.  The subsystem `.so` files
must be placed inside the `synta/` directory within the wheel or, for
development installs, inside `python/synta/`.

For a development install with all three modules in one step, use the CI helper:

```bash
./contrib/ci/local-ci.sh python-test
```

Or build manually:

```bash
# Build in development mode (with a virtualenv active)
maturin develop

# Determine the platform extension suffix (e.g. .cpython-312-x86_64-linux-gnu.so)
EXT=$(python3 -c "import sysconfig; print(sysconfig.get_config_var('EXT_SUFFIX'))")

# Build and install subsystem modules
cargo build --release -p synta-python-krb5 --features openssl
cp target/release/lib_krb5.so "python/synta/_krb5${EXT}"

cargo build --release -p synta-python-mtc --features openssl
cp target/release/lib_mtc.so "python/synta/_mtc${EXT}"
```

Maturin is configured in `pyproject.toml` to build the `synta-python` crate:

```toml
[tool.maturin]
manifest-path = "synta-python/Cargo.toml"
module-name = "synta._synta"
bindings = "pyo3"
python-source = "python"
```

To enable OpenSSL-backed features (PKCS#12 encryption, CMS EnvelopedData
construction, X.509 chain verification):

```bash
maturin develop --features openssl
maturin build --release --features openssl
```

To additionally enable legacy PKCS#12 decryption algorithms (3DES, RC2):

```bash
maturin develop --features openssl,deprecated-pkcs12-algorithms
```

## Installation

```bash
# Install the built wheel
pip install target/wheels/synta-0.1.0-cp38-abi3-manylinux_2_34_x86_64.whl
```

The wheel produced by maturin includes `_synta.abi3.so`.  When packaging for a
distribution, `_krb5.abi3.so` and `_mtc.abi3.so` are typically installed as
separate sub-packages alongside the main wheel; see
[`contrib/packages/`](../../../../contrib/packages/) for RPM spec examples.

## Running tests

```bash
# Build in development mode first
python -m venv venv
source venv/bin/activate
maturin develop

# Run the Python test suite
python -m pytest tests/python/
```

> **Note on PYTHONPATH:** When running scripts directly (not via `pytest`),
> use `PYTHONPATH=python python3 script.py` so Python can find the `synta`
> package in `python/synta/`.