OSX/sec/SOSCircle/SecureObjectSync/SOSInternal.h

   1 /*
   2  * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   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
  11  * file.
  12  *
  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.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 #ifndef _SOSINTERNAL_H_
  26 #define _SOSINTERNAL_H_
  27
  28 #include <CoreFoundation/CoreFoundation.h>
  29
  30 #include <Security/SecKey.h>
  31
  32 #include <Security/SecureObjectSync/SOSCloudCircle.h>
  33
  34 #include <utilities/SecCFWrappers.h>
  35
  36 #include <corecrypto/ccec.h>
  37
  38 __BEGIN_DECLS
  39
  40 enum {
  41     // Public errors are first (See SOSCloudCircle)
  42
  43     kSOSErrorFirstPrivateError = 1024,
  44
  45     kSOSErrorAllocationFailure  = 1024,
  46     kSOSErrorEncodeFailure      = 1025,
  47     kSOSErrorNameMismatch       = 1026,
  48     kSOSErrorSendFailure        = 1027,
  49     kSOSErrorProcessingFailure  = 1028,
  50     kSOSErrorDecodeFailure      = 1029,
  51
  52     kSOSErrorAlreadyPeer        = 1030,
  53     kSOSErrorNotApplicant       = 1031,
  54     kSOSErrorPeerNotFound       = 1032,
  55
  56     kSOSErrorNoKey              = 1033,
  57     kSOSErrorBadKey             = 1034,
  58     kSOSErrorBadFormat          = 1035,
  59     kSOSErrorNoCircleName       = 1036,
  60     kSOSErrorNoCircle           = 1037,
  61     kSOSErrorBadSignature       = 1038,
  62     kSOSErrorReplay             = 1039,
  63
  64     kSOSErrorUnexpectedType     = 1040,
  65
  66     kSOSErrorUnsupported        = 1041,
  67     kSOSErrorInvalidMessage     = 1042,
  68     kSOSErrorNoRing             = 1043,
  69
  70     kSOSErrorNoiCloudPeer       = 1044,
  71     kSOSErrorParam              = 1045,
  72 };
  73
  74
  75 // Returns false unless errorCode is 0.
  76 bool SOSErrorCreate(CFIndex errorCode, CFErrorRef *error, CFDictionaryRef formatOptions, CFStringRef descriptionString, ...);
  77
  78 bool SOSCreateError(CFIndex errorCode, CFStringRef descriptionString, CFErrorRef previousError, CFErrorRef *newError);
  79
  80 bool SOSCreateErrorWithFormat(CFIndex errorCode, CFErrorRef previousError, CFErrorRef *newError,
  81                               CFDictionaryRef formatOptions, CFStringRef formatString, ...)
  82                         CF_FORMAT_FUNCTION(5,6);
  83
  84 bool SOSCreateErrorWithFormatAndArguments(CFIndex errorCode, CFErrorRef previousError, CFErrorRef *newError,
  85                                           CFDictionaryRef formatOptions, CFStringRef formatString, va_list args)
  86                                 CF_FORMAT_FUNCTION(5,0);
  87
  88
  89 static inline bool SOSClearErrorIfTrue(bool condition, CFErrorRef *error) {
  90     if(condition && error && *error) {
  91         secdebug("errorBug", "Got Success and Error (dropping error): %@", *error);
  92         CFReleaseNull(*error);
  93     }
  94     return true;
  95 }
  96
  97 static inline bool isSOSErrorCoded(CFErrorRef error, CFIndex sosErrorCode) {
  98     return error && CFErrorGetCode(error) == sosErrorCode && CFEqualSafe(CFErrorGetDomain(error), kSOSErrorDomain);
  99 }
 100
 101 //
 102 // Backup Key handling
 103 //
 104 ccec_const_cp_t SOSGetBackupKeyCurveParameters(void);
 105 bool SOSGenerateDeviceBackupFullKey(ccec_full_ctx_t generatedKey, ccec_const_cp_t cp, CFDataRef entropy, CFErrorRef* error);
 106
 107 bool SOSPerformWithDeviceBackupFullKey(ccec_const_cp_t cp, CFDataRef entropy, CFErrorRef *error, void (^operation)(ccec_full_ctx_t fullKey));
 108 CFDataRef SOSCopyDeviceBackupPublicKey(CFDataRef entropy, CFErrorRef *error);
 109
 110 //
 111 // Wrapping and Unwrapping
 112 //
 113
 114 CFMutableDataRef SOSCopyECWrappedData(ccec_pub_ctx *ec_ctx, CFDataRef data, CFErrorRef *error);
 115 bool             SOSPerformWithUnwrappedData(ccec_full_ctx_t ec_ctx, CFDataRef data, CFErrorRef *error,
 116                                              void (^operation)(size_t size, uint8_t *buffer));
 117 CFMutableDataRef SOSCopyECUnwrappedData(ccec_full_ctx_t ec_ctx, CFDataRef data, CFErrorRef *error);
 118 //
 119 // Utility Functions
 120 //
 121 OSStatus GenerateECPair(int keySize, SecKeyRef* public, SecKeyRef *full);
 122 OSStatus GeneratePermanentECPair(int keySize, SecKeyRef* public, SecKeyRef *full);
 123
 124 CFStringRef SOSItemsChangedCopyDescription(CFDictionaryRef changes, bool is_sender);
 125
 126 CFStringRef SOSCopyIDOfDataBuffer(CFDataRef data, CFErrorRef *error);
 127 CFStringRef SOSCopyIDOfDataBufferWithLength(CFDataRef data, CFIndex len, CFErrorRef *error);
 128
 129 CFStringRef SOSCopyIDOfKey(SecKeyRef key, CFErrorRef *error);
 130 CFStringRef SOSCopyIDOfKeyWithLength(SecKeyRef key, CFIndex len, CFErrorRef *error);
 131
 132 //
 133 // Der encoding accumulation
 134 //
 135 static inline bool accumulate_size(size_t *accumulator, size_t size) {
 136     *accumulator += size;
 137     return size != 0;
 138 }
 139
 140 // Used for simple timestamping that's DERable (not durable)
 141 CFDataRef SOSDateCreate(void);
 142
 143 CFDataRef CFDataCreateWithDER(CFAllocatorRef allocator, CFIndex size, uint8_t*(^operation)(size_t size, uint8_t *buffer));
 144
 145 extern const CFStringRef kSecIDSErrorDomain;
 146 extern const CFStringRef kIDSOperationType;
 147 extern const CFStringRef kIDSMessageToSendKey;
 148 extern const CFStringRef kIDSMessageUniqueID;
 149 extern const CFStringRef kIDSMessageRecipientPeerID;
 150 extern const CFStringRef kIDSMessageRecipientDeviceID;
 151 extern const CFStringRef kIDSMessageUsesAckModel;
 152
 153
 154
 155 __END_DECLS
 156
 157 #endif