2 Unix SMB/CIFS implementation.
4 Kerberos backend for GENSEC
6 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004
7 Copyright (C) Andrew Tridgell 2001
8 Copyright (C) Luke Howard 2002-2003
9 Copyright (C) Stefan Metzmacher 2004-2005
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include "system/kerberos.h"
29 #include "system/time.h"
30 #include "system/network.h"
31 #include "auth/kerberos/kerberos.h"
32 #include "librpc/gen_ndr/ndr_krb5pac.h"
33 #include "auth/auth.h"
35 enum GENSEC_KRB5_STATE {
36 GENSEC_KRB5_SERVER_START,
37 GENSEC_KRB5_CLIENT_START,
38 GENSEC_KRB5_CLIENT_MUTUAL_AUTH,
42 struct gensec_krb5_state {
43 DATA_BLOB session_key;
45 enum GENSEC_KRB5_STATE state_position;
46 struct smb_krb5_context *smb_krb5_context;
47 krb5_auth_context auth_context;
50 krb5_keyblock keyblock;
54 #ifdef KRB5_DO_VERIFY_PAC
55 static NTSTATUS gensec_krb5_pac_checksum(DATA_BLOB pac_data,
56 struct PAC_SIGNATURE_DATA *sig,
57 struct gensec_krb5_state *gensec_krb5_state,
65 cksum.cksumtype = (CKSUMTYPE)sig->type;
66 cksum.checksum.length = sizeof(sig->signature);
67 cksum.checksum.data = sig->signature;
70 ret = krb5_crypto_init(gensec_krb5_state->smb_krb5_context->krb5_context,
71 &gensec_krb5_state->keyblock,
75 DEBUG(0,("krb5_crypto_init() failed\n"));
76 return NT_STATUS_FOOBAR;
78 for (i=0; i < 40; i++) {
80 ret = krb5_verify_checksum(gensec_krb5_state->smb_krb5_context->krb5_context,
87 DEBUG(0,("PAC Verified: keyusage: %d\n", keyusage));
91 krb5_crypto_destroy(gensec_krb5_state->smb_krb5_context->krb5_context, crypto);
94 DEBUG(0,("NOT verifying PAC checksums yet!\n"));
95 //return NT_STATUS_LOGON_FAILURE;
97 DEBUG(0,("PAC checksums verified!\n"));
104 static NTSTATUS gensec_krb5_decode_pac(TALLOC_CTX *mem_ctx,
105 struct PAC_LOGON_INFO **logon_info_out,
107 struct gensec_krb5_state *gensec_krb5_state)
110 struct PAC_SIGNATURE_DATA srv_sig;
111 struct PAC_SIGNATURE_DATA *srv_sig_ptr;
112 struct PAC_SIGNATURE_DATA kdc_sig;
113 struct PAC_SIGNATURE_DATA *kdc_sig_ptr;
114 struct PAC_LOGON_INFO *logon_info = NULL;
115 struct PAC_DATA pac_data;
116 #ifdef KRB5_DO_VERIFY_PAC
117 DATA_BLOB tmp_blob = data_blob(NULL, 0);
121 status = ndr_pull_struct_blob(&blob, mem_ctx, &pac_data,
122 (ndr_pull_flags_fn_t)ndr_pull_PAC_DATA);
123 if (!NT_STATUS_IS_OK(status)) {
124 DEBUG(0,("can't parse the PAC\n"));
127 NDR_PRINT_DEBUG(PAC_DATA, &pac_data);
129 if (pac_data.num_buffers < 3) {
130 /* we need logon_ingo, service_key and kdc_key */
131 DEBUG(0,("less than 3 PAC buffers\n"));
132 return NT_STATUS_FOOBAR;
135 for (i=0; i < pac_data.num_buffers; i++) {
136 switch (pac_data.buffers[i].type) {
137 case PAC_TYPE_LOGON_INFO:
138 if (!pac_data.buffers[i].info) {
141 logon_info = &pac_data.buffers[i].info->logon_info;
143 case PAC_TYPE_SRV_CHECKSUM:
144 if (!pac_data.buffers[i].info) {
147 srv_sig_ptr = &pac_data.buffers[i].info->srv_cksum;
148 srv_sig = pac_data.buffers[i].info->srv_cksum;
150 case PAC_TYPE_KDC_CHECKSUM:
151 if (!pac_data.buffers[i].info) {
154 kdc_sig_ptr = &pac_data.buffers[i].info->kdc_cksum;
155 kdc_sig = pac_data.buffers[i].info->kdc_cksum;
157 case PAC_TYPE_UNKNOWN_10:
165 DEBUG(0,("PAC no logon_info\n"));
166 return NT_STATUS_FOOBAR;
170 DEBUG(0,("PAC no srv_key\n"));
171 return NT_STATUS_FOOBAR;
175 DEBUG(0,("PAC no kdc_key\n"));
176 return NT_STATUS_FOOBAR;
178 #ifdef KRB5_DO_VERIFY_PAC
179 /* clear the kdc_key */
180 /* memset((void *)kdc_sig_ptr , '\0', sizeof(*kdc_sig_ptr));*/
182 status = ndr_push_struct_blob(&tmp_blob, mem_ctx, &pac_data,
183 (ndr_push_flags_fn_t)ndr_push_PAC_DATA);
184 if (!NT_STATUS_IS_OK(status)) {
187 status = ndr_pull_struct_blob(&tmp_blob, mem_ctx, &pac_data,
188 (ndr_pull_flags_fn_t)ndr_pull_PAC_DATA);
189 if (!NT_STATUS_IS_OK(status)) {
190 DEBUG(0,("can't parse the PAC\n"));
193 /*NDR_PRINT_DEBUG(PAC_DATA, &pac_data);*/
195 /* verify by kdc_key */
196 status = gensec_krb5_pac_checksum(tmp_blob, &kdc_sig, gensec_krb5_state, 0);
198 if (!NT_STATUS_IS_OK(status)) {
202 /* clear the service_key */
203 /* memset((void *)srv_sig_ptr , '\0', sizeof(*srv_sig_ptr));*/
205 status = ndr_push_struct_blob(&tmp_blob, mem_ctx, &pac_data,
206 (ndr_push_flags_fn_t)ndr_push_PAC_DATA);
207 if (!NT_STATUS_IS_OK(status)) {
210 status = ndr_pull_struct_blob(&tmp_blob, mem_ctx, &pac_data,
211 (ndr_pull_flags_fn_t)ndr_pull_PAC_DATA);
212 if (!NT_STATUS_IS_OK(status)) {
213 DEBUG(0,("can't parse the PAC\n"));
216 NDR_PRINT_DEBUG(PAC_DATA, &pac_data);
218 /* verify by servie_key */
219 status = gensec_krb5_pac_checksum(tmp_blob, &srv_sig, gensec_krb5_state, 0);
221 if (!NT_STATUS_IS_OK(status)) {
225 DEBUG(0,("account_name: %s [%s]\n",
226 logon_info->info3.base.account_name.string,
227 logon_info->info3.base.full_name.string));
228 *logon_info_out = logon_info;
233 static int gensec_krb5_destory(void *ptr)
235 struct gensec_krb5_state *gensec_krb5_state = ptr;
237 if (gensec_krb5_state->ticket.length) {
238 kerberos_free_data_contents(gensec_krb5_state->smb_krb5_context->krb5_context,
239 &gensec_krb5_state->ticket);
241 /* ccache freed in a child destructor */
243 krb5_free_keyblock_contents(gensec_krb5_state->smb_krb5_context->krb5_context,
244 &gensec_krb5_state->keyblock);
246 if (gensec_krb5_state->auth_context) {
247 krb5_auth_con_free(gensec_krb5_state->smb_krb5_context->krb5_context,
248 gensec_krb5_state->auth_context);
254 static NTSTATUS gensec_krb5_start(struct gensec_security *gensec_security)
256 struct gensec_krb5_state *gensec_krb5_state;
257 krb5_error_code ret = 0;
259 gensec_krb5_state = talloc(gensec_security, struct gensec_krb5_state);
260 if (!gensec_krb5_state) {
261 return NT_STATUS_NO_MEMORY;
264 gensec_security->private_data = gensec_krb5_state;
266 initialize_krb5_error_table();
267 gensec_krb5_state->auth_context = NULL;
268 gensec_krb5_state->ccache = NULL;
269 ZERO_STRUCT(gensec_krb5_state->ticket);
270 ZERO_STRUCT(gensec_krb5_state->keyblock);
271 gensec_krb5_state->session_key = data_blob(NULL, 0);
272 gensec_krb5_state->pac = data_blob(NULL, 0);
274 talloc_set_destructor(gensec_krb5_state, gensec_krb5_destory);
276 ret = smb_krb5_init_context(gensec_krb5_state,
277 &gensec_krb5_state->smb_krb5_context);
279 DEBUG(1,("gensec_krb5_start: krb5_init_context failed (%s)\n",
280 error_message(ret)));
281 return NT_STATUS_INTERNAL_ERROR;
284 ret = krb5_auth_con_init(gensec_krb5_state->smb_krb5_context->krb5_context, &gensec_krb5_state->auth_context);
286 DEBUG(1,("gensec_krb5_start: krb5_auth_con_init failed (%s)\n",
287 smb_get_krb5_error_message(gensec_krb5_state->smb_krb5_context->krb5_context,
288 ret, gensec_krb5_state)));
289 return NT_STATUS_INTERNAL_ERROR;
295 static NTSTATUS gensec_krb5_server_start(struct gensec_security *gensec_security)
298 struct gensec_krb5_state *gensec_krb5_state;
300 nt_status = gensec_krb5_start(gensec_security);
301 if (!NT_STATUS_IS_OK(nt_status)) {
305 gensec_krb5_state = gensec_security->private_data;
306 gensec_krb5_state->state_position = GENSEC_KRB5_SERVER_START;
311 static NTSTATUS gensec_krb5_client_start(struct gensec_security *gensec_security)
313 struct gensec_krb5_state *gensec_krb5_state;
316 const char *ccache_name;
318 const char *hostname = gensec_get_target_hostname(gensec_security);
320 DEBUG(1, ("Could not determine hostname for target computer, cannot use kerberos\n"));
321 return NT_STATUS_ACCESS_DENIED;
324 nt_status = gensec_krb5_start(gensec_security);
325 if (!NT_STATUS_IS_OK(nt_status)) {
329 gensec_krb5_state = gensec_security->private_data;
330 gensec_krb5_state->state_position = GENSEC_KRB5_CLIENT_START;
332 /* TODO: This is effecivly a static/global variable...
334 TODO: If the user set a username, we should use an in-memory CCACHE (see below)
336 ret = krb5_cc_default(gensec_krb5_state->smb_krb5_context->krb5_context, &gensec_krb5_state->ccache);
338 DEBUG(1,("krb5_cc_default failed (%s)\n",
339 smb_get_krb5_error_message(gensec_krb5_state->smb_krb5_context->krb5_context, ret, gensec_krb5_state)));
340 return NT_STATUS_INTERNAL_ERROR;
348 ret = krb5_mk_req(gensec_krb5_state->smb_krb5_context->krb5_context,
349 &gensec_krb5_state->auth_context,
350 AP_OPTS_USE_SUBKEY | AP_OPTS_MUTUAL_REQUIRED,
351 gensec_get_target_service(gensec_security),
353 &in_data, gensec_krb5_state->ccache,
354 &gensec_krb5_state->ticket);
360 case KRB5KDC_ERR_S_PRINCIPAL_UNKNOWN:
361 DEBUG(3, ("Server [%s] is not registered with our KDC: %s\n",
362 hostname, smb_get_krb5_error_message(gensec_krb5_state->smb_krb5_context->krb5_context, ret, gensec_krb5_state)));
363 return NT_STATUS_ACCESS_DENIED;
364 case KRB5KDC_ERR_PREAUTH_FAILED:
365 case KRB5KRB_AP_ERR_TKT_EXPIRED:
367 /* Too much clock skew - we will need to kinit to re-skew the clock */
368 case KRB5KRB_AP_ERR_SKEW:
369 case KRB5_KDCREP_SKEW:
371 DEBUG(3, ("kerberos (mk_req) failed: %s\n",
372 smb_get_krb5_error_message(gensec_krb5_state->smb_krb5_context->krb5_context, ret, gensec_krb5_state)));
373 /* fall down to remaining code */
377 /* just don't print a message for these really ordinary messages */
378 case KRB5_FCC_NOFILE:
379 case KRB5_CC_NOTFOUND:
382 nt_status = kinit_to_ccache(gensec_krb5_state,
383 gensec_security->credentials,
384 gensec_krb5_state->smb_krb5_context,
385 &gensec_krb5_state->ccache,
388 if (!NT_STATUS_IS_OK(nt_status)) {
394 DEBUG(0, ("kerberos: %s\n",
395 smb_get_krb5_error_message(gensec_krb5_state->smb_krb5_context->krb5_context, ret, gensec_krb5_state)));
396 return NT_STATUS_UNSUCCESSFUL;
403 * Check if the packet is one for this mechansim
405 * @param gensec_security GENSEC state
406 * @param in The request, as a DATA_BLOB
407 * @return Error, INVALID_PARAMETER if it's not a packet for us
408 * or NT_STATUS_OK if the packet is ok.
411 static NTSTATUS gensec_krb5_magic(struct gensec_security *gensec_security,
414 if (gensec_gssapi_check_oid(in, GENSEC_OID_KERBEROS5)) {
417 return NT_STATUS_INVALID_PARAMETER;
423 * Next state function for the Krb5 GENSEC mechanism
425 * @param gensec_krb5_state KRB5 State
426 * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
427 * @param in The request, as a DATA_BLOB
428 * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
429 * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
430 * or NT_STATUS_OK if the user is authenticated.
433 static NTSTATUS gensec_krb5_update(struct gensec_security *gensec_security,
434 TALLOC_CTX *out_mem_ctx,
435 const DATA_BLOB in, DATA_BLOB *out)
437 struct gensec_krb5_state *gensec_krb5_state = gensec_security->private_data;
438 krb5_error_code ret = 0;
442 switch (gensec_krb5_state->state_position) {
443 case GENSEC_KRB5_CLIENT_START:
446 DEBUG(1,("ads_krb5_mk_req (request ticket) failed (%s)\n",
447 smb_get_krb5_error_message(gensec_krb5_state->smb_krb5_context->krb5_context, ret, out_mem_ctx)));
448 nt_status = NT_STATUS_LOGON_FAILURE;
450 DATA_BLOB unwrapped_out;
452 #ifndef GENSEC_SEND_UNWRAPPED_KRB5 /* This should be a switch for the torture code to set */
453 unwrapped_out = data_blob_talloc(out_mem_ctx, gensec_krb5_state->ticket.data, gensec_krb5_state->ticket.length);
455 /* wrap that up in a nice GSS-API wrapping */
456 *out = gensec_gssapi_gen_krb5_wrap(out_mem_ctx, &unwrapped_out, TOK_ID_KRB_AP_REQ);
458 *out = data_blob_talloc(out_mem_ctx, gensec_krb5_state->ticket.data, gensec_krb5_state->ticket.length);
460 gensec_krb5_state->state_position = GENSEC_KRB5_CLIENT_MUTUAL_AUTH;
461 nt_status = NT_STATUS_MORE_PROCESSING_REQUIRED;
467 case GENSEC_KRB5_CLIENT_MUTUAL_AUTH:
470 krb5_ap_rep_enc_part *repl = NULL;
472 DATA_BLOB unwrapped_in;
474 if (!gensec_gssapi_parse_krb5_wrap(out_mem_ctx, &in, &unwrapped_in, tok_id)) {
475 DEBUG(1,("gensec_gssapi_parse_krb5_wrap(mutual authentication) failed to parse\n"));
476 dump_data_pw("Mutual authentication message:\n", in.data, in.length);
477 return NT_STATUS_INVALID_PARAMETER;
479 /* TODO: check the tok_id */
481 inbuf.data = unwrapped_in.data;
482 inbuf.length = unwrapped_in.length;
483 ret = krb5_rd_rep(gensec_krb5_state->smb_krb5_context->krb5_context,
484 gensec_krb5_state->auth_context,
487 DEBUG(1,("krb5_rd_rep (mutual authentication) failed (%s)\n",
488 smb_get_krb5_error_message(gensec_krb5_state->smb_krb5_context->krb5_context, ret, out_mem_ctx)));
489 dump_data_pw("Mutual authentication message:\n", inbuf.data, inbuf.length);
490 nt_status = NT_STATUS_ACCESS_DENIED;
492 *out = data_blob(NULL, 0);
493 nt_status = NT_STATUS_OK;
494 gensec_krb5_state->state_position = GENSEC_KRB5_DONE;
497 krb5_free_ap_rep_enc_part(gensec_krb5_state->smb_krb5_context->krb5_context, repl);
502 case GENSEC_KRB5_SERVER_START:
505 DATA_BLOB unwrapped_in;
506 DATA_BLOB unwrapped_out = data_blob(NULL, 0);
510 *out = unwrapped_out;
511 return NT_STATUS_MORE_PROCESSING_REQUIRED;
514 /* Parse the GSSAPI wrapping, if it's there... (win2k3 allows it to be omited) */
515 if (!gensec_gssapi_parse_krb5_wrap(out_mem_ctx, &in, &unwrapped_in, tok_id)) {
516 nt_status = ads_verify_ticket(out_mem_ctx,
517 gensec_krb5_state->smb_krb5_context,
518 gensec_krb5_state->auth_context,
520 gensec_get_target_service(gensec_security), &in,
521 &principal, &pac, &unwrapped_out,
522 &gensec_krb5_state->keyblock);
524 /* TODO: check the tok_id */
525 nt_status = ads_verify_ticket(out_mem_ctx,
526 gensec_krb5_state->smb_krb5_context,
527 gensec_krb5_state->auth_context,
529 gensec_get_target_service(gensec_security),
531 &principal, &pac, &unwrapped_out,
532 &gensec_krb5_state->keyblock);
535 if (!NT_STATUS_IS_OK(nt_status)) {
540 gensec_krb5_state->pac = data_blob_talloc_reference(gensec_krb5_state, &pac);
543 if (NT_STATUS_IS_OK(nt_status)) {
544 gensec_krb5_state->state_position = GENSEC_KRB5_DONE;
545 /* wrap that up in a nice GSS-API wrapping */
546 #ifndef GENSEC_SEND_UNWRAPPED_KRB5
547 *out = gensec_gssapi_gen_krb5_wrap(out_mem_ctx, &unwrapped_out, TOK_ID_KRB_AP_REP);
549 *out = unwrapped_out;
551 gensec_krb5_state->peer_principal = talloc_steal(gensec_krb5_state, principal);
555 case GENSEC_KRB5_DONE:
559 return NT_STATUS_INVALID_PARAMETER;
562 static NTSTATUS gensec_krb5_session_key(struct gensec_security *gensec_security,
563 DATA_BLOB *session_key)
565 struct gensec_krb5_state *gensec_krb5_state = gensec_security->private_data;
566 krb5_context context = gensec_krb5_state->smb_krb5_context->krb5_context;
567 krb5_auth_context auth_context = gensec_krb5_state->auth_context;
571 if (gensec_krb5_state->session_key.data) {
572 *session_key = gensec_krb5_state->session_key;
576 switch (gensec_security->gensec_role) {
578 err = krb5_auth_con_getlocalsubkey(context, auth_context, &skey);
581 err = krb5_auth_con_getremotesubkey(context, auth_context, &skey);
584 if (err == 0 && skey != NULL) {
585 DEBUG(10, ("Got KRB5 session key of length %d\n", KRB5_KEY_LENGTH(skey)));
586 gensec_krb5_state->session_key = data_blob_talloc(gensec_krb5_state,
587 KRB5_KEY_DATA(skey), KRB5_KEY_LENGTH(skey));
588 *session_key = gensec_krb5_state->session_key;
589 dump_data_pw("KRB5 Session Key:\n", session_key->data, session_key->length);
591 krb5_free_keyblock(context, skey);
594 DEBUG(10, ("KRB5 error getting session key %d\n", err));
595 return NT_STATUS_NO_USER_SESSION_KEY;
599 static NTSTATUS gensec_krb5_session_info(struct gensec_security *gensec_security,
600 struct auth_session_info **_session_info)
603 struct gensec_krb5_state *gensec_krb5_state = gensec_security->private_data;
604 struct auth_serversupplied_info *server_info = NULL;
605 struct auth_session_info *session_info = NULL;
606 struct PAC_LOGON_INFO *logon_info;
609 const char *account_name;
612 principal = talloc_strdup(gensec_krb5_state, gensec_krb5_state->peer_principal);
613 NT_STATUS_HAVE_NO_MEMORY(principal);
615 p = strchr(principal, '@');
623 account_name = principal;
625 /* decode and verify the pac */
626 nt_status = gensec_krb5_decode_pac(gensec_krb5_state, &logon_info, gensec_krb5_state->pac,
629 /* IF we have the PAC - otherwise we need to get this
630 * data from elsewere - local ldb, or (TODO) lookup of some
633 * when heimdal can generate the PAC, we should fail if there's
637 if (NT_STATUS_IS_OK(nt_status)) {
638 union netr_Validation validation;
639 validation.sam3 = &logon_info->info3;
640 nt_status = make_server_info_netlogon_validation(gensec_krb5_state,
644 talloc_free(principal);
645 NT_STATUS_NOT_OK_RETURN(nt_status);
647 DATA_BLOB user_sess_key = data_blob(NULL, 0);
648 DATA_BLOB lm_sess_key = data_blob(NULL, 0);
649 /* TODO: should we pass the krb5 session key in here? */
650 nt_status = sam_get_server_info(gensec_krb5_state, account_name, realm,
651 user_sess_key, lm_sess_key,
653 talloc_free(principal);
654 NT_STATUS_NOT_OK_RETURN(nt_status);
657 /* references the server_info into the session_info */
658 nt_status = auth_generate_session_info(gensec_krb5_state, server_info, &session_info);
659 talloc_free(server_info);
660 NT_STATUS_NOT_OK_RETURN(nt_status);
662 nt_status = gensec_krb5_session_key(gensec_security, &session_info->session_key);
663 NT_STATUS_NOT_OK_RETURN(nt_status);
665 *_session_info = session_info;
670 static BOOL gensec_krb5_have_feature(struct gensec_security *gensec_security,
673 if (feature & GENSEC_FEATURE_SESSION_KEY) {
680 static const char *gensec_krb5_oids[] = {
681 GENSEC_OID_KERBEROS5,
682 GENSEC_OID_KERBEROS5_OLD,
686 static const struct gensec_security_ops gensec_krb5_security_ops = {
688 .auth_type = DCERPC_AUTH_TYPE_KRB5,
689 .oid = gensec_krb5_oids,
690 .client_start = gensec_krb5_client_start,
691 .server_start = gensec_krb5_server_start,
692 .magic = gensec_krb5_magic,
693 .update = gensec_krb5_update,
694 .session_key = gensec_krb5_session_key,
695 .session_info = gensec_krb5_session_info,
696 .have_feature = gensec_krb5_have_feature,
700 NTSTATUS gensec_krb5_init(void)
704 ret = gensec_register(&gensec_krb5_security_ops);
705 if (!NT_STATUS_IS_OK(ret)) {
706 DEBUG(0,("Failed to register '%s' gensec backend!\n",
707 gensec_krb5_security_ops.name));