auths-core 0.1.2

Core cryptography and keychain integration for Auths
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
//! iOS Keychain storage backend.

use crate::error::AgentError;
use crate::storage::keychain::{IdentityDID, KeyAlias, KeyRole, KeyStorage};

use core_foundation::array::{CFArrayGetCount, CFArrayGetValueAtIndex, CFArrayRef};
use core_foundation::base::{CFRelease, CFTypeRef, OSStatus, TCFType};
use core_foundation::boolean::kCFBooleanTrue;
use core_foundation::data::{CFData, CFDataRef};
use core_foundation::dictionary::{CFDictionaryGetValue, CFDictionaryRef, CFMutableDictionary};
use core_foundation::number::CFNumber;
use core_foundation::string::{CFString, CFStringRef};

use security_framework_sys::access_control::kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly;
use security_framework_sys::base::{errSecItemNotFound, errSecSuccess};
use security_framework_sys::item::{
    kSecAttrAccount, kSecAttrComment, kSecAttrDescription, kSecAttrService, kSecClass,
    kSecClassGenericPassword, kSecMatchLimit, kSecMatchLimitAll, kSecReturnAttributes,
    kSecReturnData, kSecValueData,
};
use security_framework_sys::keychain_item::{SecItemAdd, SecItemCopyMatching, SecItemDelete};

use log::{debug, error, info, warn};
use std::os::raw::c_void;
use std::ptr;

/// iOS Keychain storage backend.
pub struct IOSKeychain {
    service_name: String,
}

impl IOSKeychain {
    /// Create a new `IOSKeychain` using the given service name.
    pub fn new(service_name: &str) -> Self {
        Self {
            service_name: service_name.to_string(),
        }
    }

    /// Helper function to convert OSStatus to AgentError
    fn map_os_status_err(status: OSStatus, context: &str) -> AgentError {
        if status == errSecItemNotFound {
            AgentError::KeyNotFound
        } else {
            let msg = format!("{} failed with OSStatus: {}", context, status);
            error!("{}", msg);
            AgentError::SecurityError(msg)
        }
    }

    /// Helper to extract a String value from a CFDictionary. Assumes value is CFString.
    fn get_string_from_dict_ref(dict_ref: CFDictionaryRef, key: CFTypeRef) -> Option<String> {
        unsafe {
            let value_ref = CFDictionaryGetValue(dict_ref, key);
            if value_ref.is_null() {
                return None;
            }
            let cf_string = CFString::wrap_under_get_rule(value_ref as CFStringRef);
            Some(cf_string.to_string())
        }
    }

    /// Helper to extract a Vec<u8> value from a CFDictionary. Assumes value is CFData.
    fn get_data_from_dict_ref(dict_ref: CFDictionaryRef, key: CFTypeRef) -> Option<Vec<u8>> {
        unsafe {
            let value_ref = CFDictionaryGetValue(dict_ref, key);
            if value_ref.is_null() {
                return None;
            }
            let cf_data = CFData::wrap_under_get_rule(value_ref as CFDataRef);
            Some(cf_data.bytes().to_vec())
        }
    }

    /// Builds a Security Framework query dictionary from key-value pairs.
    ///
    /// Each pair is a raw `CFTypeRef` key (e.g., `kSecClass`) and a safe `CFType` value.
    /// The returned `CFMutableDictionary` owns all entries and handles cleanup on drop.
    fn build_query(pairs: &[(CFTypeRef, CFTypeRef)]) -> CFMutableDictionary {
        let mut dict = CFMutableDictionary::new();
        for (key, value) in pairs {
            dict.add(key, value);
        }
        dict
    }
}

