/*
* Copyright (c) 2013-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@
*/
#include <Security/SecureObjectSync/SOSKVSKeys.h>
#include <utilities/SecCFWrappers.h>
#include <Security/SecureObjectSync/SOSAccountPriv.h>
#include <CoreFoundation/CFDate.h>
void AppendCircleKeyName(CFMutableArrayRef array, CFStringRef name) {
CFStringRef circle_key = SOSCircleKeyCreateWithName(name, NULL);
CFArrayAppendValue(array, circle_key);
CFReleaseNull(circle_key);
}
//
//
// MARK: KVS Keys
// TODO: Handle '|' and "¬" in other strings.
//
const CFStringRef kSOSKVSKeyParametersKey = CFSTR(">KeyParameters");
const CFStringRef kSOSKVSInitialSyncKey = CFSTR("^InitialSync");
const CFStringRef kSOSKVSAccountChangedKey = CFSTR("^AccountChanged");
const CFStringRef kSOSKVSRequiredKey = CFSTR("^Required");
const CFStringRef kSOSKVSOfficialDSIDKey = CFSTR("^OfficialDSID");
const CFStringRef kSOSKVSLastCleanupTimestampKey = CFSTR("tLastKVSKeyCleanup");
const CFStringRef kSOSKVSOTRConfigVersion = CFSTR("OTRConfigVersion");
const CFStringRef kSOSKVSWroteLastKeyParams = CFSTR("WroteLastKeyParams");
const CFStringRef kSOSKVSDebugScope = CFSTR("^DebugScope");
const CFStringRef sRingPrefix = CFSTR("~");
const CFStringRef sDebugInfoPrefix = CFSTR("dbg-");
const CFStringRef sWarningPrefix = CFSTR("!");
const CFStringRef sCirclePrefix = CFSTR("o");
const CFStringRef sRetirementPrefix = CFSTR("-");
const CFStringRef sLastKeyParametersPushedPrefix = CFSTR("k");
const CFStringRef sCircleSeparator = CFSTR("|");
const CFStringRef sFromToSeparator = CFSTR(":");
static CFStringRef copyStringEndingIn(CFMutableStringRef in, CFStringRef token) {
if(token == NULL) return CFStringCreateCopy(NULL, in);
CFRange tokenAt = CFStringFind(in, token, 0);
if(tokenAt.location == kCFNotFound) return NULL;
CFStringRef retval = CFStringCreateWithSubstring(NULL, in, CFRangeMake(0, tokenAt.location));
CFStringDelete(in, CFRangeMake(0, tokenAt.location+1));
return retval;
}
SOSKVSKeyType SOSKVSKeyGetKeyType(CFStringRef key) {
SOSKVSKeyType retval = kUnknownKey;
if(CFStringHasPrefix(key, sCirclePrefix)) retval = kCircleKey;
else if (CFStringHasPrefix(key, sRingPrefix)) retval = kRingKey;
else if(CFStringHasPrefix(key, sRetirementPrefix)) retval = kRetirementKey;
else if(CFStringHasPrefix(key, kSOSKVSKeyParametersKey)) retval = kParametersKey;
else if(CFStringHasPrefix(key, kSOSKVSInitialSyncKey)) retval = kInitialSyncKey;
else if(CFStringHasPrefix(key, kSOSKVSAccountChangedKey)) retval = kAccountChangedKey;
else if(CFStringHasPrefix(key, sDebugInfoPrefix)) retval = kDebugInfoKey;
else if(CFStringHasPrefix(key, sLastKeyParametersPushedPrefix)) retval = kLastKeyParameterKey;
else retval = kMessageKey;
return retval;
}
bool SOSKVSKeyParse(SOSKVSKeyType keyType, CFStringRef key, CFStringRef *circle, CFStringRef *peerInfo, CFStringRef *ring, CFStringRef *backupName, CFStringRef *from, CFStringRef *to) {
bool retval = true;
switch(keyType) {
case kCircleKey:
if (circle) {
CFRange fromRange = CFRangeMake(1, CFStringGetLength(key)-1);
*circle = CFStringCreateWithSubstring(NULL, key, fromRange);
}
break;
case kMessageKey: {
CFStringRef mCircle = NULL;
CFStringRef mFrom = NULL;
CFStringRef mTo = NULL;
CFMutableStringRef keycopy = CFStringCreateMutableCopy(NULL, 128, key);
if( ((mCircle = copyStringEndingIn(keycopy, sCircleSeparator)) != NULL) &&
((mFrom = copyStringEndingIn(keycopy, sFromToSeparator)) != NULL) &&
(CFStringGetLength(mFrom) > 0) ) {
mTo = copyStringEndingIn(keycopy, NULL);
if (circle && mCircle) *circle = CFStringCreateCopy(NULL, mCircle);
if (from && mFrom) *from = CFStringCreateCopy(NULL, mFrom);
if (to && mTo) *to = CFStringCreateCopy(NULL, mTo);
} else {
retval = false;
}
CFReleaseNull(mCircle);
CFReleaseNull(mFrom);
CFReleaseNull(mTo);
CFReleaseNull(keycopy);
}
break;
case kRetirementKey: {
CFStringRef mCircle = NULL;
CFStringRef mPeer = NULL;
CFMutableStringRef keycopy = CFStringCreateMutableCopy(NULL, 128, key);
CFStringDelete(keycopy, CFRangeMake(0, 1));
if( ((mCircle = copyStringEndingIn(keycopy, sCircleSeparator)) != NULL) &&
((mPeer = copyStringEndingIn(keycopy, NULL)) != NULL)) {
if (circle) *circle = CFStringCreateCopy(NULL, mCircle);
if (from) *from = CFStringCreateCopy(NULL, mPeer);
} else {
retval = false;
}
CFReleaseNull(mCircle);
CFReleaseNull(mPeer);
CFReleaseNull(keycopy);
}
break;
case kRingKey:
if (ring) {
CFRange fromRange = CFRangeMake(1, CFStringGetLength(key)-1);
*ring = CFStringCreateWithSubstring(NULL, key, fromRange);
}
break;
case kDebugInfoKey:
/* piggybacking on peerinfo */
if (peerInfo) {
CFRange dbgRange = CFRangeMake(CFStringGetLength(sDebugInfoPrefix),
CFStringGetLength(key)-CFStringGetLength(sDebugInfoPrefix));
*peerInfo = CFStringCreateWithSubstring(NULL, key, dbgRange);
}
break;
case kAccountChangedKey:
case kParametersKey:
case kInitialSyncKey:
case kUnknownKey:
break;
case kLastKeyParameterKey:
if(from) {
CFStringRef mPrefix = NULL;
CFStringRef mFrom = NULL;
CFMutableStringRef keycopy = CFStringCreateMutableCopy(NULL, 128, key);
if( ((mPrefix = copyStringEndingIn(keycopy, sCircleSeparator)) != NULL) &&
((mFrom = copyStringEndingIn(keycopy, NULL)) != NULL)) {
if (from && mFrom) *from = CFStringCreateCopy(NULL, mFrom);
} else {
retval = false;
}
CFReleaseNull(mPrefix);
CFReleaseNull(mFrom);
CFReleaseNull(keycopy);
}
break;
case kLastCircleKey:
if (circle && from) {
CFStringRef mCircle = NULL;
CFStringRef mFrom = NULL;
CFMutableStringRef keycopy = CFStringCreateMutableCopy(NULL, 128, key);
if( ((mCircle = copyStringEndingIn(keycopy, sCircleSeparator)) != NULL) &&
((mFrom = copyStringEndingIn(keycopy, NULL)) != NULL)) {
if (circle && mCircle) *circle = CFStringCreateCopy(NULL, mCircle);
if (from && mFrom) *from = CFStringCreateCopy(NULL, mFrom);
} else {
retval = false;
}
CFReleaseNull(mCircle);
CFReleaseNull(mFrom);
CFReleaseNull(keycopy);
}
break;
}
return retval;
}
SOSKVSKeyType SOSKVSKeyGetKeyTypeAndParse(CFStringRef key, CFStringRef *circle, CFStringRef *peerInfo, CFStringRef *ring, CFStringRef *backupName, CFStringRef *from, CFStringRef *to)
{
SOSKVSKeyType retval = SOSKVSKeyGetKeyType(key);
bool parsed = SOSKVSKeyParse(retval, key, circle, peerInfo, ring, backupName, from, to);
if(!parsed) retval = kUnknownKey;
return retval;
}
CFStringRef SOSCircleKeyCreateWithCircle(SOSCircleRef circle, CFErrorRef *error)
{
return SOSCircleKeyCreateWithName(SOSCircleGetName(circle), error);
}
CFStringRef SOSCircleKeyCreateWithName(CFStringRef circleName, CFErrorRef *error)
{
if(!circleName) return NULL;
return CFStringCreateWithFormat(NULL, NULL, CFSTR("}
CFStringRef SOSRingKeyCreateWithName(CFStringRef ring_name, CFErrorRef *error)
{
if(!ring_name) return NULL;
return CFStringCreateWithFormat(NULL, NULL, CFSTR("}
CFStringRef SOSCircleKeyCopyCircleName(CFStringRef key, CFErrorRef *error)
{
CFStringRef circleName = NULL;
if (kCircleKey != SOSKVSKeyGetKeyTypeAndParse(key, &circleName, NULL, NULL, NULL, NULL, NULL)) {
SOSCreateErrorWithFormat(kSOSErrorNoCircleName, NULL, error, NULL, CFSTR("Couldn't find circle name in key '%@'"), key);
CFReleaseNull(circleName);
}
return circleName;
}
CFStringRef SOSMessageKeyCopyCircleName(CFStringRef key, CFErrorRef *error)
{
CFStringRef circleName = NULL;
if (SOSKVSKeyGetKeyTypeAndParse(key, &circleName, NULL, NULL, NULL, NULL, NULL) != kMessageKey) {
SOSCreateErrorWithFormat(kSOSErrorNoCircleName, NULL, error, NULL, CFSTR("Couldn't find circle name in key '%@'"), key);
CFReleaseNull(circleName);
}
return circleName;
}
CFStringRef SOSMessageKeyCopyFromPeerName(CFStringRef messageKey, CFErrorRef *error)
{
CFStringRef fromPeer = NULL;
if (SOSKVSKeyGetKeyTypeAndParse(messageKey, NULL, NULL, NULL, NULL, &fromPeer, NULL) != kMessageKey) {
SOSCreateErrorWithFormat(kSOSErrorNoCircleName, NULL, error, NULL, CFSTR("Couldn't find from peer in key '%@'"), messageKey);
CFReleaseNull(fromPeer);
}
return fromPeer;
}
CFStringRef SOSMessageKeyCreateWithCircleNameAndPeerNames(CFStringRef circleName, CFStringRef from_peer_name, CFStringRef to_peer_name)
{
return CFStringCreateWithFormat(NULL, NULL, CFSTR(" circleName, sCircleSeparator, from_peer_name, sFromToSeparator, to_peer_name);
}
CFStringRef SOSMessageKeyCreateWithCircleAndPeerNames(SOSCircleRef circle, CFStringRef from_peer_name, CFStringRef to_peer_name)
{
return SOSMessageKeyCreateWithCircleNameAndPeerNames(SOSCircleGetName(circle), from_peer_name, to_peer_name);
}
CFStringRef SOSMessageKeyCreateWithCircleAndPeerInfos(SOSCircleRef circle, SOSPeerInfoRef from_peer, SOSPeerInfoRef to_peer)
{
return SOSMessageKeyCreateWithCircleAndPeerNames(circle, SOSPeerInfoGetPeerID(from_peer), SOSPeerInfoGetPeerID(to_peer));
}
CFStringRef SOSMessageKeyCreateFromPeerToTransport(SOSMessage* transport, CFStringRef myName, CFStringRef peer_name){
CFErrorRef error = NULL;
CFStringRef circleName = [transport SOSTransportMessageGetCircleName];
CFStringRef result = SOSMessageKeyCreateWithCircleNameAndPeerNames(circleName, peer_name, myName);
CFReleaseSafe(error);
return result;
}
CFStringRef SOSMessageKeyCreateFromTransportToPeer(SOSMessage* transport, CFStringRef myID, CFStringRef peer_name) {
CFErrorRef error = NULL;
CFStringRef circleName = [transport SOSTransportMessageGetCircleName];
CFStringRef result = SOSMessageKeyCreateWithCircleNameAndPeerNames(circleName, myID, peer_name);
CFReleaseSafe(error);
return result;
}
CFStringRef SOSRetirementKeyCreateWithCircleNameAndPeer(CFStringRef circle_name, CFStringRef retirement_peer_name)
{
return CFStringCreateWithFormat(NULL, NULL, CFSTR(" sRetirementPrefix, circle_name, sCircleSeparator, retirement_peer_name);
}
CFStringRef SOSRingKeyCreateWithRingName(CFStringRef ring_name)
{
return CFStringCreateWithFormat(NULL, NULL, CFSTR(" sRingPrefix, ring_name);
}
CFStringRef SOSRetirementKeyCreateWithCircleAndPeer(SOSCircleRef circle, CFStringRef retirement_peer_name)
{
return SOSRetirementKeyCreateWithCircleNameAndPeer(SOSCircleGetName(circle), retirement_peer_name);
}
static CFStringRef SOSAccountCreateCompactDescription(SOSAccount* a) {
CFStringRef gestaltDescription = CFDictionaryCopySuperCompactDescription((__bridge CFDictionaryRef)(a.gestalt));
CFStringRef result = CFStringCreateWithFormat(NULL, NULL, CFSTR("
CFReleaseNull(gestaltDescription);
return result;
}
//should be >KeyParameters|ourPeerID
CFStringRef SOSLastKeyParametersPushedKeyCreateWithPeerID(CFStringRef peerID){
return CFStringCreateWithFormat(NULL, NULL, CFSTR(" sLastKeyParametersPushedPrefix,kSOSKVSKeyParametersKey, sCircleSeparator, peerID);
}
//should be >KeyParameters|ourPeerID
CFStringRef SOSLastKeyParametersPushedKeyCreateWithAccountGestalt(SOSAccount* account){
CFStringRef gestaltInfo = SOSAccountCreateCompactDescription(account);
CFStringRef key= CFStringCreateWithFormat(NULL, NULL, CFSTR(" sLastKeyParametersPushedPrefix, kSOSKVSKeyParametersKey, sCircleSeparator, gestaltInfo);
CFReleaseNull(gestaltInfo);
return key;
}
CFStringRef SOSDebugInfoKeyCreateWithTypeName(CFStringRef type_name)
{
return CFStringCreateWithFormat(NULL, NULL, CFSTR(" sDebugInfoPrefix, type_name);
}