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 CKKSRemotePeerProtocol <CKKSPeer>
  44 - (BOOL)shouldHaveView:(NSString*)viewName;
  45 @end
  46
  47 @protocol CKKSSelfPeer <CKKSPeer>
  48 @property (readonly) SFECKeyPair* encryptionKey;
  49 @property (readonly) SFECKeyPair* signingKey;
  50 @end
  51
  52 // ==== Peer collection protocols ====
  53
  54 @interface CKKSSelves : NSObject
  55 @property id<CKKSSelfPeer> currentSelf;
  56 @property (nullable) NSSet<id<CKKSSelfPeer>>* allSelves;
  57 - (instancetype)initWithCurrent:(id<CKKSSelfPeer>)selfPeer allSelves:(NSSet<id<CKKSSelfPeer>>* _Nullable)allSelves;
  58 @end
  59
  60 // ==== Peer handler protocols ====
  61
  62 @protocol CKKSPeerUpdateListener;
  63
  64 @protocol CKKSPeerProvider <NSObject>
  65 @property (readonly) NSString* providerID;
  66 @property BOOL essential;
  67
  68 - (CKKSSelves* _Nullable)fetchSelfPeers:(NSError* _Nullable __autoreleasing* _Nullable)error;
  69 - (NSSet<id<CKKSRemotePeerProtocol>>* _Nullable)fetchTrustedPeers:(NSError* _Nullable __autoreleasing* _Nullable)error;
  70 // Trusted peers should include self peers
  71
  72 - (void)registerForPeerChangeUpdates:(id<CKKSPeerUpdateListener>)listener;
  73 - (void)sendSelfPeerChangedUpdate;
  74 - (void)sendTrustedPeerSetChangedUpdate;
  75 @end
  76
  77 // A CKKSPeerUpdateListener wants to be notified when a CKKSPeerProvider has new information
  78 @protocol CKKSPeerUpdateListener <NSObject>
  79 - (void)selfPeerChanged:(id<CKKSPeerProvider> _Nullable)provider;
  80 - (void)trustedPeerSetChanged:(id<CKKSPeerProvider> _Nullable)provider;
  81 @end
  82
  83 extern NSString* const CKKSSOSPeerPrefix;
  84
  85 @interface CKKSActualPeer : NSObject <CKKSPeer, CKKSRemotePeerProtocol, NSSecureCoding>
  86 @property (readonly) NSString* peerID;
  87 @property (nullable, readonly) SFECPublicKey* publicEncryptionKey;
  88 @property (nullable, readonly) SFECPublicKey* publicSigningKey;
  89 @property (nullable, readonly) NSSet<NSString*>* viewList;
  90
  91 - (instancetype)initWithPeerID:(NSString*)syncingPeerID
  92            encryptionPublicKey:(SFECPublicKey* _Nullable)encryptionKey
  93               signingPublicKey:(SFECPublicKey* _Nullable)signingKey
  94                       viewList:(NSSet<NSString*>* _Nullable)viewList;
  95 @end
  96
  97 @protocol CKKSSOSPeerProtocol <NSObject, CKKSRemotePeerProtocol>
  98 @end
  99
 100 @interface CKKSSOSPeer : NSObject <CKKSPeer, CKKSSOSPeerProtocol, CKKSRemotePeerProtocol, NSSecureCoding>
 101 - (instancetype)initWithSOSPeerID:(NSString*)syncingPeerID
 102               encryptionPublicKey:(SFECPublicKey* _Nullable)encryptionKey
 103                  signingPublicKey:(SFECPublicKey* _Nullable)signingKey
 104                          viewList:(NSSet<NSString*>* _Nullable)viewList;
 105 @end
 106
 107 @interface CKKSSOSSelfPeer : NSObject <CKKSPeer, CKKSSOSPeerProtocol, CKKSRemotePeerProtocol, CKKSSelfPeer>
 108 @property (readonly) NSString* peerID;
 109 @property (nullable, readonly) NSSet<NSString*>* viewList;
 110
 111 @property (readonly) SFECPublicKey* publicEncryptionKey;
 112 @property (readonly) SFECPublicKey* publicSigningKey;
 113
 114 @property SFECKeyPair* encryptionKey;
 115 @property SFECKeyPair* signingKey;
 116
 117 - (instancetype)initWithSOSPeerID:(NSString*)syncingPeerID
 118                     encryptionKey:(SFECKeyPair*)encryptionKey
 119                        signingKey:(SFECKeyPair*)signingKey
 120                          viewList:(NSSet<NSString*>* _Nullable)viewList;
 121 @end
 122
 123 NSSet<Class>* CKKSPeerClasses(void);
 124
 125 NS_ASSUME_NONNULL_END
 126 #endif  // OCTAGON