1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
* Copyright (c) 2004-2008 Apple Inc. All Rights Reserved.
*
* Export of this software from the United States of America may require
* a specific license from the United States Government. It is the
* responsibility of any person or organization contemplating export to
* obtain such a license before exporting.
*
* WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
* distribute this software and its documentation for any purpose and
* without fee is hereby granted, provided that the above copyright
* notice appear in all copies and that both that copyright notice and
* this permission notice appear in supporting documentation, and that
* the name of Apple Inc. not be used in advertising or publicity pertaining
* to distribution of the software without specific, written prior
* permission. Apple Inc. makes no representations about the suitability of
* this software for any purpose. It is provided "as is" without express
* or implied warranty.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
* WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*
*/
/*
* pkinit_cert_store.h - PKINIT certificate storage/retrieval utilities
*
* Created 26 May 2004 by Doug Mitchell at Apple.
*/
#ifndef _PKINIT_CERT_STORE_H_
#define _PKINIT_CERT_STORE_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <krb5/krb5.h>
/*
* Opaque reference to a machine-dependent representation of a certificate
* which is capable of signing. On Mac OS X this is actually a SecIdentityRef.
*/
typedef void *krb5_pkinit_signing_cert_t;
/*
* Opaque reference to a machine-dependent representation of a certificate.
* On Mac OS X this is actually a SecCertificateRef.
*/
typedef void *krb5_pkinit_cert_t;
/*
* Opaque reference to a database in which PKINIT-related certificates are stored.
*/
typedef void *krb5_pkinit_cert_db_t;
/*
* Obtain signing cert for specified principal. On successful return,
* caller must eventually release the cert with krb5_pkinit_release_cert().
*
* Returns KRB5_PRINC_NOMATCH if client cert not found.
*/
krb5_error_code krb5_pkinit_get_client_cert(
const char *principal, /* full principal string */
krb5_pkinit_signing_cert_t *client_cert); /* RETURNED */
/*
* Determine if the specified client has a signing cert. Returns TRUE
* if so, else returns FALSE.
*/
krb5_boolean krb5_pkinit_have_client_cert(
const char *principal); /* full principal string */
/*
* Store the specified certificate (or, more likely, some platform-dependent
* reference to it) as the specified principal's signing cert. Passing
* in NULL for the client_cert has the effect of deleting the relevant entry
* in the cert storage.
*/
krb5_error_code krb5_pkinit_set_client_cert_from_signing_cert(
const char *principal, /* full principal string */
krb5_pkinit_signing_cert_t client_cert);
krb5_error_code krb5_pkinit_set_client_cert(
const char *principal, /* full principal string */
krb5_pkinit_cert_t client_cert);
/*
* Obtain a reference to the client's cert database. Specify either principal
* name or client_cert as obtained from krb5_pkinit_get_client_cert().
*/
krb5_error_code krb5_pkinit_get_client_cert_db(
const char *principal, /* optional, full principal string */
krb5_pkinit_signing_cert_t client_cert, /* optional, from krb5_pkinit_get_client_cert() */
krb5_pkinit_cert_db_t *client_cert_db); /* RETURNED */
/*
* Obtain the KDC signing cert, with optional CA and specific cert specifiers.
* CAs and cert specifiers are in the form of DER-encoded issuerAndSerialNumbers.
*
* The client_spec argument is typically provided by the client as kdcPkId.
*
* If trusted_CAs and client_spec are NULL, a platform-dependent preferred
* KDC signing cert is returned, if one exists.
*
* On successful return, caller must eventually release the cert with
* krb5_pkinit_release_cert(). Outside of an unusual test configuration this =
*
* Returns KRB5_PRINC_NOMATCH if KDC cert not found.
*
*/
krb5_error_code krb5_pkinit_get_kdc_cert(
krb5_ui_4 num_trusted_CAs, /* sizeof *trusted_CAs */
krb5_data *trusted_CAs, /* optional */
krb5_data *client_spec, /* optional */
krb5_pkinit_signing_cert_t *kdc_cert); /* RETURNED */
/*
* Obtain a reference to the KDC's cert database.
*/
krb5_error_code krb5_pkinit_get_kdc_cert_db(
krb5_pkinit_cert_db_t *kdc_cert_db); /* RETURNED */
/*
* Release certificate references obtained via krb5_pkinit_get_client_cert() and
* krb5_pkinit_get_kdc_cert().
*/
extern void krb5_pkinit_release_cert(
krb5_pkinit_signing_cert_t cert);
/*
* Release database references obtained via krb5_pkinit_get_client_cert_db() and
* krb5_pkinit_get_kdc_cert_db().
*/
extern void krb5_pkinit_release_cert_db(
krb5_pkinit_cert_db_t cert_db);
/*
* Obtain a mallocd C-string representation of a certificate's SHA1 digest.
* Only error is a NULL return indicating memory failure.
* Caller must free the returned string.
*/
char *krb5_pkinit_cert_hash_str(
const krb5_data *cert);
/*
* Obtain a client's optional list of trusted KDC CA certs (trustedCertifiers)
* and/or trusted KDC cert (kdcPkId) for a given client and server.
* All returned values are mallocd and must be freed by caller; the contents
* of the krb5_datas are DER-encoded certificates.
*/
krb5_error_code krb5_pkinit_get_server_certs(
const char *client_principal,
const char *server_principal,
krb5_data **trusted_CAs, /* RETURNED, though return value may be NULL */
krb5_ui_4 *num_trusted_CAs, /* RETURNED */
krb5_data *kdc_cert); /* RETURNED, though may be 0/NULL */
#ifdef __cplusplus
}
#endif
#endif /* _PKINIT_CERT_STORE_H_ */
|
