klauthed-core 0.6.0

Core primitives for klauthed: typed config, clock/time, request context, CQRS, domain, and validation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! The deployment `Profile` (local / dev / test / staging / prod).

use std::fmt;
use std::str::FromStr;

/// Defines the configuration profile for the application.
/// Profiles can be used to differentiate between environments (e.g., local, dev, staging, prod).
/// The profile can influence which config sources are used (e.g., Vault for prod/staging) and which security policies apply.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Default)]
pub enum Profile {
    /// Local developer machine. File secrets and env vars are allowed.
    #[default]
    Local,

    /// Shared development environment. File secrets and env vars are allowed.
    Dev,

    /// Automated test runs. File secrets and env vars are allowed.
    Test,

    /// Staging environment. Secrets must come from Vault.
    Staging,

    /// Production environment. Secrets must come from Vault.
    Prod,
}

impl Profile {
    /// Detect the profile from the `APP_PROFILE` or `KLAUTHED_PROFILE` env var.
    /// Falls back to [`Profile::Local`] if neither is set or the value is unrecognized.
    pub fn detect() -> Self {
        std::env::var("APP_PROFILE")
            .or_else(|_| std::env::var("KLAUTHED_PROFILE"))
            .ok()
            .and_then(|s| s.parse().ok())
            .unwrap_or_default()
    }

    /// True for profiles where secrets must be sourced from Vault.
    pub fn requires_vault(&self) -> bool {
        matches!(self, Profile::Staging | Profile::Prod)
    }

    /// True for profiles where file/env secrets are permitted.
    pub fn allows_file_secrets(&self) -> bool {
        !self.requires_vault()
    }

    /// The lowercase canonical name of the profile (e.g. `"prod"`).
    pub fn as_str(&self) -> &'static str {
        match self {
            Profile::Local => "local",
            Profile::Dev => "dev",
            Profile::Test => "test",
            Profile::Staging => "staging",
            Profile::Prod => "prod",
        }
    }
}

impl fmt::Display for Profile {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for Profile {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "local" => Ok(Profile::Local),
            "dev" => Ok(Profile::Dev),
            "test" => Ok(Profile::Test),
            "staging" => Ok(Profile::Staging),
            "prod" | "production" => Ok(Profile::Prod),
            _ => Err(()),
        }
    }
}