impl KeyStorage for IOSKeychain {
    fn store_key(
        &self,
        alias: &KeyAlias,
        identity_did: &IdentityDID,
        role: KeyRole,
        encrypted_key_data: &[u8],
    ) -> Result<(), AgentError> {
        let alias = alias.as_str();
        info!(
            "Storing key for alias '{}' (DID: {}, role: {})",
            alias, identity_did, role
        );

        let service_cf = CFString::new(&self.service_name);
        let alias_cf = CFString::new(alias);
        let did_cf = CFString::new(identity_did.as_str());
        let role_cf = CFString::new(&role.to_string());
        let data_cf = CFData::from_buffer(encrypted_key_data);
        // The raw string value for kSecAttrAccessible is "pdmn"
        let key_accessible_cf = CFString::new("pdmn");

        unsafe {
            // 1. Delete existing item first
            let delete_query = Self::build_query(&[
                (
                    kSecClass as CFTypeRef,
                    kSecClassGenericPassword as CFTypeRef,
                ),
                (kSecAttrService as CFTypeRef, service_cf.as_CFTypeRef()),
                (kSecAttrAccount as CFTypeRef, alias_cf.as_CFTypeRef()),
            ]);

            let delete_status = SecItemDelete(delete_query.as_concrete_TypeRef());

            if delete_status != errSecSuccess && delete_status != errSecItemNotFound {
                warn!(
                    "SecItemDelete before add failed (status: {}) for alias '{}'. Continuing add attempt.",
                    delete_status, alias
                );
            }

            // 2. Add new item
            let add_query = Self::build_query(&[
                (
                    kSecClass as CFTypeRef,
                    kSecClassGenericPassword as CFTypeRef,
                ),
                (kSecAttrService as CFTypeRef, service_cf.as_CFTypeRef()),
                (kSecAttrAccount as CFTypeRef, alias_cf.as_CFTypeRef()),
                (kSecAttrDescription as CFTypeRef, did_cf.as_CFTypeRef()),
                (kSecAttrComment as CFTypeRef, role_cf.as_CFTypeRef()),
                (kSecValueData as CFTypeRef, data_cf.as_CFTypeRef()),
                (
                    key_accessible_cf.as_CFTypeRef(),
                    kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly as CFTypeRef,
                ),
            ]);

            let add_status = SecItemAdd(add_query.as_concrete_TypeRef(), ptr::null_mut());

            if add_status == errSecSuccess {
                info!("Successfully stored key for alias '{}'", alias);
                Ok(())
            } else {
                Err(Self::map_os_status_err(
                    add_status,
                    &format!("SecItemAdd for alias '{}'", alias),
                ))
            }
        }
    }

    fn load_key(&self, alias: &KeyAlias) -> Result<(IdentityDID, KeyRole, Vec<u8>), AgentError> {
        let alias = alias.as_str();
        debug!("Loading key for alias '{}'", alias);

        let service_cf = CFString::new(&self.service_name);
        let alias_cf = CFString::new(alias);
        let match_limit_one = CFNumber::from(1i64);
        let mut result: CFTypeRef = ptr::null_mut();

        unsafe {
            let query = Self::build_query(&[
                (
                    kSecClass as CFTypeRef,
                    kSecClassGenericPassword as CFTypeRef,
                ),
                (kSecAttrService as CFTypeRef, service_cf.as_CFTypeRef()),
                (kSecAttrAccount as CFTypeRef, alias_cf.as_CFTypeRef()),
                (kSecReturnData as CFTypeRef, kCFBooleanTrue as CFTypeRef),
                (
                    kSecReturnAttributes as CFTypeRef,
                    kCFBooleanTrue as CFTypeRef,
                ),
                (kSecMatchLimit as CFTypeRef, match_limit_one.as_CFTypeRef()),
            ]);

            let status = SecItemCopyMatching(query.as_concrete_TypeRef(), &mut result);

            if status != errSecSuccess {
                return Err(Self::map_os_status_err(
                    status,
                    &format!("SecItemCopyMatching (load) for alias '{}'", alias),
                ));
            }
        }

        let result_dict = result as CFDictionaryRef;
        let key_data_opt: Option<Vec<u8>>;
        let identity_did_opt: Option<String>;
        let role_str_opt: Option<String>;

        unsafe {
            key_data_opt =
                Self::get_data_from_dict_ref(result_dict, kSecValueData as *const c_void);
            identity_did_opt =
                Self::get_string_from_dict_ref(result_dict, kSecAttrDescription as *const c_void);
            role_str_opt =
                Self::get_string_from_dict_ref(result_dict, kSecAttrComment as *const c_void);
            CFRelease(result);
        }

        let key_data = key_data_opt.ok_or_else(|| {
            AgentError::SecurityError(format!(
                "Keychain item for alias '{}' missing key data",
                alias
            ))
        })?;
        let identity_did_str = identity_did_opt.ok_or_else(|| {
            AgentError::SecurityError(format!(
                "Keychain item for alias '{}' missing description (IdentityDID)",
                alias
            ))
        })?;

        let role = role_str_opt
            .and_then(|s| s.parse::<KeyRole>().ok())
            .unwrap_or(KeyRole::Primary);

        debug!("Successfully loaded key for alias '{}'", alias);
        #[allow(clippy::disallowed_methods)]
        // INVARIANT: loaded from iOS Keychain which stores validated DIDs
        Ok((IdentityDID::new_unchecked(identity_did_str), role, key_data))
    }

