Security-57031.1.35.tar.gz

[apple/security.git] / Security / sec / SOSCircle / SecureObjectSync / SOSInternal.h

diff --git a/Security/sec/SOSCircle/SecureObjectSync/SOSInternal.h b/Security/sec/SOSCircle/SecureObjectSync/SOSInternal.h
new file mode 100644 (file)
index 0000000..8defc8b
--- /dev/null
+++ b/Security/sec/SOSCircle/SecureObjectSync/SOSInternal.h
@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
+ *
+ * @APPLE_LICENSE_HEADER_START@
+ * 
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ * 
+ * @APPLE_LICENSE_HEADER_END@
+ */
+
+
+#ifndef _SOSINTERNAL_H_
+#define _SOSINTERNAL_H_
+
+#include <CoreFoundation/CoreFoundation.h>
+
+#include <Security/SecKey.h>
+
+#include <SecureObjectSync/SOSCloudCircle.h>
+
+#include <utilities/SecCFWrappers.h>
+
+__BEGIN_DECLS
+
+enum {
+    // Public errors are first (See SOSCloudCircle)
+
+    kSOSErrorFirstPrivateError = 1024,
+    
+    kSOSErrorAllocationFailure  = 1024,
+    kSOSErrorEncodeFailure      = 1025,
+    kSOSErrorNameMismatch       = 1026,
+    kSOSErrorSendFailure        = 1027,
+    kSOSErrorProcessingFailure  = 1028,
+    kSOSErrorDecodeFailure      = 1029,
+
+    kSOSErrorAlreadyPeer        = 1030,
+    kSOSErrorNotApplicant       = 1031,
+    kSOSErrorPeerNotFound       = 1032,
+
+    kSOSErrorNoKey              = 1033,
+    kSOSErrorBadKey             = 1034,
+    kSOSErrorBadFormat          = 1035,
+    kSOSErrorNoCircleName       = 1036,
+    kSOSErrorNoCircle           = 1037,
+    kSOSErrorBadSignature       = 1038,
+    kSOSErrorReplay             = 1039,
+
+    kSOSErrorUnexpectedType     = 1040,
+
+    kSOSErrorUnsupported        = 1041
+};
+
+// Returns false unless errorCode is 0.
+bool SOSErrorCreate(CFIndex errorCode, CFErrorRef *error, CFDictionaryRef formatOptions, CFStringRef descriptionString, ...);
+
+bool SOSCreateError(CFIndex errorCode, CFStringRef descriptionString, CFErrorRef previousError, CFErrorRef *newError);
+
+bool SOSCreateErrorWithFormat(CFIndex errorCode, CFErrorRef previousError, CFErrorRef *newError,
+                              CFDictionaryRef formatOptions, CFStringRef formatString, ...)
+                        CF_FORMAT_FUNCTION(5,6);
+
+bool SOSCreateErrorWithFormatAndArguments(CFIndex errorCode, CFErrorRef previousError, CFErrorRef *newError,
+                                          CFDictionaryRef formatOptions, CFStringRef formatString, va_list args)
+                                CF_FORMAT_FUNCTION(5,0);
+
+
+static inline bool isSOSErrorCoded(CFErrorRef error, CFIndex sosErrorCode) {
+    return error && CFErrorGetCode(error) == sosErrorCode && CFEqualSafe(CFErrorGetDomain(error), kSOSErrorDomain);
+}
+
+
+//
+// Utility Functions
+//
+OSStatus GenerateECPair(int keySize, SecKeyRef* public, SecKeyRef *full);
+OSStatus GeneratePermanentECPair(int keySize, SecKeyRef* public, SecKeyRef *full);
+
+CFStringRef SOSChangesCopyDescription(CFDictionaryRef changes, bool is_sender);
+
+CFStringRef SOSCopyIDOfKey(SecKeyRef key, CFErrorRef *error);
+
+//
+// Der encoding accumulation
+//
+static inline bool accumulate_size(size_t *accumulator, size_t size) {
+    *accumulator += size;
+    return size != 0;
+}
+
+__END_DECLS
+
+#endif