containerization-framework 0.4.0

Rust bindings for Apple's Containerization framework: Linux containers in lightweight VMs, in-process and without a daemon.
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use super::RegistryInfo;
use crate::error::Error;
use crate::platform;
use crate::platform::ffi;
use std::fmt;
use std::time::SystemTime;

/// `KeychainQueryResult`.
#[derive(Clone, Eq, Hash, PartialEq)]
pub struct KeychainQueryResult {
  pub username: String,
  pub password: String,
  pub modified_date: SystemTime,
  pub created_date: SystemTime,
}

/// Leaves out the password.
impl fmt::Debug for KeychainQueryResult {
  fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
    formatter
      .debug_struct("KeychainQueryResult")
      .field("username", &self.username)
      .field("modified_date", &self.modified_date)
      .field("created_date", &self.created_date)
      .finish_non_exhaustive()
  }
}

/// `KeychainQuery`, which reads and writes internet passwords in the macOS
/// keychain. Swift's `accessGroup` arguments default to `nil`.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub struct KeychainQuery;

impl KeychainQuery {
  /// `KeychainQuery()`.
  pub fn new() -> Self {
    Self
  }

  /// `save(securityDomain:accessGroup:hostname:username:password:)`, which
  /// replaces any entry for `hostname`.
  pub fn save(
    &self,
    security_domain: &str,
    access_group: Option<&str>,
    hostname: &str,
    username: &str,
    password: &str,
  ) -> Result<(), Error> {
    platform::outcome(
      ffi::cz_keychain_query_save(
        security_domain,
        access_group.map(str::to_string),
        hostname,
        username,
        password,
      ),
      format!("save {hostname} to the keychain"),
    )
    .map(drop)
  }

  /// `delete(securityDomain:accessGroup:hostname:)`, which succeeds when there
  /// is no entry.
  pub fn delete(&self, security_domain: &str, access_group: Option<&str>, hostname: &str) -> Result<(), Error> {
    platform::outcome(
      ffi::cz_keychain_query_delete(security_domain, access_group.map(str::to_string), hostname),
      format!("delete {hostname} from the keychain"),
    )
    .map(drop)
  }

  /// `get(securityDomain:accessGroup:hostname:)`.
  pub fn get(
    &self,
    security_domain: &str,
    access_group: Option<&str>,
    hostname: &str,
  ) -> Result<Option<KeychainQueryResult>, Error> {
    platform::outcome(
      ffi::cz_keychain_query_get(security_domain, access_group.map(str::to_string), hostname),
      format!("read {hostname} from the keychain"),
    )
    .map(|outcome| outcome.is_some().then(|| outcome.keychain_query_result()))
  }

  /// `list(securityDomain:accessGroup:)`.
  pub fn list(&self, security_domain: &str, access_group: Option<&str>) -> Result<Vec<RegistryInfo>, Error> {
    platform::outcome(
      ffi::cz_keychain_query_list(security_domain, access_group.map(str::to_string)),
      format!("list the keychain's entries for {security_domain}"),
    )
    .map(|outcome| outcome.registry_infos())
  }

  /// `exists(securityDomain:accessGroup:hostname:)`.
  pub fn exists(&self, security_domain: &str, access_group: Option<&str>, hostname: &str) -> Result<bool, Error> {
    platform::outcome(
      ffi::cz_keychain_query_exists(security_domain, access_group.map(str::to_string), hostname),
      format!("look for {hostname} in the keychain"),
    )
    .map(|outcome| outcome.boolean())
  }
}