Skip to content

authority_credentials

Structs

Enums


firma_sidecar::authority_credentials::RedactedPreSharedKey

Section titled “firma_sidecar::authority_credentials::RedactedPreSharedKey”

Struct

Pre-shared key wrapper with redacted debug output.

Tuple Struct: ()

Methods:

  • fn new(value: String) -> Self - Wrap a plaintext pre-shared key.
  • fn expose_secret(self: &Self) -> &str - Expose the plaintext secret for the final Authority request message.

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> RedactedPreSharedKey
  • PartialEq
    • fn eq(self: &Self, other: &RedactedPreSharedKey) -> bool
  • Debug
    • fn fmt(self: &Self, formatter: & mut fmt::Formatter) -> fmt::Result

firma_sidecar::authority_credentials::ResolvedSidecarCredentials

Section titled “firma_sidecar::authority_credentials::ResolvedSidecarCredentials”

Struct

Resolved Sidecar credentials ready to attach to Authority requests.

Fields:

  • workspace_id: String - Workspace the Sidecar belongs to.
  • sidecar_id: String - Authority-assigned Sidecar identity.
  • pre_shared_key: RedactedPreSharedKey - Resolved pre-shared key.
  • source: SidecarCredentialSource - Source used to resolve the PSK.

Methods:

  • fn to_proto(self: &Self) -> SidecarCredentials - Convert to the generated protobuf message.

Traits: Eq

Trait Implementations:

  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • Clone
    • fn clone(self: &Self) -> ResolvedSidecarCredentials
  • PartialEq
    • fn eq(self: &Self, other: &ResolvedSidecarCredentials) -> bool

firma_sidecar::authority_credentials::SidecarCredentialSource

Section titled “firma_sidecar::authority_credentials::SidecarCredentialSource”

Enum

Resolved credential source, kept for startup logging.

Variants:

  • Env(String) - PSK was read from an environment variable.
  • File(std::path::PathBuf) - PSK was read from a file.

Methods:

  • fn kind(self: &Self) -> &'static str - Return the source kind for structured logs.

Traits: Eq

Trait Implementations:

  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • Clone
    • fn clone(self: &Self) -> SidecarCredentialSource
  • PartialEq
    • fn eq(self: &Self, other: &SidecarCredentialSource) -> bool

firma_sidecar::authority_credentials::SidecarCredentialsConfig

Section titled “firma_sidecar::authority_credentials::SidecarCredentialsConfig”

Struct

Configured source for Sidecar pre-shared-key credentials.

Fields:

  • workspace_id: String - Workspace the Sidecar belongs to.
  • sidecar_id: String - Authority-assigned Sidecar identity.
  • pre_shared_key_env: Option<String> - Environment variable containing the pre-shared key.
  • pre_shared_key_path: Option<std::path::PathBuf> - File containing the pre-shared key.

Methods:

  • fn validate(self: &Self) -> Result<(), String> - Validate configured Sidecar credentials.
  • fn rebase_defaults(self: & mut Self, config_dir: &Path) - Re-base a relative PSK file path against the config directory.
  • fn resolve(self: &Self) -> Result<ResolvedSidecarCredentials, String> - Resolve the configured PSK source into in-memory credentials.

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> SidecarCredentialsConfig
  • Deserialize
    • fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
  • PartialEq
    • fn eq(self: &Self, other: &SidecarCredentialsConfig) -> bool
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result