1/* 2 * Copyright (c) 2006-2009,2012-2013 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/*! 43 @function SecCertificateGetTypeID 44 @abstract Returns the type identifier of SecCertificate instances. 45 @result The CFTypeID of SecCertificate instances. 46*/ 47CFTypeID SecCertificateGetTypeID(void) 48 __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0); 49 50/*! 51 @function SecCertificateCreateWithData 52 @abstract Create a certificate given it's DER representation as a CFData. 53 @param allocator CFAllocator to allocate the certificate with. 54 @param certificate DER encoded X.509 certificate. 55 @result Return NULL if the passed-in data is not a valid DER-encoded 56 X.509 certificate, return a SecCertificateRef otherwise. 57*/ 58SecCertificateRef SecCertificateCreateWithData(CFAllocatorRef allocator, 59 CFDataRef data) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0); 60 61/*! 62 @function SecCertificateCopyData 63 @abstract Return the DER representation of an X.509 certificate. 64 @param certificate SecCertificate object created with 65 SecCertificateCreateWithData(). 66 @result DER encoded X.509 certificate. 67*/ 68CFDataRef SecCertificateCopyData(SecCertificateRef certificate) 69 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0); 70 71/*! 72 @function SecCertificateCopySubjectSummary 73 @abstract Return a simple string which hopefully represents a human 74 understandable summary. 75 @param certificate SecCertificate object created with 76 SecCertificateCreateWithData(). 77 @discussion All the data in this string comes from the certificate itself 78 and thus it's in whatever language the certificate itself is in. 79 @result A CFStringRef which the caller should CFRelease() once it's no 80 longer needed. 81*/ 82CFStringRef SecCertificateCopySubjectSummary(SecCertificateRef certificate) 83 __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0); 84 85__END_DECLS 86 87#endif /* !_SECURITY_SECCERTIFICATE_H_ */ 88