Skip to main content

security/ffi/
mod.rs

1//! Raw FFI declarations for the subset of `Security.framework` used by this crate.
2
3#![allow(
4    non_camel_case_types,
5    non_snake_case,
6    non_upper_case_globals,
7    missing_docs
8)]
9
10use libc::{c_char, c_void, size_t};
11
12mod access_control;
13mod item;
14mod key;
15mod policy;
16
17pub use access_control::*;
18pub use item::*;
19pub use key::*;
20pub use policy::*;
21pub use apple_cf::raw::{
22    Boolean, CFAllocatorRef, CFArrayRef, CFBooleanRef, CFDataRef, CFDictionaryRef, CFErrorRef,
23    CFIndex, CFMutableDictionaryRef, CFNumberRef, CFOptionFlags, CFStringRef, CFTypeID,
24    CFTypeRef, OSStatus,
25};
26pub type SecRandomRef = *const c_void;
27pub type SecAccessControlRef = *const c_void;
28pub type SecCertificateRef = *const c_void;
29pub type SecKeyRef = *const c_void;
30pub type SecPolicyRef = *const c_void;
31pub type SecTrustRef = *const c_void;
32pub type SecCodeRef = *const c_void;
33pub type SecStaticCodeRef = *const c_void;
34pub type SecCSFlags = u32;
35
36pub const kCFStringEncodingUTF8: u32 = 0x0800_0100;
37pub const kCFNumberSInt64Type: i64 = 4;
38
39pub const kSecCSDefaultFlags: SecCSFlags = 0;
40pub const kSecCSSigningInformation: SecCSFlags = 1 << 1;
41pub const kSecCSDynamicInformation: SecCSFlags = 1 << 3;
42
43pub mod status {
44    use super::OSStatus;
45
46    pub const SUCCESS: OSStatus = 0;
47    pub const DUPLICATE_ITEM: OSStatus = -25299;
48    pub const ITEM_NOT_FOUND: OSStatus = -25300;
49    pub const INTERACTION_NOT_ALLOWED: OSStatus = -25308;
50}
51
52extern "C" {
53    pub static kCFAllocatorDefault: CFAllocatorRef;
54    pub static kCFBooleanTrue: CFBooleanRef;
55    pub static kCFTypeDictionaryKeyCallBacks: c_void;
56    pub static kCFTypeDictionaryValueCallBacks: c_void;
57    pub static kCFTypeArrayCallBacks: c_void;
58
59    pub fn CFRelease(cf: CFTypeRef);
60    pub fn CFGetTypeID(cf: CFTypeRef) -> CFTypeID;
61
62    pub fn CFStringCreateWithCString(
63        alloc: CFAllocatorRef,
64        c_str: *const c_char,
65        encoding: u32,
66    ) -> CFStringRef;
67    pub fn CFStringGetLength(string: CFStringRef) -> CFIndex;
68    pub fn CFStringGetCString(
69        string: CFStringRef,
70        buffer: *mut c_char,
71        buffer_size: CFIndex,
72        encoding: u32,
73    ) -> bool;
74    pub fn CFStringGetTypeID() -> CFTypeID;
75
76    pub fn CFDataCreate(alloc: CFAllocatorRef, bytes: *const u8, length: CFIndex) -> CFDataRef;
77    pub fn CFDataGetLength(data: CFDataRef) -> CFIndex;
78    pub fn CFDataGetBytePtr(data: CFDataRef) -> *const u8;
79    pub fn CFDataGetTypeID() -> CFTypeID;
80
81    pub fn CFArrayCreate(
82        allocator: CFAllocatorRef,
83        values: *const *const c_void,
84        num_values: CFIndex,
85        call_backs: *const c_void,
86    ) -> CFArrayRef;
87    pub fn CFArrayGetCount(array: CFArrayRef) -> CFIndex;
88    pub fn CFArrayGetValueAtIndex(array: CFArrayRef, index: CFIndex) -> *const c_void;
89    pub fn CFArrayGetTypeID() -> CFTypeID;
90
91    pub fn CFDictionaryCreateMutable(
92        allocator: CFAllocatorRef,
93        capacity: CFIndex,
94        key_call_backs: *const c_void,
95        value_call_backs: *const c_void,
96    ) -> CFMutableDictionaryRef;
97    pub fn CFDictionarySetValue(
98        dictionary: CFMutableDictionaryRef,
99        key: *const c_void,
100        value: *const c_void,
101    );
102    pub fn CFDictionaryGetValue(dictionary: CFDictionaryRef, key: *const c_void) -> *const c_void;
103    pub fn CFDictionaryGetCount(dictionary: CFDictionaryRef) -> CFIndex;
104    pub fn CFDictionaryGetKeysAndValues(
105        dictionary: CFDictionaryRef,
106        keys: *mut *const c_void,
107        values: *mut *const c_void,
108    );
109    pub fn CFDictionaryGetTypeID() -> CFTypeID;
110
111    pub fn CFBooleanGetValue(boolean: CFBooleanRef) -> bool;
112    pub fn CFBooleanGetTypeID() -> CFTypeID;
113
114    pub fn CFNumberGetValue(number: CFNumberRef, number_type: i64, value_ptr: *mut c_void) -> bool;
115    pub fn CFNumberGetTypeID() -> CFTypeID;
116
117    pub fn CFErrorCopyDescription(err: CFErrorRef) -> CFStringRef;
118
119    pub fn SecCopyErrorMessageString(status: OSStatus, reserved: *mut c_void) -> CFStringRef;
120
121    pub static kSecClass: CFStringRef;
122    pub static kSecClassGenericPassword: CFStringRef;
123    pub static kSecAttrAccount: CFStringRef;
124    pub static kSecAttrService: CFStringRef;
125    pub static kSecValueData: CFStringRef;
126    pub static kSecReturnData: CFStringRef;
127    pub static kSecReturnAttributes: CFStringRef;
128    pub static kSecMatchLimit: CFStringRef;
129    pub static kSecMatchLimitOne: CFStringRef;
130    pub static kSecMatchLimitAll: CFStringRef;
131
132    pub fn SecItemCopyMatching(query: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
133    pub fn SecItemAdd(attributes: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
134    pub fn SecItemUpdate(query: CFDictionaryRef, attributes_to_update: CFDictionaryRef)
135        -> OSStatus;
136    pub fn SecItemDelete(query: CFDictionaryRef) -> OSStatus;
137
138    pub fn SecCertificateCreateWithData(
139        allocator: CFAllocatorRef,
140        data: CFDataRef,
141    ) -> SecCertificateRef;
142    pub fn SecCertificateCopySubjectSummary(certificate: SecCertificateRef) -> CFStringRef;
143    pub fn SecCertificateCopyData(certificate: SecCertificateRef) -> CFDataRef;
144    pub fn SecCertificateCopyKey(certificate: SecCertificateRef) -> SecKeyRef;
145
146    pub fn SecPolicyCreateBasicX509() -> SecPolicyRef;
147    pub fn SecPolicyCreateSSL(server: Boolean, hostname: CFStringRef) -> SecPolicyRef;
148
149    pub fn SecTrustCreateWithCertificates(
150        certificates: CFTypeRef,
151        policies: CFTypeRef,
152        trust: *mut SecTrustRef,
153    ) -> OSStatus;
154    pub fn SecTrustSetPolicies(trust: SecTrustRef, policies: CFTypeRef) -> OSStatus;
155    pub fn SecTrustEvaluateWithError(trust: SecTrustRef, error: *mut CFErrorRef) -> Boolean;
156
157    pub fn SecCodeCopySelf(flags: SecCSFlags, self_code: *mut SecCodeRef) -> OSStatus;
158    pub static kSecCodeInfoIdentifier: CFStringRef;
159    pub static kSecCodeInfoTeamIdentifier: CFStringRef;
160    pub static kSecCodeInfoEntitlementsDict: CFStringRef;
161    pub static kSecCodeInfoStatus: CFStringRef;
162    pub fn SecCodeCopySigningInformation(
163        code: SecStaticCodeRef,
164        flags: SecCSFlags,
165        information: *mut CFDictionaryRef,
166    ) -> OSStatus;
167
168    pub static kSecRandomDefault: SecRandomRef;
169    pub fn SecRandomCopyBytes(rnd: SecRandomRef, count: size_t, bytes: *mut c_void) -> i32;
170}