]> git.saurik.com Git - apple/security.git/blame - sec/Security/SecIdentity.h
Security-55471.14.18.tar.gz
[apple/security.git] / sec / Security / SecIdentity.h
CommitLineData
b1ab9ed8
A
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
427c49bc 36__BEGIN_DECLS
b1ab9ed8
A
37
38/*!
39 @function SecIdentityGetTypeID
40 @abstract Returns the type identifier of SecIdentity instances.
41 @result The CFTypeID of SecIdentity instances.
42*/
43CFTypeID SecIdentityGetTypeID(void)
44 __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
45
46/*!
47 @function SecIdentityCopyCertificate
48 @abstract Returns a reference to a certificate for the given identity
49 reference.
50 @param identityRef An identity reference.
51 @param certificateRef On return, a pointer to the found certificate
52 reference.
53 @result A result code. See "Security Error Codes" (SecBase.h).
54*/
55OSStatus SecIdentityCopyCertificate(
56 SecIdentityRef identityRef,
57 SecCertificateRef *certificateRef)
58 __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
59
60/*!
61 @function SecIdentityCopyPrivateKey
62 @abstract Returns the private key associated with an identity.
63 @param identityRef An identity reference.
64 @param privateKeyRef On return, a pointer to the private key for the given
65 identity. The private key must be of class type kSecAppleKeyItemClass.
66 @result A result code. See "Security Error Codes" (SecBase.h).
67*/
68OSStatus SecIdentityCopyPrivateKey(
69 SecIdentityRef identityRef,
70 SecKeyRef *privateKeyRef)
71 __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
72
427c49bc 73__END_DECLS
b1ab9ed8
A
74
75#endif /* !_SECURITY_SECIDENTITY_H_ */