2 * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
25 #ifndef _SOSINTERNAL_H_
26 #define _SOSINTERNAL_H_
28 #include <CoreFoundation/CoreFoundation.h>
30 #include <Security/SecKey.h>
32 #include <Security/SecureObjectSync/SOSCloudCircle.h>
34 #include <utilities/SecCFWrappers.h>
36 #include <corecrypto/ccec.h>
43 // Public errors are first (See SOSCloudCircle)
45 kSOSErrorFirstPrivateError
= 1024,
47 kSOSErrorAllocationFailure
= 1024,
48 kSOSErrorEncodeFailure
= 1025,
49 kSOSErrorNameMismatch
= 1026,
50 kSOSErrorSendFailure
= 1027,
51 kSOSErrorProcessingFailure
= 1028,
52 kSOSErrorDecodeFailure
= 1029,
54 kSOSErrorAlreadyPeer
= 1030,
55 kSOSErrorNotApplicant
= 1031,
56 kSOSErrorPeerNotFound
= 1032,
58 kSOSErrorNoKey
= 1033,
59 kSOSErrorBadKey
= 1034,
60 kSOSErrorBadFormat
= 1035,
61 kSOSErrorNoCircleName
= 1036,
62 kSOSErrorNoCircle
= 1037,
63 kSOSErrorBadSignature
= 1038,
64 kSOSErrorReplay
= 1039,
66 kSOSErrorUnexpectedType
= 1040,
68 kSOSErrorUnsupported
= 1041,
69 kSOSErrorInvalidMessage
= 1042,
70 kSOSErrorNoRing
= 1043,
72 kSOSErrorNoiCloudPeer
= 1044,
73 kSOSErrorParam
= 1045,
74 kSOSErrorNotInCircle
= 1046,
78 kSecIDSErrorNoDeviceID
= -1, //default case
79 kSecIDSErrorNotRegistered
= -2,
80 kSecIDSErrorFailedToSend
=-3,
81 kSecIDSErrorCouldNotFindMatchingAuthToken
= -4,
82 kSecIDSErrorDeviceIsLocked
= -5,
83 kSecIDSErrorNoPeersAvailable
= -6
88 extern const CFStringRef SOSTransportMessageTypeIDSV2
;
89 extern const CFStringRef SOSTransportMessageTypeKVS
;
90 extern const CFStringRef kSOSDSIDKey
;
92 // Returns false unless errorCode is 0.
93 bool SOSErrorCreate(CFIndex errorCode
, CFErrorRef
*error
, CFDictionaryRef formatOptions
, CFStringRef descriptionString
, ...);
95 bool SOSCreateError(CFIndex errorCode
, CFStringRef descriptionString
, CFErrorRef previousError
, CFErrorRef
*newError
);
97 bool SOSCreateErrorWithFormat(CFIndex errorCode
, CFErrorRef previousError
, CFErrorRef
*newError
,
98 CFDictionaryRef formatOptions
, CFStringRef formatString
, ...)
99 CF_FORMAT_FUNCTION(5,6);
101 bool SOSCreateErrorWithFormatAndArguments(CFIndex errorCode
, CFErrorRef previousError
, CFErrorRef
*newError
,
102 CFDictionaryRef formatOptions
, CFStringRef formatString
, va_list args
)
103 CF_FORMAT_FUNCTION(5,0);
106 static inline bool SOSClearErrorIfTrue(bool condition
, CFErrorRef
*error
) {
107 if(condition
&& error
&& *error
) {
108 secdebug("errorBug", "Got Success and Error (dropping error): %@", *error
);
109 CFReleaseNull(*error
);
114 static inline bool isSOSErrorCoded(CFErrorRef error
, CFIndex sosErrorCode
) {
115 return error
&& CFErrorGetCode(error
) == sosErrorCode
&& CFEqualSafe(CFErrorGetDomain(error
), kSOSErrorDomain
);
119 // Backup Key handling
121 ccec_const_cp_t
SOSGetBackupKeyCurveParameters(void);
122 bool SOSGenerateDeviceBackupFullKey(ccec_full_ctx_t generatedKey
, ccec_const_cp_t cp
, CFDataRef entropy
, CFErrorRef
* error
);
124 bool SOSPerformWithDeviceBackupFullKey(ccec_const_cp_t cp
, CFDataRef entropy
, CFErrorRef
*error
, void (^operation
)(ccec_full_ctx_t fullKey
));
125 CFDataRef
SOSCopyDeviceBackupPublicKey(CFDataRef entropy
, CFErrorRef
*error
);
128 // Wrapping and Unwrapping
131 CFMutableDataRef
SOSCopyECWrappedData(ccec_pub_ctx_t ec_ctx
, CFDataRef data
, CFErrorRef
*error
);
132 bool SOSPerformWithUnwrappedData(ccec_full_ctx_t ec_ctx
, CFDataRef data
, CFErrorRef
*error
,
133 void (^operation
)(size_t size
, uint8_t *buffer
));
134 CFMutableDataRef
SOSCopyECUnwrappedData(ccec_full_ctx_t ec_ctx
, CFDataRef data
, CFErrorRef
*error
);
138 OSStatus
GenerateECPair(int keySize
, SecKeyRef
* public, SecKeyRef
*full
);
139 OSStatus
GeneratePermanentECPair(int keySize
, SecKeyRef
* public, SecKeyRef
*full
);
141 CFStringRef
SOSItemsChangedCopyDescription(CFDictionaryRef changes
, bool is_sender
);
143 CFStringRef
SOSCopyIDOfDataBuffer(CFDataRef data
, CFErrorRef
*error
);
144 CFStringRef
SOSCopyIDOfDataBufferWithLength(CFDataRef data
, CFIndex len
, CFErrorRef
*error
);
146 CFStringRef
SOSCopyIDOfKey(SecKeyRef key
, CFErrorRef
*error
);
147 CFStringRef
SOSCopyIDOfKeyWithLength(SecKeyRef key
, CFIndex len
, CFErrorRef
*error
);
150 // Der encoding accumulation
152 static inline bool accumulate_size(size_t *accumulator
, size_t size
) {
153 *accumulator
+= size
;
157 // Used for simple timestamping that's DERable (not durable)
158 CFDataRef
SOSDateCreate(void);
160 CFDataRef
CFDataCreateWithDER(CFAllocatorRef allocator
, CFIndex size
, uint8_t*(^operation
)(size_t size
, uint8_t *buffer
));
162 extern const CFStringRef kSecIDSErrorDomain
;
163 extern const CFStringRef kIDSOperationType
;
164 extern const CFStringRef kIDSMessageToSendKey
;
165 extern const CFStringRef kIDSMessageUniqueID
;
166 extern const CFStringRef kIDSMessageRecipientPeerID
;
167 extern const CFStringRef kIDSMessageRecipientDeviceID
;
168 extern const CFStringRef kIDSMessageUsesAckModel
;
169 extern const CFStringRef kIDSMessageSenderDeviceID
;