Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Rust API Reference

Full rustdoc-generated API documentation is available at /api/.

This page provides a high-level map of the six crates and their public API surface to help you find what you need.

Crate overview

ahu

License: Apache-2.0 / MIT

The bundle format library. Use this crate if you need to read, write, or verify ahu containers from your own Rust code.

Key public types and modules:

ItemDescription
BundleTop-level type for reading and inspecting an ahu bundle
BundleBuilderConstruct a new bundle with manifest, entries, and seal
FileHeaderFixed 64-byte file header (magic, format version, region offsets)
Manifest / CaScopeCBOR manifest metadata and per-CA scopes (epoch, completeness, window)
IndexRecord / IndexFlagsSorted 48-byte index records and their flag bits
MmapBundleMemory-mapped bundle access for zero-copy serving
verify_structure / check_epochsStructural verification and anti-rollback epoch checks
verify_seal / verify_seal_with_anchors / verify_seal_with_pinsCMS seal verification, standalone or against configured trust
apply / diffMaterialize delta bundles and compare generations

This crate is dual-licensed (Apache-2.0/MIT) so it can be used as a dependency without GPL obligations.

hoike-core

License: GPL-3.0-or-later

Shared types, configuration parsing, and protocol logic used by all other hoike crates.

Key public types and modules:

ItemDescription
ConfigParsed hoike.toml configuration (the config module exposes the section types)
CaConfigPer-CA configuration ([[ca]] section)
ServerConfigServer mode, listen address, max_request limit
StorageConfigBundle directory, state DB path, seal trust
ResponderStateThe loaded working set: scope routing, lookup, hot reload
LookupResult / ScopeDetailServe-time lookup results and per-bundle scope diagnostics
StateStore / StateDirectoryLockDurable anti-rollback state and the exclusive writer lock
ParsedRequest / ParsedCertId / NonceActionStrict request parsing, CertID extraction, RFC 9654 nonce classification
install_bundle / InstallResultAuthenticated offline bundle installation

hoike-sign

License: GPL-3.0-or-later

The signing engine. Parses CRLs, produces OCSP responses, and seals them into ahu bundles.

Key public types and modules:

ItemDescription
produce_bundle / produce_dual_bundleBatch production of single- and dual-algorithm bundles
GenerationConfig / CertIdCompatProduction parameters (epoch, CertID compatibility mode)
sign_live_response / LiveCertStatusLive nonce signing, including the signed-unknown path
CrlSource / DogtagSyncSourceAuthenticated CRL and 389 DS syncrepl revocation sources
RevocationSource / StatusSnapshot / CertificateStatusThe revocation source trait and its snapshots
CaIdentityCA label plus issuer name and key bytes for CertID computation
EcdsaP256Signer / MlDsaSignerVariantClassical and post-quantum signer bridges
Pkcs11Signer / Pkcs11MlDsaSignerPKCS#11 HSM signers (pkcs11 feature)
create_cms_seal / load_or_generate_seal_materialCMS seal creation and the seal/OCSP key-separation policy

hoike-server

License: GPL-3.0-or-later

The axum-based HTTP server that handles OCSP requests and serves pre-signed responses.

Key public types and modules:

ItemDescription
AppStateShared server state (responder, live signers, gossip handle, admin config)
SignerContext / LiveSignerStatePer-CA live signing material for nonce responses
build_router / build_admin_router_standaloneThe public OCSP router and the dedicated admin listener router
build_metrics_router / install_metricsPrometheus metrics endpoint (metrics feature)
build_forward_clientsPer-CA forwarding clients with pinned per-CA trust roots
announce_bundle_scopesBroadcast a new bundle’s scopes to the gossip mesh

hoike-gossip

License: GPL-3.0-or-later

SWIM gossip protocol integration via foca for edge fleet coordination.

Key public types and modules:

ItemDescription
GossipNodeManages the foca SWIM instance and broadcast handling
GossipMessageBroadcast payloads: GenerationAnnouncement and UrgentRevocation
GossipConfig / AuthModeGossip parameters and the broadcast authentication policy (required / permissive)
GossipSigner / GossipVerifier / load_authenticationEd25519 broadcast signing and verification

hoike-cli

License: GPL-3.0-or-later

CLI entry points and argument parsing for the hoike and ahu binaries. This crate wires together all other crates behind the command-line interface.

You generally do not depend on this crate as a library. Its public API is the CLI itself, documented in the hoike CLI and ahu CLI reference pages.

Building the docs locally

Generate the full API documentation with:

cargo doc --workspace --no-deps --open

This builds rustdoc for all six crates and opens the result in your browser. The --no-deps flag skips documentation for third-party dependencies.

To build docs for a single crate:

cargo doc -p ahu --no-deps --open