/* CFError equal checks for equality of domain, code, and userInfo.
*/
static Boolean __CFErrorEqual(CFTypeRef cf1, CFTypeRef cf2) {
CFErrorRef err1 = (CFErrorRef)cf1;
CFErrorRef err2 = (CFErrorRef)cf2;
// First do quick checks of code and domain (in that order for performance)
if (CFErrorGetCode(err1) != CFErrorGetCode(err2)) return false;
if (!CFEqual(CFErrorGetDomain(err1), CFErrorGetDomain(err2))) return false;
// If those are equal, then check the dictionaries
CFDictionaryRef dict1 = CFErrorCopyUserInfo(err1);
CFDictionaryRef dict2 = CFErrorCopyUserInfo(err2);
Boolean result = false;
if (dict1 == dict2) {
result = true;
} else if (dict1 && dict2 && CFEqual(dict1, dict2)) {
result = true;
}
if (dict1) CFRelease(dict1);
if (dict2) CFRelease(dict2);
return result;
}
/* Built-in callback for Mach domain.
*/
static CFTypeRef _CFErrorMachCallBack(CFErrorRef err, CFStringRef key) {
if (CFEqual(key, kCFErrorDescriptionKey)) {
const char *errStr = mach_error_string(CFErrorGetCode(err));
if (errStr && strlen(errStr)) return CFStringCreateWithCString(kCFAllocatorSystemDefault, errStr, kCFStringEncodingUTF8);
}
return NULL;
}
__private_extern__ CFStreamError _CFStreamErrorFromError(CFErrorRef error) {
CFStreamError result;
Boolean canUpCall;
__CFSpinLock(&(CFNetworkSupport.lock));
if (!__CFBitIsSet(CFNetworkSupport.flags, kTriedToLoad)) initializeCFNetworkSupport();
canUpCall = (CFNetworkSupport._CFStreamErrorFromCFError != NULL);
__CFSpinUnlock(&(CFNetworkSupport.lock));
if (canUpCall) {
result = CFNETWORK_CALL(_CFStreamErrorFromCFError, (error));
} else {
CFStringRef domain = CFErrorGetDomain(error);
if (CFEqual(domain, kCFErrorDomainPOSIX)) {
result.domain = kCFStreamErrorDomainPOSIX;
} else if (CFEqual(domain, kCFErrorDomainOSStatus)) {
result.domain = kCFStreamErrorDomainMacOSStatus;
} else if (CFEqual(domain, kCFErrorDomainMach)) {
result.domain = 11; // kCFStreamErrorDomainMach, but that symbol is in CFNetwork
} else {
result.domain = kCFStreamErrorDomainCustom;
}
result.error = CFErrorGetCode(error);
}
return result;
}
/* The "debug" description, used by CFCopyDescription and -[NSObject description].
*/
CFStringRef _CFErrorCreateDebugDescription(CFErrorRef err) {
CFMutableStringRef result = CFStringCreateMutable(
kCFAllocatorSystemDefault, 0);
CFStringAppendFormat(
result, NULL,
CFSTR("Error Domain=%@ Code=%d"),
CFErrorGetDomain(err), (int)CFErrorGetCode(err));
CFDictionaryRef userInfo = _CFErrorGetUserInfo(err);
if (userInfo) {
CFStringAppendFormat(result, NULL, CFSTR(" UserInfo=%p"), userInfo);
}
CFStringRef desc = CFErrorCopyDescription(err);
if (desc) {
CFStringAppendFormat(result, NULL, CFSTR(" \"%@\""), desc);
CFRelease(desc);
}
CFStringRef debugDesc = _CFErrorCopyUserInfoKey(err, kCFErrorDebugDescriptionKey);
if (debugDesc) {
if (CFStringGetLength(debugDesc) > 0) {
CFStringAppendFormat(result, NULL, CFSTR(" (%@)"), debugDesc);
}
CFRelease(debugDesc);
}
return result;
}
void SocketStreamHandle::reportErrorToClient(CFErrorRef error)
{
CFIndex errorCode = CFErrorGetCode(error);
String description;
#if PLATFORM(MAC)
#if COMPILER(CLANG)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
#endif
if (CFEqual(CFErrorGetDomain(error), kCFErrorDomainOSStatus)) {
const char* descriptionOSStatus = GetMacOSStatusCommentString(static_cast<OSStatus>(errorCode));
if (descriptionOSStatus && descriptionOSStatus[0] != '\0')
description = "OSStatus Error " + String::number(errorCode) + ": " + descriptionOSStatus;
}
#if COMPILER(CLANG)
#pragma clang diagnostic pop
#endif
#endif
if (description.isNull()) {
RetainPtr<CFStringRef> descriptionCF(AdoptCF, CFErrorCopyDescription(error));
description = String(descriptionCF.get());
}
m_client->didFailSocketStream(this, SocketStreamError(static_cast<int>(errorCode), m_url.string(), description));
}
CFStreamError _CFStreamErrorFromCFError(CFErrorRef err) {
CFStreamError error = { 0, 0 };
error.error = CFErrorGetCode(err);
CFStringRef domain = CFErrorGetDomain(err);
if (CFStringCompare(domain, CFStreamErrorDomainPOSIX, 0)) {
error.domain = kCFStreamErrorDomainPOSIX;
} else if (CFStringCompare(domain, CFStreamErrorDomainFTP, 0)) {
error.domain = kCFStreamErrorDomainFTP;
} else if (CFStringCompare(domain, CFStreamErrorDomainNetDB, 0)) {
error.domain = kCFStreamErrorDomainNetDB;
} else if (CFStringCompare(domain, CFStreamErrorDomainSystemConfiguration, 0)) {
error.domain = kCFStreamErrorDomainSystemConfiguration;
} else if (CFStringCompare(domain, CFStreamErrorDomainHTTP, 0)) {
error.domain = kCFStreamErrorDomainHTTP;
} else if (CFStringCompare(domain, CFStreamErrorDomainMach, 0)) {
error.domain = kCFStreamErrorDomainMach;
} else if (CFStringCompare(domain, CFStreamErrorDomainNetServices, 0)) {
error.domain = kCFStreamErrorDomainNetServices;
} else if (CFStringCompare(domain, CFStreamErrorDomainSOCKS, 0)) {
error.domain = kCFStreamErrorDomainSOCKS;
} else if (CFStringCompare(domain, CFStreamErrorDomainSSL, 0)) {
error.domain = kCFStreamErrorDomainSSL;
} else if (CFStringCompare(domain, CFStreamErrorDomainMacOSStatus, 0)) {
error.domain = kCFStreamErrorDomainMacOSStatus;
} else if (CFStringCompare(domain, CFStreamErrorDomainCustom, 0)) {
error.domain = kCFStreamErrorDomainCustom;
}
return error;
}
ResourceError::ResourceError(CFErrorRef cfError)
: m_dataIsUpToDate(false)
, m_platformError(cfError)
{
m_isNull = !cfError;
if (!m_isNull)
m_isTimeout = CFErrorGetCode(m_platformError.get()) == kCFURLErrorTimedOut;
}
void __CFWriteStreamClientCallBack(CFWriteStreamRef stream, CFStreamEventType eventType, void *clientCallBackInfo) {
// Extract the context
tnet_transport_t *transport = (tnet_transport_t *) clientCallBackInfo;
transport_context_t *context = transport->context;
/* lock context */
tsk_safeobj_lock(context);
// Extract the native socket
CFDataRef data = CFWriteStreamCopyProperty(stream, kCFStreamPropertySocketNativeHandle);
CFSocketNativeHandle fd;
CFDataGetBytes(data, CFRangeMake(0, sizeof(CFSocketNativeHandle)), (UInt8*) &fd);
CFRelease(data);
transport_socket_t *sock = (transport_socket_t *) getSocket(context, fd);
switch(eventType) {
case kCFStreamEventOpenCompleted:
{
TSK_DEBUG_INFO("__CFWriteStreamClientCallBack --> kCFStreamEventOpenCompleted");
if (TNET_SOCKET_TYPE_IS_SECURE(sock->type)) {
#if !TARGET_OS_IPHONE
SSLContextRef sslContext = NULL;
data = CFWriteStreamCopyProperty(stream, kCFStreamPropertySocketSSLContext);
CFDataGetBytes(data, CFRangeMake(0, sizeof(SSLContextRef)), (UInt8*) &sslContext);
CFRelease(data);
// TODO: Set the client certificates
#endif
}
break;
}
case kCFStreamEventEndEncountered:
case kCFStreamEventErrorOccurred:
{
// Get the error code
CFErrorRef error = CFWriteStreamCopyError(stream);
CFIndex index = CFErrorGetCode(error);
CFRelease(error);
TSK_DEBUG_INFO("__CFWriteStreamClientCallBack --> Error %lu", index);
TSK_RUNNABLE_ENQUEUE(transport, event_error, transport->callback_data, sock->fd);
removeSocket(sock, context);
break;
}
default:
{
// Not Implemented
assert(42 == 0);
break;
}
}
/* unlock context */
tsk_safeobj_unlock(context);
}
static void SEC_PrintCFError(CFErrorRef CF_RELEASES_ARGUMENT error) {
if (error) {
CFStringRef errorDesc = CFErrorCopyDescription(error);
dprintf("SecKey API returned: %ld, %s", CFErrorGetCode(error),
errorDesc ? CFStringGetCStringPtr(errorDesc, kCFStringEncodingUTF8) : "");
CFRelease(error);
if (errorDesc) { CFRelease(errorDesc); }
}
}
void ResourceHandle::loadResourceSynchronously(NetworkingContext* context, const ResourceRequest& request, StoredCredentials storedCredentials, ResourceError& error, ResourceResponse& response, Vector<char>& vector)
{
LOG(Network, "ResourceHandle::loadResourceSynchronously:%s allowStoredCredentials:%u", request.url().string().utf8().data(), storedCredentials);
ASSERT(!request.isEmpty());
ASSERT(response.isNull());
ASSERT(error.isNull());
OwnPtr<WebCoreSynchronousLoaderClient> client = WebCoreSynchronousLoaderClient::create(response, error);
client->setAllowStoredCredentials(storedCredentials == AllowStoredCredentials);
RefPtr<ResourceHandle> handle = adoptRef(new ResourceHandle(request, client.get(), false /*defersLoading*/, true /*shouldContentSniff*/));
handle->d->m_storageSession = context->storageSession();
if (handle->d->m_scheduledFailureType != NoFailure) {
error = context->blockedError(request);
return;
}
handle->createCFURLConnection(storedCredentials == AllowStoredCredentials, shouldRelaxThirdPartyCookiePolicy(context, request.url()), ResourceHandle::shouldContentSniffURL(request.url()));
CFURLConnectionScheduleWithRunLoop(handle->connection(), CFRunLoopGetCurrent(), synchronousLoadRunLoopMode());
CFURLConnectionScheduleDownloadWithRunLoop(handle->connection(), CFRunLoopGetCurrent(), synchronousLoadRunLoopMode());
CFURLConnectionStart(handle->connection());
while (!client->isDone())
CFRunLoopRunInMode(synchronousLoadRunLoopMode(), UINT_MAX, true);
CFURLConnectionCancel(handle->connection());
if (error.isNull() && response.mimeType().isNull())
setDefaultMIMEType(response.cfURLResponse());
RetainPtr<CFDataRef> data = client->data();
if (!error.isNull()) {
response = ResourceResponse(request.url(), String(), 0, String(), String());
CFErrorRef cfError = error;
CFStringRef domain = CFErrorGetDomain(cfError);
// FIXME: Return the actual response for failed authentication.
if (domain == kCFErrorDomainCFNetwork)
response.setHTTPStatusCode(CFErrorGetCode(cfError));
else
response.setHTTPStatusCode(404);
}
if (data) {
ASSERT(vector.isEmpty());
vector.append(CFDataGetBytePtr(data.get()), CFDataGetLength(data.get()));
}
}
// Convert from securityd error codes to OSStatus for legacy API.
OSStatus SecErrorGetOSStatus(CFErrorRef error) {
OSStatus status;
if (error == NULL) {
status = errSecSuccess;
} else {
CFStringRef domain = CFErrorGetDomain(error);
if (domain == NULL) {
secerror("No error domain for error: %@", error);
status = errSecInternal;
} else if (CFEqual(kSecErrorDomain, domain)) {
status = (OSStatus)CFErrorGetCode(error);
} else if (CFEqual(kSecDbErrorDomain, domain)) {
status = osstatus_for_s3e((int)CFErrorGetCode(error));
} else if (CFEqual(kSecErrnoDomain, domain)) {
status = (OSStatus)CFErrorGetCode(error);
} else if (CFEqual(kSecKernDomain, domain)) {
status = osstatus_for_kern_return(CFErrorGetCode(error));
} else if (CFEqual(sSecXPCErrorDomain, domain)) {
status = osstatus_for_xpc_error(CFErrorGetCode(error));
} else if (CFEqual(sSecDERErrorDomain, domain)) {
status = osstatus_for_der_error(CFErrorGetCode(error));
} else {
secnotice("securityd", "unknown error domain: %@ for error: %@", domain, error);
status = errSecInternal;
}
}
return status;
}
/* Built-in callback for POSIX domain.
* Note that we will pick up localizations from ErrnoErrors.strings
* in /System/Library/CoreServices/CoreTypes.bundle, if the file happens to be there.
*/
static CFTypeRef _CFErrorPOSIXCallBack(CFErrorRef err, CFStringRef key) {
if (!CFEqual(key, kCFErrorDescriptionKey) &&
!CFEqual(key, kCFErrorLocalizedFailureReasonKey))
{
return NULL;
}
const char* errCStr = strerror(CFErrorGetCode(err));
CFStringRef errStr = (errCStr && strlen(errCStr)) ?
CFStringCreateWithCString(kCFAllocatorSystemDefault, errCStr, kCFStringEncodingUTF8) :
NULL;
if (!errStr) {
return NULL;
}
if (CFEqual(key, kCFErrorDescriptionKey)) {
// If all we wanted was the non-localized description, we're done
return errStr;
}
// TODO _CFErrorPOSIXCallBack
//// We need a kCFErrorLocalizedFailureReasonKey, so look up a possible localization for the error message
//// Look for the bundle in /System/Library/CoreServices/CoreTypes.bundle
//CFArrayRef paths = CFCopySearchPathForDirectoriesInDomains(kCFLibraryDirectory, kCFSystemDomainMask, false);
//if (paths) {
// if (CFArrayGetCount(paths) > 0) {
// CFStringRef path = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, CFSTR("%@/CoreServices/CoreTypes.bundle"), CFArrayGetValueAtIndex(paths, 0));
// CFURLRef url = CFURLCreateWithFileSystemPath(kCFAllocatorSystemDefault, path, kCFURLPOSIXPathStyle, false /* not a directory */);
// if (url) {
// CFBundleRef bundle = CFBundleCreate(kCFAllocatorSystemDefault, url);
// if (bundle) {
// // We only want to return a result if there was a localization
// CFStringRef localizedErrStr = CFBundleCopyLocalizedString(bundle, errStr, errStr, CFSTR("ErrnoErrors"));
// if (localizedErrStr == errStr) {
// CFRelease(localizedErrStr);
// CFRelease(errStr);
// errStr = NULL;
// } else {
// CFRelease(errStr);
// errStr = localizedErrStr;
// }
// CFRelease(bundle);
// }
// CFRelease(url);
// }
// CFRelease(path);
// }
// CFRelease(paths);
//}
return errStr;
}
void ResourceError::platformLazyInit()
{
if (m_dataIsUpToDate)
return;
if (!m_platformError)
return;
CFStringRef domain = CFErrorGetDomain(m_platformError.get());
if (domain == kCFErrorDomainMach || domain == kCFErrorDomainCocoa)
m_domain ="NSCustomErrorDomain";
else if (domain == kCFErrorDomainCFNetwork)
m_domain = "CFURLErrorDomain";
else if (domain == kCFErrorDomainPOSIX)
m_domain = "NSPOSIXErrorDomain";
else if (domain == kCFErrorDomainOSStatus)
m_domain = "NSOSStatusErrorDomain";
else if (domain == kCFErrorDomainWinSock)
m_domain = "kCFErrorDomainWinSock";
else
m_domain = domain;
m_errorCode = CFErrorGetCode(m_platformError.get());
RetainPtr<CFDictionaryRef> userInfo = adoptCF(CFErrorCopyUserInfo(m_platformError.get()));
if (userInfo.get()) {
CFStringRef failingURLString = (CFStringRef) CFDictionaryGetValue(userInfo.get(), failingURLStringKey);
if (failingURLString)
m_failingURL = String(failingURLString);
else {
CFURLRef failingURL = (CFURLRef) CFDictionaryGetValue(userInfo.get(), failingURLKey);
if (failingURL) {
RetainPtr<CFURLRef> absoluteURLRef = adoptCF(CFURLCopyAbsoluteURL(failingURL));
if (absoluteURLRef.get()) {
// FIXME: CFURLGetString returns a normalized URL which is different from what is actually used by CFNetwork.
// We should use CFURLGetBytes instead.
failingURLString = CFURLGetString(absoluteURLRef.get());
m_failingURL = String(failingURLString);
}
}
}
m_localizedDescription = (CFStringRef) CFDictionaryGetValue(userInfo.get(), kCFErrorLocalizedDescriptionKey);
#if PLATFORM(WIN)
m_certificate = wkGetSSLPeerCertificateData(userInfo.get());
#endif
}
m_dataIsUpToDate = true;
}
int
odkerb_possibly_reset_search_node(CFErrorRef error)
{
if (error != NULL && gSearchNode != NULL) {
if (! IS_EXPECTED_DS_ERROR(CFErrorGetCode(error))) {
/* this is an unexpected error, let's flush the search node */
ODKERB_LOG_CFERROR(LOG_DEBUG, "Flushing search node because of unexpected error", error);
CF_SAFE_RELEASE(gSearchNode);
gSearchNode = NULL;
}
}
return 0;
}
void ResourceError::platformLazyInit()
{
if (m_dataIsUpToDate)
return;
if (!m_platformError)
return;
CFStringRef domain = CFErrorGetDomain(m_platformError.get());
if (domain == kCFErrorDomainMach || domain == kCFErrorDomainCocoa)
m_domain ="NSCustomErrorDomain";
else if (domain == kCFErrorDomainCFNetwork)
m_domain = "CFURLErrorDomain";
else if (domain == kCFErrorDomainPOSIX)
m_domain = "NSPOSIXErrorDomain";
else if (domain == kCFErrorDomainOSStatus)
m_domain = "NSOSStatusErrorDomain";
else if (domain == kCFErrorDomainWinSock)
m_domain = "kCFErrorDomainWinSock";
m_errorCode = CFErrorGetCode(m_platformError.get());
RetainPtr<CFDictionaryRef> userInfo(AdoptCF, CFErrorCopyUserInfo(m_platformError.get()));
if (userInfo.get()) {
CFStringRef failingURLString = (CFStringRef) CFDictionaryGetValue(userInfo.get(), failingURLStringKey);
if (failingURLString)
m_failingURL = String(failingURLString);
else {
CFURLRef failingURL = (CFURLRef) CFDictionaryGetValue(userInfo.get(), failingURLKey);
if (failingURL) {
RetainPtr<CFURLRef> absoluteURLRef(AdoptCF, CFURLCopyAbsoluteURL(failingURL));
if (absoluteURLRef.get()) {
failingURLString = CFURLGetString(absoluteURLRef.get());
m_failingURL = String(failingURLString);
}
}
}
m_localizedDescription = (CFStringRef) CFDictionaryGetValue(userInfo.get(), kCFErrorLocalizedDescriptionKey);
#if PLATFORM(WIN)
m_certificate = wkGetSSLPeerCertificateData(userInfo.get());
#endif
}
m_dataIsUpToDate = true;
}
static void RegressionsLogError(CFErrorRef error) {
if (error == NULL) {
return;
}
CFDictionaryRef tempDictionary = CFErrorCopyUserInfo(error);
CFIndex errorCode = CFErrorGetCode(error);
CFStringRef errorDomain = CFErrorGetDomain(error);
CFStringRef errorString = CFDictionaryGetValue(tempDictionary, kCFErrorDescriptionKey);
CFErrorRef previousError = (CFErrorRef)CFDictionaryGetValue(tempDictionary, kCFErrorUnderlyingErrorKey);
if (previousError != NULL) {
RegressionsLogError(previousError);
}
char errorDomainStr[1024];
char errorStringStr[1024];
CFStringGetCString(errorDomain, errorDomainStr, 1024, kCFStringEncodingUTF8);
CFStringGetCString(errorString, errorStringStr, 1024, kCFStringEncodingUTF8);
printf("OTR: %s (%ld) -- %s\n", errorDomainStr, errorCode, errorStringStr);
CFReleaseSafe(tempDictionary);
}
void SocketStreamHandle::reportErrorToClient(CFErrorRef error)
{
CFIndex errorCode = CFErrorGetCode(error);
String description;
#if PLATFORM(MAC)
if (CFEqual(CFErrorGetDomain(error), kCFErrorDomainOSStatus)) {
const char* descriptionOSStatus = GetMacOSStatusCommentString(static_cast<OSStatus>(errorCode));
if (descriptionOSStatus && descriptionOSStatus[0] != '\0')
description = makeString("OSStatus Error ", String::number(errorCode), ": ", descriptionOSStatus);
}
#endif
if (description.isNull()) {
RetainPtr<CFStringRef> descriptionCF(AdoptCF, CFErrorCopyDescription(error));
description = String(descriptionCF.get());
}
m_client->didFail(this, SocketStreamError(static_cast<int>(errorCode), m_url.string(), description));
}
static void tests(void)
{
// look up our entry for localhost
CFStringRef acct1 = CFSTR("local");
CFStringRef acct2 = CFSTR("admin");
CFStringRef fqdn = CFSTR("localhost");
CFStringRef not_my_fqdn = CFSTR("store.apple.com"); // something we aren't entitled to share
__block bool adding;
__block bool requesting;
__block bool deleting;
// UInt8 buf[6] = { 'l', 'o', 'c', 'a', 'l', '\0' };
// CFDataRef cred = CFDataCreate(kCFAllocatorDefault, (const UInt8 *)&buf, sizeof(buf));
CFStringRef cred = CFStringCreateCopy(kCFAllocatorDefault, CFSTR("local"));
// should get denied if we request a fqdn which is not in our entitlement
requesting = true;
SecRequestSharedWebCredential(not_my_fqdn, NULL, ^void (CFArrayRef credentials, CFErrorRef error) {
OSStatus status = (OSStatus)((error) ? CFErrorGetCode(error) : errSecSuccess);
is(status == errSecItemNotFound || expected_failure(status), true, "fqdn not entitled");
is(CFArrayGetCount(credentials) > 0, false, "returned credential array == 0");
requesting = false;
});
static SInt32 printErrorOrMessage( CFErrorRef *inError, const char *errorString, bool inVerbose )
{
SInt32 errorCode = EX_USAGE;
if ( inError == NULL || (*inError) == NULL || (inVerbose == false && errorString != NULL) )
{
CFStringRef cfString = CFStringCreateWithCString( kCFAllocatorDefault, errorString, kCFStringEncodingUTF8 );
if ( cfString != NULL ) {
CFShow( cfString );
CFRelease( cfString );
}
}
else if ( inError != NULL && (*inError) != NULL )
{
if ( inVerbose == true )
{
CFStringRef cfString = CFErrorCopyDescription( *inError );
if ( cfString != NULL ) {
CFShow( cfString );
CFRelease( cfString );
}
}
CFIndex errorCode = CFErrorGetCode( *inError );
// this is temporary until ODFramework has some kind of ranges for error types
if ( errorCode >= kODErrorCredentialsInvalid && errorCode < kODErrorCredentialsInvalid+999 ) {
errorCode = EX_NOPERM;
}
// we null the pointer
*inError = NULL;
}
return errorCode;
}
static void tests(void)
{
CFErrorRef error = NULL;
CFDataRef cfpassword = CFDataCreate(NULL, (uint8_t *) "FooFooFoo", 10);
CFDataRef cfwrong_password = CFDataCreate(NULL, (uint8_t *) "NotFooFooFoo", 10);
CFStringRef cfaccount = CFSTR("*****@*****.**");
CFMutableDictionaryRef changes = CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault);
SOSAccountRef alice_account = CreateAccountForLocalChanges(CFSTR("Alice"), CFSTR("TestSource"));
SOSAccountRef bob_account = CreateAccountForLocalChanges(CFSTR("Bob"), CFSTR("TestSource"));
SOSAccountRef carol_account = CreateAccountForLocalChanges(CFSTR("Carol"), CFSTR("TestSource"));
ok(SOSAccountAssertUserCredentialsAndUpdate(bob_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
// Bob wins writing at this point, feed the changes back to alice.
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, NULL), 1, "updates");
ok(SOSAccountAssertUserCredentialsAndUpdate(alice_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
CFReleaseNull(error);
ok(SOSAccountTryUserCredentials(alice_account, cfaccount, cfpassword, &error), "Credential trying (%@)", error);
CFReleaseNull(error);
ok(!SOSAccountTryUserCredentials(alice_account, cfaccount, cfwrong_password, &error), "Credential failing (%@)", error);
CFReleaseNull(cfwrong_password);
is(error ? CFErrorGetCode(error) : 0, kSOSErrorWrongPassword, "Expected SOSErrorWrongPassword");
CFReleaseNull(error);
ok(SOSAccountResetToOffering_wTxn(alice_account, &error), "Reset to offering (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, NULL), 2, "updates");
ok(SOSAccountJoinCircles_wTxn(bob_account, &error), "Bob Applies (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, NULL), 2, "updates");
{
CFArrayRef applicants = SOSAccountCopyApplicants(alice_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(alice_account, applicants, &error), "Alice accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, NULL), 3, "updates");
accounts_agree("bob&alice pair", bob_account, alice_account);
CFArrayRef peers = SOSAccountCopyPeers(alice_account, &error);
ok(peers && CFArrayGetCount(peers) == 2, "See two peers %@ (%@)", peers, error);
CFReleaseNull(peers);
//bob now goes def while Alice does some stuff.
ok(SOSAccountLeaveCircle(alice_account, &error), "ALICE LEAVES THE CIRCLE (%@)", error);
ok(SOSAccountResetToOffering_wTxn(alice_account, &error), "Alice resets to offering again (%@)", error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, NULL), 2, "updates");
accounts_agree("bob&alice pair", bob_account, alice_account);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 1, "updates");
ok(SOSAccountAssertUserCredentialsAndUpdate(carol_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
SOSAccountSetUserPublicTrustedForTesting(carol_account);
ok(SOSAccountResetToOffering_wTxn(carol_account, &error), "Carol is going to push a reset to offering (%@)", error);
int64_t valuePtr = 0;
CFNumberRef gencount = CFNumberCreate(kCFAllocatorDefault, kCFNumberCFIndexType, &valuePtr);
SOSCircleSetGeneration(carol_account->trusted_circle, gencount);
SecKeyRef user_privkey = SOSUserKeygen(cfpassword, carol_account->user_key_parameters, &error);
CFNumberRef genCountTest = SOSCircleGetGeneration(carol_account->trusted_circle);
CFIndex testPtr;
CFNumberGetValue(genCountTest, kCFNumberCFIndexType, &testPtr);
ok(testPtr== 0);
SOSCircleSignOldStyleResetToOfferingCircle(carol_account->trusted_circle, carol_account->my_identity, user_privkey, &error);
SOSTransportCircleTestRemovePendingChange(carol_account->circle_transport, SOSCircleGetName(carol_account->trusted_circle), NULL);
CFDataRef circle_data = SOSCircleCopyEncodedData(carol_account->trusted_circle, kCFAllocatorDefault, &error);
if (circle_data) {
SOSTransportCirclePostCircle(carol_account->circle_transport, SOSCircleGetName(carol_account->trusted_circle), circle_data, &error);
}
genCountTest = SOSCircleGetGeneration(carol_account->trusted_circle);
CFNumberGetValue(genCountTest, kCFNumberCFIndexType, &testPtr);
ok(testPtr== 0);
ok(SOSAccountAssertUserCredentialsAndUpdate(bob_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
ok(SOSAccountAssertUserCredentialsAndUpdate(alice_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
SOSAccountSetUserPublicTrustedForTesting(alice_account);
SOSAccountSetUserPublicTrustedForTesting(bob_account);
is(ProcessChangesUntilNoChange(changes, carol_account, alice_account, bob_account, NULL), 2, "updates");
ok(kSOSCCNotInCircle == SOSAccountGetCircleStatus(alice_account, &error), "alice is not in the account (%@)", error);
ok(kSOSCCNotInCircle == SOSAccountGetCircleStatus(bob_account, &error), "bob is not in the account (%@)", error);
ok(kSOSCCInCircle == SOSAccountGetCircleStatus(carol_account, &error), "carol is in the account (%@)", error);
CFReleaseNull(gencount);
CFReleaseNull(bob_account);
CFReleaseNull(alice_account);
CFReleaseNull(cfpassword);
SOSTestCleanup();
}
int init_server_keys(bool ecdsa,
unsigned char *cert_der, size_t cert_der_len,
unsigned char *key_der, size_t key_der_len,
SSLCertificate *cert, tls_private_key_t *key)
{
int err = 0;
cert->next = NULL;
cert->derCert.data = cert_der;
cert->derCert.length = cert_der_len;
SecKeyRef privKey = NULL;
#if TARGET_OS_IPHONE
if(ecdsa)
{
privKey = SecKeyCreateECPrivateKey(kCFAllocatorDefault, key_der, key_der_len,
kSecKeyEncodingPkcs1);
} else {
privKey = SecKeyCreateRSAPrivateKey(kCFAllocatorDefault, key_der, key_der_len,
kSecKeyEncodingPkcs1);
}
require_action(privKey, fail, err=-1);
#else
// Create the SecKeyRef
CFErrorRef error = NULL;
CFDataRef keyData = CFDataCreate(kCFAllocatorDefault, key_der, key_der_len);
CFMutableDictionaryRef parameters = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, NULL, NULL);
CFDictionarySetValue(parameters, kSecAttrKeyType, ecdsa?kSecAttrKeyTypeECDSA:kSecAttrKeyTypeRSA);
CFDictionarySetValue(parameters, kSecAttrKeyClass, kSecAttrKeyClassPrivate);
privKey = SecKeyCreateFromData(parameters, keyData, &error);
require_action(privKey, fail, err=(int)CFErrorGetCode(error));
#endif
size_t keySize = SecKeyGetBlockSize(privKey);
if(ecdsa) {
#if TARGET_OS_IPHONE
/* Compute signature size from key size */
size_t sigSize = 8+2*keySize;
#else
size_t sigSize = keySize;
#endif
require((*key = tls_private_key_ecdsa_create(privKey, sigSize,
SecECKeyGetNamedCurve(privKey), mySSLPrivKeyECDSA_sign)), fail);
} else {
require((*key = tls_private_key_rsa_create(privKey, keySize,
mySSLPrivKeyRSA_sign, mySSLPrivKeyRSA_decrypt)), fail);
}
err = 0;
fail:
#if !TARGET_OS_IPHONE
CFReleaseSafe(parameters);
CFReleaseSafe(keyData);
CFReleaseSafe(error);
#endif
return err;
}
void __CFReadStreamClientCallBack(CFReadStreamRef stream, CFStreamEventType eventType, void *clientCallBackInfo) {
// Extract the context
tnet_transport_t *transport = (tnet_transport_t *) clientCallBackInfo;
transport_context_t *context = transport->context;
/* lock context */
tsk_safeobj_lock(context);
// Extract the native socket
CFDataRef data = CFReadStreamCopyProperty(stream, kCFStreamPropertySocketNativeHandle);
CFSocketNativeHandle fd;
CFDataGetBytes(data, CFRangeMake(0, sizeof(CFSocketNativeHandle)), (UInt8*) &fd);
CFRelease(data);
transport_socket_t *sock = (transport_socket_t *) getSocket(context, fd);
switch(eventType) {
case kCFStreamEventOpenCompleted:
{
TSK_DEBUG_INFO("__CFReadStreamClientCallBack --> kCFStreamEventOpenCompleted");
break;
}
case kCFStreamEventHasBytesAvailable:
{
tsk_size_t len = 0;
void *buffer = 0;
tnet_transport_event_t* e;
// Allocate a standard buffer
len = TNET_BUFFER_SIZE;
if (!(buffer = tsk_calloc(len, sizeof(uint8_t)))) {
TSK_DEBUG_ERROR("TSK_CALLOC FAILED.");
break;
}
// Process to read data
CFIndex index = CFReadStreamRead(stream, buffer, TNET_BUFFER_SIZE);
len = index;
TSK_DEBUG_INFO("__CFReadStreamClientCallBack --> %u bytes read", len);
e = tnet_transport_event_create(event_data, transport->callback_data, sock->fd);
e->data = buffer;
e->size = len;
TSK_RUNNABLE_ENQUEUE_OBJECT(TSK_RUNNABLE(transport), e);
break;
}
case kCFStreamEventEndEncountered:
case kCFStreamEventErrorOccurred:
{
// Get the error code
CFErrorRef error = CFReadStreamCopyError(stream);
CFIndex index = CFErrorGetCode(error);
CFRelease(error);
TSK_DEBUG_INFO("__CFReadStreamClientCallBack --> Error %lu", index);
TSK_RUNNABLE_ENQUEUE(transport, event_error, transport->callback_data, sock->fd);
removeSocket(sock, context);
break;
}
default:
{
// Not Implemented
assert(42 == 0);
break;
}
}
/* unlock context */
tsk_safeobj_unlock(context);
}
static void tests(void)
{
CFErrorRef error = NULL;
CFDataRef cfpassword = CFDataCreate(NULL, (uint8_t *) "FooFooFoo", 10);
CFDataRef cfwrong_password = CFDataCreate(NULL, (uint8_t *) "NotFooFooFoo", 10);
CFStringRef cfaccount = CFSTR("*****@*****.**");
CFMutableDictionaryRef changes = CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault);
SOSAccountRef alice_account = CreateAccountForLocalChanges(CFSTR("Alice"), CFSTR("TestSource"));
SOSAccountRef bob_account = CreateAccountForLocalChanges(CFSTR("Bob"), CFSTR("TestSource"));
SOSAccountRef carol_account = CreateAccountForLocalChanges(CFSTR("Carol"), CFSTR("TestSource"));
ok(SOSAccountAssertUserCredentialsAndUpdate(bob_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
// Bob wins writing at this point, feed the changes back to alice.
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 1, "updates");
ok(SOSAccountAssertUserCredentialsAndUpdate(alice_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
CFReleaseNull(error);
ok(SOSAccountTryUserCredentials(alice_account, cfaccount, cfpassword, &error), "Credential trying (%@)", error);
CFReleaseNull(error);
ok(!SOSAccountTryUserCredentials(alice_account, cfaccount, cfwrong_password, &error), "Credential failing (%@)", error);
CFReleaseNull(cfwrong_password);
is(error ? CFErrorGetCode(error) : 0, kSOSErrorWrongPassword, "Expected SOSErrorWrongPassword");
CFReleaseNull(error);
ok(SOSAccountResetToOffering_wTxn(alice_account, &error), "Reset to offering (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
ok(SOSAccountHasCompletedInitialSync(alice_account), "Alice thinks she's completed initial sync");
ok(SOSAccountJoinCircles_wTxn(bob_account, &error), "Bob Applies (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
{
CFArrayRef applicants = SOSAccountCopyApplicants(alice_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(alice_account, applicants, &error), "Alice accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 3, "updates");
accounts_agree("bob&alice pair", bob_account, alice_account);
CFArrayRef peers = SOSAccountCopyPeers(alice_account, &error);
ok(peers && CFArrayGetCount(peers) == 2, "See two peers %@ (%@)", peers, error);
CFReleaseNull(peers);
ok(!SOSAccountHasCompletedInitialSync(bob_account), "Bob thinks he hasn't completed initial sync");
CFDictionaryRef alice_new_gestalt = SOSCreatePeerGestaltFromName(CFSTR("Alice, but different"));
ok(SOSAccountUpdateGestalt(alice_account, alice_new_gestalt), "Update gestalt %@ (%@)", alice_account, error);
SOSAccountUpdateTestTransports(alice_account, alice_new_gestalt);
CFReleaseNull(alice_new_gestalt);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
accounts_agree("Alice's name changed", bob_account, alice_account);
ok(SOSAccountLeaveCircle(alice_account, &error), "Alice Leaves (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
accounts_agree("Alice bails", bob_account, alice_account);
peers = SOSAccountCopyPeers(alice_account, &error);
ok(peers && CFArrayGetCount(peers) == 1, "See one peer %@ (%@)", peers, error);
CFReleaseNull(peers);
ok(SOSAccountJoinCircles_wTxn(alice_account, &error), "Alice re-applies (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
{
CFArrayRef applicants = SOSAccountCopyApplicants(alice_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(bob_account, applicants, &error), "Bob accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 3, "updates");
accounts_agree("Alice accepts' Bob", bob_account, alice_account);
ok(SOSAccountLeaveCircle(alice_account, &error), "Alice Leaves (%@)", error);
CFReleaseNull(error);
ok(SOSAccountJoinCircles_wTxn(alice_account, &error), "Alice re-applies (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
{
CFArrayRef applicants = SOSAccountCopyApplicants(alice_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(bob_account, applicants, &error), "Bob accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 3, "updates");
accounts_agree("Bob accepts Alice", bob_account, alice_account);
// As of PR-13917727/PR-13906870 this no longer works (by "design"), in favor of making another more common
// failure (apply/OSX-psudo-reject/re-apply) work. Write races might be "fixed better" with affirmitave rejection.
#if 0
//
// Write race emulation.
//
//
ok(SOSAccountLeaveCircle(alice_account, &error), "Alice Leaves (%@)", error);
CFReleaseNull(error);
FeedChangesTo(changes, bob_account); // Bob sees Alice leaving and rejoining
FeedChangesTo(changes, alice_account); // Alice sees bob concurring
accounts_agree("Alice leaves & returns", bob_account, alice_account);
ok(SOSAccountJoinCircles(alice_account, &error), "Alice re-applies (%@)", error);
CFReleaseNull(error);
FeedChangesTo(changes, bob_account); // Bob sees Alice Applying
{
CFArrayRef applicants = SOSAccountCopyApplicants(alice_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(bob_account, applicants, &error), "Bob accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
CFMutableDictionaryRef bobAcceptanceChanges = ExtractPendingChanges(changes);
// Alice re-applies without seeing that she was accepted.
ok(SOSAccountLeaveCircles(alice_account, &error), "Alice Leaves again (%@)", error);
CFReleaseNull(error);
ok(SOSAccountJoinCircles(alice_account, &error), "Alice re-applies (%@)", error);
CFReleaseNull(error);
CFReleaseSafe(ExtractPendingChanges(changes)); // Alice loses the race to write her changes - bob never sees em.
FeedChangesTo(&bobAcceptanceChanges, alice_account); // Alice sees bob inviting her in the circle.
FeedChangesTo(changes, bob_account); // Bob sees Alice Concurring
// As of PR-13917727/PR-13906870
accounts_agree("Alice leave, applies back, loses a race and eventually gets in", bob_account, alice_account);
#endif
// Both in circle.
// Emulation of <rdar://problem/13919554> Innsbruck11A368 +Roots: Device A was removed when Device B joined.
// We want Alice to leave circle while an Applicant on a full concordance signed circle with old-Alice as an Alum and Bob a peer.
// ZZZ
ok(SOSAccountLeaveCircle(alice_account, &error), "Alice leaves once more (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
accounts_agree("Alice and Bob see Alice out of circle", bob_account, alice_account);
ok(SOSAccountJoinCircles_wTxn(alice_account, &error), "Alice re-applies (%@)", error);
CFReleaseNull(error);
ok(SOSAccountLeaveCircle(alice_account, &error), "Alice leaves while applying (%@)", error);
FeedChangesTo(changes, bob_account); // Bob sees Alice become an Alum.
CFReleaseNull(error);
is(SOSAccountGetCircleStatus(alice_account, &error), kSOSCCNotInCircle, "Alice isn't applying any more");
accounts_agree("Alice leaves & some fancy concordance stuff happens", bob_account, alice_account);
ok(SOSAccountJoinCircles_wTxn(alice_account, &error), "Alice re-applies (%@)", error);
CFReleaseNull(error);
FeedChangesTo(changes, bob_account); // Bob sees Alice reapply.
{
CFArrayRef applicants = SOSAccountCopyApplicants(alice_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(bob_account, applicants, &error), "Bob accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "updates");
accounts_agree("Alice comes back", bob_account, alice_account);
// Emulation of <rdar://problem/13889901>
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 1, "updates");
ok(SOSAccountAssertUserCredentialsAndUpdate(carol_account, cfaccount, cfpassword, &error), "Credential setting (%@)", error);
CFReleaseNull(cfpassword);
ok(SOSAccountJoinCircles_wTxn(carol_account, &error), "Carol Applies (%@)", error);
CFReleaseNull(error);
CFMutableDictionaryRef dropped_changes = CFDictionaryCreateMutableForCFTypes(kCFAllocatorDefault);
FillChanges(dropped_changes, carol_account);
CFReleaseNull(dropped_changes);
ok(SOSAccountResetToOffering_wTxn(carol_account, &error), "Reset to offering (%@)", error);
CFReleaseNull(error);
is(ProcessChangesUntilNoChange(changes, bob_account, carol_account, NULL), 2, "updates");
accounts_agree("13889901", carol_account, bob_account);
is(SOSAccountGetLastDepartureReason(bob_account, &error), kSOSMembershipRevoked, "Bob affirms he hasn't left.");
ok(SOSAccountJoinCircles_wTxn(bob_account, &error), "Bob ReApplies (%@)", error);
is(ProcessChangesUntilNoChange(changes, bob_account, carol_account, NULL), 2, "updates");
{
CFArrayRef applicants = SOSAccountCopyApplicants(carol_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(carol_account, applicants, &error), "Carol accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
is(ProcessChangesUntilNoChange(changes, bob_account, carol_account, NULL), 3, "updates");
accounts_agree("rdar://problem/13889901-II", bob_account, carol_account);
// Alice has been out of the loop, bring her back up to speed before changing things (to avoid gen count race)
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 1, "Reset propogation");
// Test multiple removal, including our own departure via that API
ok(SOSAccountResetToOffering_wTxn(alice_account, NULL), "Reset to offering");
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "Reset propogation");
ok(SOSAccountJoinCircles_wTxn(bob_account, NULL), "bob joins again");
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "Bob request");
{
CFArrayRef applicants = SOSAccountCopyApplicants(alice_account, &error);
ok(applicants && CFArrayGetCount(applicants) == 1, "See one applicant %@ (%@)", applicants, error);
ok(SOSAccountAcceptApplicants(alice_account, applicants, &error), "Alice accepts (%@)", error);
CFReleaseNull(error);
CFReleaseNull(applicants);
}
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 3, "carol request");
ok(SOSAccountJoinCircles_wTxn(carol_account, NULL), "carol joins again");
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 2, "carol request");
CFArrayRef peers_to_remove_array = CFArrayCreateForCFTypes(kCFAllocatorDefault,
SOSAccountGetMyPeerInfo(bob_account),
SOSAccountGetMyPeerInfo(carol_account),
NULL);
ok(SOSAccountRemovePeersFromCircle(bob_account, peers_to_remove_array, NULL));
is(ProcessChangesUntilNoChange(changes, alice_account, bob_account, carol_account, NULL), 4, "Remove peers");
ok(SOSAccountIsInCircle(alice_account, NULL), "Alice still here");
ok(!SOSAccountIsInCircle(bob_account, NULL), "Bob not in circle");
// Carol's not in circle, but reapplied, as she's persistent until positive rejection.
ok(!SOSAccountIsInCircle(carol_account, NULL), "carol not in circle");
CFReleaseNull(peers_to_remove_array);
CFReleaseNull(alice_new_gestalt);
CFReleaseNull(bob_account);
CFReleaseNull(alice_account);
CFReleaseNull(carol_account);
SOSTestCleanup();
}
CFStringRef _CFErrorCreateDebugDescription(CFErrorRef err) {
CFStringRef desc = CFErrorCopyDescription(err);
CFStringRef debugDesc = _CFErrorCopyUserInfoKey(err, kCFErrorDebugDescriptionKey);
CFDictionaryRef userInfo = _CFErrorGetUserInfo(err);
CFMutableStringRef result = CFStringCreateMutable(kCFAllocatorSystemDefault, 0);
CFStringAppendFormat(result, NULL, CFSTR("Error Domain=%@ Code=%d"), CFErrorGetDomain(err), (long)CFErrorGetCode(err));
CFStringAppendFormat(result, NULL, CFSTR(" \"%@\""), desc);
if (debugDesc && CFStringGetLength(debugDesc) > 0) CFStringAppendFormat(result, NULL, CFSTR(" (%@)"), debugDesc);
if (userInfo) {
CFStringAppendFormat(result, NULL, CFSTR(" UserInfo=%p {"), userInfo);
CFDictionaryApplyFunction(userInfo, userInfoKeyValueShow, (void *)result);
CFIndex commaLength = (CFStringHasSuffix(result, CFSTR(", "))) ? 2 : 0;
CFStringReplace(result, CFRangeMake(CFStringGetLength(result)-commaLength, commaLength), CFSTR("}"));
}
if (debugDesc) CFRelease(debugDesc);
if (desc) CFRelease(desc);
return result;
}
/* The real guts of the description creation functionality. See the header file for the steps this function goes through to compute the description. This function can take a CF or NSError. It's called by NSError for the localizedDescription computation.
*/
CFStringRef _CFErrorCreateLocalizedDescription(CFErrorRef err) {
// First look for kCFErrorLocalizedDescriptionKey; if non-NULL, return that as-is.
CFStringRef localizedDesc = _CFErrorCopyUserInfoKey(err, kCFErrorLocalizedDescriptionKey);
if (localizedDesc) return localizedDesc;
#if DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_WINDOWS
// Cache the CF bundle since we will be using it for localized strings.
CFBundleRef cfBundle = CFBundleGetBundleWithIdentifier(CFSTR("com.apple.CoreFoundation"));
if (!cfBundle) { // This should be rare, but has been observed in the wild, due to running out of file descriptors. Normally we might not go to such extremes, but since we want to be able to present reasonable errors even in the case of errors such as running out of file descriptors, why not. This is CFError after all. !!! Be sure to have the same logic here as below for going through various options for fetching the strings.
#endif
CFStringRef result = NULL, reasonOrDesc;
if ((reasonOrDesc = _CFErrorCopyUserInfoKey(err, kCFErrorLocalizedFailureReasonKey))) { // First look for kCFErrorLocalizedFailureReasonKey
result = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, CFSTR("The operation couldn\\U2019t be completed. %@"), reasonOrDesc);
} else if ((reasonOrDesc = _CFErrorCopyUserInfoKey(err, kCFErrorDescriptionKey))) { // Then try kCFErrorDescriptionKey
result = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, CFSTR("The operation couldn\\U2019t be completed. (%@ error %ld - %@)"), CFErrorGetDomain(err), (long)CFErrorGetCode(err), reasonOrDesc);
} else { // Last resort, just the domain and code
result = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, CFSTR("The operation couldn\\U2019t be completed. (%@ error %ld.)"), CFErrorGetDomain(err), (long)CFErrorGetCode(err));
}
if (reasonOrDesc) CFRelease(reasonOrDesc);
return result;
#if DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_WINDOWS
}
#endif
#if DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_WINDOWS
// Then look for kCFErrorLocalizedFailureReasonKey; if there, create a full sentence from that.
CFStringRef reason = _CFErrorCopyUserInfoKey(err, kCFErrorLocalizedFailureReasonKey);
if (reason) {
CFStringRef operationFailedStr = CFCopyLocalizedStringFromTableInBundle(CFSTR("The operation couldn\\U2019t be completed. %@"), CFSTR("Error"), cfBundle, "A generic error string indicating there was a problem. The %@ will be replaced by a second sentence which indicates why the operation failed.");
CFStringRef result = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, operationFailedStr, reason);
CFRelease(operationFailedStr);
CFRelease(reason);
return result;
}
// Otherwise, generate a semi-user presentable string from the domain, code, and if available, the presumably non-localized kCFErrorDescriptionKey.
CFStringRef result;
CFStringRef desc = _CFErrorCopyUserInfoKey(err, kCFErrorDescriptionKey);
CFStringRef localizedDomain = CFCopyLocalizedStringFromTableInBundle(CFErrorGetDomain(err), CFSTR("Error"), cfBundle, "These are localized in the comment above");
if (desc) { // We have kCFErrorDescriptionKey, so include that with the error domain and code
CFStringRef operationFailedStr = CFCopyLocalizedStringFromTableInBundle(CFSTR("The operation couldn\\U2019t be completed. (%@ error %ld - %@)"), CFSTR("Error"), cfBundle, "A generic error string indicating there was a problem, followed by a parenthetical sentence which indicates error domain, code, and a description when there is no other way to present an error to the user. The first %@ indicates the error domain, %ld indicates the error code, and the second %@ indicates the description; so this might become '(Mach error 42 - Server error.)' for instance.");
result = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, operationFailedStr, localizedDomain, (long)CFErrorGetCode(err), desc);
CFRelease(operationFailedStr);
CFRelease(desc);
} else { // We don't have kCFErrorDescriptionKey, so just use error domain and code
CFStringRef operationFailedStr = CFCopyLocalizedStringFromTableInBundle(CFSTR("The operation couldn\\U2019t be completed. (%@ error %ld.)"), CFSTR("Error"), cfBundle, "A generic error string indicating there was a problem, followed by a parenthetical sentence which indicates error domain and code when there is no other way to present an error to the user. The %@ indicates the error domain while %ld indicates the error code; so this might become '(Mach error 42.)' for instance.");
result = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, operationFailedStr, localizedDomain, (long)CFErrorGetCode(err));
CFRelease(operationFailedStr);
}
CFRelease(localizedDomain);
return result;
#endif
}
