2 * Copyright (c) 2019 Apple Inc. All Rights Reserved.
4 * @APPLE_LICENSE_HEADER_START@
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
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.
21 * @APPLE_LICENSE_HEADER_END@
26 #import <utilities/debugging.h>
28 #import "keychain/ot/OTVouchWithRecoveryKeyOperation.h"
29 #import "keychain/ot/OTClientStateMachine.h"
30 #import "keychain/ot/OTCuttlefishContext.h"
31 #import "keychain/ot/OTFetchCKKSKeysOperation.h"
33 #import "keychain/TrustedPeersHelper/TrustedPeersHelperProtocol.h"
34 #import "keychain/ot/ObjCImprovements.h"
36 @interface OTVouchWithRecoveryKeyOperation ()
37 @property OTOperationDependencies* deps;
39 @property NSString* salt;
40 @property NSString* recoveryKey;
42 @property NSOperation* finishOp;
45 @implementation OTVouchWithRecoveryKeyOperation
46 @synthesize intendedState = _intendedState;
48 - (instancetype)initWithDependencies:(OTOperationDependencies*)dependencies
49 intendedState:(OctagonState*)intendedState
50 errorState:(OctagonState*)errorState
51 recoveryKey:(NSString*)recoveryKey
53 if((self = [super init])) {
55 _intendedState = intendedState;
56 _nextState = errorState;
58 _recoveryKey = recoveryKey;
65 secnotice("octagon", "creating voucher using a recovery key");
67 self.finishOp = [[NSOperation alloc] init];
68 [self dependOnBeforeGroupFinished:self.finishOp];
70 NSString *altDSID = [self.deps.authKitAdapter primaryiCloudAccountAltDSID:nil];
72 secnotice("octagon", "using auth kit adapter, altdsid is: %@", altDSID);
76 NSError* accountError = nil;
77 OTAccountMetadataClassC* account = [self.deps.stateHolder loadOrCreateAccountMetadata:&accountError];
79 if(account && !accountError) {
80 secnotice("octagon", "retrieved account, altdsid is: %@", account.altDSID);
81 self.salt = account.altDSID;
83 if(accountError || !account){
84 secerror("failed to rerieve account object: %@", accountError);
88 // First, let's preflight the vouch (to receive a policy and view set to use for TLK fetching
90 [self.deps.cuttlefishXPCWrapper preflightVouchWithRecoveryKeyWithContainer:self.deps.containerName
91 context:self.deps.contextID
92 recoveryKey:self.recoveryKey
94 reply:^(NSString * _Nullable recoveryKeyID,
95 NSSet<NSString*>* peerSyncingViews,
96 TPPolicy* peerSyncingPolicy,
97 NSError * _Nullable error) {
99 [[CKKSAnalytics logger] logResultForEvent:OctagonEventPreflightVouchWithRecoveryKey hardFailure:true result:error];
101 if(error || !recoveryKeyID) {
102 secerror("octagon: Error preflighting voucher using recovery key: %@", error);
104 [self runBeforeGroupFinished:self.finishOp];
108 secnotice("octagon", "Recovery key ID %@ looks good to go", recoveryKeyID);
110 // Tell CKKS to spin up the new views and policy
111 // But, do not persist this view set! We'll do that when we actually manage to join
112 [self.deps.viewManager setSyncingViews:peerSyncingViews sortingPolicy:peerSyncingPolicy];
114 [self proceedWithRecoveryKeyID:recoveryKeyID];
118 - (void)proceedWithRecoveryKeyID:(NSString*)recoveryKeyID
122 // After a vouch, we also want to acquire all TLKs that the bottled peer might have had
123 OTFetchCKKSKeysOperation* fetchKeysOp = [[OTFetchCKKSKeysOperation alloc] initWithDependencies:self.deps];
124 [self runBeforeGroupFinished:fetchKeysOp];
126 CKKSResultOperation* proceedWithKeys = [CKKSResultOperation named:@"recovery-tlks"
130 NSMutableArray<CKKSTLKShare*>* filteredTLKShares = [NSMutableArray array];
131 for(CKKSTLKShare* share in fetchKeysOp.tlkShares) {
132 // If we didn't get a recoveryKeyID, just pass every tlkshare and hope for the best
133 if(recoveryKeyID == nil || [share.receiverPeerID isEqualToString:recoveryKeyID]) {
134 [filteredTLKShares addObject:share];
138 [self proceedWithKeys:fetchKeysOp.viewKeySets tlkShares:filteredTLKShares salt:self.salt];
141 [proceedWithKeys addDependency:fetchKeysOp];
142 [self runBeforeGroupFinished:proceedWithKeys];
145 - (void)proceedWithKeys:(NSArray<CKKSKeychainBackedKeySet*>*)viewKeySets tlkShares:(NSArray<CKKSTLKShare*>*)tlkShares salt:(NSString*)salt
149 [self.deps.cuttlefishXPCWrapper vouchWithRecoveryKeyWithContainer:self.deps.containerName
150 context:self.deps.contextID
151 recoveryKey:self.recoveryKey
154 reply:^(NSData * _Nullable voucher, NSData * _Nullable voucherSig, NSError * _Nullable error) {
157 [[CKKSAnalytics logger] logResultForEvent:OctagonEventVoucherWithRecoveryKey hardFailure:true result:error];
158 secerror("octagon: Error preparing voucher using recovery key: %@", error);
160 [self runBeforeGroupFinished:self.finishOp];
163 self.voucher = voucher;
164 self.voucherSig = voucherSig;
165 self.nextState = self.intendedState;
166 [self runBeforeGroupFinished:self.finishOp];