keychain/trust/TrustedPeers/TPPolicy.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 NS_ASSUME_NONNULL_BEGIN
  27
  28 @class TPCategoryRule;
  29
  30 /*!
  31  TPPolicy represents the ability to calculate Octagon Policy, as per
  32  https://confluence.sd.apple.com/display/KEY/Octagon+Policy
  33
  34  Instances of this class are typically obtained from TPPolicyDocument,
  35  by passing a (possibly empty) dictionary of secrets to
  36  policyWithSecrets:decrypter:error:.
  37 */
  38 @protocol TPPolicy <NSObject>
  39
  40 - (nullable NSString *)categoryForModel:(NSString *)model;
  41 - (BOOL)trustedPeerInCategory:(NSString *)trustedCategory canIntroduceCategory:(NSString *)candidateCategory;
  42 - (BOOL)peerInCategory:(NSString *)category canAccessView:(NSString *)view;
  43
  44 @end
  45
  46
  47 @interface TPPolicy : NSObject<TPPolicy>
  48
  49 + (instancetype)policyWithModelToCategory:(NSArray<TPCategoryRule*> *)modelToCategory
  50                          categoriesByView:(NSDictionary<NSString*,NSSet<NSString*>*> *)categoriesByView
  51                     introducersByCategory:(NSDictionary<NSString*,NSSet<NSString*>*> *)introducersByCategory;
  52
  53 @end
  54
  55 NS_ASSUME_NONNULL_END