OSX/sec/Security/SecCertificatePath.h

   1 /*
   2  * Copyright (c) 2007-2009,2012-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         @header SecCertificatePath
  26         CoreFoundation based certificate path object
  27 */
  28
  29 #ifndef _SECURITY_SECCERTIFICATEPATH_H_
  30 #define _SECURITY_SECCERTIFICATEPATH_H_
  31
  32 #include <Security/SecCertificate.h>
  33 #include <CoreFoundation/CFArray.h>
  34 #include <CoreFoundation/CFDictionary.h>
  35 #include <CoreFoundation/CFDate.h>
  36 #include <CoreFoundation/CFError.h>
  37 #include <xpc/xpc.h>
  38
  39 __BEGIN_DECLS
  40
  41 typedef struct SecCertificatePath *SecCertificatePathRef;
  42
  43 /* SecCertificatePath API functions. */
  44 CFTypeID SecCertificatePathGetTypeID(void);
  45
  46 /* Create a new certificate path from an xpc_array of datas. */
  47 SecCertificatePathRef SecCertificatePathCreateWithXPCArray(xpc_object_t xpc_path, CFErrorRef *error);
  48
  49 /* Create a new certificate path from a CFArray of datas. */
  50 SecCertificatePathRef SecCertificatePathCreateDeserialized(CFArrayRef certificates, CFErrorRef *error);
  51
  52 /* Create an array of CFDataRefs from a certificate path. */
  53 xpc_object_t SecCertificatePathCopyXPCArray(SecCertificatePathRef path, CFErrorRef *error);
  54
  55 /* Create an array of SecCertificateRefs from a certificate path. */
  56 CFArrayRef SecCertificatePathCopyCertificates(SecCertificatePathRef path, CFErrorRef *error);
  57
  58 /* Create a new certificate path from an array of SecCertificateRefs. */
  59 SecCertificatePathRef SecCertificatePathCreateWithCertificates(CFArrayRef certificates, CFErrorRef *error);
  60
  61 /* Create a serialized Certificate Array from a certificate path. */
  62 CFArrayRef SecCertificatePathCreateSerialized(SecCertificatePathRef path, CFErrorRef *error);
  63
  64 CFIndex SecCertificatePathGetCount(
  65         SecCertificatePathRef certificatePath);
  66
  67 SecCertificateRef SecCertificatePathGetCertificateAtIndex(
  68         SecCertificatePathRef certificatePath, CFIndex ix);
  69
  70 /* Return the index of certificate in path or kCFNotFound if certificate is
  71    not in path. */
  72 CFIndex SecCertificatePathGetIndexOfCertificate(SecCertificatePathRef path,
  73     SecCertificateRef certificate);
  74
  75 SecKeyRef SecCertificatePathCopyPublicKeyAtIndex(
  76         SecCertificatePathRef certificatePath, CFIndex ix);
  77
  78 __END_DECLS
  79
  80 #endif /* !_SECURITY_SECCERTIFICATEPATH_H_ */