a3s-box-core 2.3.0

Core types, config, and error handling for A3S Box MicroVM runtime
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

//! Credential provider abstraction.
//!
//! Decouples registry authentication from the file-based credential
//! store in `a3s-box-runtime`. Implementations can source credentials
//! from any backend: files, Vault, cloud IAM, OS keychain, etc.

use crate::error::Result;

/// Abstraction over container registry credential lookup.
///
/// The runtime calls `get` when authenticating with a container registry
/// during image pull/push operations.
///
/// # Thread Safety
///
/// Implementations must be `Send + Sync`.
pub trait CredentialProvider: Send + Sync {
    /// Get credentials for a registry.
    ///
    /// Returns `Some((username, password))` if credentials are available,
    /// `None` if the registry is not configured (anonymous access).
    fn get(&self, registry: &str) -> Result<Option<(String, String)>>;

    /// Store credentials for a registry.
    ///
    /// Not all backends support writes (e.g., environment-variable-based
    /// providers are read-only). Default implementation returns an error.
    fn store(&self, _registry: &str, _username: &str, _password: &str) -> Result<()> {
        Err(crate::error::BoxError::ConfigError(
            "This credential provider does not support storing credentials".to_string(),
        ))
    }

    /// Remove credentials for a registry.
    ///
    /// Default implementation returns an error.
    fn remove(&self, _registry: &str) -> Result<bool> {
        Err(crate::error::BoxError::ConfigError(
            "This credential provider does not support removing credentials".to_string(),
        ))
    }
}