Keychain/SecIdentity.h

   1 /*
   2  * Copyright (c) 2002 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18 /*!
  19         @header SecIdentity
  20         The functions provided in SecIdentity implement a convenient way to match private keys with certificates.
  21 */
  22
  23 #ifndef _SECURITY_SECIDENTITY_H_
  24 #define _SECURITY_SECIDENTITY_H_
  25
  26 #include <Security/SecBase.h>
  27
  28
  29 #if defined(__cplusplus)
  30 extern "C" {
  31 #endif
  32
  33 /*!
  34         @function SecIdentityGetTypeID
  35         @abstract Returns the type identifier of SecIdentity instances.
  36         @result The CFTypeID of SecIdentity instances.
  37 */
  38 CFTypeID SecIdentityGetTypeID(void);
  39
  40 /*!
  41         @function SecIdentityGetCertificate
  42     @abstract Returns a reference to a certificate for the given identity reference.
  43     @param identityRef An identity reference.
  44         @param certificateRef On return, a pointer to the found certificate reference.
  45     @result A result code.  See "Security Error Codes" (SecBase.h).
  46 */
  47 OSStatus SecIdentityCopyCertificate(
  48             SecIdentityRef identityRef,
  49             SecCertificateRef *certificateRef);
  50
  51 /*!
  52         @function SecIdentityGetPrivateKey
  53     @abstract Returns the private key associated with an identity.
  54     @param identityRef An identity reference.
  55         @param privateKeyRef On return, a pointer to the private key for the given identity. The private key must be of class type kSecAppleKeyItemClass.
  56     @result A result code.  See "Security Error Codes" (SecBase.h).
  57 */
  58 OSStatus SecIdentityCopyPrivateKey(
  59             SecIdentityRef identityRef,
  60             SecKeyRef *privateKeyRef);
  61
  62 #if defined(__cplusplus)
  63 }
  64 #endif
  65
  66 #endif /* !_SECURITY_SECIDENTITY_H_ */