2 Unix SMB/CIFS implementation.
3 simple kerberos5/SPNEGO routines
4 Copyright (C) Andrew Tridgell 2001
5 Copyright (C) Jim McDonough 2002
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 2 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, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
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(uint8 guid[16],
30 const char *principal)
36 memset(&data, 0, sizeof(data));
38 asn1_write(&data, guid, 16);
39 asn1_push_tag(&data,ASN1_APPLICATION(0));
40 asn1_write_OID(&data,OID_SPNEGO);
41 asn1_push_tag(&data,ASN1_CONTEXT(0));
42 asn1_push_tag(&data,ASN1_SEQUENCE(0));
44 asn1_push_tag(&data,ASN1_CONTEXT(0));
45 asn1_push_tag(&data,ASN1_SEQUENCE(0));
46 for (i=0; OIDs[i]; i++) {
47 asn1_write_OID(&data,OIDs[i]);
52 asn1_push_tag(&data, ASN1_CONTEXT(3));
53 asn1_push_tag(&data, ASN1_SEQUENCE(0));
54 asn1_push_tag(&data, ASN1_CONTEXT(0));
55 asn1_write_GeneralString(&data,principal);
66 DEBUG(1,("Failed to build negTokenInit at offset %d\n", (int)data.ofs));
70 ret = data_blob(data.data, data.length);
77 Generate a negTokenInit as used by the client side ... It has a mechType
78 (OID), and a mechToken (a security blob) ...
80 Really, we need to break out the NTLMSSP stuff as well, because it could be
83 DATA_BLOB gen_negTokenInit(const char *OID, DATA_BLOB blob)
88 memset(&data, 0, sizeof(data));
90 asn1_push_tag(&data, ASN1_APPLICATION(0));
91 asn1_write_OID(&data,OID_SPNEGO);
92 asn1_push_tag(&data, ASN1_CONTEXT(0));
93 asn1_push_tag(&data, ASN1_SEQUENCE(0));
95 asn1_push_tag(&data, ASN1_CONTEXT(0));
96 asn1_push_tag(&data, ASN1_SEQUENCE(0));
97 asn1_write_OID(&data, OID);
101 asn1_push_tag(&data, ASN1_CONTEXT(2));
102 asn1_write_OctetString(&data,blob.data,blob.length);
110 if (data.has_error) {
111 DEBUG(1,("Failed to build negTokenInit at offset %d\n", (int)data.ofs));
115 ret = data_blob(data.data, data.length);
122 parse a negTokenInit packet giving a GUID, a list of supported
123 OIDs (the mechanisms) and a principal name string
125 BOOL spnego_parse_negTokenInit(DATA_BLOB blob,
126 char *OIDs[ASN1_MAX_OIDS],
133 asn1_load(&data, blob);
135 asn1_start_tag(&data,ASN1_APPLICATION(0));
136 asn1_check_OID(&data,OID_SPNEGO);
137 asn1_start_tag(&data,ASN1_CONTEXT(0));
138 asn1_start_tag(&data,ASN1_SEQUENCE(0));
140 asn1_start_tag(&data,ASN1_CONTEXT(0));
141 asn1_start_tag(&data,ASN1_SEQUENCE(0));
142 for (i=0; asn1_tag_remaining(&data) > 0 && i < ASN1_MAX_OIDS; i++) {
144 asn1_read_OID(&data,&oid);
151 asn1_start_tag(&data, ASN1_CONTEXT(3));
152 asn1_start_tag(&data, ASN1_SEQUENCE(0));
153 asn1_start_tag(&data, ASN1_CONTEXT(0));
154 asn1_read_GeneralString(&data,principal);
164 ret = !data.has_error;
171 generate a negTokenTarg packet given a list of OIDs and a security blob
173 DATA_BLOB gen_negTokenTarg(const char *OIDs[], DATA_BLOB blob)
179 memset(&data, 0, sizeof(data));
181 asn1_push_tag(&data, ASN1_APPLICATION(0));
182 asn1_write_OID(&data,OID_SPNEGO);
183 asn1_push_tag(&data, ASN1_CONTEXT(0));
184 asn1_push_tag(&data, ASN1_SEQUENCE(0));
186 asn1_push_tag(&data, ASN1_CONTEXT(0));
187 asn1_push_tag(&data, ASN1_SEQUENCE(0));
188 for (i=0; OIDs[i]; i++) {
189 asn1_write_OID(&data,OIDs[i]);
194 asn1_push_tag(&data, ASN1_CONTEXT(2));
195 asn1_write_OctetString(&data,blob.data,blob.length);
203 if (data.has_error) {
204 DEBUG(1,("Failed to build negTokenTarg at offset %d\n", (int)data.ofs));
208 ret = data_blob(data.data, data.length);
216 parse a negTokenTarg packet giving a list of OIDs and a security blob
218 BOOL parse_negTokenTarg(DATA_BLOB blob, char *OIDs[ASN1_MAX_OIDS], DATA_BLOB *secblob)
223 asn1_load(&data, blob);
224 asn1_start_tag(&data, ASN1_APPLICATION(0));
225 asn1_check_OID(&data,OID_SPNEGO);
226 asn1_start_tag(&data, ASN1_CONTEXT(0));
227 asn1_start_tag(&data, ASN1_SEQUENCE(0));
229 asn1_start_tag(&data, ASN1_CONTEXT(0));
230 asn1_start_tag(&data, ASN1_SEQUENCE(0));
231 for (i=0; asn1_tag_remaining(&data) > 0 && i < ASN1_MAX_OIDS; i++) {
233 asn1_read_OID(&data,&oid);
240 asn1_start_tag(&data, ASN1_CONTEXT(2));
241 asn1_read_OctetString(&data,secblob);
249 if (data.has_error) {
250 DEBUG(1,("Failed to parse negTokenTarg at offset %d\n", (int)data.ofs));
260 generate a krb5 GSS-API wrapper packet given a ticket
262 DATA_BLOB spnego_gen_krb5_wrap(DATA_BLOB ticket)
267 memset(&data, 0, sizeof(data));
269 asn1_push_tag(&data, ASN1_APPLICATION(0));
270 asn1_write_OID(&data, OID_KERBEROS5);
271 asn1_write_BOOLEAN(&data, 0);
272 asn1_write(&data, ticket.data, ticket.length);
275 if (data.has_error) {
276 DEBUG(1,("Failed to build krb5 wrapper at offset %d\n", (int)data.ofs));
280 ret = data_blob(data.data, data.length);
287 parse a krb5 GSS-API wrapper packet giving a ticket
289 BOOL spnego_parse_krb5_wrap(DATA_BLOB blob, DATA_BLOB *ticket)
295 asn1_load(&data, blob);
296 asn1_start_tag(&data, ASN1_APPLICATION(0));
297 asn1_check_OID(&data, OID_KERBEROS5);
298 asn1_check_BOOLEAN(&data, 0);
300 data_remaining = asn1_tag_remaining(&data);
302 if (data_remaining < 1) {
303 data.has_error = True;
306 *ticket = data_blob(data.data, data_remaining);
307 asn1_read(&data, ticket->data, ticket->length);
312 ret = !data.has_error;
321 generate a SPNEGO negTokenTarg packet, ready for a EXTENDED_SECURITY
322 kerberos session setup
324 DATA_BLOB spnego_gen_negTokenTarg(const char *principal, int time_offset)
326 DATA_BLOB tkt, tkt_wrapped, targ;
327 const char *krb_mechs[] = {OID_KERBEROS5_OLD, OID_NTLMSSP, NULL};
329 /* get a kerberos ticket for the service */
330 tkt = krb5_get_ticket(principal, time_offset);
332 /* wrap that up in a nice GSS-API wrapping */
333 tkt_wrapped = spnego_gen_krb5_wrap(tkt);
335 /* and wrap that in a shiny SPNEGO wrapper */
336 targ = gen_negTokenTarg(krb_mechs, tkt_wrapped);
338 data_blob_free(&tkt_wrapped);
339 data_blob_free(&tkt);
346 parse a spnego NTLMSSP challenge packet giving two security blobs
348 BOOL spnego_parse_challenge(DATA_BLOB blob,
349 DATA_BLOB *chal1, DATA_BLOB *chal2)
357 asn1_load(&data, blob);
358 asn1_start_tag(&data,ASN1_CONTEXT(1));
359 asn1_start_tag(&data,ASN1_SEQUENCE(0));
361 asn1_start_tag(&data,ASN1_CONTEXT(0));
362 asn1_check_enumerated(&data,1);
365 asn1_start_tag(&data,ASN1_CONTEXT(1));
366 asn1_check_OID(&data, OID_NTLMSSP);
369 asn1_start_tag(&data,ASN1_CONTEXT(2));
370 asn1_read_OctetString(&data, chal1);
373 /* the second challenge is optional (XP doesn't send it) */
374 if (asn1_tag_remaining(&data)) {
375 asn1_start_tag(&data,ASN1_CONTEXT(3));
376 asn1_read_OctetString(&data, chal2);
383 ret = !data.has_error;
390 generate a SPNEGO NTLMSSP auth packet. This will contain the encrypted passwords
392 DATA_BLOB spnego_gen_auth(DATA_BLOB blob)
397 memset(&data, 0, sizeof(data));
399 asn1_push_tag(&data, ASN1_CONTEXT(1));
400 asn1_push_tag(&data, ASN1_SEQUENCE(0));
401 asn1_push_tag(&data, ASN1_CONTEXT(2));
402 asn1_write_OctetString(&data,blob.data,blob.length);
407 ret = data_blob(data.data, data.length);
415 parse a SPNEGO NTLMSSP auth packet. This contains the encrypted passwords
417 BOOL spnego_parse_auth(DATA_BLOB blob, DATA_BLOB *auth)
421 asn1_load(&data, blob);
422 asn1_start_tag(&data, ASN1_CONTEXT(1));
423 asn1_start_tag(&data, ASN1_SEQUENCE(0));
424 asn1_start_tag(&data, ASN1_CONTEXT(2));
425 asn1_read_OctetString(&data,auth);
430 if (data.has_error) {
431 DEBUG(3,("spnego_parse_auth failed at %d\n", (int)data.ofs));
441 generate a minimal SPNEGO NTLMSSP response packet. Doesn't contain much.
443 DATA_BLOB spnego_gen_auth_response(DATA_BLOB *ntlmssp_reply, NTSTATUS nt_status)
449 if (NT_STATUS_IS_OK(nt_status)) {
450 negResult = SPNEGO_NEG_RESULT_ACCEPT;
451 } else if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
452 negResult = SPNEGO_NEG_RESULT_INCOMPLETE;
454 negResult = SPNEGO_NEG_RESULT_REJECT;
459 asn1_push_tag(&data, ASN1_CONTEXT(1));
460 asn1_push_tag(&data, ASN1_SEQUENCE(0));
461 asn1_push_tag(&data, ASN1_CONTEXT(0));
462 asn1_write_enumerated(&data, negResult);
464 if (negResult == SPNEGO_NEG_RESULT_INCOMPLETE) {
465 asn1_push_tag(&data,ASN1_CONTEXT(1));
466 asn1_write_OID(&data, OID_NTLMSSP);
469 asn1_push_tag(&data,ASN1_CONTEXT(2));
470 asn1_write_OctetString(&data, ntlmssp_reply->data, ntlmssp_reply->length);
477 ret = data_blob(data.data, data.length);
483 this is a tiny msrpc packet generator. I am only using this to
484 avoid tying this code to a particular varient of our rpc code. This
485 generator is not general enough for all our rpc needs, its just
486 enough for the spnego/ntlmssp code
488 format specifiers are:
490 U = unicode string (input is unix string)
491 a = address (input is BOOL unicode, char *unix_string)
492 (1 byte type, 1 byte length, unicode/ASCII string, all inline)
493 A = ASCII string (input is unix string)
494 B = data blob (pointer + length)
495 b = data blob in header (pointer + length)
498 C = constant ascii string
500 BOOL msrpc_gen(DATA_BLOB *blob,
501 const char *format, ...)
507 int head_size=0, data_size=0;
508 int head_ofs, data_ofs;
511 /* first scan the format to work out the header and body size */
512 va_start(ap, format);
513 for (i=0; format[i]; i++) {
516 s = va_arg(ap, char *);
518 data_size += str_charnum(s) * 2;
521 s = va_arg(ap, char *);
523 data_size += str_ascii_charnum(s);
526 unicode = va_arg(ap, BOOL);
528 s = va_arg(ap, char *);
530 data_size += (str_charnum(s) * 2) + 4;
532 data_size += (str_ascii_charnum(s)) + 4;
536 b = va_arg(ap, uint8 *);
538 data_size += va_arg(ap, int);
541 b = va_arg(ap, uint8 *);
542 head_size += va_arg(ap, int);
549 s = va_arg(ap, char *);
550 head_size += str_charnum(s) + 1;
556 /* allocate the space, then scan the format again to fill in the values */
557 *blob = data_blob(NULL, head_size + data_size);
560 data_ofs = head_size;
562 va_start(ap, format);
563 for (i=0; format[i]; i++) {
566 s = va_arg(ap, char *);
568 SSVAL(blob->data, head_ofs, n*2); head_ofs += 2;
569 SSVAL(blob->data, head_ofs, n*2); head_ofs += 2;
570 SIVAL(blob->data, head_ofs, data_ofs); head_ofs += 4;
571 push_string(NULL, blob->data+data_ofs, s, n*2, STR_UNICODE|STR_NOALIGN);
575 s = va_arg(ap, char *);
576 n = str_ascii_charnum(s);
577 SSVAL(blob->data, head_ofs, n); head_ofs += 2;
578 SSVAL(blob->data, head_ofs, n); head_ofs += 2;
579 SIVAL(blob->data, head_ofs, data_ofs); head_ofs += 4;
580 push_string(NULL, blob->data+data_ofs, s, n, STR_ASCII|STR_NOALIGN);
584 unicode = va_arg(ap, BOOL);
586 SSVAL(blob->data, data_ofs, n); data_ofs += 2;
587 s = va_arg(ap, char *);
590 SSVAL(blob->data, data_ofs, n*2); data_ofs += 2;
592 push_string(NULL, blob->data+data_ofs, s, n*2,
593 STR_UNICODE|STR_NOALIGN);
597 n = str_ascii_charnum(s);
598 SSVAL(blob->data, data_ofs, n); data_ofs += 2;
600 push_string(NULL, blob->data+data_ofs, s, n,
601 STR_ASCII|STR_NOALIGN);
608 b = va_arg(ap, uint8 *);
610 SSVAL(blob->data, head_ofs, n); head_ofs += 2;
611 SSVAL(blob->data, head_ofs, n); head_ofs += 2;
612 SIVAL(blob->data, head_ofs, data_ofs); head_ofs += 4;
613 memcpy(blob->data+data_ofs, b, n);
618 SIVAL(blob->data, head_ofs, n); head_ofs += 4;
621 b = va_arg(ap, uint8 *);
623 memcpy(blob->data + head_ofs, b, n);
627 s = va_arg(ap, char *);
628 head_ofs += push_string(NULL, blob->data+head_ofs, s, -1,
629 STR_ASCII|STR_TERMINATE);
639 /* a helpful macro to avoid running over the end of our blob */
640 #define NEED_DATA(amount) \
641 if (head_ofs + amount > blob->length) { \
646 this is a tiny msrpc packet parser. This the the partner of msrpc_gen
648 format specifiers are:
650 U = unicode string (output is unix string)
653 b = data blob in header
655 C = constant ascii string
658 BOOL msrpc_parse(DATA_BLOB *blob,
659 const char *format, ...)
671 va_start(ap, format);
672 for (i=0; format[i]; i++) {
676 len1 = SVAL(blob->data, head_ofs); head_ofs += 2;
677 len2 = SVAL(blob->data, head_ofs); head_ofs += 2;
678 ptr = IVAL(blob->data, head_ofs); head_ofs += 4;
680 /* make sure its in the right format - be strict */
681 if (len1 != len2 || ptr + len1 > blob->length) {
685 /* if odd length and unicode */
689 ps = va_arg(ap, char **);
691 pull_string(NULL, p, blob->data + ptr, sizeof(p),
693 STR_UNICODE|STR_NOALIGN);
701 len1 = SVAL(blob->data, head_ofs); head_ofs += 2;
702 len2 = SVAL(blob->data, head_ofs); head_ofs += 2;
703 ptr = IVAL(blob->data, head_ofs); head_ofs += 4;
705 /* make sure its in the right format - be strict */
706 if (len1 != len2 || ptr + len1 > blob->length) {
710 ps = va_arg(ap, char **);
712 pull_string(NULL, p, blob->data + ptr, sizeof(p),
714 STR_ASCII|STR_NOALIGN);
722 len1 = SVAL(blob->data, head_ofs); head_ofs += 2;
723 len2 = SVAL(blob->data, head_ofs); head_ofs += 2;
724 ptr = IVAL(blob->data, head_ofs); head_ofs += 4;
725 /* make sure its in the right format - be strict */
726 if (len1 != len2 || ptr + len1 > blob->length) {
729 b = (DATA_BLOB *)va_arg(ap, void *);
730 *b = data_blob(blob->data + ptr, len1);
733 b = (DATA_BLOB *)va_arg(ap, void *);
734 len1 = va_arg(ap, unsigned);
735 /* make sure its in the right format - be strict */
737 *b = data_blob(blob->data + head_ofs, len1);
741 v = va_arg(ap, uint32 *);
743 *v = IVAL(blob->data, head_ofs); head_ofs += 4;
746 s = va_arg(ap, char *);
747 head_ofs += pull_string(NULL, p, blob->data+head_ofs, sizeof(p),
748 blob->length - head_ofs,
749 STR_ASCII|STR_TERMINATE);
750 if (strcmp(s, p) != 0) {
762 * Print out the NTLMSSP flags for debugging
765 void debug_ntlmssp_flags(uint32 neg_flags)
767 DEBUG(3,("Got NTLMSSP neg_flags=0x%08x\n", neg_flags));
769 if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE)
770 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_UNICODE\n"));
771 if (neg_flags & NTLMSSP_NEGOTIATE_OEM)
772 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_OEM\n"));
773 if (neg_flags & NTLMSSP_REQUEST_TARGET)
774 DEBUGADD(4, (" NTLMSSP_REQUEST_TARGET\n"));
775 if (neg_flags & NTLMSSP_NEGOTIATE_SIGN)
776 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_SIGN\n"));
777 if (neg_flags & NTLMSSP_NEGOTIATE_SEAL)
778 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_SEAL\n"));
779 if (neg_flags & NTLMSSP_NEGOTIATE_LM_KEY)
780 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_LM_KEY\n"));
781 if (neg_flags & NTLMSSP_NEGOTIATE_NETWARE)
782 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NETWARE\n"));
783 if (neg_flags & NTLMSSP_NEGOTIATE_NTLM)
784 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NTLM\n"));
785 if (neg_flags & NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED)
786 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED\n"));
787 if (neg_flags & NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED)
788 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED\n"));
789 if (neg_flags & NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL)
790 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL\n"));
791 if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN)
792 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_ALWAYS_SIGN\n"));
793 if (neg_flags & NTLMSSP_NEGOTIATE_NTLM2)
794 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NTLM2\n"));
795 if (neg_flags & NTLMSSP_CHAL_TARGET_INFO)
796 DEBUGADD(4, (" NTLMSSP_CHAL_TARGET_INFO\n"));
797 if (neg_flags & NTLMSSP_NEGOTIATE_128)
798 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_128\n"));
799 if (neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)
800 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_KEY_EXCH\n"));