Repository navigation
Home
Jay edited this page Oct 3, 2026
·
2 revisions
X.509, ASN.1 and cryptography in C++17, implemented from scratch — the repository.
- API Reference — one page per public class, struct and enum, each with its documentation and a worked example.
- Integration Guide — consuming the library from another project: CMake, platforms, what performance to expect, and which parts are constant-time.
- FAQ — questions that have actually come up.
- Troubleshooting — failures people hit, and what they mean.
A wiki is not versioned with the code, so a page here describing a signature starts drifting the moment that signature changes, and nothing marks it stale. Two things keep that from quietly misleading you:
- The pages are generated from the headers, whose Javadoc blocks are the documentation. Nothing is retyped, so a page cannot disagree with the header by having been written from memory.
-
Every page records the commit it came from, in a line at the bottom. If
that commit is behind
main, treat the page as a snapshot and check the header it links to. The header is always right.
The examples are the exception to "generated": they are written by hand, and each one is compiled and linked against the library before it is published. An example here is code a compiler accepted, not code that looks plausible.
These live in the repository, because they have to version with the code:
README |
What the library is and does |
specs/api-map.md |
Which header and type for which task |
specs/recipes.md |
Working code for common jobs |
specs/pitfalls.md |
Ways to call it wrongly that still appear to work |
docs/architecture.md |
Module responsibilities, file by file |
docs/coding-conventions.md |
Naming, guards, formatting |
docs/build.md |
Full CMake reference |
docs/changelog.md |
Why things are the way they are |
docs/roadmap.md |
What is asked for and not built yet |
Most have a Korean translation beside them, named <name>.ko.md.
- No third-party cryptography. Everything — DER, big integers, binary fields, hashes, ciphers, AEADs, signatures, post-quantum — is implemented in this repository. The only vendored dependency is doctest, used by the test suite and not linked into the library.
- Published vectors, not self-consistency. NIST ACVP for ML-KEM and ML-DSA, each RFC's own vectors elsewhere, and real commercially-issued certificates on disk. New units additionally get a negative control: an invariant is deliberately broken to confirm the tests fail. A suite that passes against broken code measures nothing, and this project has caught several bugs that the published vectors alone could not see.
- Not audited. Parts are constant-time by construction and say so; parts explicitly are not. See Integration Guide for the list before deploying anywhere timing is an adversary's input.
- Early-stage. Interfaces may still change. Currently 1.0.1.