Crate kitsune2_bootstrap_srv 

Kitsune2 bootstrap server is an HTTP REST server for handling bootstrapping discovery of peer network reachability in p2p applications.

Despite being in the kitsune2 repo, bootstrap_srv and bootstrap_cli do not depend on any Kitsune2 crates. This is to ensure the bootstrapping functionality is well-defined, self-contained, easily testable in isolation, and usable for projects that don’t choose to make use of Kitsune2 itself.

That being said, the bootstrap server and client are designed to transfer the AgentInfoSigned data type defined in the kitsune2_api crate. Since the canonical encoding of that type is JSON, we just redefine a subset of the schema here, and only validate the parts required for bootstrapping.

For additional details, please see the spec.

Modules

iroh_relay_axum

Axum integration for the iroh relay server.

spec

This is a documentation module containing the kitsune2_bootstrap spec.

Structs

AuthConfig

Configuration for authentication.

AuthTokenTracker

Tracks valid authentication tokens and their last-used timestamps.

BootstrapSrv

An actual kitsune2_bootstrap_srv server instance.

Config

Configuration for running a BootstrapSrv.

RelayAllowlist

Allowlist mapping iroh endpoint public keys to the bearer token that was used to register them.

TlsConfig

Configuration for TLS.

Enums

AuthenticateError

Errors that can occur during authentication.

Functions

process_authenticate

Process an authentication request.