OSX/sec/Security/SecIdentity.h

   1 /*
   2  * Copyright (c) 2002-2004,2007-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 SecIdentity
  26         The functions provided in SecIdentity.h implement a convenient way to
  27         match private keys with certificates.
  28 */
  29
  30 #ifndef _SECURITY_SECIDENTITY_H_
  31 #define _SECURITY_SECIDENTITY_H_
  32
  33 #include <Security/SecBase.h>
  34 #include <CoreFoundation/CFBase.h>
  35
  36 __BEGIN_DECLS
  37
  38 CF_ASSUME_NONNULL_BEGIN
  39 CF_IMPLICIT_BRIDGING_ENABLED
  40
  41 /*!
  42         @function SecIdentityGetTypeID
  43         @abstract Returns the type identifier of SecIdentity instances.
  44         @result The CFTypeID of SecIdentity instances.
  45 */
  46 CFTypeID SecIdentityGetTypeID(void)
  47     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
  48
  49 /*!
  50         @function SecIdentityCopyCertificate
  51     @abstract Returns a reference to a certificate for the given identity
  52     reference.
  53     @param identityRef An identity reference.
  54         @param certificateRef On return, a pointer to the found certificate
  55     reference.
  56     @result A result code.  See "Security Error Codes" (SecBase.h).
  57 */
  58 OSStatus SecIdentityCopyCertificate(
  59             SecIdentityRef identityRef,
  60             SecCertificateRef * __nonnull CF_RETURNS_RETAINED certificateRef)
  61     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
  62
  63 /*!
  64         @function SecIdentityCopyPrivateKey
  65     @abstract Returns the private key associated with an identity.
  66     @param identityRef An identity reference.
  67         @param privateKeyRef On return, a pointer to the private key for the given
  68     identity. The private key must be of class type kSecAppleKeyItemClass.
  69     @result A result code.  See "Security Error Codes" (SecBase.h).
  70 */
  71 OSStatus SecIdentityCopyPrivateKey(
  72             SecIdentityRef identityRef,
  73             SecKeyRef * __nonnull CF_RETURNS_RETAINED privateKeyRef)
  74     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
  75
  76 CF_IMPLICIT_BRIDGING_DISABLED
  77 CF_ASSUME_NONNULL_END
  78
  79 __END_DECLS
  80
  81 #endif /* !_SECURITY_SECIDENTITY_H_ */