RIP BOOL. Convert BOOL -> bool. I found a few interesting
[samba.git] / source3 / libsmb / clispnego.c
index da8c6450ae51789684d009ff43152a6d546e242c..f95b11e4cded9153788be458a7091d01cda0ff8b 100644 (file)
@@ -1,12 +1,13 @@
 /* 
-   Unix SMB/Netbios implementation.
-   Version 3.0
+   Unix SMB/CIFS implementation.
    simple kerberos5/SPNEGO routines
    Copyright (C) Andrew Tridgell 2001
+   Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2002
+   Copyright (C) Luke Howard     2003
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "includes.h"
 
 /*
   generate a negTokenInit packet given a GUID, a list of supported
-  OIDs (the mechanisms) and a principle name string 
+  OIDs (the mechanisms) and a principal name string 
 */
-ASN1_DATA spnego_gen_negTokenInit(uint8 guid[16], 
+DATA_BLOB spnego_gen_negTokenInit(char guid[16], 
                                  const char *OIDs[], 
-                                 const char *principle)
+                                 const char *principal)
 {
        int i;
        ASN1_DATA data;
+       DATA_BLOB ret;
 
        memset(&data, 0, sizeof(data));
 
@@ -51,7 +52,7 @@ ASN1_DATA spnego_gen_negTokenInit(uint8 guid[16],
        asn1_push_tag(&data, ASN1_CONTEXT(3));
        asn1_push_tag(&data, ASN1_SEQUENCE(0));
        asn1_push_tag(&data, ASN1_CONTEXT(0));
-       asn1_write_GeneralString(&data,principle);
+       asn1_write_GeneralString(&data,principal);
        asn1_pop_tag(&data);
        asn1_pop_tag(&data);
        asn1_pop_tag(&data);
@@ -66,26 +67,71 @@ ASN1_DATA spnego_gen_negTokenInit(uint8 guid[16],
                asn1_free(&data);
        }
 
-       return data;
+       ret = data_blob(data.data, data.length);
+       asn1_free(&data);
+
+       return ret;
 }
 
+/*
+  Generate a negTokenInit as used by the client side ... It has a mechType
+  (OID), and a mechToken (a security blob) ... 
+
+  Really, we need to break out the NTLMSSP stuff as well, because it could be
+  raw in the packets!
+*/
+DATA_BLOB gen_negTokenInit(const char *OID, DATA_BLOB blob)
+{
+       ASN1_DATA data;
+       DATA_BLOB ret;
+
+       memset(&data, 0, sizeof(data));
+
+       asn1_push_tag(&data, ASN1_APPLICATION(0));
+       asn1_write_OID(&data,OID_SPNEGO);
+       asn1_push_tag(&data, ASN1_CONTEXT(0));
+       asn1_push_tag(&data, ASN1_SEQUENCE(0));
+
+       asn1_push_tag(&data, ASN1_CONTEXT(0));
+       asn1_push_tag(&data, ASN1_SEQUENCE(0));
+       asn1_write_OID(&data, OID);
+       asn1_pop_tag(&data);
+       asn1_pop_tag(&data);
+
+       asn1_push_tag(&data, ASN1_CONTEXT(2));
+       asn1_write_OctetString(&data,blob.data,blob.length);
+       asn1_pop_tag(&data);
+
+       asn1_pop_tag(&data);
+       asn1_pop_tag(&data);
+
+       asn1_pop_tag(&data);
+
+       if (data.has_error) {
+               DEBUG(1,("Failed to build negTokenInit at offset %d\n", (int)data.ofs));
+               asn1_free(&data);
+       }
+
+       ret = data_blob(data.data, data.length);
+       asn1_free(&data);
+
+       return ret;
+}
 
 /*
   parse a negTokenInit packet giving a GUID, a list of supported
-  OIDs (the mechanisms) and a principle name string 
+  OIDs (the mechanisms) and a principal name string 
 */
-BOOL spnego_parse_negTokenInit(DATA_BLOB blob,
-                              uint8 guid[16], 
+bool spnego_parse_negTokenInit(DATA_BLOB blob,
                               char *OIDs[ASN1_MAX_OIDS], 
-                              char **principle)
+                              char **principal)
 {
        int i;
-       BOOL ret;
+       bool ret;
        ASN1_DATA data;
 
        asn1_load(&data, blob);
 
-       asn1_read(&data, guid, 16);
        asn1_start_tag(&data,ASN1_APPLICATION(0));
        asn1_check_OID(&data,OID_SPNEGO);
        asn1_start_tag(&data,ASN1_CONTEXT(0));
@@ -93,22 +139,25 @@ BOOL spnego_parse_negTokenInit(DATA_BLOB blob,
 
        asn1_start_tag(&data,ASN1_CONTEXT(0));
        asn1_start_tag(&data,ASN1_SEQUENCE(0));
-       for (i=0; asn1_tag_remaining(&data) > 0 && i < ASN1_MAX_OIDS; i++) {
-               char *oid = NULL;
-               asn1_read_OID(&data,&oid);
-               OIDs[i] = oid;
+       for (i=0; asn1_tag_remaining(&data) > 0 && i < ASN1_MAX_OIDS-1; i++) {
+               char *oid_str = NULL;
+               asn1_read_OID(&data,&oid_str);
+               OIDs[i] = oid_str;
        }
        OIDs[i] = NULL;
        asn1_end_tag(&data);
        asn1_end_tag(&data);
 
-       asn1_start_tag(&data, ASN1_CONTEXT(3));
-       asn1_start_tag(&data, ASN1_SEQUENCE(0));
-       asn1_start_tag(&data, ASN1_CONTEXT(0));
-       asn1_read_GeneralString(&data,principle);
-       asn1_end_tag(&data);
-       asn1_end_tag(&data);
-       asn1_end_tag(&data);
+       *principal = NULL;
+       if (asn1_tag_remaining(&data) > 0) {
+               asn1_start_tag(&data, ASN1_CONTEXT(3));
+               asn1_start_tag(&data, ASN1_SEQUENCE(0));
+               asn1_start_tag(&data, ASN1_CONTEXT(0));
+               asn1_read_GeneralString(&data,principal);
+               asn1_end_tag(&data);
+               asn1_end_tag(&data);
+               asn1_end_tag(&data);
+       }
 
        asn1_end_tag(&data);
        asn1_end_tag(&data);
@@ -116,11 +165,18 @@ BOOL spnego_parse_negTokenInit(DATA_BLOB blob,
        asn1_end_tag(&data);
 
        ret = !data.has_error;
+       if (data.has_error) {
+               int j;
+               SAFE_FREE(*principal);
+               for(j = 0; j < i && j < ASN1_MAX_OIDS-1; j++) {
+                       SAFE_FREE(OIDs[j]);
+               }
+       }
+
        asn1_free(&data);
        return ret;
 }
 
-
 /*
   generate a negTokenTarg packet given a list of OIDs and a security blob
 */
@@ -165,11 +221,59 @@ DATA_BLOB gen_negTokenTarg(const char *OIDs[], DATA_BLOB blob)
        return ret;
 }
 
+/*
+  parse a negTokenTarg packet giving a list of OIDs and a security blob
+*/
+bool parse_negTokenTarg(DATA_BLOB blob, char *OIDs[ASN1_MAX_OIDS], DATA_BLOB *secblob)
+{
+       int i;
+       ASN1_DATA data;
+
+       asn1_load(&data, blob);
+       asn1_start_tag(&data, ASN1_APPLICATION(0));
+       asn1_check_OID(&data,OID_SPNEGO);
+       asn1_start_tag(&data, ASN1_CONTEXT(0));
+       asn1_start_tag(&data, ASN1_SEQUENCE(0));
+
+       asn1_start_tag(&data, ASN1_CONTEXT(0));
+       asn1_start_tag(&data, ASN1_SEQUENCE(0));
+       for (i=0; asn1_tag_remaining(&data) > 0 && i < ASN1_MAX_OIDS-1; i++) {
+               char *oid_str = NULL;
+               asn1_read_OID(&data,&oid_str);
+               OIDs[i] = oid_str;
+       }
+       OIDs[i] = NULL;
+       asn1_end_tag(&data);
+       asn1_end_tag(&data);
+
+       asn1_start_tag(&data, ASN1_CONTEXT(2));
+       asn1_read_OctetString(&data,secblob);
+       asn1_end_tag(&data);
+
+       asn1_end_tag(&data);
+       asn1_end_tag(&data);
+
+       asn1_end_tag(&data);
+
+       if (data.has_error) {
+               int j;
+               data_blob_free(secblob);
+               for(j = 0; j < i && j < ASN1_MAX_OIDS-1; j++) {
+                       SAFE_FREE(OIDs[j]);
+               }
+               DEBUG(1,("Failed to parse negTokenTarg at offset %d\n", (int)data.ofs));
+               asn1_free(&data);
+               return False;
+       }
+
+       asn1_free(&data);
+       return True;
+}
 
 /*
   generate a krb5 GSS-API wrapper packet given a ticket
 */
-static DATA_BLOB spnego_gen_krb5_wrap(DATA_BLOB ticket)
+DATA_BLOB spnego_gen_krb5_wrap(const DATA_BLOB ticket, const uint8 tok_id[2])
 {
        ASN1_DATA data;
        DATA_BLOB ret;
@@ -178,7 +282,8 @@ static DATA_BLOB spnego_gen_krb5_wrap(DATA_BLOB ticket)
 
        asn1_push_tag(&data, ASN1_APPLICATION(0));
        asn1_write_OID(&data, OID_KERBEROS5);
-       asn1_write_BOOLEAN(&data, 0);
+
+       asn1_write(&data, tok_id, 2);
        asn1_write(&data, ticket.data, ticket.length);
        asn1_pop_tag(&data);
 
@@ -193,52 +298,85 @@ static DATA_BLOB spnego_gen_krb5_wrap(DATA_BLOB ticket)
        return ret;
 }
 
+/*
+  parse a krb5 GSS-API wrapper packet giving a ticket
+*/
+bool spnego_parse_krb5_wrap(DATA_BLOB blob, DATA_BLOB *ticket, uint8 tok_id[2])
+{
+       bool ret;
+       ASN1_DATA data;
+       int data_remaining;
+
+       asn1_load(&data, blob);
+       asn1_start_tag(&data, ASN1_APPLICATION(0));
+       asn1_check_OID(&data, OID_KERBEROS5);
+
+       data_remaining = asn1_tag_remaining(&data);
+
+       if (data_remaining < 3) {
+               data.has_error = True;
+       } else {
+               asn1_read(&data, tok_id, 2);
+               data_remaining -= 2;
+               *ticket = data_blob(NULL, data_remaining);
+               asn1_read(&data, ticket->data, ticket->length);
+       }
+
+       asn1_end_tag(&data);
+
+       ret = !data.has_error;
+
+       if (data.has_error) {
+               data_blob_free(ticket);
+       }
+
+       asn1_free(&data);
+
+       return ret;
+}
+
 
 /* 
    generate a SPNEGO negTokenTarg packet, ready for a EXTENDED_SECURITY
    kerberos session setup 
 */
-DATA_BLOB spnego_gen_negTokenTarg(struct cli_state *cli, char *principle)
+int spnego_gen_negTokenTarg(const char *principal, int time_offset, 
+                           DATA_BLOB *targ, 
+                           DATA_BLOB *session_key_krb5, uint32 extra_ap_opts,
+                           time_t *expire_time)
 {
-       char *p;
-       fstring service;
-       char *realm;
-       DATA_BLOB tkt, tkt_wrapped, targ;
-       const char *krb_mechs[] = {OID_KERBEROS5_OLD, OID_NTLMSSP, NULL};
-
-       fstrcpy(service, principle);
-       p = strchr_m(service, '@');
-       if (!p) {
-               DEBUG(1,("Malformed principle [%s] in spnego_gen_negTokenTarg\n",
-                        principle));
-               return data_blob(NULL, 0);
-       }
-       *p = 0;
-       realm = p+1;
+       int retval;
+       DATA_BLOB tkt, tkt_wrapped;
+       const char *krb_mechs[] = {OID_KERBEROS5_OLD, OID_KERBEROS5, OID_NTLMSSP, NULL};
+
+       /* get a kerberos ticket for the service and extract the session key */
+       retval = cli_krb5_get_ticket(principal, time_offset,
+                                       &tkt, session_key_krb5, extra_ap_opts, NULL, 
+                                       expire_time);
 
-       /* get a kerberos ticket for the service */
-       tkt = krb5_get_ticket(service, realm);
+       if (retval)
+               return retval;
 
        /* wrap that up in a nice GSS-API wrapping */
-       tkt_wrapped = spnego_gen_krb5_wrap(tkt);
+       tkt_wrapped = spnego_gen_krb5_wrap(tkt, TOK_ID_KRB_AP_REQ);
 
        /* and wrap that in a shiny SPNEGO wrapper */
-       targ = gen_negTokenTarg(krb_mechs, tkt_wrapped);
+       *targ = gen_negTokenTarg(krb_mechs, tkt_wrapped);
 
-       data_blob_free(tkt_wrapped);
-       data_blob_free(tkt);
+       data_blob_free(&tkt_wrapped);
+       data_blob_free(&tkt);
 
-       return targ;
+       return retval;
 }
 
 
 /*
   parse a spnego NTLMSSP challenge packet giving two security blobs
 */
-BOOL spnego_parse_challenge(DATA_BLOB blob,
+bool spnego_parse_challenge(const DATA_BLOB blob,
                            DATA_BLOB *chal1, DATA_BLOB *chal2)
 {
-       BOOL ret;
+       bool ret;
        ASN1_DATA data;
 
        ZERO_STRUCTP(chal1);
@@ -257,13 +395,13 @@ BOOL spnego_parse_challenge(DATA_BLOB blob,
        asn1_end_tag(&data);
 
        asn1_start_tag(&data,ASN1_CONTEXT(2));
-       asn1_read_octet_string(&data, chal1);
+       asn1_read_OctetString(&data, chal1);
        asn1_end_tag(&data);
 
        /* the second challenge is optional (XP doesn't send it) */
        if (asn1_tag_remaining(&data)) {
                asn1_start_tag(&data,ASN1_CONTEXT(3));
-               asn1_read_octet_string(&data, chal2);
+               asn1_read_OctetString(&data, chal2);
                asn1_end_tag(&data);
        }
 
@@ -271,12 +409,19 @@ BOOL spnego_parse_challenge(DATA_BLOB blob,
        asn1_end_tag(&data);
 
        ret = !data.has_error;
+
+       if (data.has_error) {
+               data_blob_free(chal1);
+               data_blob_free(chal2);
+       }
+
        asn1_free(&data);
        return ret;
 }
 
+
 /*
- generate a SPNEGO NTLMSSP auth packet. This will contain the encrypted passwords
+ generate a SPNEGO auth packet. This will contain the encrypted passwords
 */
 DATA_BLOB spnego_gen_auth(DATA_BLOB blob)
 {
@@ -298,100 +443,144 @@ DATA_BLOB spnego_gen_auth(DATA_BLOB blob)
        asn1_free(&data);
 
        return ret;
-       
 }
 
+/*
+ parse a SPNEGO auth packet. This contains the encrypted passwords
+*/
+bool spnego_parse_auth(DATA_BLOB blob, DATA_BLOB *auth)
+{
+       ASN1_DATA data;
+
+       asn1_load(&data, blob);
+       asn1_start_tag(&data, ASN1_CONTEXT(1));
+       asn1_start_tag(&data, ASN1_SEQUENCE(0));
+       asn1_start_tag(&data, ASN1_CONTEXT(2));
+       asn1_read_OctetString(&data,auth);
+       asn1_end_tag(&data);
+       asn1_end_tag(&data);
+       asn1_end_tag(&data);
+
+       if (data.has_error) {
+               DEBUG(3,("spnego_parse_auth failed at %d\n", (int)data.ofs));
+               data_blob_free(auth);
+               asn1_free(&data);
+               return False;
+       }
+
+       asn1_free(&data);
+       return True;
+}
 
 /*
-  this is a tiny msrpc packet generator. I am only using this to
-  avoid tying this code to a particular varient of our rpc code. This
-  generator is not general enough for all our rpc needs, its just
-  enough for the spnego/ntlmssp code
-
-  format specifiers are:
-
-  U = unicode string (input is unix string)
-  B = data blob (pointer + length)
-  d = word (4 bytes)
-  C = constant ascii string
- */
-BOOL msrpc_gen(DATA_BLOB *blob,
-              const char *format, ...)
+  generate a minimal SPNEGO response packet.  Doesn't contain much.
+*/
+DATA_BLOB spnego_gen_auth_response(DATA_BLOB *reply, NTSTATUS nt_status,
+                                  const char *mechOID)
 {
-       int i, n;
-       va_list ap;
-       char *s;
-       uint8 *b;
-       int head_size=0, data_size=0;
-       int head_ofs, data_ofs;
-
-       /* first scan the format to work out the header and body size */
-       va_start(ap, format);
-       for (i=0; format[i]; i++) {
-               switch (format[i]) {
-               case 'U':
-                       s = va_arg(ap, char *);
-                       head_size += 8;
-                       data_size += str_charnum(s) * 2;
-                       break;
-               case 'B':
-                       b = va_arg(ap, uint8 *);
-                       head_size += 8;
-                       data_size += va_arg(ap, int);
-                       break;
-               case 'd':
-                       n = va_arg(ap, int);
-                       head_size += 4;
-                       break;
-               case 'C':
-                       s = va_arg(ap, char *);
-                       head_size += str_charnum(s) + 1;
-                       break;
-               }
+       ASN1_DATA data;
+       DATA_BLOB ret;
+       uint8 negResult;
+
+       if (NT_STATUS_IS_OK(nt_status)) {
+               negResult = SPNEGO_NEG_RESULT_ACCEPT;
+       } else if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
+               negResult = SPNEGO_NEG_RESULT_INCOMPLETE; 
+       } else {
+               negResult = SPNEGO_NEG_RESULT_REJECT; 
+       }
+
+       ZERO_STRUCT(data);
+
+       asn1_push_tag(&data, ASN1_CONTEXT(1));
+       asn1_push_tag(&data, ASN1_SEQUENCE(0));
+       asn1_push_tag(&data, ASN1_CONTEXT(0));
+       asn1_write_enumerated(&data, negResult);
+       asn1_pop_tag(&data);
+
+       if (reply->data != NULL) {
+               asn1_push_tag(&data,ASN1_CONTEXT(1));
+               asn1_write_OID(&data, mechOID);
+               asn1_pop_tag(&data);
+               
+               asn1_push_tag(&data,ASN1_CONTEXT(2));
+               asn1_write_OctetString(&data, reply->data, reply->length);
+               asn1_pop_tag(&data);
+       }
+
+       asn1_pop_tag(&data);
+       asn1_pop_tag(&data);
+
+       ret = data_blob(data.data, data.length);
+       asn1_free(&data);
+       return ret;
+}
+
+/*
+ parse a SPNEGO auth packet. This contains the encrypted passwords
+*/
+bool spnego_parse_auth_response(DATA_BLOB blob, NTSTATUS nt_status,
+                               const char *mechOID,
+                               DATA_BLOB *auth)
+{
+       ASN1_DATA data;
+       uint8 negResult;
+
+       if (NT_STATUS_IS_OK(nt_status)) {
+               negResult = SPNEGO_NEG_RESULT_ACCEPT;
+       } else if (NT_STATUS_EQUAL(nt_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
+               negResult = SPNEGO_NEG_RESULT_INCOMPLETE;
+       } else {
+               negResult = SPNEGO_NEG_RESULT_REJECT;
        }
-       va_end(ap);
-
-       /* allocate the space, then scan the format again to fill in the values */
-       blob->data = malloc(head_size + data_size);
-       blob->length = head_size + data_size;
-       if (!blob->data) return False;
-
-       head_ofs = 0;
-       data_ofs = head_size;
-
-       va_start(ap, format);
-       for (i=0; format[i]; i++) {
-               switch (format[i]) {
-               case 'U':
-                       s = va_arg(ap, char *);
-                       n = str_charnum(s);
-                       SSVAL(blob->data, head_ofs, n*2); head_ofs += 2;
-                       SSVAL(blob->data, head_ofs, n*2); head_ofs += 2;
-                       SIVAL(blob->data, head_ofs, data_ofs); head_ofs += 4;
-                       push_string(NULL, blob->data+data_ofs, s, n*2, STR_UNICODE|STR_NOALIGN);
-                       data_ofs += n*2;
-                       break;
-               case 'B':
-                       b = va_arg(ap, uint8 *);
-                       n = va_arg(ap, int);
-                       SSVAL(blob->data, head_ofs, n); head_ofs += 2;
-                       SSVAL(blob->data, head_ofs, n); head_ofs += 2;
-                       SIVAL(blob->data, head_ofs, data_ofs); head_ofs += 4;
-                       memcpy(blob->data+data_ofs, b, n);
-                       data_ofs += n;
-                       break;
-               case 'd':
-                       n = va_arg(ap, int);
-                       SIVAL(blob->data, head_ofs, n); head_ofs += 4;
-                       break;
-               case 'C':
-                       s = va_arg(ap, char *);
-                       head_ofs += push_string(NULL, blob->data+head_ofs, s, -1, 
-                                               STR_ASCII|STR_TERMINATE);
-                       break;
+
+       asn1_load(&data, blob);
+       asn1_start_tag(&data, ASN1_CONTEXT(1));
+       asn1_start_tag(&data, ASN1_SEQUENCE(0));
+       asn1_start_tag(&data, ASN1_CONTEXT(0));
+       asn1_check_enumerated(&data, negResult);
+       asn1_end_tag(&data);
+
+       *auth = data_blob_null;
+
+       if (asn1_tag_remaining(&data)) {
+               asn1_start_tag(&data,ASN1_CONTEXT(1));
+               asn1_check_OID(&data, mechOID);
+               asn1_end_tag(&data);
+
+               if (asn1_tag_remaining(&data)) {
+                       asn1_start_tag(&data,ASN1_CONTEXT(2));
+                       asn1_read_OctetString(&data, auth);
+                       asn1_end_tag(&data);
                }
+       } else if (negResult == SPNEGO_NEG_RESULT_INCOMPLETE) {
+               data.has_error = 1;
        }
-       va_end(ap);
 
+       /* Binding against Win2K DC returns a duplicate of the responseToken in
+        * the optional mechListMIC field. This is a bug in Win2K. We ignore
+        * this field if it exists. Win2K8 may return a proper mechListMIC at
+        * which point we need to implement the integrity checking. */
+       if (asn1_tag_remaining(&data)) {
+               DATA_BLOB mechList = data_blob_null;
+               asn1_start_tag(&data, ASN1_CONTEXT(3));
+               asn1_read_OctetString(&data, &mechList);
+               asn1_end_tag(&data);
+               data_blob_free(&mechList);
+               DEBUG(5,("spnego_parse_auth_response received mechListMIC, "
+                   "ignoring.\n"));
+       }
+
+       asn1_end_tag(&data);
+       asn1_end_tag(&data);
+
+       if (data.has_error) {
+               DEBUG(3,("spnego_parse_auth_response failed at %d\n", (int)data.ofs));
+               asn1_free(&data);
+               data_blob_free(auth);
+               return False;
+       }
+
+       asn1_free(&data);
        return True;
 }