OSX/sec/securityd/SecPinningDb.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
  25 /*!
  26  @header SecPinningDb
  27  The functions in SecPinningDb.h provide an interface to look up
  28  pinning rules based on hostname.
  29  */
  30
  31 #ifndef _SECURITY_SECPINNINGDB_H_
  32 #define _SECURITY_SECPINNINGDB_H_
  33
  34 #include <CoreFoundation/CoreFoundation.h>
  35
  36 __BEGIN_DECLS
  37
  38 CF_ASSUME_NONNULL_BEGIN
  39 CF_IMPLICIT_BRIDGING_ENABLED
  40
  41 extern const CFStringRef kSecPinningDbKeyHostname;
  42 extern const CFStringRef kSecPinningDbKeyPolicyName;
  43 extern const CFStringRef kSecPinningDbKeyRules;
  44
  45 CFDictionaryRef _Nullable SecPinningDbCopyMatching(CFDictionaryRef _Nonnull query);
  46 void SecPinningDbInitialize(void);
  47
  48 #if !TARGET_OS_BRIDGE && __OBJC__
  49 /* Updating the pinning DB isn't supported on BridgeOS because we treat the disk as read-only. */
  50 bool SecPinningDbUpdateFromURL(NSURL *url, NSError **error);
  51 #endif
  52
  53 CFNumberRef SecPinningDbCopyContentVersion(void);
  54
  55 CF_IMPLICIT_BRIDGING_DISABLED
  56 CF_ASSUME_NONNULL_END
  57
  58 __END_DECLS
  59
  60
  61 #endif /* _SECURITY_SECPINNINGDB_H_ */