security-framework-sys 2.17.0

Apple `Security.framework` low-level FFI bindings
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

use core_foundation_sys::array::CFArrayRef;
#[cfg(target_os = "macos")]
use core_foundation_sys::base::CFTypeRef;
use core_foundation_sys::base::OSStatus;
use core_foundation_sys::data::CFDataRef;
use core_foundation_sys::dictionary::CFDictionaryRef;
use core_foundation_sys::string::CFStringRef;
#[cfg(target_os = "macos")]
use std::os::raw::c_uint;

#[cfg(target_os = "macos")]
use crate::base::{SecAccessRef, SecKeychainRef};

#[cfg(target_os = "macos")]
/// <https://developer.apple.com/documentation/security/secexternalformat>
pub type SecExternalFormat = u32;
#[cfg(target_os = "macos")]
pub type SecExternalItemType = u32;
#[cfg(target_os = "macos")]
pub type SecItemImportExportFlags = u32;
#[cfg(target_os = "macos")]
pub type SecKeyImportExportFlags = u32;

#[cfg(target_os = "macos")]
pub const kSecKeyImportOnlyOne: SecKeyImportExportFlags = 1;
#[cfg(target_os = "macos")]
pub const kSecKeySecurePassphrase: SecKeyImportExportFlags = 2;
#[cfg(target_os = "macos")]
pub const kSecKeyNoAccessControl: SecKeyImportExportFlags = 4;

#[cfg(target_os = "macos")]
pub const SEC_KEY_IMPORT_EXPORT_PARAMS_VERSION: c_uint = 0;

#[cfg(target_os = "macos")]
mod sec_external_format {
    use super::SecExternalFormat;
    pub const kSecFormatUnknown: SecExternalFormat = 0;
    /// a.k.a. X509 for public keys
    pub const kSecFormatOpenSSL: SecExternalFormat = 1;
    /// OpenSSH v.1
    pub const kSecFormatSSH: SecExternalFormat = 2;
    pub const kSecFormatBSAFE: SecExternalFormat = 3;
    /// raw unformatted key bits
    pub const kSecFormatRawKey: SecExternalFormat = 4;
    pub const kSecFormatWrappedPKCS8: SecExternalFormat = 5;
    /// traditional openssl
    pub const kSecFormatWrappedOpenSSL: SecExternalFormat = 6;
    /// OpenSSH v.1
    pub const kSecFormatWrappedSSH: SecExternalFormat = 7;
    pub const kSecFormatWrappedLSH: SecExternalFormat = 8;
    /// DER encoded
    pub const kSecFormatX509Cert: SecExternalFormat = 9;
    /// sequence of certs and/or keys, implies PEM
    pub const kSecFormatPEMSequence: SecExternalFormat = 10;
    /// sequence of certs
    pub const kSecFormatPKCS7: SecExternalFormat = 11;
    /// set of certs and private keys
    pub const kSecFormatPKCS12: SecExternalFormat = 12;
    /// sequence of certs, form netscape-cert-sequence
    pub const kSecFormatNetscapeCertSequence: SecExternalFormat = 13;
    /// OpenSSH v.2
    pub const kSecFormatSSHv2: SecExternalFormat = 14;
}

#[cfg(target_os = "macos")]
pub use sec_external_format::*;

#[repr(C)]
#[derive(Copy, Clone)]
#[cfg(target_os = "macos")]
pub struct SecItemImportExportKeyParameters {
    pub version: c_uint,
    pub flags: SecKeyImportExportFlags,
    pub passphrase: CFTypeRef,
    pub alertTitle: CFStringRef,
    pub alertPrompt: CFStringRef,
    pub accessRef: SecAccessRef,
    pub keyUsage: CFArrayRef,
    pub keyAttributes: CFArrayRef,
}

extern "C" {
    #[cfg(target_os = "macos")]
    pub fn SecItemImport(
        importedData: CFDataRef,
        fileNameOrExtension: CFStringRef,
        inputFormat: *mut SecExternalFormat,
        itemType: *mut SecExternalItemType,
        flags: SecItemImportExportFlags,
        keyParams: *const SecItemImportExportKeyParameters,
        importKeychain: SecKeychainRef,
        outItems: *mut CFArrayRef,
    ) -> OSStatus;

    #[cfg(target_os = "macos")]
    pub fn SecItemExport(
        secItemOrArray: CFTypeRef,
        outputFormat: SecExternalFormat,
        flags: SecItemImportExportFlags,
        keyParams: *const SecItemImportExportKeyParameters,
        exportedData: *mut CFDataRef,
    ) -> OSStatus;

    pub static kSecImportExportPassphrase: CFStringRef;
    #[cfg(target_os = "macos")]
    pub static kSecImportExportKeychain: CFStringRef;
    #[cfg(target_os = "macos")]
    pub static kSecImportExportAccess: CFStringRef;

    pub static kSecImportItemLabel: CFStringRef;
    pub static kSecImportItemKeyID: CFStringRef;
    pub static kSecImportItemTrust: CFStringRef;
    pub static kSecImportItemCertChain: CFStringRef;
    pub static kSecImportItemIdentity: CFStringRef;

    pub fn SecPKCS12Import(
        pkcs12_data: CFDataRef,
        options: CFDictionaryRef,
        items: *mut CFArrayRef,
    ) -> OSStatus;
}