lib: Add messaging_send_all
[Samba.git] / auth / kerberos / gssapi_pac.c
blob253976aecdf2bfeed70b0d108031a063d0695c6d
1 /*
2 Unix SMB/CIFS implementation.
3 kerberos authorization data (PAC) utility library
4 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2011
5 Copyright (C) Simo Sorce 2010.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "includes.h"
22 #ifdef HAVE_KRB5
24 #include "auth/kerberos/pac_utils.h"
26 #if 0
27 /* FIXME - need proper configure/waf test
28 * to determine if gss_mech_krb5 and friends
29 * exist. JRA.
32 * These are not exported by Solaris -lkrb5
33 * Maybe move to libreplace somewhere?
35 static const gss_OID_desc krb5_gss_oid_array[] = {
36 /* this is the official, rfc-specified OID */
37 { 9, "\052\206\110\206\367\022\001\002\002" },
38 /* this is the pre-RFC mech OID */
39 { 5, "\053\005\001\005\002" },
40 /* this is the unofficial, incorrect mech OID emitted by MS */
41 { 9, "\052\206\110\202\367\022\001\002\002" },
42 { 0, 0 }
45 const gss_OID_desc * const gss_mech_krb5 = krb5_gss_oid_array+0;
46 const gss_OID_desc * const gss_mech_krb5_old = krb5_gss_oid_array+1;
47 const gss_OID_desc * const gss_mech_krb5_wrong = krb5_gss_oid_array+2;
48 #endif
50 #ifndef GSS_KRB5_INQ_SSPI_SESSION_KEY_OID
51 #define GSS_KRB5_INQ_SSPI_SESSION_KEY_OID_LENGTH 11
52 #define GSS_KRB5_INQ_SSPI_SESSION_KEY_OID "\x2a\x86\x48\x86\xf7\x12\x01\x02\x02\x05\x05"
53 #endif
55 gss_OID_desc gse_sesskey_inq_oid = {
56 GSS_KRB5_INQ_SSPI_SESSION_KEY_OID_LENGTH,
57 discard_const(GSS_KRB5_INQ_SSPI_SESSION_KEY_OID)
60 #ifndef GSS_KRB5_SESSION_KEY_ENCTYPE_OID
61 #define GSS_KRB5_SESSION_KEY_ENCTYPE_OID_LENGTH 10
62 #define GSS_KRB5_SESSION_KEY_ENCTYPE_OID "\x2a\x86\x48\x86\xf7\x12\x01\x02\x02\x04"
63 #endif
65 gss_OID_desc gse_sesskeytype_oid = {
66 GSS_KRB5_SESSION_KEY_ENCTYPE_OID_LENGTH,
67 discard_const(GSS_KRB5_SESSION_KEY_ENCTYPE_OID)
70 /* The Heimdal OID for getting the PAC */
71 #define EXTRACT_PAC_AUTHZ_DATA_FROM_SEC_CONTEXT_OID_LENGTH 8
72 /* EXTRACTION OID AUTHZ ID */
73 #define EXTRACT_PAC_AUTHZ_DATA_FROM_SEC_CONTEXT_OID "\x2a\x85\x70\x2b\x0d\x03" "\x81\x00"
75 NTSTATUS gssapi_obtain_pac_blob(TALLOC_CTX *mem_ctx,
76 gss_ctx_id_t gssapi_context,
77 gss_name_t gss_client_name,
78 DATA_BLOB *pac_blob)
80 NTSTATUS status;
81 OM_uint32 gss_maj, gss_min;
82 #ifdef HAVE_GSS_GET_NAME_ATTRIBUTE
84 * gss_get_name_attribute() in MIT krb5 1.10.0 can return unintialized pac_display_buffer
85 * and later gss_release_buffer() will crash on attempting to release it.
87 * So always initialize the buffer descriptors.
89 * See following links for more details:
90 * http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=658514
91 * http://krbdev.mit.edu/rt/Ticket/Display.html?user=guest&pass=guest&id=7087
93 gss_buffer_desc pac_buffer = {
94 .value = NULL,
95 .length = 0
97 gss_buffer_desc pac_display_buffer = {
98 .value = NULL,
99 .length = 0
101 gss_buffer_desc pac_name = {
102 .value = discard_const("urn:mspac:"),
103 .length = sizeof("urn:mspac:")-1
105 int more = -1;
106 int authenticated = false;
107 int complete = false;
109 gss_maj = gss_get_name_attribute(
110 &gss_min, gss_client_name, &pac_name,
111 &authenticated, &complete,
112 &pac_buffer, &pac_display_buffer, &more);
114 if (gss_maj != 0) {
115 gss_OID oid = discard_const(gss_mech_krb5);
116 DBG_NOTICE("obtaining PAC via GSSAPI gss_get_name_attribute "
117 "failed: %s\n", gssapi_error_string(mem_ctx,
118 gss_maj, gss_min,
119 oid));
120 return NT_STATUS_ACCESS_DENIED;
121 } else if (authenticated && complete) {
122 /* The PAC blob is returned directly */
123 *pac_blob = data_blob_talloc(mem_ctx, pac_buffer.value,
124 pac_buffer.length);
126 if (!pac_blob->data) {
127 status = NT_STATUS_NO_MEMORY;
128 } else {
129 status = NT_STATUS_OK;
132 gss_maj = gss_release_buffer(&gss_min, &pac_buffer);
133 gss_maj = gss_release_buffer(&gss_min, &pac_display_buffer);
134 return status;
135 } else {
136 DEBUG(0, ("obtaining PAC via GSSAPI failed: authenticated: %s, complete: %s, more: %s\n",
137 authenticated ? "true" : "false",
138 complete ? "true" : "false",
139 more ? "true" : "false"));
140 return NT_STATUS_ACCESS_DENIED;
143 #elif defined(HAVE_GSS_INQUIRE_SEC_CONTEXT_BY_OID)
144 gss_OID_desc pac_data_oid = {
145 .elements = discard_const(EXTRACT_PAC_AUTHZ_DATA_FROM_SEC_CONTEXT_OID),
146 .length = EXTRACT_PAC_AUTHZ_DATA_FROM_SEC_CONTEXT_OID_LENGTH
149 gss_buffer_set_t set = GSS_C_NO_BUFFER_SET;
151 /* If we didn't have the routine to get a verified, validated
152 * PAC (supplied only by MIT at the time of writing), then try
153 * with the Heimdal OID (fetches the PAC directly and always
154 * validates) */
155 gss_maj = gss_inquire_sec_context_by_oid(
156 &gss_min, gssapi_context,
157 &pac_data_oid, &set);
159 /* First check for the error MIT gives for an unknown OID */
160 if (gss_maj == GSS_S_UNAVAILABLE) {
161 DEBUG(1, ("unable to obtain a PAC against this GSSAPI library. "
162 "GSSAPI secured connections are available only with Heimdal or MIT Kerberos >= 1.8\n"));
163 } else if (gss_maj != 0) {
164 DEBUG(2, ("obtaining PAC via GSSAPI gss_inqiure_sec_context_by_oid (Heimdal OID) failed: %s\n",
165 gssapi_error_string(mem_ctx, gss_maj, gss_min, gss_mech_krb5)));
166 } else {
167 if (set == GSS_C_NO_BUFFER_SET) {
168 DEBUG(0, ("gss_inquire_sec_context_by_oid returned unknown "
169 "data in results.\n"));
170 return NT_STATUS_INTERNAL_ERROR;
173 /* The PAC blob is returned directly */
174 *pac_blob = data_blob_talloc(mem_ctx, set->elements[0].value,
175 set->elements[0].length);
176 if (!pac_blob->data) {
177 status = NT_STATUS_NO_MEMORY;
178 } else {
179 status = NT_STATUS_OK;
182 gss_maj = gss_release_buffer_set(&gss_min, &set);
183 return status;
185 #else
186 DEBUG(1, ("unable to obtain a PAC against this GSSAPI library. "
187 "GSSAPI secured connections are available only with Heimdal or MIT Kerberos >= 1.8\n"));
188 #endif
189 return NT_STATUS_ACCESS_DENIED;
192 NTSTATUS gssapi_get_session_key(TALLOC_CTX *mem_ctx,
193 gss_ctx_id_t gssapi_context,
194 DATA_BLOB *session_key,
195 uint32_t *keytype)
197 OM_uint32 gss_min, gss_maj;
198 gss_buffer_set_t set = GSS_C_NO_BUFFER_SET;
200 gss_maj = gss_inquire_sec_context_by_oid(
201 &gss_min, gssapi_context,
202 &gse_sesskey_inq_oid, &set);
203 if (gss_maj) {
204 DEBUG(0, ("gss_inquire_sec_context_by_oid failed [%s]\n",
205 gssapi_error_string(mem_ctx,
206 gss_maj,
207 gss_min,
208 discard_const_p(struct gss_OID_desc_struct,
209 gss_mech_krb5))));
210 return NT_STATUS_NO_USER_SESSION_KEY;
213 if ((set == GSS_C_NO_BUFFER_SET) ||
214 (set->count == 0)) {
215 #ifdef HAVE_GSSKRB5_GET_SUBKEY
216 krb5_keyblock *subkey;
217 gss_maj = gsskrb5_get_subkey(&gss_min,
218 gssapi_context,
219 &subkey);
220 if (gss_maj != 0) {
221 DEBUG(1, ("NO session key for this mech\n"));
222 return NT_STATUS_NO_USER_SESSION_KEY;
224 if (session_key) {
225 *session_key = data_blob_talloc(mem_ctx,
226 KRB5_KEY_DATA(subkey), KRB5_KEY_LENGTH(subkey));
228 if (keytype) {
229 *keytype = KRB5_KEY_TYPE(subkey);
231 krb5_free_keyblock(NULL /* should be krb5_context */, subkey);
232 return NT_STATUS_OK;
233 #else
234 DEBUG(0, ("gss_inquire_sec_context_by_oid didn't return any session key (and no alternative method available)\n"));
235 return NT_STATUS_NO_USER_SESSION_KEY;
236 #endif
239 if (session_key) {
240 *session_key = data_blob_talloc(mem_ctx, set->elements[0].value,
241 set->elements[0].length);
244 if (keytype) {
245 int diflen, i;
246 const uint8_t *p;
248 *keytype = 0;
249 if (set->count < 2) {
251 #ifdef HAVE_GSSKRB5_GET_SUBKEY
252 krb5_keyblock *subkey;
253 gss_maj = gsskrb5_get_subkey(&gss_min,
254 gssapi_context,
255 &subkey);
256 if (gss_maj == 0) {
257 *keytype = KRB5_KEY_TYPE(subkey);
258 krb5_free_keyblock(NULL /* should be krb5_context */, subkey);
260 #endif
261 gss_maj = gss_release_buffer_set(&gss_min, &set);
263 return NT_STATUS_OK;
265 } else if (memcmp(set->elements[1].value,
266 gse_sesskeytype_oid.elements,
267 gse_sesskeytype_oid.length) != 0) {
268 /* Perhaps a non-krb5 session key */
269 gss_maj = gss_release_buffer_set(&gss_min, &set);
270 return NT_STATUS_OK;
272 p = (const uint8_t *)set->elements[1].value + gse_sesskeytype_oid.length;
273 diflen = set->elements[1].length - gse_sesskeytype_oid.length;
274 if (diflen <= 0) {
275 gss_maj = gss_release_buffer_set(&gss_min, &set);
276 return NT_STATUS_INVALID_PARAMETER;
278 for (i = 0; i < diflen; i++) {
279 *keytype = (*keytype << 7) | (p[i] & 0x7f);
280 if (i + 1 != diflen && (p[i] & 0x80) == 0) {
281 gss_maj = gss_release_buffer_set(&gss_min, &set);
282 return NT_STATUS_INVALID_PARAMETER;
287 gss_maj = gss_release_buffer_set(&gss_min, &set);
288 return NT_STATUS_OK;
292 char *gssapi_error_string(TALLOC_CTX *mem_ctx,
293 OM_uint32 maj_stat, OM_uint32 min_stat,
294 const gss_OID mech)
296 OM_uint32 disp_min_stat, disp_maj_stat;
297 gss_buffer_desc maj_error_message;
298 gss_buffer_desc min_error_message;
299 char *maj_error_string, *min_error_string;
300 OM_uint32 msg_ctx = 0;
302 char *ret;
304 maj_error_message.value = NULL;
305 min_error_message.value = NULL;
306 maj_error_message.length = 0;
307 min_error_message.length = 0;
309 disp_maj_stat = gss_display_status(&disp_min_stat, maj_stat,
310 GSS_C_GSS_CODE, mech,
311 &msg_ctx, &maj_error_message);
312 if (disp_maj_stat != 0) {
313 maj_error_message.value = NULL;
314 maj_error_message.length = 0;
316 disp_maj_stat = gss_display_status(&disp_min_stat, min_stat,
317 GSS_C_MECH_CODE, mech,
318 &msg_ctx, &min_error_message);
319 if (disp_maj_stat != 0) {
320 min_error_message.value = NULL;
321 min_error_message.length = 0;
324 maj_error_string = talloc_strndup(mem_ctx,
325 (char *)maj_error_message.value,
326 maj_error_message.length);
328 min_error_string = talloc_strndup(mem_ctx,
329 (char *)min_error_message.value,
330 min_error_message.length);
332 ret = talloc_asprintf(mem_ctx, "%s: %s",
333 maj_error_string, min_error_string);
335 talloc_free(maj_error_string);
336 talloc_free(min_error_string);
338 gss_release_buffer(&disp_min_stat, &maj_error_message);
339 gss_release_buffer(&disp_min_stat, &min_error_message);
341 return ret;
344 #endif /* HAVE_KRB5 */