keychain/ot/OTControlProtocol.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   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
  11  * file.
  12  *
  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.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #import <Foundation/Foundation.h>
  25 NS_ASSUME_NONNULL_BEGIN
  26
  27 @protocol OTControlProtocol <NSObject>
  28 - (void)restore:(NSString *)contextID dsid:(NSString *)dsid secret:(NSData*)secret escrowRecordID:(NSString*)escrowRecordID reply:(void (^)(NSData* _Nullable signingKeyData, NSData* _Nullable encryptionKeyData, NSError * _Nullable error))reply;
  29 - (void)octagonEncryptionPublicKey:(void (^)(NSData* _Nullable encryptionKey, NSError * _Nullable))reply;;
  30 - (void)octagonSigningPublicKey:(void (^)(NSData* _Nullable signingKey, NSError * _Nullable))reply;;
  31 - (void)listOfEligibleBottledPeerRecords:(void (^)(NSArray* listOfRecords, NSError *))reply;
  32 - (void)signOut:(void (^)(BOOL result, NSError * _Nullable signedOutError))reply;
  33 - (void)signIn:(NSString*)dsid reply:(void (^)(BOOL result, NSError * _Nullable signedInError))reply;
  34 - (void)reset:(void (^)(BOOL result, NSError * _Nullable error))reply;
  35 - (void)scheduleCFUForFuture;
  36
  37 - (void)preflightBottledPeer:(NSString*)contextID
  38                         dsid:(NSString*)dsid
  39                        reply:(void (^)(NSData* _Nullable entropy,
  40                                        NSString* _Nullable bottleID,
  41                                        NSData* _Nullable signingPublicKey,
  42                                        NSError* _Nullable error))reply;
  43 - (void)launchBottledPeer:(NSString*)contextID
  44                  bottleID:(NSString*)bottleID
  45                     reply:(void (^ _Nullable)(NSError* _Nullable error))reply;
  46 - (void)scrubBottledPeer:(NSString*)contextID
  47                 bottleID:(NSString*)bottleID
  48                    reply:(void (^ _Nullable)(NSError* _Nullable error))reply;
  49 @end
  50
  51 NSXPCInterface* OTSetupControlProtocol(NSXPCInterface* interface);
  52
  53 NS_ASSUME_NONNULL_END