Package reference
API reference for the implemented packages. Scaffolded packages (v0.0.1) are not documented in detail here — see Overview and package catalog for the full list and version table.
| Package | Description |
|---|---|
pq-oid | OID constants and algorithm metadata |
pq-algorithm-id | Canonical identifier mappings (name / OID / JOSE / COSE / X.509) |
pq-key-encoder | DER, PEM, JWK, SPKI, PKCS#8 key encoding |
pq-key-fingerprint | Public key fingerprint generation |
Package layering
These four packages are intentionally layered:
pq-oidis the lowest layer. It exposes OID constants and anAlgorithmtable with sizes and metadata. No I/O, no encoding, no key material.pq-algorithm-idbuilds onpq-oidand adds the multi-identifier mapping API used by anything that needs to translate between JOSE / COSE / X.509 algorithm descriptors. New code should prefer this overpq-oid's legacy JOSE/COSE helpers.pq-key-encoderconsumes algorithm identifiers to encode and decode key material in DER, PEM, JWK, SPKI, and PKCS#8 forms. Key material flows in and out asUint8Arrays.pq-key-fingerprintbuilds onpq-key-encoderandpq-algorithm-idto produce stable hashes of public keys for display, deduplication, and authentication-bound identifiers.
If you find yourself reimplementing one of these, consider contributing instead — see Contributing.