keychain/trust/TrustedPeers/TPPeer.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
  26 #import "TPHash.h"
  27 #import "TPSigningKey.h"
  28 #import "TPTypes.h"
  29
  30 @class TPCircle;
  31 @class TPVoucher;
  32 @class TPPeerPermanentInfo;
  33 @class TPPeerStableInfo;
  34 @class TPPeerDynamicInfo;
  35
  36 NS_ASSUME_NONNULL_BEGIN
  37
  38 @interface TPPeer : NSObject
  39
  40 @property (nonatomic, readonly) NSString* peerID;
  41
  42 @property (nonatomic, readonly) TPPeerPermanentInfo* permanentInfo;
  43 @property (nonatomic, readonly, nullable) TPPeerStableInfo* stableInfo;
  44 @property (nonatomic, readonly, nullable) TPPeerDynamicInfo* dynamicInfo;
  45 @property (nonatomic, strong) NSData* wrappedPrivateKeys;
  46
  47 // setCircle asserts that circle.circleID == dynamicInfo.circleID
  48 @property (nonatomic, strong, nullable) TPCircle* circle;
  49
  50 @property (nonatomic, readonly) NSSet<NSString*>* trustedPeerIDs;
  51
  52 - (instancetype)initWithPermanentInfo:(TPPeerPermanentInfo *)permanentInfo;
  53
  54 - (TPResult)updateStableInfo:(TPPeerStableInfo *)stableInfo;
  55
  56 // Returns YES on success, or NO if:
  57 // - the data or signature is invalid
  58 // - this update makes a change without advancing dynamicInfo.clock
  59 //
  60 // An "update" with unchanged data is considered success.
  61 //
  62 // This call also sets self.circle to nil.
  63 // The caller should subsequently call updateCircle to update it.
  64 - (TPResult)updateDynamicInfo:(TPPeerDynamicInfo *)dynamicInfo;
  65
  66 @end
  67
  68 NS_ASSUME_NONNULL_END