OTJoinWithVoucherOperation.m   [plain text]

/*
 * Copyright (c) 2018 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@
 */

#if OCTAGON

#import <utilities/debugging.h>

#import <CloudKit/CloudKit_Private.h>

#import "keychain/ot/OTJoinWithVoucherOperation.h"
#import "keychain/ot/OTOperationDependencies.h"
#import "keychain/ot/OTFetchCKKSKeysOperation.h"
#import "keychain/ckks/CKKSNearFutureScheduler.h"
#import "keychain/ckks/CloudKitCategories.h"

#import "keychain/TrustedPeersHelper/TrustedPeersHelperProtocol.h"
#import "keychain/ot/ObjCImprovements.h"
#import "keychain/ot/OTStates.h"

@interface OTJoinWithVoucherOperation ()
@property OTOperationDependencies* deps;

@property OctagonState* ckksConflictState;

@property NSOperation* finishedOp;
@end

@implementation OTJoinWithVoucherOperation

@synthesize intendedState = _intendedState;

- (instancetype)initWithDependencies:(OTOperationDependencies*)dependencies
                       intendedState:(OctagonState*)intendedState
                   ckksConflictState:(OctagonState*)ckksConflictState
                          errorState:(OctagonState*)errorState
{
    if((self = [super init])) {
        _deps = dependencies;

        _intendedState = intendedState;
        _nextState = errorState;
        _ckksConflictState = ckksConflictState;

        _peerID = nil;
        _voucherData = nil;
        _voucherSig = nil;
    }
    return self;
}

- (void)groupStart
{
    // Load the voucher from the state handler
    NSError* error = nil;
    OTAccountMetadataClassC* metadata = [self.deps.stateHolder loadOrCreateAccountMetadata:&error];

    if(!metadata.voucher || !metadata.voucherSignature || error) {
        secnotice("octagon", "No voucher available: %@", error);
        self.error = error;
        return;
    }

    self.voucherData = metadata.voucher;
    self.voucherSig = metadata.voucherSignature;

    secnotice("octagon", "joining with a voucher: %@", self.voucherData);

    self.finishedOp = [[NSOperation alloc] init];
    [self dependOnBeforeGroupFinished:self.finishedOp];

    WEAKIFY(self);

    OTFetchCKKSKeysOperation* fetchKeysOp = [[OTFetchCKKSKeysOperation alloc] initWithDependencies:self.deps
                                                                                     refetchNeeded:NO];
    // We only care about TLKs that are ready for upload. Don't wait long.
    fetchKeysOp.desiredTimeout = 2*NSEC_PER_SEC;
    [self runBeforeGroupFinished:fetchKeysOp];

    CKKSResultOperation* proceedWithKeys = [CKKSResultOperation named:@"vouch-with-keys"
                                                            withBlock:^{
                                                                STRONGIFY(self);
                                                                [self proceedWithKeys:fetchKeysOp.viewKeySets
                                                                     pendingTLKShares:fetchKeysOp.pendingTLKShares];
                                                            }];

    [proceedWithKeys addDependency:fetchKeysOp];
    [self runBeforeGroupFinished:proceedWithKeys];
}

- (void)proceedWithKeys:(NSArray<CKKSKeychainBackedKeySet*>*)viewKeySets pendingTLKShares:(NSArray<CKKSTLKShare*>*)pendingTLKShares
{
    WEAKIFY(self);

    NSArray<NSData*>* publicSigningSPKIs = nil;
    if(self.deps.sosAdapter.sosEnabled) {
        NSError* sosPreapprovalError = nil;
        publicSigningSPKIs = [OTSOSAdapterHelpers peerPublicSigningKeySPKIsForCircle:self.deps.sosAdapter error:&sosPreapprovalError];

        if(publicSigningSPKIs) {
            secnotice("octagon-sos", "SOS preapproved keys are %@", publicSigningSPKIs);
        } else {
            secnotice("octagon-sos", "Unable to fetch SOS preapproved keys: %@", sosPreapprovalError);
        }

    } else {
        secnotice("octagon-sos", "SOS not enabled; no preapproved keys");
    }

    [self.deps.cuttlefishXPCWrapper joinWithContainer:self.deps.containerName
                                              context:self.deps.contextID
                                          voucherData:self.voucherData
                                           voucherSig:self.voucherSig
                                             ckksKeys:viewKeySets
                                            tlkShares:pendingTLKShares
                                      preapprovedKeys:publicSigningSPKIs
                                                reply:^(NSString * _Nullable peerID,
                                                        NSArray<CKRecord*>* keyHierarchyRecords,
                                                        TPSyncingPolicy* _Nullable syncingPolicy,
                                                        NSError * _Nullable error) {
            STRONGIFY(self);
            if(error){
                secerror("octagon: Error joining with voucher: %@", error);
                [[CKKSAnalytics logger] logRecoverableError:error forEvent:OctagonEventJoinWithVoucher withAttributes:NULL];

                // IF this is a CKKS conflict error, don't retry
                if ([error isCuttlefishError:CuttlefishErrorKeyHierarchyAlreadyExists]) {
                    secnotice("octagon-ckks", "A CKKS key hierarchy is out of date; going to state '%@'", self.ckksConflictState);
                    self.nextState = self.ckksConflictState;
                } else if ([error isCuttlefishError:CuttlefishErrorResultGraphNotFullyReachable]) {
                    secnotice("octagon", "requesting cuttlefish health check");
                    self.nextState = OctagonStateCuttlefishTrustCheck;
                    self.error = error;
                } else {
                    self.error = error;
                }
            } else {
                self.peerID = peerID;

                [[CKKSAnalytics logger] logSuccessForEventNamed:OctagonEventJoinWithVoucher];

                [self.deps.viewManager setCurrentSyncingPolicy:syncingPolicy];

                NSError* localError = nil;
                BOOL persisted = [self.deps.stateHolder persistAccountChanges:^OTAccountMetadataClassC * _Nonnull(OTAccountMetadataClassC * _Nonnull metadata) {
                    metadata.trustState = OTAccountMetadataClassC_TrustState_TRUSTED;
                    metadata.peerID = peerID;

                    metadata.voucher = nil;
                    metadata.voucherSignature = nil;

                    [metadata setTPSyncingPolicy:syncingPolicy];
                    return metadata;
                } error:&localError];
                if(!persisted || localError) {
                    secnotice("octagon", "Couldn't persist results: %@", localError);
                    self.error = localError;
                } else {
                    secerror("octagon: join successful");
                    self.nextState = self.intendedState;
                }

                // Tell CKKS about our shiny new records!
                for (id key in self.deps.viewManager.views) {
                    CKKSKeychainView* view = self.deps.viewManager.views[key];
                    secnotice("octagon-ckks", "Providing join() records to %@", view);
                    [view receiveTLKUploadRecords: keyHierarchyRecords];
                }
            }
            [self runBeforeGroupFinished:self.finishedOp];
        }];
}

@end

#endif // OCTAGON