Skip to main content

hoike_gossip/
config.rs

1use serde::{Deserialize, Serialize};
2use std::path::PathBuf;
3
4use crate::crypto::GossipCryptoError;
5
6/// Explicit inbound authentication policy for gossip broadcasts (FPT_ITT.1).
7///
8/// The policy no longer follows implicitly from which key files happen to be
9/// present:
10///
11/// - [`AuthMode::Required`] (the default) must have a local `identity_key`
12///   and drops unsigned, unknown, and forged broadcasts.
13/// - [`AuthMode::Permissive`] is the explicit rollout mode: unsigned legacy
14///   broadcasts are still accepted, but every signed frame is verified
15///   against the provisioned named identities — unknown or forged signed
16///   frames reject in both modes.
17#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
18#[serde(rename_all = "lowercase")]
19pub enum AuthMode {
20    #[default]
21    Required,
22    Permissive,
23}
24
25impl std::str::FromStr for AuthMode {
26    type Err = GossipCryptoError;
27
28    fn from_str(s: &str) -> Result<Self, Self::Err> {
29        match s {
30            "required" => Ok(Self::Required),
31            "permissive" => Ok(Self::Permissive),
32            other => Err(GossipCryptoError::Config(format!(
33                "invalid gossip auth_mode '{other}' — expected \"required\" or \"permissive\""
34            ))),
35        }
36    }
37}
38
39#[derive(Debug, Deserialize, Clone)]
40pub struct GossipConfig {
41    #[serde(default)]
42    pub enabled: bool,
43    #[serde(default = "default_bind")]
44    pub bind: String,
45    #[serde(default)]
46    pub seeds: Vec<String>,
47    #[serde(default = "default_node_name")]
48    pub node_name: String,
49    /// Explicit inbound authentication policy (FPT_ITT.1). Defaults to
50    /// `required`; see [`AuthMode`] for what each mode enforces.
51    #[serde(default)]
52    pub auth_mode: AuthMode,
53    /// Ed25519 PKCS#8 private key for signing outbound broadcasts (FPT_ITT.1).
54    /// Required in `required` mode; optional while a fleet rolls out in
55    /// `permissive` mode.
56    #[serde(default)]
57    pub identity_key: Option<PathBuf>,
58    /// Deprecated unbound key list. Nonempty values fail startup with migration
59    /// instructions; use peer_identities to authorize each key's node identity.
60    #[serde(default)]
61    pub peer_keys: Vec<PathBuf>,
62    /// Authorized node name to Ed25519 SPKI public key.
63    #[serde(default)]
64    pub peer_identities: std::collections::BTreeMap<String, PathBuf>,
65}
66
67impl Default for GossipConfig {
68    fn default() -> Self {
69        Self {
70            enabled: false,
71            bind: default_bind(),
72            seeds: Vec::new(),
73            node_name: default_node_name(),
74            auth_mode: AuthMode::default(),
75            identity_key: None,
76            peer_keys: Vec::new(),
77            peer_identities: Default::default(),
78        }
79    }
80}
81
82fn default_bind() -> String {
83    "0.0.0.0:7946".into()
84}
85
86fn default_node_name() -> String {
87    std::env::var("HOSTNAME").unwrap_or_else(|_| "hoike-node".into())
88}
89
90#[cfg(test)]
91mod tests {
92    use super::*;
93    use std::str::FromStr;
94
95    #[test]
96    fn auth_mode_defaults_to_required_and_parses_lowercase() {
97        assert_eq!(AuthMode::default(), AuthMode::Required);
98        assert_eq!(
99            serde_json::from_str::<AuthMode>("\"permissive\"").unwrap(),
100            AuthMode::Permissive
101        );
102        let config: GossipConfig = serde_json::from_str("{}").unwrap();
103        assert_eq!(config.auth_mode, AuthMode::Required);
104        assert_eq!(
105            serde_json::to_string(&AuthMode::Permissive).unwrap(),
106            "\"permissive\""
107        );
108    }
109
110    #[test]
111    fn auth_mode_from_str_rejects_unknown_values() {
112        assert_eq!(AuthMode::from_str("required").unwrap(), AuthMode::Required);
113        assert_eq!(
114            AuthMode::from_str("permissive").unwrap(),
115            AuthMode::Permissive
116        );
117        assert!(matches!(
118            AuthMode::from_str("strict"),
119            Err(GossipCryptoError::Config(_))
120        ));
121    }
122}