keychain/trust/TrustedPeers/TPPolicyDocument.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 "TPPolicy.h"
  27 #import "TPEncrypter.h"
  28 #import "TPDecrypter.h"
  29 #import "TPHash.h"
  30 #import "TPTypes.h"
  31
  32 NS_ASSUME_NONNULL_BEGIN
  33
  34 /*!
  35  This class is a value type -- its members are immutable and
  36  instances with identical contents are interchangeable.
  37  */
  38 @interface TPPolicyDocument : NSObject
  39
  40 @property (nonatomic, readonly) TPCounter policyVersion;
  41 @property (nonatomic, readonly) NSString *policyHash;
  42 @property (nonatomic, readonly) NSData *pList;
  43
  44 + (nullable instancetype)policyDocWithHash:(NSString *)policyHash
  45                                      pList:(NSData *)pList;
  46
  47 + (instancetype)policyDocWithVersion:(TPCounter)policyVersion
  48                      modelToCategory:(NSArray<NSDictionary*> *)modelToCategory
  49                     categoriesByView:(NSDictionary<NSString*,NSArray<NSString*>*> *)categoriesByView
  50                introducersByCategory:(NSDictionary<NSString*,NSArray<NSString*>*> *)introducersByCategory
  51                           redactions:(NSDictionary<NSString*,NSData*> *)redactions
  52                             hashAlgo:(TPHashAlgo)hashAlgo;
  53
  54 + (nullable NSData *)redactionWithEncrypter:(id<TPEncrypter>)encrypter
  55                             modelToCategory:(nullable NSArray<NSDictionary*> *)modelToCategory
  56                            categoriesByView:(nullable NSDictionary<NSString*,NSArray<NSString*>*> *)categoriesByView
  57                       introducersByCategory:(nullable NSDictionary<NSString*,NSArray<NSString*>*> *)introducersByCategory
  58                                       error:(NSError **)error;
  59
  60 - (nullable id<TPPolicy>)policyWithSecrets:(NSDictionary<NSString*,NSData*> *)secrets
  61                                  decrypter:(id<TPDecrypter>)decrypter
  62                                      error:(NSError **)error;
  63
  64 - (BOOL)isEqualToPolicyDocument:(TPPolicyDocument *)other;
  65
  66 @end
  67
  68 NS_ASSUME_NONNULL_END