//
// keychain_log.c
// sec
//
// Created by Richard Murphy on 1/26/16.
//
//
#include "keychain_log.h"
/*
* Copyright (c) 2003-2007,2009-2010,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@
*
* keychain_add.c
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/utsname.h>
#include <sys/stat.h>
#include <time.h>
#include <Security/SecItem.h>
#include <CoreFoundation/CFNumber.h>
#include <CoreFoundation/CFString.h>
#include <Security/SecureObjectSync/SOSCloudCircle.h>
#include <Security/SecureObjectSync/SOSCloudCircleInternal.h>
#include <Security/SecureObjectSync/SOSPeerInfo.h>
#include <Security/SecureObjectSync/SOSPeerInfoPriv.h>
#include <Security/SecureObjectSync/SOSPeerInfoV2.h>
#include <Security/SecureObjectSync/SOSUserKeygen.h>
#include <Security/SecureObjectSync/SOSKVSKeys.h>
#include <securityd/SOSCloudCircleServer.h>
#include <Security/SecOTRSession.h>
#include <SOSCircle/CKBridge/SOSCloudKeychainClient.h>
#include <utilities/SecCFWrappers.h>
#include <utilities/debugging.h>
#include <SecurityTool/readline.h>
#include <notify.h>
#include "keychain_log.h"
#include "secToolFileIO.h"
#include "secViewDisplay.h"
#include <utilities/debugging.h>
#include <Security/SecPasswordGenerate.h>
#define MAXKVSKEYTYPE kUnknownKey
#define DATE_LENGTH 18
static const char *getSOSCCStatusDescription(SOSCCStatus ccstatus)
{
switch (ccstatus)
{
case kSOSCCInCircle: return "In Circle";
case kSOSCCNotInCircle: return "Not in Circle";
case kSOSCCRequestPending: return "Request pending";
case kSOSCCCircleAbsent: return "Circle absent";
case kSOSCCError: return "Circle error";
default:
return "<unknown ccstatus>";
break;
}
}
static void printPeerInfos(char *label, CFArrayRef (^getArray)(CFErrorRef *error)) {
CFErrorRef error = NULL;
CFArrayRef ppi = getArray(&error);
SOSPeerInfoRef me = SOSCCCopyMyPeerInfo(NULL);
CFStringRef mypeerID = SOSPeerInfoGetPeerID(me);
if(ppi) {
printmsg(CFSTR(" CFArrayForEach(ppi, ^(const void *value) {
char buf[160];
SOSPeerInfoRef peer = (SOSPeerInfoRef)value;
CFIndex version = SOSPeerInfoGetVersion(peer);
CFStringRef peerName = SOSPeerInfoGetPeerName(peer);
CFStringRef devtype = SOSPeerInfoGetPeerDeviceType(peer);
CFStringRef peerID = SOSPeerInfoGetPeerID(peer);
CFStringRef transportType = CFSTR("KVS");
CFStringRef deviceID = CFSTR("");
CFDictionaryRef gestalt = SOSPeerInfoCopyPeerGestalt(peer);
CFStringRef osVersion = CFDictionaryGetValue(gestalt, CFSTR("OSVersion"));
CFReleaseNull(gestalt);
if(version >= 2){
CFDictionaryRef v2Dictionary = peer->v2Dictionary;
transportType = CFDictionaryGetValue(v2Dictionary, sTransportType);
deviceID = CFDictionaryGetValue(v2Dictionary, sDeviceID);
}
char *pname = CFStringToCString(peerName);
char *dname = CFStringToCString(devtype);
char *tname = CFStringToCString(transportType);
char *iname = CFStringToCString(deviceID);
char *osname = CFStringToCString(osVersion);
const char *me = CFEqualSafe(mypeerID, peerID) ? "me>" : " ";
snprintf(buf, 160, "
free(pname);
free(dname);
CFStringRef pid = SOSPeerInfoGetPeerID(peer);
CFIndex vers = SOSPeerInfoGetVersion(peer);
printmsg(CFSTR(" free(osname);
});
} else {
printmsg(CFSTR("No }
CFReleaseNull(ppi);
CFReleaseNull(error);
}
static void dumpCircleInfo()
{
CFErrorRef error = NULL;
CFArrayRef generations = NULL;
bool is_accountKeyIsTrusted = false;
__block int count = 0;
SOSCCStatus ccstatus = SOSCCThisDeviceIsInCircle(&error);
if(ccstatus == kSOSCCError) {
printmsg(CFSTR("End of Dump - unable to proceed due to ccstatus ( return;
}
printmsg(CFSTR("ccstatus:
is_accountKeyIsTrusted = SOSCCValidateUserPublic(&error);
if(is_accountKeyIsTrusted)
printmsg(CFSTR("Account user public is trusted else
printmsg(CFSTR("Account user public is not trusted error:( CFReleaseNull(error);
generations = SOSCCCopyGenerationPeerInfo(&error);
if(generations) {
CFArrayForEach(generations, ^(const void *value) {
count++;
if(count printmsg(CFSTR("Circle name:
if(count CFStringRef genDesc = SOSGenerationCountCopyDescription(value);
printmsg(CFSTR("Generation Count: CFReleaseNull(genDesc);
}
printmsg(CFSTR(" });
} else {
printmsg(CFSTR("No generation count: }
CFReleaseNull(generations);
CFReleaseNull(error);
printPeerInfos(" Peers", ^(CFErrorRef *error) { return SOSCCCopyValidPeerPeerInfo(error); });
printPeerInfos(" Invalid", ^(CFErrorRef *error) { return SOSCCCopyNotValidPeerPeerInfo(error); });
printPeerInfos(" Retired", ^(CFErrorRef *error) { return SOSCCCopyRetirementPeerInfo(error); });
printPeerInfos(" Concur", ^(CFErrorRef *error) { return SOSCCCopyConcurringPeerPeerInfo(error); });
printPeerInfos("Applicants", ^(CFErrorRef *error) { return SOSCCCopyApplicantPeerInfo(error); });
if (!SOSCCForEachEngineStateAsString(&error, ^(CFStringRef oneStateString) {
printmsg(CFSTR(" })) {
printmsg(CFSTR("No engine peers: }
CFReleaseNull(error);
}
static CFTypeRef getObjectsFromCloud(CFArrayRef keysToGet, dispatch_queue_t processQueue, dispatch_group_t dgroup)
{
__block CFTypeRef object = NULL;
const uint64_t maxTimeToWaitInSeconds = 30ull * NSEC_PER_SEC;
dispatch_semaphore_t waitSemaphore = dispatch_semaphore_create(0);
dispatch_time_t finishTime = dispatch_time(DISPATCH_TIME_NOW, maxTimeToWaitInSeconds);
dispatch_group_enter(dgroup);
CloudKeychainReplyBlock replyBlock =
^ (CFDictionaryRef returnedValues, CFErrorRef error)
{
secinfo("sync", "SOSCloudKeychainGetObjectsFromCloud returned: object = returnedValues;
if (object)
CFRetain(object);
if (error)
{
secerror("SOSCloudKeychainGetObjectsFromCloud returned error: }
dispatch_group_leave(dgroup);
secinfo("sync", "SOSCloudKeychainGetObjectsFromCloud block exit: dispatch_semaphore_signal(waitSemaphore);
};
if (!keysToGet)
SOSCloudKeychainGetAllObjectsFromCloud(processQueue, replyBlock);
else
SOSCloudKeychainGetObjectsFromCloud(keysToGet, processQueue, replyBlock);
dispatch_semaphore_wait(waitSemaphore, finishTime);
if (object && (CFGetTypeID(object) == CFNullGetTypeID())) // return a NULL instead of a CFNull
{
CFRelease(object);
object = NULL;
}
secerror("returned: return object;
}
static CFStringRef printFullDataString(CFDataRef data){
__block CFStringRef fullData = NULL;
BufferPerformWithHexString(CFDataGetBytePtr(data), CFDataGetLength(data), ^(CFStringRef dataHex) {
fullData = CFStringCreateWithFormat(kCFAllocatorDefault, NULL, CFSTR(" });
return fullData;
}
static void displayLastKeyParameters(CFTypeRef key, CFTypeRef value)
{
CFDataRef valueAsData = asData(value, NULL);
if(valueAsData){
CFDataRef dateData = CFDataCreateCopyFromRange(kCFAllocatorDefault, valueAsData, CFRangeMake(0, DATE_LENGTH));
CFDataRef keyParameterData = CFDataCreateCopyFromPositions(kCFAllocatorDefault, valueAsData, DATE_LENGTH, CFDataGetLength(valueAsData));
CFStringRef dateString = CFStringCreateFromExternalRepresentation(kCFAllocatorDefault, dateData, kCFStringEncodingUTF8);
CFStringRef keyParameterDescription = UserParametersDescription(keyParameterData);
if(keyParameterDescription)
printmsg(CFSTR(" else
printmsg(CFSTR(" CFReleaseNull(dateString);
CFReleaseNull(keyParameterData);
CFReleaseNull(dateData);
CFReleaseNull(keyParameterDescription);
}
else{
printmsg(CFSTR(" }
}
static void displayKeyParameters(CFTypeRef key, CFTypeRef value)
{
if(isData(value)){
CFStringRef keyParameterDescription = UserParametersDescription((CFDataRef)value);
if(keyParameterDescription)
printmsg(CFSTR(" else
printmsg(CFSTR("
CFReleaseNull(keyParameterDescription);
}
else{
printmsg(CFSTR(" }
}
static void displayLastCircle(CFTypeRef key, CFTypeRef value)
{
CFDataRef valueAsData = asData(value, NULL);
if(valueAsData){
CFErrorRef localError = NULL;
CFDataRef dateData = CFDataCreateCopyFromRange(kCFAllocatorDefault, valueAsData, CFRangeMake(0, DATE_LENGTH));
CFDataRef circleData = CFDataCreateCopyFromPositions(kCFAllocatorDefault, valueAsData, DATE_LENGTH, CFDataGetLength(valueAsData));
CFStringRef dateString = CFStringCreateFromExternalRepresentation(kCFAllocatorDefault, dateData, kCFStringEncodingUTF8);
SOSCircleRef circle = SOSCircleCreateFromData(NULL, (CFDataRef) circleData, &localError);
if(circle){
CFIndex size = 5;
CFNumberRef idLength = CFNumberCreate(kCFAllocatorDefault, kCFNumberCFIndexType, &size);
CFDictionaryRef format = CFDictionaryCreateForCFTypes(kCFAllocatorDefault, CFSTR("SyncD"), CFSTR("SyncD"), CFSTR("idLength"), idLength, NULL);
printmsgWithFormatOptions(format, CFSTR(" CFReleaseNull(idLength);
CFReleaseNull(format);
}
else
printmsg(CFSTR("
CFReleaseNull(dateString);
CFReleaseNull(circleData);
CFReleaseSafe(circle);
CFReleaseNull(dateData);
CFReleaseNull(localError);
}
else{
printmsg(CFSTR(" }
}
static void displayCircle(CFTypeRef key, CFTypeRef value)
{
CFDataRef circleData = (CFDataRef)value;
CFErrorRef localError = NULL;
if (isData(circleData))
{
CFIndex size = 5;
CFNumberRef idLength = CFNumberCreate(kCFAllocatorDefault, kCFNumberCFIndexType, &size);
CFDictionaryRef format = CFDictionaryCreateForCFTypes(kCFAllocatorDefault, CFSTR("SyncD"), CFSTR("SyncD"), CFSTR("idLength"), idLength, NULL);
SOSCircleRef circle = SOSCircleCreateFromData(NULL, circleData, &localError);
printmsgWithFormatOptions(format, CFSTR(" CFReleaseSafe(circle);
CFReleaseNull(idLength);
CFReleaseNull(format);
}
else
printmsg(CFSTR("}
static void displayMessage(CFTypeRef key, CFTypeRef value)
{
CFDataRef message = (CFDataRef)value;
if(isData(message)){
const char* messageType = SecOTRPacketTypeString(message);
printmsg(CFSTR(" }
else
printmsg(CFSTR("}
static void printEverything(CFTypeRef objects)
{
CFDictionaryForEach(objects, ^(const void *key, const void *value) {
if (isData(value))
{
printmsg(CFSTR(" }
else
printmsg(CFSTR(" });
}
static void decodeForKeyType(CFTypeRef key, CFTypeRef value, SOSKVSKeyType type){
switch (type) {
case kCircleKey:
displayCircle(key, value);
break;
case kRetirementKey:
case kMessageKey:
displayMessage(key, value);
break;
case kParametersKey:
displayKeyParameters(key, value);
break;
case kLastKeyParameterKey:
displayLastKeyParameters(key, value);
break;
case kLastCircleKey:
displayLastCircle(key, value);
break;
case kInitialSyncKey:
case kAccountChangedKey:
case kDebugInfoKey:
case kRingKey:
default:
printmsg(CFSTR(" break;
}
}
static void decodeAllTheValues(CFTypeRef objects){
SOSKVSKeyType keyType = 0;
__block bool didPrint = false;
for (keyType = 0; keyType <= MAXKVSKEYTYPE; keyType++){
CFDictionaryForEach(objects, ^(const void *key, const void *value) {
if(SOSKVSKeyGetKeyType(key) == keyType){
decodeForKeyType(key, value, keyType);
didPrint = true;
}
});
if(didPrint)
printmsg(CFSTR(" didPrint = false;
}
}
static bool dumpKVS(char *itemName, CFErrorRef *err)
{
CFArrayRef keysToGet = NULL;
if (itemName)
{
CFStringRef itemStr = CFStringCreateWithCString(kCFAllocatorDefault, itemName, kCFStringEncodingUTF8);
fprintf(outFile, "Retrieving keysToGet = CFArrayCreateForCFTypes(kCFAllocatorDefault, itemStr, NULL);
CFReleaseSafe(itemStr);
}
dispatch_queue_t generalq = dispatch_queue_create("general", DISPATCH_QUEUE_SERIAL);
dispatch_group_t work_group = dispatch_group_create();
CFTypeRef objects = getObjectsFromCloud(keysToGet, generalq, work_group);
CFReleaseSafe(keysToGet);
if (objects)
{
fprintf(outFile, "All keys and values straight from KVS\n");
printEverything(objects);
fprintf(outFile, "\nAll values in decoded form...\n");
decodeAllTheValues(objects);
}
fprintf(outFile, "\n");
return true;
}
#define USE_NEW_SPI 1
#if ! USE_NEW_SPI
static char *createDateStrNow() {
char *retval = NULL;
time_t clock;
struct tm *tmstruct;
time(&clock);
tmstruct = localtime(&clock);
retval = malloc(15);
sprintf(retval, " return retval;
}
// #include <CoreFoundation/CFPriv.h>
CF_EXPORT CFDictionaryRef _CFCopySystemVersionDictionary(void);
CF_EXPORT const CFStringRef _kCFSystemVersionProductNameKey;
CF_EXPORT const CFStringRef _kCFSystemVersionProductVersionKey;
CF_EXPORT const CFStringRef _kCFSystemVersionBuildVersionKey;
static char *CFDictionaryCopyCString(CFDictionaryRef dict, const void *key) {
CFStringRef val = CFDictionaryGetValue(dict, key);
char *retval = CFStringToCString(val);
return retval;
}
#include <pwd.h>
static void sysdiagnose_dump() {
char *outputBase = NULL;
char *outputParent = NULL;
char *outputDir = NULL;
char hostname[80];
char *productName = "NA";
char *productVersion = "NA";
char *buildVersion = "NA";
char *keysToRegister = NULL;
char *cloudkeychainproxy3 = NULL;
char *now = createDateStrNow();
size_t length = 0;
int status = 0;
CFDictionaryRef sysfdef = _CFCopySystemVersionDictionary();
if(gethostname(hostname, 80)) {
strcpy(hostname, "unknownhost");
}
if(sysfdef) {
productName = CFDictionaryCopyCString(sysfdef, _kCFSystemVersionProductNameKey);
productVersion = CFDictionaryCopyCString(sysfdef, _kCFSystemVersionProductVersionKey);
buildVersion = CFDictionaryCopyCString(sysfdef, _kCFSystemVersionBuildVersionKey);
}
// OUTPUTBASE=ckcdiagnose_snapshot_${HOSTNAME}_${PRODUCT_VERSION}_${NOW}
length = strlen("ckcdiagnose_snapshot___") + strlen(hostname) + strlen(productVersion) + strlen(now) + 1;
outputBase = malloc(length);
status = snprintf(outputBase, length, "ckcdiagnose_snapshot_ if(status < 0) outputBase = "";
#if TARGET_OS_EMBEDDED
outputParent = "/Library/Logs/CrashReporter";
keysToRegister = "/private/var/preferences/com.apple.security.cloudkeychainproxy3.keysToRegister.plist";
cloudkeychainproxy3 = "/var/mobile/Library/SyncedPreferences/com.apple.security.cloudkeychainproxy3.plist";
#else
outputParent = "/var/tmp";
{
char *homeDir = "";
struct passwd* pwd = getpwuid(getuid());
if (pwd) homeDir = pwd->pw_dir;
char *k2regfmt = " char *ckp3fmt = " size_t k2rlen = strlen(homeDir) + strlen(k2regfmt) + 2;
size_t ckp3len = strlen(homeDir) + strlen(ckp3fmt) + 2;
keysToRegister = malloc(k2rlen);
cloudkeychainproxy3 = malloc(ckp3len);
snprintf(keysToRegister, k2rlen, k2regfmt, homeDir);
snprintf(cloudkeychainproxy3, ckp3len, ckp3fmt, homeDir);
}
#endif
length = strlen(outputParent) + strlen(outputBase) + 2;
outputDir = malloc(length);
status = snprintf(outputDir, length, " if(status < 0) return;
mkdir(outputDir, 0700);
SOSLogSetOutputTo(outputDir, "sw_vers.log");
// report uname stuff + hostname
fprintf(outFile, "HostName: fprintf(outFile, "ProductName: fprintf(outFile, "ProductVersion: fprintf(outFile, "BuildVersion: closeOutput();
SOSLogSetOutputTo(outputDir, "syncD.log");
// do sync -D
dumpKVS(optarg, NULL);
closeOutput();
SOSLogSetOutputTo(outputDir, "synci.log");
// do sync -i
dumpCircleInfo();
closeOutput();
SOSLogSetOutputTo(outputDir, "syncL.log");
// do sync -L
listviewcmd(NULL);
closeOutput();
copyFileToOutputDir(outputDir, keysToRegister);
copyFileToOutputDir(outputDir, cloudkeychainproxy3);
free(now);
CFReleaseNull(sysfdef);
#if ! TARGET_OS_EMBEDDED
free(keysToRegister);
free(cloudkeychainproxy3);
#endif
}
#else
static void sysdiagnose_dump() {
SOSCCSysdiagnose(NULL);
}
#endif /* USE_NEW_SPI */
static bool logmark(const char *optarg) {
if(!optarg) return false;
secnotice("mark", " return true;
}
// enable, disable, accept, reject, status, Reset, Clear
int
keychain_log(int argc, char * const *argv)
{
/*
"Keychain Logging"
" -i info (current status)"
" -D [itemName] dump contents of KVS"
" -L list all known view and their status"
" -s sysdiagnose log dumps"
" -M string place a mark in the syslog - category \"mark\""
*/
SOSLogSetOutputTo(NULL, NULL);
int ch, result = 0;
CFErrorRef error = NULL;
bool hadError = false;
while ((ch = getopt(argc, argv, "DiLM:s")) != -1)
switch (ch) {
case 'i':
dumpCircleInfo();
break;
case 's':
sysdiagnose_dump();
break;
case 'D':
hadError = !dumpKVS(optarg, &error);
break;
case 'L':
hadError = !listviewcmd(&error);
break;
case 'M':
hadError = !logmark(optarg);
break;
case '?':
default:
return 2; /* Return 2 triggers usage message. */
}
if (hadError)
printerr(CFSTR("Error:
return result;
}