OSX/sec/Security/SecCertificate.h

   1 /*
   2  * Copyright (c) 2006-2009,2012-2015 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 SecCertificate
  26         The functions provided in SecCertificate.h implement and manage a
  27     particular type of keychain item that represents a X.509 public key
  28     certificate. You can store a certificate in a keychain, but a
  29     certificate can also be a transient object.
  30
  31         You can use a certificate as a keychain item in most functions.
  32 */
  33
  34 #ifndef _SECURITY_SECCERTIFICATE_H_
  35 #define _SECURITY_SECCERTIFICATE_H_
  36
  37 #include <Security/SecBase.h>
  38 #include <CoreFoundation/CFData.h>
  39
  40 __BEGIN_DECLS
  41
  42 CF_ASSUME_NONNULL_BEGIN
  43 CF_IMPLICIT_BRIDGING_ENABLED
  44
  45 /*!
  46         @function SecCertificateGetTypeID
  47         @abstract Returns the type identifier of SecCertificate instances.
  48         @result The CFTypeID of SecCertificate instances.
  49 */
  50 CFTypeID SecCertificateGetTypeID(void)
  51     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
  52
  53 /*!
  54         @function SecCertificateCreateWithData
  55         @abstract Create a certificate given it's DER representation as a CFData.
  56     @param allocator CFAllocator to allocate the certificate with.
  57     @param certificate DER encoded X.509 certificate.
  58         @result Return NULL if the passed-in data is not a valid DER-encoded
  59     X.509 certificate, return a SecCertificateRef otherwise.
  60 */
  61 __nullable
  62 SecCertificateRef SecCertificateCreateWithData(CFAllocatorRef __nullable allocator,
  63     CFDataRef data) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0);
  64
  65 /*!
  66         @function SecCertificateCopyData
  67         @abstract Return the DER representation of an X.509 certificate.
  68     @param certificate SecCertificate object created with
  69     SecCertificateCreateWithData().
  70         @result DER encoded X.509 certificate.
  71 */
  72 CFDataRef SecCertificateCopyData(SecCertificateRef certificate)
  73     __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0);
  74
  75 /*!
  76         @function SecCertificateCopySubjectSummary
  77         @abstract Return a simple string which hopefully represents a human
  78     understandable summary.
  79     @param certificate SecCertificate object created with
  80     SecCertificateCreateWithData().
  81     @discussion All the data in this string comes from the certificate itself
  82     and thus it's in whatever language the certificate itself is in.
  83         @result A CFStringRef which the caller should CFRelease() once it's no
  84     longer needed.
  85 */
  86 CFStringRef SecCertificateCopySubjectSummary(SecCertificateRef certificate)
  87     __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0);
  88
  89 CF_IMPLICIT_BRIDGING_DISABLED
  90 CF_ASSUME_NONNULL_END
  91
  92 __END_DECLS
  93
  94 #endif /* !_SECURITY_SECCERTIFICATE_H_ */
  95