keychain/trust/TrustedPeers/TPPeerDynamicInfo.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 "TPTypes.h"
  27 #import "TPSigningKey.h"
  28
  29 NS_ASSUME_NONNULL_BEGIN
  30
  31 /*!
  32  Having an instance of this class does *not* mean that
  33  its signature has been checked. Checking the signature
  34  is up to whoever consumes it.
  35
  36  This class is a value type -- its members are immutable and
  37  instances with identical contents are interchangeable.
  38  */
  39 @interface TPPeerDynamicInfo : NSObject
  40
  41 /*!
  42  Can return nil with error if [trustSigningKey signatureForData:error:] errors.
  43  */
  44 + (nullable instancetype)dynamicInfoWithCircleID:(NSString *)circleID
  45                                           clique:(NSString *)clique
  46                                         removals:(TPCounter)removals
  47                                            clock:(TPCounter)clock
  48                                  trustSigningKey:(id<TPSigningKey>)trustSigningKey
  49                                            error:(NSError **)error;
  50
  51 // Returns nil if data cannot be deserialized to a dictionary
  52 // or that dictionary does not contain the expected keys and value types.
  53 + (nullable instancetype)dynamicInfoWithPListData:(NSData *)dynamicInfoPList
  54                                    dynamicInfoSig:(NSData *)dynamicInfoSig;
  55
  56 - (BOOL)isEqualToPeerDynamicInfo:(TPPeerDynamicInfo *)other;
  57
  58 @property (nonatomic, readonly) NSString *circleID;
  59 @property (nonatomic, readonly) NSString *clique;
  60 @property (nonatomic, readonly) TPCounter removals;
  61 @property (nonatomic, readonly) TPCounter clock;
  62 @property (nonatomic, readonly) NSData *dynamicInfoPList;
  63 @property (nonatomic, readonly) NSData *dynamicInfoSig;
  64
  65 @end
  66
  67 NS_ASSUME_NONNULL_END