2 Unix SMB/CIFS implementation.
4 RFC2478 Compliant SPNEGO implementation
6 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
7 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #define DBGC_CLASS DBGC_AUTH
30 enum spnego_state_position {
41 enum spnego_message_type expected_packet;
42 enum spnego_state_position state_position;
43 struct gensec_security *sub_sec_security;
46 static NTSTATUS gensec_spnego_client_start(struct gensec_security *gensec_security)
48 struct spnego_state *spnego_state;
50 spnego_state = talloc_p(gensec_security, struct spnego_state);
52 return NT_STATUS_NO_MEMORY;
55 spnego_state->expected_packet = SPNEGO_NEG_TOKEN_INIT;
56 spnego_state->state_position = SPNEGO_CLIENT_START;
57 spnego_state->sub_sec_security = NULL;
59 gensec_security->private_data = spnego_state;
63 static NTSTATUS gensec_spnego_server_start(struct gensec_security *gensec_security)
65 struct spnego_state *spnego_state;
67 spnego_state = talloc_p(gensec_security, struct spnego_state);
69 return NT_STATUS_NO_MEMORY;
72 spnego_state->expected_packet = SPNEGO_NEG_TOKEN_INIT;
73 spnego_state->state_position = SPNEGO_SERVER_START;
74 spnego_state->sub_sec_security = NULL;
76 gensec_security->private_data = spnego_state;
81 wrappers for the spnego_*() functions
83 static NTSTATUS gensec_spnego_unseal_packet(struct gensec_security *gensec_security,
85 uint8_t *data, size_t length,
86 const uint8_t *whole_pdu, size_t pdu_length,
89 struct spnego_state *spnego_state = gensec_security->private_data;
91 if (spnego_state->state_position != SPNEGO_DONE
92 && spnego_state->state_position != SPNEGO_FALLBACK) {
93 return NT_STATUS_INVALID_PARAMETER;
96 return gensec_unseal_packet(spnego_state->sub_sec_security,
99 whole_pdu, pdu_length,
103 static NTSTATUS gensec_spnego_check_packet(struct gensec_security *gensec_security,
105 const uint8_t *data, size_t length,
106 const uint8_t *whole_pdu, size_t pdu_length,
107 const DATA_BLOB *sig)
109 struct spnego_state *spnego_state = gensec_security->private_data;
111 return NT_STATUS_NOT_IMPLEMENTED;
112 if (spnego_state->state_position != SPNEGO_DONE
113 && spnego_state->state_position != SPNEGO_FALLBACK) {
114 return NT_STATUS_INVALID_PARAMETER;
117 return gensec_check_packet(spnego_state->sub_sec_security,
120 whole_pdu, pdu_length,
124 static NTSTATUS gensec_spnego_seal_packet(struct gensec_security *gensec_security,
126 uint8_t *data, size_t length,
127 const uint8_t *whole_pdu, size_t pdu_length,
130 struct spnego_state *spnego_state = gensec_security->private_data;
132 return NT_STATUS_NOT_IMPLEMENTED;
133 if (spnego_state->state_position != SPNEGO_DONE
134 && spnego_state->state_position != SPNEGO_FALLBACK) {
135 return NT_STATUS_INVALID_PARAMETER;
138 return gensec_seal_packet(spnego_state->sub_sec_security,
141 whole_pdu, pdu_length,
145 static NTSTATUS gensec_spnego_sign_packet(struct gensec_security *gensec_security,
147 const uint8_t *data, size_t length,
148 const uint8_t *whole_pdu, size_t pdu_length,
151 struct spnego_state *spnego_state = gensec_security->private_data;
153 if (spnego_state->state_position != SPNEGO_DONE
154 && spnego_state->state_position != SPNEGO_FALLBACK) {
155 return NT_STATUS_INVALID_PARAMETER;
158 return gensec_sign_packet(spnego_state->sub_sec_security,
161 whole_pdu, pdu_length,
165 static size_t gensec_spnego_sig_size(struct gensec_security *gensec_security)
167 struct spnego_state *spnego_state = gensec_security->private_data;
169 if (spnego_state->state_position != SPNEGO_DONE
170 && spnego_state->state_position != SPNEGO_FALLBACK) {
174 return gensec_sig_size(spnego_state->sub_sec_security);
177 static NTSTATUS gensec_spnego_session_key(struct gensec_security *gensec_security,
178 DATA_BLOB *session_key)
180 struct spnego_state *spnego_state = gensec_security->private_data;
181 if (!spnego_state->sub_sec_security) {
182 return NT_STATUS_INVALID_PARAMETER;
185 return gensec_session_key(spnego_state->sub_sec_security,
189 static NTSTATUS gensec_spnego_session_info(struct gensec_security *gensec_security,
190 struct auth_session_info **session_info)
192 struct spnego_state *spnego_state = gensec_security->private_data;
193 if (!spnego_state->sub_sec_security) {
194 return NT_STATUS_INVALID_PARAMETER;
197 return gensec_session_info(spnego_state->sub_sec_security,
201 /** Fallback to another GENSEC mechanism, based on magic strings
203 * This is the 'fallback' case, where we don't get SPNEGO, and have to
204 * try all the other options (and hope they all have a magic string
208 static NTSTATUS gensec_spnego_server_try_fallback(struct gensec_security *gensec_security,
209 struct spnego_state *spnego_state,
210 TALLOC_CTX *out_mem_ctx,
211 const DATA_BLOB in, DATA_BLOB *out)
215 const struct gensec_security_ops **all_ops = gensec_security_all(&num_ops);
216 for (i=0; i < num_ops; i++) {
218 if (!all_ops[i]->oid) {
221 nt_status = gensec_subcontext_start(gensec_security,
222 &spnego_state->sub_sec_security);
223 if (!NT_STATUS_IS_OK(nt_status)) {
226 /* select the sub context */
227 nt_status = gensec_start_mech_by_oid(spnego_state->sub_sec_security,
229 if (!NT_STATUS_IS_OK(nt_status)) {
230 gensec_end(&spnego_state->sub_sec_security);
233 nt_status = gensec_update(spnego_state->sub_sec_security,
234 out_mem_ctx, in, out);
235 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
236 spnego_state->state_position = SPNEGO_FALLBACK;
239 gensec_end(&spnego_state->sub_sec_security);
241 DEBUG(1, ("Failed to parse SPNEGO request\n"));
242 return NT_STATUS_INVALID_PARAMETER;
246 static NTSTATUS gensec_spnego_parse_negTokenInit(struct gensec_security *gensec_security,
247 struct spnego_state *spnego_state,
248 TALLOC_CTX *out_mem_ctx,
249 const char **mechType,
250 const DATA_BLOB unwrapped_in, DATA_BLOB *unwrapped_out)
254 DATA_BLOB null_data_blob = data_blob(NULL,0);
256 for (i=0; mechType && mechType[i]; i++) {
257 nt_status = gensec_subcontext_start(gensec_security,
258 &spnego_state->sub_sec_security);
259 if (!NT_STATUS_IS_OK(nt_status)) {
262 /* select the sub context */
263 nt_status = gensec_start_mech_by_oid(spnego_state->sub_sec_security,
265 if (!NT_STATUS_IS_OK(nt_status)) {
266 gensec_end(&spnego_state->sub_sec_security);
271 nt_status = gensec_update(spnego_state->sub_sec_security,
276 /* only get the helping start blob for the first OID */
277 nt_status = gensec_update(spnego_state->sub_sec_security,
282 if (!NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)
283 && (!NT_STATUS_IS_OK(nt_status))) {
284 DEBUG(1, ("SPNEGO(%s) NEG_TOKEN_INIT failed: %s\n",
285 spnego_state->sub_sec_security->ops->name, nt_errstr(nt_status)));
286 gensec_end(&spnego_state->sub_sec_security);
291 if (!mechType || !mechType[i]) {
292 DEBUG(1, ("SPNEGO: Could not find a suitable mechtype in NEG_TOKEN_INIT\n"));
297 /** create a client negTokenInit
299 * This is the case, where the client is the first one who sends data
302 static NTSTATUS gensec_spnego_client_negTokenInit(struct gensec_security *gensec_security,
303 struct spnego_state *spnego_state,
304 TALLOC_CTX *out_mem_ctx,
305 const DATA_BLOB in, DATA_BLOB *out)
307 DATA_BLOB null_data_blob = data_blob(NULL,0);
309 const char **mechTypes = NULL;
310 DATA_BLOB unwrapped_out = data_blob(NULL,0);
312 mechTypes = gensec_security_oids(out_mem_ctx, OID_SPNEGO);
315 DEBUG(1, ("no GENSEC OID backends available\n"));
316 return NT_STATUS_INVALID_PARAMETER;
319 nt_status = gensec_subcontext_start(gensec_security,
320 &spnego_state->sub_sec_security);
321 if (!NT_STATUS_IS_OK(nt_status)) {
324 /* select our preferred mech */
325 nt_status = gensec_start_mech_by_oid(spnego_state->sub_sec_security,
327 if (!NT_STATUS_IS_OK(nt_status)) {
328 gensec_end(&spnego_state->sub_sec_security);
331 nt_status = gensec_update(spnego_state->sub_sec_security,
332 out_mem_ctx, in, &unwrapped_out);
333 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
334 struct spnego_data spnego_out;
335 spnego_out.type = SPNEGO_NEG_TOKEN_INIT;
336 spnego_out.negTokenInit.mechTypes = mechTypes;
337 spnego_out.negTokenInit.reqFlags = 0;
338 spnego_out.negTokenInit.mechListMIC = null_data_blob;
339 spnego_out.negTokenInit.mechToken = unwrapped_out;
341 if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
342 DEBUG(1, ("Failed to write SPNEGO reply to NEG_TOKEN_INIT\n"));
343 return NT_STATUS_INVALID_PARAMETER;
347 spnego_state->expected_packet = SPNEGO_NEG_TOKEN_TARG;
348 spnego_state->state_position = SPNEGO_CLIENT_TARG;
351 gensec_end(&spnego_state->sub_sec_security);
353 DEBUG(1, ("Failed to setup SPNEGO netTokenInit request\n"));
354 return NT_STATUS_INVALID_PARAMETER;
358 /** create a client negTokenTarg
360 * This is the case, where the client is the first one who sends data
363 static NTSTATUS gensec_spnego_server_negTokenTarg(struct gensec_security *gensec_security,
364 struct spnego_state *spnego_state,
365 TALLOC_CTX *out_mem_ctx,
367 const DATA_BLOB unwrapped_out, DATA_BLOB *out)
369 struct spnego_data spnego_out;
370 DATA_BLOB null_data_blob = data_blob(NULL, 0);
373 spnego_out.type = SPNEGO_NEG_TOKEN_TARG;
374 spnego_out.negTokenTarg.supportedMech
375 = spnego_state->sub_sec_security->ops->oid;
376 spnego_out.negTokenTarg.responseToken = unwrapped_out;
377 spnego_out.negTokenTarg.mechListMIC = null_data_blob;
379 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
380 spnego_out.negTokenTarg.negResult = SPNEGO_ACCEPT_INCOMPLETE;
381 spnego_state->state_position = SPNEGO_SERVER_TARG;
382 } else if (NT_STATUS_IS_OK(nt_status)) {
383 spnego_out.negTokenTarg.negResult = SPNEGO_ACCEPT_COMPLETED;
384 spnego_state->state_position = SPNEGO_DONE;
386 spnego_out.negTokenTarg.negResult = SPNEGO_REJECT;
387 DEBUG(1, ("SPNEGO(%s) login failed: %s\n",
388 spnego_state->sub_sec_security->ops->name,
389 nt_errstr(nt_status)));
390 spnego_state->state_position = SPNEGO_DONE;
393 if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
394 DEBUG(1, ("Failed to write SPNEGO reply to NEG_TOKEN_TARG\n"));
395 return NT_STATUS_INVALID_PARAMETER;
398 spnego_state->expected_packet = SPNEGO_NEG_TOKEN_TARG;
404 static NTSTATUS gensec_spnego_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
405 const DATA_BLOB in, DATA_BLOB *out)
407 struct spnego_state *spnego_state = gensec_security->private_data;
408 DATA_BLOB null_data_blob = data_blob(NULL, 0);
409 DATA_BLOB unwrapped_out = data_blob(NULL, 0);
410 struct spnego_data spnego_out;
411 struct spnego_data spnego;
415 *out = data_blob(NULL, 0);
418 out_mem_ctx = spnego_state;
421 /* and switch into the state machine */
423 switch (spnego_state->state_position) {
424 case SPNEGO_FALLBACK:
425 return gensec_update(spnego_state->sub_sec_security,
426 out_mem_ctx, in, out);
427 case SPNEGO_SERVER_START:
432 len = spnego_read_data(in, &spnego);
434 return gensec_spnego_server_try_fallback(gensec_security, spnego_state, out_mem_ctx, in, out);
436 /* client sent NegTargetInit, we send NegTokenTarg */
438 /* OK, so it's real SPNEGO, check the packet's the one we expect */
439 if (spnego.type != spnego_state->expected_packet) {
440 DEBUG(1, ("Invalid SPNEGO request: %d, expected %d\n", spnego.type,
441 spnego_state->expected_packet));
442 dump_data(1, (const char *)in.data, in.length);
443 spnego_free_data(&spnego);
444 return NT_STATUS_INVALID_PARAMETER;
447 nt_status = gensec_spnego_parse_negTokenInit(gensec_security,
450 spnego.negTokenInit.mechTypes,
451 spnego.negTokenInit.mechToken,
454 nt_status = gensec_spnego_server_negTokenTarg(gensec_security,
461 spnego_free_data(&spnego);
465 const char **mechlist = gensec_security_oids(out_mem_ctx, OID_SPNEGO);
467 spnego_out.type = SPNEGO_NEG_TOKEN_INIT;
468 spnego_out.negTokenInit.mechTypes = mechlist;
469 spnego_out.negTokenInit.reqFlags = 0;
470 spnego_out.negTokenInit.mechListMIC = null_data_blob;
471 spnego_out.negTokenInit.mechToken = unwrapped_out;
473 if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
474 DEBUG(1, ("Failed to write SPNEGO reply to NEG_TOKEN_INIT\n"));
475 return NT_STATUS_INVALID_PARAMETER;
479 spnego_state->expected_packet = SPNEGO_NEG_TOKEN_TARG;
480 spnego_state->state_position = SPNEGO_SERVER_TARG;
482 return NT_STATUS_MORE_PROCESSING_REQUIRED;
486 case SPNEGO_CLIENT_START:
488 /* The server offers a list of mechanisms */
490 char *my_mechs[] = {NULL, NULL};
491 NTSTATUS nt_status = NT_STATUS_INVALID_PARAMETER;
494 /* client to produce negTokenInit */
495 return gensec_spnego_client_negTokenInit(gensec_security, spnego_state, out_mem_ctx, in, out);
498 len = spnego_read_data(in, &spnego);
501 DEBUG(1, ("Invalid SPNEGO request:\n"));
502 dump_data(1, (const char *)in.data, in.length);
503 return NT_STATUS_INVALID_PARAMETER;
506 /* OK, so it's real SPNEGO, check the packet's the one we expect */
507 if (spnego.type != spnego_state->expected_packet) {
508 DEBUG(1, ("Invalid SPNEGO request: %d, expected %d\n", spnego.type,
509 spnego_state->expected_packet));
510 dump_data(1, (const char *)in.data, in.length);
511 spnego_free_data(&spnego);
512 return NT_STATUS_INVALID_PARAMETER;
515 if (spnego.negTokenInit.targetPrincipal) {
516 DEBUG(5, ("Server claims it's principal name is %s\n", spnego.negTokenInit.targetPrincipal));
517 nt_status = gensec_set_target_principal(gensec_security,
518 spnego.negTokenInit.targetPrincipal);
519 if (!NT_STATUS_IS_OK(nt_status)) {
520 spnego_free_data(&spnego);
525 nt_status = gensec_spnego_parse_negTokenInit(gensec_security,
528 spnego.negTokenInit.mechTypes,
529 spnego.negTokenInit.mechToken,
532 if (!NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED) && !NT_STATUS_IS_OK(nt_status)) {
533 spnego_free_data(&spnego);
538 my_mechs[0] = spnego_state->sub_sec_security->ops->oid;
540 spnego_out.type = SPNEGO_NEG_TOKEN_INIT;
541 spnego_out.negTokenInit.mechTypes = my_mechs;
542 spnego_out.negTokenInit.reqFlags = 0;
543 spnego_out.negTokenInit.mechListMIC = null_data_blob;
544 spnego_out.negTokenInit.mechToken = unwrapped_out;
546 if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
547 DEBUG(1, ("Failed to write SPNEGO reply to NEG_TOKEN_INIT\n"));
548 return NT_STATUS_INVALID_PARAMETER;
552 spnego_state->expected_packet = SPNEGO_NEG_TOKEN_TARG;
553 spnego_state->state_position = SPNEGO_CLIENT_TARG;
555 return NT_STATUS_MORE_PROCESSING_REQUIRED;
557 case SPNEGO_SERVER_TARG:
561 return NT_STATUS_INVALID_PARAMETER;
564 len = spnego_read_data(in, &spnego);
567 DEBUG(1, ("Invalid SPNEGO request:\n"));
568 dump_data(1, (const char *)in.data, in.length);
569 return NT_STATUS_INVALID_PARAMETER;
572 /* OK, so it's real SPNEGO, check the packet's the one we expect */
573 if (spnego.type != spnego_state->expected_packet) {
574 DEBUG(1, ("Invalid SPNEGO request: %d, expected %d\n", spnego.type,
575 spnego_state->expected_packet));
576 dump_data(1, (const char *)in.data, in.length);
577 spnego_free_data(&spnego);
578 return NT_STATUS_INVALID_PARAMETER;
581 nt_status = gensec_update(spnego_state->sub_sec_security,
583 spnego.negTokenTarg.responseToken,
586 nt_status = gensec_spnego_server_negTokenTarg(gensec_security,
593 spnego_free_data(&spnego);
597 case SPNEGO_CLIENT_TARG:
601 return NT_STATUS_INVALID_PARAMETER;
604 len = spnego_read_data(in, &spnego);
607 DEBUG(1, ("Invalid SPNEGO request:\n"));
608 dump_data(1, (const char *)in.data, in.length);
609 return NT_STATUS_INVALID_PARAMETER;
612 /* OK, so it's real SPNEGO, check the packet's the one we expect */
613 if (spnego.type != spnego_state->expected_packet) {
614 DEBUG(1, ("Invalid SPNEGO request: %d, expected %d\n", spnego.type,
615 spnego_state->expected_packet));
616 dump_data(1, (const char *)in.data, in.length);
617 spnego_free_data(&spnego);
618 return NT_STATUS_INVALID_PARAMETER;
621 if (spnego.negTokenTarg.negResult == SPNEGO_REJECT) {
622 return NT_STATUS_ACCESS_DENIED;
625 nt_status = gensec_update(spnego_state->sub_sec_security,
627 spnego.negTokenTarg.responseToken,
631 if (NT_STATUS_IS_OK(nt_status)
632 && (spnego.negTokenTarg.negResult != SPNEGO_ACCEPT_COMPLETED)) {
633 DEBUG(1,("gensec_update ok but not accepted\n"));
634 nt_status = NT_STATUS_INVALID_PARAMETER;
637 spnego_free_data(&spnego);
639 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
641 spnego_out.type = SPNEGO_NEG_TOKEN_TARG;
642 spnego_out.negTokenTarg.negResult = SPNEGO_NONE_RESULT;
643 spnego_out.negTokenTarg.supportedMech = NULL;
644 spnego_out.negTokenTarg.responseToken = unwrapped_out;
645 spnego_out.negTokenTarg.mechListMIC = null_data_blob;
647 if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
648 DEBUG(1, ("Failed to write SPNEGO reply to NEG_TOKEN_TARG\n"));
649 return NT_STATUS_INVALID_PARAMETER;
652 spnego_state->state_position = SPNEGO_CLIENT_TARG;
653 } else if (NT_STATUS_IS_OK(nt_status)) {
654 /* all done - server has accepted, and we agree */
656 if (unwrapped_out.length) {
657 spnego_out.type = SPNEGO_NEG_TOKEN_TARG;
658 spnego_out.negTokenTarg.negResult = SPNEGO_NONE_RESULT;
659 spnego_out.negTokenTarg.supportedMech = NULL;
660 spnego_out.negTokenTarg.responseToken = unwrapped_out;
661 spnego_out.negTokenTarg.mechListMIC = null_data_blob;
663 if (spnego_write_data(out_mem_ctx, out, &spnego_out) == -1) {
664 DEBUG(1, ("Failed to write SPNEGO reply to NEG_TOKEN_TARG\n"));
665 return NT_STATUS_INVALID_PARAMETER;
668 *out = null_data_blob;
671 spnego_state->state_position = SPNEGO_DONE;
673 DEBUG(1, ("SPNEGO(%s) login failed: %s\n",
674 spnego_state->sub_sec_security->ops->name,
675 nt_errstr(nt_status)));
682 return NT_STATUS_INVALID_PARAMETER;
685 static void gensec_spnego_end(struct gensec_security *gensec_security)
687 struct spnego_state *spnego_state = gensec_security->private_data;
689 if (spnego_state->sub_sec_security) {
690 gensec_end(&spnego_state->sub_sec_security);
693 talloc_free(spnego_state);
695 gensec_security->private_data = NULL;
698 static const struct gensec_security_ops gensec_spnego_security_ops = {
700 .sasl_name = "GSS-SPNEGO",
701 .auth_type = DCERPC_AUTH_TYPE_SPNEGO,
703 .client_start = gensec_spnego_client_start,
704 .server_start = gensec_spnego_server_start,
705 .update = gensec_spnego_update,
706 .seal_packet = gensec_spnego_seal_packet,
707 .sign_packet = gensec_spnego_sign_packet,
708 .sig_size = gensec_spnego_sig_size,
709 .check_packet = gensec_spnego_check_packet,
710 .unseal_packet = gensec_spnego_unseal_packet,
711 .session_key = gensec_spnego_session_key,
712 .session_info = gensec_spnego_session_info,
713 .end = gensec_spnego_end
716 NTSTATUS gensec_spnego_init(void)
719 ret = register_backend("gensec", &gensec_spnego_security_ops);
720 if (!NT_STATUS_IS_OK(ret)) {
721 DEBUG(0,("Failed to register '%s' gensec backend!\n",
722 gensec_spnego_security_ops.name));