keychain/ot/OTIdentity.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 #if OCTAGON
  25
  26 #include <SecurityFoundation/SFKey.h>
  27 NS_ASSUME_NONNULL_BEGIN
  28
  29 @interface OTIdentity : NSObject
  30
  31 @property (nonatomic, readonly) NSString*     peerID;
  32 @property (nonatomic, readonly) NSString*     spID;
  33 @property (nonatomic, readonly) SFECKeyPair*  peerSigningKey;
  34 @property (nonatomic, readonly) SFECKeyPair*  peerEncryptionKey;
  35
  36
  37 - (instancetype) initWithPeerID:(nullable NSString*)peerID
  38                            spID:(nullable NSString*)spID
  39                  peerSigningKey:(SFECKeyPair*)peerSigningKey
  40               peerEncryptionkey:(SFECKeyPair*)peerEncryptionKey
  41                           error:(NSError**)error;
  42
  43 + (nullable instancetype) currentIdentityFromSOS:(NSError**)error;
  44
  45 -(BOOL)isEqual:(OTIdentity*)identity;
  46
  47
  48 +(BOOL) storeOctagonIdentityIntoKeychain:(_SFECKeyPair *)restoredSigningKey
  49                    restoredEncryptionKey:(_SFECKeyPair *)restoredEncryptionKey
  50                  escrowSigningPubKeyHash:(NSString *)escrowSigningPubKeyHash
  51                           restoredPeerID:(NSString *)peerID
  52                                    error:(NSError**)error;
  53
  54 @end
  55
  56 NS_ASSUME_NONNULL_END
  57 #endif
  58