2 Unix SMB/CIFS implementation.
3 simple kerberos5/SPNEGO routines
4 Copyright (C) Andrew Tridgell 2001
5 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2002
6 Copyright (C) Luke Howard 2003
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "../libcli/auth/spnego.h"
27 generate a negTokenInit packet given a GUID, a list of supported
28 OIDs (the mechanisms) and a principal name string
30 DATA_BLOB spnego_gen_negTokenInit(char guid[16],
32 const char *principal)
38 data = asn1_init(talloc_tos());
40 return data_blob_null;
43 asn1_write(data, guid, 16);
44 asn1_push_tag(data,ASN1_APPLICATION(0));
45 asn1_write_OID(data,OID_SPNEGO);
46 asn1_push_tag(data,ASN1_CONTEXT(0));
47 asn1_push_tag(data,ASN1_SEQUENCE(0));
49 asn1_push_tag(data,ASN1_CONTEXT(0));
50 asn1_push_tag(data,ASN1_SEQUENCE(0));
51 for (i=0; OIDs[i]; i++) {
52 asn1_write_OID(data,OIDs[i]);
57 asn1_push_tag(data, ASN1_CONTEXT(3));
58 asn1_push_tag(data, ASN1_SEQUENCE(0));
59 asn1_push_tag(data, ASN1_CONTEXT(0));
60 asn1_write_GeneralString(data,principal);
70 if (data->has_error) {
71 DEBUG(1,("Failed to build negTokenInit at offset %d\n", (int)data->ofs));
74 ret = data_blob(data->data, data->length);
81 Generate a negTokenInit as used by the client side ... It has a mechType
82 (OID), and a mechToken (a security blob) ...
84 Really, we need to break out the NTLMSSP stuff as well, because it could be
87 DATA_BLOB gen_negTokenInit(const char *OID, DATA_BLOB blob)
92 data = asn1_init(talloc_tos());
94 return data_blob_null;
97 asn1_push_tag(data, ASN1_APPLICATION(0));
98 asn1_write_OID(data,OID_SPNEGO);
99 asn1_push_tag(data, ASN1_CONTEXT(0));
100 asn1_push_tag(data, ASN1_SEQUENCE(0));
102 asn1_push_tag(data, ASN1_CONTEXT(0));
103 asn1_push_tag(data, ASN1_SEQUENCE(0));
104 asn1_write_OID(data, OID);
108 asn1_push_tag(data, ASN1_CONTEXT(2));
109 asn1_write_OctetString(data,blob.data,blob.length);
117 if (data->has_error) {
118 DEBUG(1,("Failed to build negTokenInit at offset %d\n", (int)data->ofs));
121 ret = data_blob(data->data, data->length);
128 parse a negTokenInit packet giving a GUID, a list of supported
129 OIDs (the mechanisms) and a principal name string
131 bool spnego_parse_negTokenInit(DATA_BLOB blob,
132 char *OIDs[ASN1_MAX_OIDS],
139 data = asn1_init(talloc_tos());
144 asn1_load(data, blob);
146 asn1_start_tag(data,ASN1_APPLICATION(0));
148 asn1_check_OID(data,OID_SPNEGO);
150 /* negTokenInit [0] NegTokenInit */
151 asn1_start_tag(data,ASN1_CONTEXT(0));
152 asn1_start_tag(data,ASN1_SEQUENCE(0));
154 /* mechTypes [0] MechTypeList OPTIONAL */
156 /* Not really optional, we depend on this to decide
157 * what mechanisms we have to work with. */
159 asn1_start_tag(data,ASN1_CONTEXT(0));
160 asn1_start_tag(data,ASN1_SEQUENCE(0));
161 for (i=0; asn1_tag_remaining(data) > 0 && i < ASN1_MAX_OIDS-1; i++) {
162 const char *oid_str = NULL;
163 asn1_read_OID(data,talloc_autofree_context(),&oid_str);
164 OIDs[i] = CONST_DISCARD(char *, oid_str);
173 Win7 + Live Sign-in Assistant attaches a mechToken
174 ASN1_CONTEXT(2) to the negTokenInit packet
175 which breaks our negotiation if we just assume
176 the next tag is ASN1_CONTEXT(3).
179 if (asn1_peek_tag(data, ASN1_CONTEXT(1))) {
182 /* reqFlags [1] ContextFlags OPTIONAL */
183 asn1_start_tag(data, ASN1_CONTEXT(1));
184 asn1_start_tag(data, ASN1_BIT_STRING);
185 while (asn1_tag_remaining(data) > 0) {
186 asn1_read_uint8(data, &flags);
192 if (asn1_peek_tag(data, ASN1_CONTEXT(2))) {
193 /* mechToken [2] OCTET STRING OPTIONAL */
195 asn1_start_tag(data, ASN1_CONTEXT(2));
196 asn1_read_OctetString(data, talloc_autofree_context(),
199 /* Throw away the token - not used. */
200 data_blob_free(&token);
203 if (asn1_peek_tag(data, ASN1_CONTEXT(3))) {
204 /* mechListMIC [3] OCTET STRING OPTIONAL */
205 asn1_start_tag(data, ASN1_CONTEXT(3));
206 asn1_start_tag(data, ASN1_SEQUENCE(0));
207 asn1_start_tag(data, ASN1_CONTEXT(0));
208 asn1_read_GeneralString(data,talloc_autofree_context(),
220 ret = !data->has_error;
221 if (data->has_error) {
223 TALLOC_FREE(*principal);
224 for(j = 0; j < i && j < ASN1_MAX_OIDS-1; j++) {
225 TALLOC_FREE(OIDs[j]);
234 generate a negTokenTarg packet given a list of OIDs and a security blob
236 DATA_BLOB gen_negTokenTarg(const char *OIDs[], DATA_BLOB blob)
242 data = asn1_init(talloc_tos());
244 return data_blob_null;
247 asn1_push_tag(data, ASN1_APPLICATION(0));
248 asn1_write_OID(data,OID_SPNEGO);
249 asn1_push_tag(data, ASN1_CONTEXT(0));
250 asn1_push_tag(data, ASN1_SEQUENCE(0));
252 asn1_push_tag(data, ASN1_CONTEXT(0));
253 asn1_push_tag(data, ASN1_SEQUENCE(0));
254 for (i=0; OIDs[i]; i++) {
255 asn1_write_OID(data,OIDs[i]);
260 asn1_push_tag(data, ASN1_CONTEXT(2));
261 asn1_write_OctetString(data,blob.data,blob.length);
269 if (data->has_error) {
270 DEBUG(1,("Failed to build negTokenTarg at offset %d\n", (int)data->ofs));
273 ret = data_blob(data->data, data->length);
280 parse a negTokenTarg packet giving a list of OIDs and a security blob
282 bool parse_negTokenTarg(DATA_BLOB blob, char *OIDs[ASN1_MAX_OIDS], DATA_BLOB *secblob)
287 data = asn1_init(talloc_tos());
292 asn1_load(data, blob);
293 asn1_start_tag(data, ASN1_APPLICATION(0));
294 asn1_check_OID(data,OID_SPNEGO);
295 asn1_start_tag(data, ASN1_CONTEXT(0));
296 asn1_start_tag(data, ASN1_SEQUENCE(0));
298 asn1_start_tag(data, ASN1_CONTEXT(0));
299 asn1_start_tag(data, ASN1_SEQUENCE(0));
300 for (i=0; asn1_tag_remaining(data) > 0 && i < ASN1_MAX_OIDS-1; i++) {
301 const char *oid_str = NULL;
302 asn1_read_OID(data,talloc_autofree_context(),&oid_str);
303 OIDs[i] = CONST_DISCARD(char *, oid_str);
309 /* Skip any optional req_flags that are sent per RFC 4178 */
310 if (asn1_peek_tag(data, ASN1_CONTEXT(1))) {
313 asn1_start_tag(data, ASN1_CONTEXT(1));
314 asn1_start_tag(data, ASN1_BIT_STRING);
315 while (asn1_tag_remaining(data) > 0)
316 asn1_read_uint8(data, &flags);
321 asn1_start_tag(data, ASN1_CONTEXT(2));
322 asn1_read_OctetString(data,talloc_autofree_context(),secblob);
330 if (data->has_error) {
332 data_blob_free(secblob);
333 for(j = 0; j < i && j < ASN1_MAX_OIDS-1; j++) {
334 TALLOC_FREE(OIDs[j]);
336 DEBUG(1,("Failed to parse negTokenTarg at offset %d\n", (int)data->ofs));
346 generate a krb5 GSS-API wrapper packet given a ticket
348 DATA_BLOB spnego_gen_krb5_wrap(const DATA_BLOB ticket, const uint8 tok_id[2])
353 data = asn1_init(talloc_tos());
355 return data_blob_null;
358 asn1_push_tag(data, ASN1_APPLICATION(0));
359 asn1_write_OID(data, OID_KERBEROS5);
361 asn1_write(data, tok_id, 2);
362 asn1_write(data, ticket.data, ticket.length);
365 if (data->has_error) {
366 DEBUG(1,("Failed to build krb5 wrapper at offset %d\n", (int)data->ofs));
369 ret = data_blob(data->data, data->length);
376 parse a krb5 GSS-API wrapper packet giving a ticket
378 bool spnego_parse_krb5_wrap(DATA_BLOB blob, DATA_BLOB *ticket, uint8 tok_id[2])
384 data = asn1_init(talloc_tos());
389 asn1_load(data, blob);
390 asn1_start_tag(data, ASN1_APPLICATION(0));
391 asn1_check_OID(data, OID_KERBEROS5);
393 data_remaining = asn1_tag_remaining(data);
395 if (data_remaining < 3) {
396 data->has_error = True;
398 asn1_read(data, tok_id, 2);
400 *ticket = data_blob(NULL, data_remaining);
401 asn1_read(data, ticket->data, ticket->length);
406 ret = !data->has_error;
408 if (data->has_error) {
409 data_blob_free(ticket);
419 generate a SPNEGO negTokenTarg packet, ready for a EXTENDED_SECURITY
420 kerberos session setup
422 int spnego_gen_negTokenTarg(const char *principal, int time_offset,
424 DATA_BLOB *session_key_krb5, uint32 extra_ap_opts,
428 DATA_BLOB tkt, tkt_wrapped;
429 const char *krb_mechs[] = {OID_KERBEROS5_OLD, OID_KERBEROS5, OID_NTLMSSP, NULL};
431 /* get a kerberos ticket for the service and extract the session key */
432 retval = cli_krb5_get_ticket(principal, time_offset,
433 &tkt, session_key_krb5, extra_ap_opts, NULL,
439 /* wrap that up in a nice GSS-API wrapping */
440 tkt_wrapped = spnego_gen_krb5_wrap(tkt, TOK_ID_KRB_AP_REQ);
442 /* and wrap that in a shiny SPNEGO wrapper */
443 *targ = gen_negTokenTarg(krb_mechs, tkt_wrapped);
445 data_blob_free(&tkt_wrapped);
446 data_blob_free(&tkt);
453 parse a spnego NTLMSSP challenge packet giving two security blobs
455 bool spnego_parse_challenge(const DATA_BLOB blob,
456 DATA_BLOB *chal1, DATA_BLOB *chal2)
464 data = asn1_init(talloc_tos());
469 asn1_load(data, blob);
470 asn1_start_tag(data,ASN1_CONTEXT(1));
471 asn1_start_tag(data,ASN1_SEQUENCE(0));
473 asn1_start_tag(data,ASN1_CONTEXT(0));
474 asn1_check_enumerated(data,1);
477 asn1_start_tag(data,ASN1_CONTEXT(1));
478 asn1_check_OID(data, OID_NTLMSSP);
481 asn1_start_tag(data,ASN1_CONTEXT(2));
482 asn1_read_OctetString(data, talloc_autofree_context(), chal1);
485 /* the second challenge is optional (XP doesn't send it) */
486 if (asn1_tag_remaining(data)) {
487 asn1_start_tag(data,ASN1_CONTEXT(3));
488 asn1_read_OctetString(data, talloc_autofree_context(), chal2);
495 ret = !data->has_error;
497 if (data->has_error) {
498 data_blob_free(chal1);
499 data_blob_free(chal2);
508 generate a SPNEGO auth packet. This will contain the encrypted passwords
510 DATA_BLOB spnego_gen_auth(DATA_BLOB blob)
515 data = asn1_init(talloc_tos());
517 return data_blob_null;
520 asn1_push_tag(data, ASN1_CONTEXT(1));
521 asn1_push_tag(data, ASN1_SEQUENCE(0));
522 asn1_push_tag(data, ASN1_CONTEXT(2));
523 asn1_write_OctetString(data,blob.data,blob.length);
528 ret = data_blob(data->data, data->length);
536 parse a SPNEGO auth packet. This contains the encrypted passwords
538 bool spnego_parse_auth(DATA_BLOB blob, DATA_BLOB *auth)
541 struct spnego_data token;
543 len = spnego_read_data(talloc_tos(), blob, &token);
545 DEBUG(3,("spnego_parse_auth: spnego_read_data failed\n"));
549 if (token.type != SPNEGO_NEG_TOKEN_TARG) {
550 DEBUG(3,("spnego_parse_auth: wrong token type: %d\n",
552 spnego_free_data(&token);
556 *auth = data_blob_talloc(talloc_tos(),
557 token.negTokenTarg.responseToken.data,
558 token.negTokenTarg.responseToken.length);
559 spnego_free_data(&token);
565 generate a minimal SPNEGO response packet. Doesn't contain much.
567 DATA_BLOB spnego_gen_auth_response(DATA_BLOB *reply, NTSTATUS nt_status,
574 if (NT_STATUS_IS_OK(nt_status)) {
575 negResult = SPNEGO_ACCEPT_COMPLETED;
576 } else if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
577 negResult = SPNEGO_ACCEPT_INCOMPLETE;
579 negResult = SPNEGO_REJECT;
582 data = asn1_init(talloc_tos());
584 return data_blob_null;
587 asn1_push_tag(data, ASN1_CONTEXT(1));
588 asn1_push_tag(data, ASN1_SEQUENCE(0));
589 asn1_push_tag(data, ASN1_CONTEXT(0));
590 asn1_write_enumerated(data, negResult);
594 asn1_push_tag(data,ASN1_CONTEXT(1));
595 asn1_write_OID(data, mechOID);
599 if (reply && reply->data != NULL) {
600 asn1_push_tag(data,ASN1_CONTEXT(2));
601 asn1_write_OctetString(data, reply->data, reply->length);
608 ret = data_blob(data->data, data->length);
614 parse a SPNEGO auth packet. This contains the encrypted passwords
616 bool spnego_parse_auth_response(DATA_BLOB blob, NTSTATUS nt_status,
623 if (NT_STATUS_IS_OK(nt_status)) {
624 negResult = SPNEGO_ACCEPT_COMPLETED;
625 } else if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
626 negResult = SPNEGO_ACCEPT_INCOMPLETE;
628 negResult = SPNEGO_REJECT;
631 data = asn1_init(talloc_tos());
636 asn1_load(data, blob);
637 asn1_start_tag(data, ASN1_CONTEXT(1));
638 asn1_start_tag(data, ASN1_SEQUENCE(0));
639 asn1_start_tag(data, ASN1_CONTEXT(0));
640 asn1_check_enumerated(data, negResult);
643 *auth = data_blob_null;
645 if (asn1_tag_remaining(data)) {
646 asn1_start_tag(data,ASN1_CONTEXT(1));
647 asn1_check_OID(data, mechOID);
650 if (asn1_tag_remaining(data)) {
651 asn1_start_tag(data,ASN1_CONTEXT(2));
652 asn1_read_OctetString(data, talloc_autofree_context(), auth);
655 } else if (negResult == SPNEGO_ACCEPT_INCOMPLETE) {
659 /* Binding against Win2K DC returns a duplicate of the responseToken in
660 * the optional mechListMIC field. This is a bug in Win2K. We ignore
661 * this field if it exists. Win2K8 may return a proper mechListMIC at
662 * which point we need to implement the integrity checking. */
663 if (asn1_tag_remaining(data)) {
664 DATA_BLOB mechList = data_blob_null;
665 asn1_start_tag(data, ASN1_CONTEXT(3));
666 asn1_read_OctetString(data, talloc_autofree_context(), &mechList);
668 data_blob_free(&mechList);
669 DEBUG(5,("spnego_parse_auth_response received mechListMIC, "
676 if (data->has_error) {
677 DEBUG(3,("spnego_parse_auth_response failed at %d\n", (int)data->ofs));
679 data_blob_free(auth);