API index
This API section is organized for the NoxTLS Rust workspace. It maps product concerns to crate-level APIs, topic guides, and per-algorithm pages (OEM-style parity, Rust-accurate). Use these pages for function behavior and Cargo feature notes; generated crate stubs in this site link to sources but do not replace the narrative API material here.
OEM parity and mapping
- OEM → Rust API mapping — how OEM C doc pages map to this tree
- Documentation parity matrix — high-level OEM vs Rust doc status
Primary topic guides
| Topic | Page |
|---|---|
Core (noxtls-core) | Core |
| Hash / HMAC / HKDF | Hash |
| Symmetric ciphers | Sym |
| DRBG | DRBG |
| Public-key crypto | PKC |
| X.509 / PKIX | X.509 |
TLS / DTLS (noxtls) | TLS |
Per-algorithm and support pages
Core, build, errors, utility
- Common (errors, helpers)
- Build configuration
- Version information
- Errors / return-code mapping
- Utility (PEM, encoding)
Hash and digests
- Message digest / TLS PRF hub
- SHA-256 · SHA-512 · SHA-3 / SHAKE256 · SHA-1
- BLAKE2 · MD4 · MD5 · RIPEMD-160 — not supported in public Rust API (see each page)
Symmetric encryption
- Encryption hub · Symmetric topic
- AES: AES · CBC · CCM · CFB · CTR · ECB · GCM · OFB · cipher object · XTS
- ARIA: ARIA · CBC · CFB · CTR · ECB · OFB
- Camellia: Camellia · CBC · CFB · CTR · ECB · OFB · cipher object
- ChaCha20: ChaCha20 · ChaCha20-Poly1305
- Legacy: DES · RC4 —
hazardous-legacy-crypto
Public-key cryptography
- PKC topic
- RSA · ECC / P-256 · Ed25519 · X25519 · X448
- ML-KEM · ML-DSA
- Ed448 · DH · DSA — see pages for Rust API status
Certificates
TLS / DTLS protocol versions
Use the TLS API sidebar group for the full list. Entry points:
- TLS topic · DTLS
- TLS 1.0 · TLS 1.1 · TLS 1.2 · TLS 1.3
- TLS 1.3 PQC · Unified connection (OEM mapping)
Generated crate reference pages
Use Crate reference (generated) in the sidebar for Cargo.toml metadata and source links: noxtls, noxtls-core, noxtls-crypto, noxtls-io, noxtls-pem, noxtls-platform, noxtls-psa, noxtls-x509, noxtls-test.
Why this differs from OEM C docs
OEM used Doxygen per C module. Here, topic guides stay the primary integration path; per-algorithm pages give OEM-style discoverability while still describing Rust crates and features.