Struct PairingCodePolicy 

pub struct PairingCodePolicy {
    pub length: usize,
    pub charset: PairingCodeCharset,
}

The one pairing-code generation policy.

Every code the gateway issues — the startup code, zeroclaw gateway get-paircode --new, POST /api/pairing/initiate, and the rotate-device flow — comes from this policy via PairingGuard. There is no second pairing-code setting anywhere in the schema.

Default

32 case-sensitive alphanumeric characters ≈ 190.6 bits of entropy, against ≈19.9 bits for the six-digit numeric code shipped before the shared policy. Pairing codes are pasted far more often than they are retyped, and a pairing code is the gateway’s front door: getting it wrong is an authentication bypass, while getting it long is a paste.

Operators who transfer the code by hand have two supported alternatives, both still far stronger than the old default:

# Read-aloud friendly: 24 Crockford-Base32 chars ≈ 120 bits.
[gateway.pairing_code]
length = 24
charset = "unambiguous"

# Exact legacy behaviour. Only for local, short-lived pairing.
[gateway.pairing_code]
length = 6
charset = "numeric"

Fields

length: usize

Number of characters in a generated pairing code (6..=128, default: 32).

charset: PairingCodeCharset

Character family: numeric, alphanumeric (default), or unambiguous.

Implementations

impl PairingCodePolicy

pub fn configurable_prefix() -> &'static str

Returns the #[prefix] value for this Configurable struct.

pub fn init_requires_explicit_config() -> bool

True when this struct has a required leaf field that a bare/ancestor-prefix init_defaults scaffold must not materialize (it would fill the field with its Rust Default, which prune_empty_leaves then strips on save, leaving a partial sub-table that fails strict reload). Explicitly targeting this section (or a descendant of it) still scaffolds regardless of this flag, so the section can be materialized for the operator to fill in.

pub fn secret_fields(&self) -> Vec<SecretFieldInfo>

Returns metadata about all #[secret] fields on this struct and nested children.

pub fn secret_field_terminals() -> Vec<&'static str>

pub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>

Encrypt all secret fields in place using the provided store.

pub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>

Decrypt all secret fields in place using the provided store.

pub fn set_secret(&mut self, name: &str, value: String) -> Result<(), Error>

Set a secret field by its full dotted name, dispatching to nested children.

pub fn prop_fields(&self) -> Vec<PropFieldInfo>

Returns metadata about all property fields on this struct and nested children.

pub fn get_prop(&self, name: &str) -> Result<String, Error>

Get a property value by its full dotted name, returning it as a display string.

pub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<(), Error>

Set a property value by its full dotted name, parsing from string.

pub fn prop_is_secret(name: &str) -> bool

Check if a property name refers to a secret field (static, no instance needed).

pub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>

Instantiate None nested sections whose prefix matches. Returns the prefixes that were initialized.

pub fn map_key_sections() -> Vec<MapKeySection>

Enumerate every map-keyed (HashMap<String, T>) and list-shaped (Vec<T>) section discoverable from this Configurable’s tree. The dashboard / CLI consume this to surface “+ Add” affordances without hardcoding the section list.

pub fn nested_section_help(name: &str) -> Option<&'static str>

Help blurb for a #[nested] field on this struct, sourced from the field-level /// docstring. Returns None for unknown names so callers can fall through to a different lookup.

pub fn nested_section_group(name: &str) -> Option<&'static str>

pub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>

Return the current alias keys at section_path, or None if the path doesn’t resolve to a map-keyed section in this tree.

pub fn nested_option_entries(&self) -> Vec<NestedOptionEntry>

pub fn create_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>

pub fn delete_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>

pub fn rename_map_key( &mut self, section_path: &str, map_key: &str, new_key: &str, ) -> Result<bool, String>

impl PairingCodePolicy

pub fn new( length: usize, charset: PairingCodeCharset, ) -> Result<PairingCodePolicy, PairingCodePolicyError>

Build a validated policy.

pub const fn numeric_compat() -> PairingCodePolicy

The exact legacy policy: six numeric digits.

Kept as a named constructor so the compatibility shape is testable and greppable rather than a magic pair of literals.

pub fn validate(&self) -> Result<(), PairingCodePolicyError>

Reject lengths outside PAIRING_CODE_MIN_LENGTH..=PAIRING_CODE_MAX_LENGTH.

pub fn resolve_length(&self) -> (usize, Option<usize>)

The length generation will actually use, paired with the configured length it replaced when the two differ.

Split out from Self::generate so the clamp decision is a plain value a test can assert on directly, independent of the WARN that Self::generate emits when it fires.

pub fn effective_length(&self) -> usize

The length actually used for generation.

Config::validate rejects an out-of-range length, and the gateway PATCH /api/config path refuses such a write outright, so reaching the clamp means the policy was built by some other route. Generation must still never panic or emit a zero-length code.

pub fn entropy_bits(&self) -> f64

Shannon entropy of a code generated under this policy, in bits.

Reported so a security-posture surface can state the active strength rather than restating the raw length and charset.

pub fn generate(&self) -> String

Generate one pairing code using cryptographically secure randomness.

Each character is drawn by rejection sampling so every symbol in the alphabet is equally likely — a plain % would bias the low symbols for any alphabet size that does not divide u32::MAX + 1.

Trait Implementations

impl Clone for PairingCodePolicy

fn clone(&self) -> PairingCodePolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PairingCodePolicy

impl Debug for PairingCodePolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for PairingCodePolicy

fn default() -> PairingCodePolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PairingCodePolicy

fn deserialize<__D>( __deserializer: __D, ) -> Result<PairingCodePolicy, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PairingCodePolicy

impl JsonSchema for PairingCodePolicy

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl MaskSecrets for PairingCodePolicy

fn mask_secrets(&mut self)

fn restore_secrets_from(&mut self, current: &PairingCodePolicy)

impl PartialEq for PairingCodePolicy

fn eq(&self, other: &PairingCodePolicy) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PairingCodePolicy

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PairingCodePolicy