    fn delete_key(&self, alias: &KeyAlias) -> Result<(), AgentError> {
        let alias = alias.as_str();
        info!("Deleting key for alias '{}'", alias);
        let service_cf = CFString::new(&self.service_name);
        let alias_cf = CFString::new(alias);

        let status = unsafe {
            let query = Self::build_query(&[
                (
                    kSecClass as CFTypeRef,
                    kSecClassGenericPassword as CFTypeRef,
                ),
                (kSecAttrService as CFTypeRef, service_cf.as_CFTypeRef()),
                (kSecAttrAccount as CFTypeRef, alias_cf.as_CFTypeRef()),
            ]);

            SecItemDelete(query.as_concrete_TypeRef())
        };

        if status == errSecSuccess || status == errSecItemNotFound {
            info!(
                "Successfully deleted (or did not find) key for alias '{}'",
                alias
            );
            Ok(())
        } else {
            Err(Self::map_os_status_err(
                status,
                &format!("SecItemDelete for alias '{}'", alias),
            ))
        }
    }

    fn list_aliases(&self) -> Result<Vec<KeyAlias>, AgentError> {
        debug!("Listing all aliases for service '{}'", self.service_name);
        let service_cf = CFString::new(&self.service_name);
        let mut result: CFTypeRef = ptr::null_mut();

        let status = unsafe {
            let query = Self::build_query(&[
                (
                    kSecClass as CFTypeRef,
                    kSecClassGenericPassword as CFTypeRef,
                ),
                (kSecAttrService as CFTypeRef, service_cf.as_CFTypeRef()),
                (
                    kSecReturnAttributes as CFTypeRef,
                    kCFBooleanTrue as CFTypeRef,
                ),
                (kSecMatchLimit as CFTypeRef, kSecMatchLimitAll as CFTypeRef),
            ]);

            SecItemCopyMatching(query.as_concrete_TypeRef(), &mut result)
        };

        if status == errSecItemNotFound {
            return Ok(vec![]);
        }
        if status != errSecSuccess {
            return Err(Self::map_os_status_err(
                status,
                "SecItemCopyMatching (list_aliases)",
            ));
        }

        let result_array = result as CFArrayRef;
        let count = unsafe { CFArrayGetCount(result_array) };
        let mut aliases = Vec::with_capacity(count as usize);

        for i in 0..count {
            unsafe {
                let item_dict = CFArrayGetValueAtIndex(result_array, i) as CFDictionaryRef;
                if item_dict.is_null() {
                    continue;
                }
                if let Some(alias) =
                    Self::get_string_from_dict_ref(item_dict, kSecAttrAccount as *const c_void)
                {
                    aliases.push(KeyAlias::new_unchecked(alias));
                } else {
                    warn!(
                        "Keychain item found for service '{}' missing account (alias) at index {}",
                        self.service_name, i
                    );
                }
            }
        }
        unsafe {
            CFRelease(result);
        }
        debug!(
            "Found {} aliases for service '{}'",
            aliases.len(),
            self.service_name
        );
        Ok(aliases)
    }

