keychain/ckks/CKKSPeer.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 #import <Foundation/Foundation.h>
  27 #import <SecurityFoundation/SFKey.h>
  28 #import <SecurityFoundation/SFKey_Private.h>
  29
  30 NS_ASSUME_NONNULL_BEGIN
  31
  32 // ==== Peer protocols ====
  33
  34 @protocol CKKSPeer <NSObject>
  35 @property (readonly) NSString* peerID;
  36 @property (nullable, readonly) SFECPublicKey* publicEncryptionKey;
  37 @property (nullable, readonly) SFECPublicKey* publicSigningKey;
  38
  39 // Not exactly isEqual, since this only compares peerID
  40 - (bool)matchesPeer:(id<CKKSPeer>)peer;
  41 @end
  42
  43 @protocol CKKSSelfPeer <CKKSPeer>
  44 @property (readonly) SFECKeyPair* encryptionKey;
  45 @property (readonly) SFECKeyPair* signingKey;
  46 @end
  47
  48 // ==== Peer collection protocols ====
  49
  50 @interface CKKSSelves : NSObject
  51 @property id<CKKSSelfPeer> currentSelf;
  52 @property (nullable) NSSet<id<CKKSSelfPeer>>* allSelves;
  53 - (instancetype)initWithCurrent:(id<CKKSSelfPeer>)selfPeer allSelves:(NSSet<id<CKKSSelfPeer>>* _Nullable)allSelves;
  54 @end
  55
  56 // ==== Peer handler protocols ====
  57
  58 @protocol CKKSPeerUpdateListener;
  59
  60 @protocol CKKSPeerProvider <NSObject>
  61 - (CKKSSelves* _Nullable)fetchSelfPeers:(NSError* _Nullable __autoreleasing* _Nullable)error;
  62 - (NSSet<id<CKKSPeer>>* _Nullable)fetchTrustedPeers:(NSError* _Nullable __autoreleasing* _Nullable)error;
  63 // Trusted peers should include self peers
  64
  65 - (void)registerForPeerChangeUpdates:(id<CKKSPeerUpdateListener>)listener;
  66 @end
  67
  68 // A CKKSPeerUpdateListener wants to be notified when a CKKSPeerProvider has new information
  69 @protocol CKKSPeerUpdateListener <NSObject>
  70 - (void)selfPeerChanged;
  71 - (void)trustedPeerSetChanged;
  72 @end
  73
  74 extern NSString* const CKKSSOSPeerPrefix;
  75
  76 // These should be replaced by Octagon peers, when those exist
  77 @interface CKKSSOSPeer : NSObject <CKKSPeer>
  78 @property (readonly) NSString* peerID;
  79 @property (nullable, readonly) SFECPublicKey* publicEncryptionKey;
  80 @property (nullable, readonly) SFECPublicKey* publicSigningKey;
  81
  82 - (instancetype)initWithSOSPeerID:(NSString*)syncingPeerID
  83               encryptionPublicKey:(SFECPublicKey* _Nullable)encryptionKey
  84                  signingPublicKey:(SFECPublicKey* _Nullable)signingKey;
  85 @end
  86
  87 @interface CKKSSOSSelfPeer : NSObject <CKKSPeer, CKKSSelfPeer>
  88 @property (readonly) NSString* peerID;
  89 @property (readonly) SFECPublicKey* publicEncryptionKey;
  90 @property (readonly) SFECPublicKey* publicSigningKey;
  91
  92 @property SFECKeyPair* encryptionKey;
  93 @property SFECKeyPair* signingKey;
  94
  95 - (instancetype)initWithSOSPeerID:(NSString*)syncingPeerID
  96                     encryptionKey:(SFECKeyPair*)encryptionKey
  97                        signingKey:(SFECKeyPair*)signingKey;
  98 @end
  99
 100 NS_ASSUME_NONNULL_END
 101 #endif  // OCTAGON