sec/Security/SecIdentity.h

   1 /*
   2  * Copyright (c) 2002-2004,2007-2009 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 #if defined(__cplusplus)
  37 extern "C" {
  38 #endif
  39
  40 /*!
  41         @function SecIdentityGetTypeID
  42         @abstract Returns the type identifier of SecIdentity instances.
  43         @result The CFTypeID of SecIdentity instances.
  44 */
  45 CFTypeID SecIdentityGetTypeID(void)
  46     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
  47
  48 /*!
  49         @function SecIdentityCopyCertificate
  50     @abstract Returns a reference to a certificate for the given identity
  51     reference.
  52     @param identityRef An identity reference.
  53         @param certificateRef On return, a pointer to the found certificate
  54     reference.
  55     @result A result code.  See "Security Error Codes" (SecBase.h).
  56 */
  57 OSStatus SecIdentityCopyCertificate(
  58             SecIdentityRef identityRef,
  59             SecCertificateRef *certificateRef)
  60     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
  61
  62 /*!
  63         @function SecIdentityCopyPrivateKey
  64     @abstract Returns the private key associated with an identity.
  65     @param identityRef An identity reference.
  66         @param privateKeyRef On return, a pointer to the private key for the given
  67     identity. The private key must be of class type kSecAppleKeyItemClass.
  68     @result A result code.  See "Security Error Codes" (SecBase.h).
  69 */
  70 OSStatus SecIdentityCopyPrivateKey(
  71             SecIdentityRef identityRef,
  72             SecKeyRef *privateKeyRef)
  73     __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
  74
  75 #if defined(__cplusplus)
  76 }
  77 #endif
  78
  79 #endif /* !_SECURITY_SECIDENTITY_H_ */