    fn list_aliases_for_identity(
        &self,
        identity_did: &IdentityDID,
    ) -> Result<Vec<KeyAlias>, AgentError> {
        debug!("Listing aliases for identity DID '{}'", identity_did);
        let service_cf = CFString::new(&self.service_name);
        let did_cf = CFString::new(identity_did.as_str());
        let mut result: CFTypeRef = ptr::null_mut();

        let status = unsafe {
            let query = Self::build_query(&[
                (
                    kSecClass as CFTypeRef,
                    kSecClassGenericPassword as CFTypeRef,
                ),
                (kSecAttrService as CFTypeRef, service_cf.as_CFTypeRef()),
                (kSecAttrDescription as CFTypeRef, did_cf.as_CFTypeRef()),
                (
                    kSecReturnAttributes as CFTypeRef,
                    kCFBooleanTrue as CFTypeRef,
                ),
                (kSecMatchLimit as CFTypeRef, kSecMatchLimitAll as CFTypeRef),
            ]);

            SecItemCopyMatching(query.as_concrete_TypeRef(), &mut result)
        };

        if status == errSecItemNotFound {
            return Ok(vec![]);
        }
        if status != errSecSuccess {
            return Err(Self::map_os_status_err(
                status,
                &format!(
                    "SecItemCopyMatching (list_aliases_for_identity) for DID '{}'",
                    identity_did
                ),
            ));
        }

        let result_array = result as CFArrayRef;
        let count = unsafe { CFArrayGetCount(result_array) };
        let mut aliases = Vec::with_capacity(count as usize);

        for i in 0..count {
            unsafe {
                let item_dict = CFArrayGetValueAtIndex(result_array, i) as CFDictionaryRef;
                if item_dict.is_null() {
                    continue;
                }
                if let Some(alias) =
                    Self::get_string_from_dict_ref(item_dict, kSecAttrAccount as *const c_void)
                {
                    aliases.push(KeyAlias::new_unchecked(alias));
                } else {
                    warn!(
                        "Keychain item found for DID '{}' missing account (alias) at index {}",
                        identity_did, i
                    );
                }
            }
        }
        unsafe {
            CFRelease(result_array as CFTypeRef);
        }
        debug!(
            "Found {} aliases for identity DID '{}'",
            aliases.len(),
            identity_did
        );
        Ok(aliases)
    }

    fn get_identity_for_alias(&self, alias: &KeyAlias) -> Result<IdentityDID, AgentError> {
        let alias = alias.as_str();
        debug!("Getting identity DID for alias '{}'", alias);
        let service_cf = CFString::new(&self.service_name);
        let alias_cf = CFString::new(alias);
        let match_limit_one = CFNumber::from(1i64);
        let mut result: CFTypeRef = ptr::null_mut();

        let status = unsafe {
            let query = Self::build_query(&[
                (
                    kSecClass as CFTypeRef,
                    kSecClassGenericPassword as CFTypeRef,
                ),
                (kSecAttrService as CFTypeRef, service_cf.as_CFTypeRef()),
                (kSecAttrAccount as CFTypeRef, alias_cf.as_CFTypeRef()),
                (
                    kSecReturnAttributes as CFTypeRef,
                    kCFBooleanTrue as CFTypeRef,
                ),
                (kSecMatchLimit as CFTypeRef, match_limit_one.as_CFTypeRef()),
            ]);

            SecItemCopyMatching(query.as_concrete_TypeRef(), &mut result)
        };

        if status != errSecSuccess {
            return Err(Self::map_os_status_err(
                status,
                &format!("SecItemCopyMatching (get_identity) for alias '{}'", alias),
            ));
        }

        let result_dict = result as CFDictionaryRef;
        let identity_did_opt: Option<String>;

        unsafe {
            identity_did_opt =
                Self::get_string_from_dict_ref(result_dict, kSecAttrDescription as *const c_void);
            CFRelease(result);
        }

        let identity_did = identity_did_opt.ok_or_else(|| {
            AgentError::SecurityError(format!(
                "Keychain item for alias '{}' missing description (IdentityDID)",
                alias
            ))
        })?;

        debug!("Found identity DID for alias '{}'", alias);
        #[allow(clippy::disallowed_methods)]
        // INVARIANT: loaded from iOS Keychain which stores validated DIDs
        Ok(IdentityDID::new_unchecked(identity_did))
    }

    fn backend_name(&self) -> &'static str {
        "iOS Keychain"
    }
}