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/>.
25 generate a negTokenInit packet given a GUID, a list of supported
26 OIDs (the mechanisms) and a principal name string
28 DATA_BLOB spnego_gen_negTokenInit(char guid[16],
30 const char *principal)
36 data = asn1_init(talloc_tos());
38 return data_blob_null;
41 asn1_write(data, guid, 16);
42 asn1_push_tag(data,ASN1_APPLICATION(0));
43 asn1_write_OID(data,OID_SPNEGO);
44 asn1_push_tag(data,ASN1_CONTEXT(0));
45 asn1_push_tag(data,ASN1_SEQUENCE(0));
47 asn1_push_tag(data,ASN1_CONTEXT(0));
48 asn1_push_tag(data,ASN1_SEQUENCE(0));
49 for (i=0; OIDs[i]; i++) {
50 asn1_write_OID(data,OIDs[i]);
55 asn1_push_tag(data, ASN1_CONTEXT(3));
56 asn1_push_tag(data, ASN1_SEQUENCE(0));
57 asn1_push_tag(data, ASN1_CONTEXT(0));
58 asn1_write_GeneralString(data,principal);
68 if (data->has_error) {
69 DEBUG(1,("Failed to build negTokenInit at offset %d\n", (int)data->ofs));
72 ret = data_blob(data->data, data->length);
79 Generate a negTokenInit as used by the client side ... It has a mechType
80 (OID), and a mechToken (a security blob) ...
82 Really, we need to break out the NTLMSSP stuff as well, because it could be
85 DATA_BLOB gen_negTokenInit(const char *OID, DATA_BLOB blob)
90 data = asn1_init(talloc_tos());
92 return data_blob_null;
95 asn1_push_tag(data, ASN1_APPLICATION(0));
96 asn1_write_OID(data,OID_SPNEGO);
97 asn1_push_tag(data, ASN1_CONTEXT(0));
98 asn1_push_tag(data, ASN1_SEQUENCE(0));
100 asn1_push_tag(data, ASN1_CONTEXT(0));
101 asn1_push_tag(data, ASN1_SEQUENCE(0));
102 asn1_write_OID(data, OID);
106 asn1_push_tag(data, ASN1_CONTEXT(2));
107 asn1_write_OctetString(data,blob.data,blob.length);
115 if (data->has_error) {
116 DEBUG(1,("Failed to build negTokenInit at offset %d\n", (int)data->ofs));
119 ret = data_blob(data->data, data->length);
126 parse a negTokenInit packet giving a GUID, a list of supported
127 OIDs (the mechanisms) and a principal name string
129 bool spnego_parse_negTokenInit(DATA_BLOB blob,
130 char *OIDs[ASN1_MAX_OIDS],
137 data = asn1_init(talloc_tos());
142 asn1_load(data, blob);
144 asn1_start_tag(data,ASN1_APPLICATION(0));
146 asn1_check_OID(data,OID_SPNEGO);
147 asn1_start_tag(data,ASN1_CONTEXT(0));
148 asn1_start_tag(data,ASN1_SEQUENCE(0));
150 asn1_start_tag(data,ASN1_CONTEXT(0));
151 asn1_start_tag(data,ASN1_SEQUENCE(0));
152 for (i=0; asn1_tag_remaining(data) > 0 && i < ASN1_MAX_OIDS-1; i++) {
153 const char *oid_str = NULL;
154 asn1_read_OID(data,NULL,&oid_str);
155 OIDs[i] = CONST_DISCARD(char *, oid_str);
162 if (asn1_tag_remaining(data) > 0) {
163 asn1_start_tag(data, ASN1_CONTEXT(3));
164 asn1_start_tag(data, ASN1_SEQUENCE(0));
165 asn1_start_tag(data, ASN1_CONTEXT(0));
166 asn1_read_GeneralString(data,NULL,principal);
177 ret = !data->has_error;
178 if (data->has_error) {
180 TALLOC_FREE(*principal);
181 for(j = 0; j < i && j < ASN1_MAX_OIDS-1; j++) {
182 TALLOC_FREE(OIDs[j]);
191 generate a negTokenTarg packet given a list of OIDs and a security blob
193 DATA_BLOB gen_negTokenTarg(const char *OIDs[], DATA_BLOB blob)
199 data = asn1_init(talloc_tos());
201 return data_blob_null;
204 asn1_push_tag(data, ASN1_APPLICATION(0));
205 asn1_write_OID(data,OID_SPNEGO);
206 asn1_push_tag(data, ASN1_CONTEXT(0));
207 asn1_push_tag(data, ASN1_SEQUENCE(0));
209 asn1_push_tag(data, ASN1_CONTEXT(0));
210 asn1_push_tag(data, ASN1_SEQUENCE(0));
211 for (i=0; OIDs[i]; i++) {
212 asn1_write_OID(data,OIDs[i]);
217 asn1_push_tag(data, ASN1_CONTEXT(2));
218 asn1_write_OctetString(data,blob.data,blob.length);
226 if (data->has_error) {
227 DEBUG(1,("Failed to build negTokenTarg at offset %d\n", (int)data->ofs));
230 ret = data_blob(data->data, data->length);
237 parse a negTokenTarg packet giving a list of OIDs and a security blob
239 bool parse_negTokenTarg(DATA_BLOB blob, char *OIDs[ASN1_MAX_OIDS], DATA_BLOB *secblob)
244 data = asn1_init(talloc_tos());
249 asn1_load(data, blob);
250 asn1_start_tag(data, ASN1_APPLICATION(0));
251 asn1_check_OID(data,OID_SPNEGO);
252 asn1_start_tag(data, ASN1_CONTEXT(0));
253 asn1_start_tag(data, ASN1_SEQUENCE(0));
255 asn1_start_tag(data, ASN1_CONTEXT(0));
256 asn1_start_tag(data, ASN1_SEQUENCE(0));
257 for (i=0; asn1_tag_remaining(data) > 0 && i < ASN1_MAX_OIDS-1; i++) {
258 const char *oid_str = NULL;
259 asn1_read_OID(data,NULL,&oid_str);
260 OIDs[i] = CONST_DISCARD(char *, oid_str);
266 /* Skip any optional req_flags that are sent per RFC 4178 */
267 if (asn1_peek_tag(data, ASN1_CONTEXT(1))) {
270 asn1_start_tag(data, ASN1_CONTEXT(1));
271 asn1_start_tag(data, ASN1_BITFIELD);
272 while (asn1_tag_remaining(data) > 0)
273 asn1_read_uint8(data, &flags);
278 asn1_start_tag(data, ASN1_CONTEXT(2));
279 asn1_read_OctetString(data,NULL,secblob);
287 if (data->has_error) {
289 data_blob_free(secblob);
290 for(j = 0; j < i && j < ASN1_MAX_OIDS-1; j++) {
291 TALLOC_FREE(OIDs[j]);
293 DEBUG(1,("Failed to parse negTokenTarg at offset %d\n", (int)data->ofs));
303 generate a krb5 GSS-API wrapper packet given a ticket
305 DATA_BLOB spnego_gen_krb5_wrap(const DATA_BLOB ticket, const uint8 tok_id[2])
310 data = asn1_init(talloc_tos());
312 return data_blob_null;
315 asn1_push_tag(data, ASN1_APPLICATION(0));
316 asn1_write_OID(data, OID_KERBEROS5);
318 asn1_write(data, tok_id, 2);
319 asn1_write(data, ticket.data, ticket.length);
322 if (data->has_error) {
323 DEBUG(1,("Failed to build krb5 wrapper at offset %d\n", (int)data->ofs));
326 ret = data_blob(data->data, data->length);
333 parse a krb5 GSS-API wrapper packet giving a ticket
335 bool spnego_parse_krb5_wrap(DATA_BLOB blob, DATA_BLOB *ticket, uint8 tok_id[2])
341 data = asn1_init(talloc_tos());
346 asn1_load(data, blob);
347 asn1_start_tag(data, ASN1_APPLICATION(0));
348 asn1_check_OID(data, OID_KERBEROS5);
350 data_remaining = asn1_tag_remaining(data);
352 if (data_remaining < 3) {
353 data->has_error = True;
355 asn1_read(data, tok_id, 2);
357 *ticket = data_blob(NULL, data_remaining);
358 asn1_read(data, ticket->data, ticket->length);
363 ret = !data->has_error;
365 if (data->has_error) {
366 data_blob_free(ticket);
376 generate a SPNEGO negTokenTarg packet, ready for a EXTENDED_SECURITY
377 kerberos session setup
379 int spnego_gen_negTokenTarg(const char *principal, int time_offset,
381 DATA_BLOB *session_key_krb5, uint32 extra_ap_opts,
385 DATA_BLOB tkt, tkt_wrapped;
386 const char *krb_mechs[] = {OID_KERBEROS5_OLD, OID_KERBEROS5, OID_NTLMSSP, NULL};
388 /* get a kerberos ticket for the service and extract the session key */
389 retval = cli_krb5_get_ticket(principal, time_offset,
390 &tkt, session_key_krb5, extra_ap_opts, NULL,
396 /* wrap that up in a nice GSS-API wrapping */
397 tkt_wrapped = spnego_gen_krb5_wrap(tkt, TOK_ID_KRB_AP_REQ);
399 /* and wrap that in a shiny SPNEGO wrapper */
400 *targ = gen_negTokenTarg(krb_mechs, tkt_wrapped);
402 data_blob_free(&tkt_wrapped);
403 data_blob_free(&tkt);
410 parse a spnego NTLMSSP challenge packet giving two security blobs
412 bool spnego_parse_challenge(const DATA_BLOB blob,
413 DATA_BLOB *chal1, DATA_BLOB *chal2)
421 data = asn1_init(talloc_tos());
426 asn1_load(data, blob);
427 asn1_start_tag(data,ASN1_CONTEXT(1));
428 asn1_start_tag(data,ASN1_SEQUENCE(0));
430 asn1_start_tag(data,ASN1_CONTEXT(0));
431 asn1_check_enumerated(data,1);
434 asn1_start_tag(data,ASN1_CONTEXT(1));
435 asn1_check_OID(data, OID_NTLMSSP);
438 asn1_start_tag(data,ASN1_CONTEXT(2));
439 asn1_read_OctetString(data, NULL, chal1);
442 /* the second challenge is optional (XP doesn't send it) */
443 if (asn1_tag_remaining(data)) {
444 asn1_start_tag(data,ASN1_CONTEXT(3));
445 asn1_read_OctetString(data, NULL, chal2);
452 ret = !data->has_error;
454 if (data->has_error) {
455 data_blob_free(chal1);
456 data_blob_free(chal2);
465 generate a SPNEGO auth packet. This will contain the encrypted passwords
467 DATA_BLOB spnego_gen_auth(DATA_BLOB blob)
472 data = asn1_init(talloc_tos());
474 return data_blob_null;
477 asn1_push_tag(data, ASN1_CONTEXT(1));
478 asn1_push_tag(data, ASN1_SEQUENCE(0));
479 asn1_push_tag(data, ASN1_CONTEXT(2));
480 asn1_write_OctetString(data,blob.data,blob.length);
485 ret = data_blob(data->data, data->length);
493 parse a SPNEGO auth packet. This contains the encrypted passwords
495 bool spnego_parse_auth(DATA_BLOB blob, DATA_BLOB *auth)
499 data = asn1_init(talloc_tos());
504 asn1_load(data, blob);
505 asn1_start_tag(data, ASN1_CONTEXT(1));
506 asn1_start_tag(data, ASN1_SEQUENCE(0));
507 asn1_start_tag(data, ASN1_CONTEXT(2));
508 asn1_read_OctetString(data, NULL, auth);
513 if (data->has_error) {
514 DEBUG(3,("spnego_parse_auth failed at %d\n", (int)data->ofs));
515 data_blob_free(auth);
525 generate a minimal SPNEGO response packet. Doesn't contain much.
527 DATA_BLOB spnego_gen_auth_response(DATA_BLOB *reply, NTSTATUS nt_status,
534 if (NT_STATUS_IS_OK(nt_status)) {
535 negResult = SPNEGO_NEG_RESULT_ACCEPT;
536 } else if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
537 negResult = SPNEGO_NEG_RESULT_INCOMPLETE;
539 negResult = SPNEGO_NEG_RESULT_REJECT;
542 data = asn1_init(talloc_tos());
544 return data_blob_null;
547 asn1_push_tag(data, ASN1_CONTEXT(1));
548 asn1_push_tag(data, ASN1_SEQUENCE(0));
549 asn1_push_tag(data, ASN1_CONTEXT(0));
550 asn1_write_enumerated(data, negResult);
554 asn1_push_tag(data,ASN1_CONTEXT(1));
555 asn1_write_OID(data, mechOID);
559 if (reply && reply->data != NULL) {
560 asn1_push_tag(data,ASN1_CONTEXT(2));
561 asn1_write_OctetString(data, reply->data, reply->length);
568 ret = data_blob(data->data, data->length);
574 parse a SPNEGO auth packet. This contains the encrypted passwords
576 bool spnego_parse_auth_response(DATA_BLOB blob, NTSTATUS nt_status,
583 if (NT_STATUS_IS_OK(nt_status)) {
584 negResult = SPNEGO_NEG_RESULT_ACCEPT;
585 } else if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
586 negResult = SPNEGO_NEG_RESULT_INCOMPLETE;
588 negResult = SPNEGO_NEG_RESULT_REJECT;
591 data = asn1_init(talloc_tos());
596 asn1_load(data, blob);
597 asn1_start_tag(data, ASN1_CONTEXT(1));
598 asn1_start_tag(data, ASN1_SEQUENCE(0));
599 asn1_start_tag(data, ASN1_CONTEXT(0));
600 asn1_check_enumerated(data, negResult);
603 *auth = data_blob_null;
605 if (asn1_tag_remaining(data)) {
606 asn1_start_tag(data,ASN1_CONTEXT(1));
607 asn1_check_OID(data, mechOID);
610 if (asn1_tag_remaining(data)) {
611 asn1_start_tag(data,ASN1_CONTEXT(2));
612 asn1_read_OctetString(data, NULL, auth);
615 } else if (negResult == SPNEGO_NEG_RESULT_INCOMPLETE) {
619 /* Binding against Win2K DC returns a duplicate of the responseToken in
620 * the optional mechListMIC field. This is a bug in Win2K. We ignore
621 * this field if it exists. Win2K8 may return a proper mechListMIC at
622 * which point we need to implement the integrity checking. */
623 if (asn1_tag_remaining(data)) {
624 DATA_BLOB mechList = data_blob_null;
625 asn1_start_tag(data, ASN1_CONTEXT(3));
626 asn1_read_OctetString(data, NULL, &mechList);
628 data_blob_free(&mechList);
629 DEBUG(5,("spnego_parse_auth_response received mechListMIC, "
636 if (data->has_error) {
637 DEBUG(3,("spnego_parse_auth_response failed at %d\n", (int)data->ofs));
639 data_blob_free(auth);