gensec: clarify memory ownership for gensec_session_info() and gensec_session_key()
[samba.git] / source4 / auth / ntlmssp / ntlmssp.c
index 9452ac3e96efc69c05cb8378b52187540b1b13c6..a53e5547ab21b7f13cfec6ab99d36b425e2ca9bd 100644 (file)
@@ -9,7 +9,7 @@
 
    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"
-#include "auth/auth.h"
 #include "auth/ntlmssp/ntlmssp.h"
+#include "../libcli/auth/libcli_auth.h"
+#include "librpc/gen_ndr/ndr_dcerpc.h"
+#include "auth/gensec/gensec.h"
+#include "auth/gensec/gensec_proto.h"
 
 /**
  * Callbacks for NTLMSSP - for both client and server operating modes
 
 static const struct ntlmssp_callbacks {
        enum ntlmssp_role role;
-       enum ntlmssp_message_type ntlmssp_command;
-       NTSTATUS (*fn)(struct gensec_security *gensec_security, 
-                      TALLOC_CTX *out_mem_ctx, 
-                      DATA_BLOB in, DATA_BLOB *out);
+       enum ntlmssp_message_type command;
+       NTSTATUS (*sync_fn)(struct gensec_security *gensec_security,
+                           TALLOC_CTX *out_mem_ctx,
+                           DATA_BLOB in, DATA_BLOB *out);
 } ntlmssp_callbacks[] = {
-       {NTLMSSP_CLIENT, NTLMSSP_INITIAL, ntlmssp_client_initial},
-       {NTLMSSP_SERVER, NTLMSSP_NEGOTIATE, ntlmssp_server_negotiate},
-       {NTLMSSP_CLIENT, NTLMSSP_CHALLENGE, ntlmssp_client_challenge},
-       {NTLMSSP_SERVER, NTLMSSP_AUTH, ntlmssp_server_auth},
+       {
+               .role           = NTLMSSP_CLIENT,
+               .command        = NTLMSSP_INITIAL,
+               .sync_fn        = ntlmssp_client_initial,
+       },{
+               .role           = NTLMSSP_SERVER,
+               .command        = NTLMSSP_NEGOTIATE,
+               .sync_fn        = gensec_ntlmssp_server_negotiate,
+       },{
+               .role           = NTLMSSP_CLIENT,
+               .command        = NTLMSSP_CHALLENGE,
+               .sync_fn        = ntlmssp_client_challenge,
+       },{
+               .role           = NTLMSSP_SERVER,
+               .command        = NTLMSSP_AUTH,
+               .sync_fn        = gensec_ntlmssp_server_auth,
+       }
 };
 
 
-/**
- * Print out the NTLMSSP flags for debugging 
- * @param neg_flags The flags from the packet
- */
-
-void debug_ntlmssp_flags(uint32_t neg_flags)
-{
-       DEBUG(3,("Got NTLMSSP neg_flags=0x%08x\n", neg_flags));
-       
-       if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_UNICODE\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_OEM) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_OEM\n"));
-       if (neg_flags & NTLMSSP_REQUEST_TARGET) 
-               DEBUGADD(4, ("  NTLMSSP_REQUEST_TARGET\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_SIGN) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_SIGN\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_SEAL) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_SEAL\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_LM_KEY\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_NETWARE) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_NETWARE\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_NTLM) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_NTLM\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_ALWAYS_SIGN\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_NTLM2) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_NTLM2\n"));
-       if (neg_flags & NTLMSSP_CHAL_TARGET_INFO) 
-               DEBUGADD(4, ("  NTLMSSP_CHAL_TARGET_INFO\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_128) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_128\n"));
-       if (neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH) 
-               DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_KEY_EXCH\n"));
-}
-
 static NTSTATUS gensec_ntlmssp_magic(struct gensec_security *gensec_security, 
                                     const DATA_BLOB *first_packet) 
 {
@@ -98,30 +70,17 @@ static NTSTATUS gensec_ntlmssp_magic(struct gensec_security *gensec_security,
        }
 }
 
-/**
- * Next state function for the wrapped NTLMSSP state machine
- * 
- * @param gensec_security GENSEC state, initialised to NTLMSSP
- * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
- * @param in The request, as a DATA_BLOB
- * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
- * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent, 
- *                or NT_STATUS_OK if the user is authenticated. 
- */
-
-static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security, 
-                                     TALLOC_CTX *out_mem_ctx, 
-                                     const DATA_BLOB input, DATA_BLOB *out) 
+static NTSTATUS gensec_ntlmssp_update_find(struct ntlmssp_state *ntlmssp_state,
+                                          const DATA_BLOB input, uint32_t *idx)
 {
-       struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
-       NTSTATUS status;
-
+       struct gensec_ntlmssp_context *gensec_ntlmssp =
+               talloc_get_type_abort(ntlmssp_state->callback_private,
+                                     struct gensec_ntlmssp_context);
+       struct gensec_security *gensec_security = gensec_ntlmssp->gensec_security;
        uint32_t ntlmssp_command;
-       int i;
+       uint32_t i;
 
-       *out = data_blob(NULL, 0);
-
-       if (gensec_ntlmssp_state->expected_state == NTLMSSP_DONE) {
+       if (ntlmssp_state->expected_state == NTLMSSP_DONE) {
                /* We are strict here because other modules, which we
                 * don't fully control (such as GSSAPI) are also
                 * strict, but are tested less often */
@@ -130,14 +89,8 @@ static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
                return NT_STATUS_INVALID_PARAMETER;
        }
 
-       if (!out_mem_ctx) {
-               /* if the caller doesn't want to manage/own the memory, 
-                  we can put it on our context */
-               out_mem_ctx = gensec_ntlmssp_state;
-       }
-
        if (!input.length) {
-               switch (gensec_ntlmssp_state->role) {
+               switch (ntlmssp_state->role) {
                case NTLMSSP_CLIENT:
                        ntlmssp_command = NTLMSSP_INITIAL;
                        break;
@@ -153,7 +106,7 @@ static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
                        break;
                }
        } else {
-               if (!msrpc_parse(gensec_ntlmssp_state, 
+               if (!msrpc_parse(ntlmssp_state,
                                 &input, "Cd",
                                 "NTLMSSP",
                                 &ntlmssp_command)) {
@@ -163,191 +116,158 @@ static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
                }
        }
 
-       if (ntlmssp_command != gensec_ntlmssp_state->expected_state) {
-               DEBUG(2, ("got NTLMSSP command %u, expected %u\n", ntlmssp_command, gensec_ntlmssp_state->expected_state));
+       if (ntlmssp_command != ntlmssp_state->expected_state) {
+               DEBUG(2, ("got NTLMSSP command %u, expected %u\n", ntlmssp_command, ntlmssp_state->expected_state));
                return NT_STATUS_INVALID_PARAMETER;
        }
 
        for (i=0; i < ARRAY_SIZE(ntlmssp_callbacks); i++) {
-               if (ntlmssp_callbacks[i].role == gensec_ntlmssp_state->role 
-                   && ntlmssp_callbacks[i].ntlmssp_command == ntlmssp_command) {
-                       status = ntlmssp_callbacks[i].fn(gensec_security, out_mem_ctx, input, out);
-                       break;
+               if (ntlmssp_callbacks[i].role == ntlmssp_state->role &&
+                   ntlmssp_callbacks[i].command == ntlmssp_command) {
+                       *idx = i;
+                       return NT_STATUS_OK;
                }
        }
 
-       if (i == ARRAY_SIZE(ntlmssp_callbacks)) {
-               
-               DEBUG(1, ("failed to find NTLMSSP callback for NTLMSSP mode %u, command %u\n", 
-                         gensec_ntlmssp_state->role, ntlmssp_command)); 
+       DEBUG(1, ("failed to find NTLMSSP callback for NTLMSSP mode %u, command %u\n", 
+                 ntlmssp_state->role, ntlmssp_command));
                
-               return NT_STATUS_INVALID_PARAMETER;
-       }
-
-       if (!NT_STATUS_IS_OK(status)) {
-               /* error or more processing required */
-               return status;
-       }
-       
-       return status;
+       return NT_STATUS_INVALID_PARAMETER;
 }
 
 /**
- * Return the NTLMSSP master session key
+ * Next state function for the wrapped NTLMSSP state machine
  * 
- * @param gensec_ntlmssp_state NTLMSSP State
+ * @param gensec_security GENSEC state, initialised to NTLMSSP
+ * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
+ * @param in The request, as a DATA_BLOB
+ * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
+ * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent, 
+ *                or NT_STATUS_OK if the user is authenticated. 
  */
 
-NTSTATUS gensec_ntlmssp_session_key(struct gensec_security *gensec_security, 
-                                   DATA_BLOB *session_key)
-{
-       struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
-
-       if (!gensec_ntlmssp_state->session_key.data) {
-               return NT_STATUS_NO_USER_SESSION_KEY;
-       }
-       *session_key = gensec_ntlmssp_state->session_key;
-
-       return NT_STATUS_OK;
-}
-
-void ntlmssp_handle_neg_flags(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
-                             uint32_t neg_flags, BOOL allow_lm)
+static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security, 
+                                     TALLOC_CTX *out_mem_ctx, 
+                                     const DATA_BLOB input, DATA_BLOB *out)
 {
-       if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE) {
-               gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_UNICODE;
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_OEM;
-               gensec_ntlmssp_state->unicode = True;
-       } else {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_UNICODE;
-               gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_OEM;
-               gensec_ntlmssp_state->unicode = False;
-       }
+       struct gensec_ntlmssp_context *gensec_ntlmssp =
+               talloc_get_type_abort(gensec_security->private_data,
+                                     struct gensec_ntlmssp_context);
+       struct ntlmssp_state *ntlmssp_state = gensec_ntlmssp->ntlmssp_state;
+       NTSTATUS status;
+       uint32_t i;
 
-       if ((neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) && allow_lm && !gensec_ntlmssp_state->use_ntlmv2) {
-               /* other end forcing us to use LM */
-               gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_LM_KEY;
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
-       } else {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_LM_KEY;
-       }
+       *out = data_blob(NULL, 0);
 
-       if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN) {
-               gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_ALWAYS_SIGN;
+       if (!out_mem_ctx) {
+               /* if the caller doesn't want to manage/own the memory, 
+                  we can put it on our context */
+               out_mem_ctx = ntlmssp_state;
        }
 
-       if (!(neg_flags & NTLMSSP_NEGOTIATE_SIGN)) {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SIGN;
-       }
+       status = gensec_ntlmssp_update_find(ntlmssp_state, input, &i);
+       NT_STATUS_NOT_OK_RETURN(status);
 
-       if (!(neg_flags & NTLMSSP_NEGOTIATE_SEAL)) {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SEAL;
-       }
+       status = ntlmssp_callbacks[i].sync_fn(gensec_security, out_mem_ctx, input, out);
+       NT_STATUS_NOT_OK_RETURN(status);
+       
+       return NT_STATUS_OK;
+}
 
-       if (!(neg_flags & NTLMSSP_NEGOTIATE_NTLM2)) {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
-       }
+/**
+ * Return the NTLMSSP master session key
+ * 
+ * @param ntlmssp_state NTLMSSP State
+ */
 
-       if (!(neg_flags & NTLMSSP_NEGOTIATE_128)) {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_128;
-               if (neg_flags & NTLMSSP_NEGOTIATE_56) {
-                       gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_56;
-               }
-       }
+NTSTATUS gensec_ntlmssp_session_key(struct gensec_security *gensec_security, 
+                                   TALLOC_CTX *mem_ctx,
+                                   DATA_BLOB *session_key)
+{
+       struct gensec_ntlmssp_context *gensec_ntlmssp =
+               talloc_get_type_abort(gensec_security->private_data,
+                                     struct gensec_ntlmssp_context);
+       struct ntlmssp_state *ntlmssp_state = gensec_ntlmssp->ntlmssp_state;
 
-       if (!(neg_flags & NTLMSSP_NEGOTIATE_56)) {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_56;
+       if (ntlmssp_state->expected_state != NTLMSSP_DONE) {
+               return NT_STATUS_NO_USER_SESSION_KEY;
        }
 
-       if (!(neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)) {
-               gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_KEY_EXCH;
+       if (!ntlmssp_state->session_key.data) {
+               return NT_STATUS_NO_USER_SESSION_KEY;
        }
-
-       if ((neg_flags & NTLMSSP_REQUEST_TARGET)) {
-               gensec_ntlmssp_state->neg_flags |= NTLMSSP_REQUEST_TARGET;
+       *session_key = data_blob_talloc(mem_ctx, ntlmssp_state->session_key.data, ntlmssp_state->session_key.length);
+       if (!session_key->data) {
+               return NT_STATUS_NO_MEMORY;
        }
-       
-}
-
-/**
-   Weaken NTLMSSP keys to cope with down-level clients and servers.
-
-   We probably should have some parameters to control this, but as
-   it only occours for LM_KEY connections, and this is controlled
-   by the client lanman auth/lanman auth parameters, it isn't too bad.
-*/
 
-void ntlmssp_weaken_keys(struct gensec_ntlmssp_state *gensec_ntlmssp_state) 
-{
-       /* Key weakening not performed on the master key for NTLM2
-          and does not occour for NTLM1.  Therefore we only need
-          to do this for the LM_KEY.  
-       */
-
-       if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) {
-               if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_128) {
-                       
-               } else if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_56) {
-                       gensec_ntlmssp_state->session_key.data[7] = 0xa0;
-               } else { /* forty bits */
-                       gensec_ntlmssp_state->session_key.data[5] = 0xe5;
-                       gensec_ntlmssp_state->session_key.data[6] = 0x38;
-                       gensec_ntlmssp_state->session_key.data[7] = 0xb0;
-               }
-               gensec_ntlmssp_state->session_key.length = 8;
-       }
+       return NT_STATUS_OK;
 }
 
-static BOOL gensec_ntlmssp_have_feature(struct gensec_security *gensec_security,
+static bool gensec_ntlmssp_have_feature(struct gensec_security *gensec_security,
                                        uint32_t feature)
 {
-       struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
+       struct gensec_ntlmssp_context *gensec_ntlmssp =
+               talloc_get_type_abort(gensec_security->private_data,
+                                     struct gensec_ntlmssp_context);
+       struct ntlmssp_state *ntlmssp_state = gensec_ntlmssp->ntlmssp_state;
+
        if (feature & GENSEC_FEATURE_SIGN) {
-               if (!gensec_ntlmssp_state->session_key.length) {
-                       return False;
+               if (!ntlmssp_state->session_key.length) {
+                       return false;
                }
-               if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SIGN) {
-                       return True;
+               if (ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SIGN) {
+                       return true;
                }
        }
        if (feature & GENSEC_FEATURE_SEAL) {
-               if (!gensec_ntlmssp_state->session_key.length) {
-                       return False;
+               if (!ntlmssp_state->session_key.length) {
+                       return false;
                }
-               if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SEAL) {
-                       return True;
+               if (ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SEAL) {
+                       return true;
                }
        }
        if (feature & GENSEC_FEATURE_SESSION_KEY) {
-               if (gensec_ntlmssp_state->session_key.length) {
-                       return True;
+               if (ntlmssp_state->session_key.length) {
+                       return true;
                }
        }
        if (feature & GENSEC_FEATURE_DCE_STYLE) {
-               return True;
+               return true;
        }
        if (feature & GENSEC_FEATURE_ASYNC_REPLIES) {
-               if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
-                       return True;
+               if (ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
+                       return true;
                }
        }
-       return False;
+       return false;
 }
 
 NTSTATUS gensec_ntlmssp_start(struct gensec_security *gensec_security)
 {
-       struct gensec_ntlmssp_state *gensec_ntlmssp_state;
-       
-       gensec_ntlmssp_state = talloc_zero(gensec_security, struct gensec_ntlmssp_state);
-       if (!gensec_ntlmssp_state) {
+       struct gensec_ntlmssp_context *gensec_ntlmssp;
+       struct ntlmssp_state *ntlmssp_state;
+
+       gensec_ntlmssp = talloc_zero(gensec_security,
+                                    struct gensec_ntlmssp_context);
+       if (!gensec_ntlmssp) {
                return NT_STATUS_NO_MEMORY;
        }
 
-       gensec_ntlmssp_state->gensec_security = gensec_security;
-       gensec_ntlmssp_state->auth_context = NULL;
-       gensec_ntlmssp_state->server_info = NULL;
+       gensec_ntlmssp->gensec_security = gensec_security;
 
-       gensec_security->private_data = gensec_ntlmssp_state;
+       ntlmssp_state = talloc_zero(gensec_ntlmssp,
+                                   struct ntlmssp_state);
+       if (!ntlmssp_state) {
+               return NT_STATUS_NO_MEMORY;
+       }
+
+       ntlmssp_state->callback_private = gensec_ntlmssp;
+
+       gensec_ntlmssp->ntlmssp_state = ntlmssp_state;
+
+       gensec_security->private_data = gensec_ntlmssp;
        return NT_STATUS_OK;
 }
 
@@ -358,7 +278,7 @@ static const char *gensec_ntlmssp_oids[] = {
 
 static const struct gensec_security_ops gensec_ntlmssp_security_ops = {
        .name           = "ntlmssp",
-       .sasl_name      = "NTLM",
+       .sasl_name      = GENSEC_SASL_NAME_NTLMSSP, /* "NTLM" */
        .auth_type      = DCERPC_AUTH_TYPE_NTLMSSP,
        .oid            = gensec_ntlmssp_oids,
        .client_start   = gensec_ntlmssp_client_start,
@@ -375,13 +295,15 @@ static const struct gensec_security_ops gensec_ntlmssp_security_ops = {
        .session_key    = gensec_ntlmssp_session_key,
        .session_info   = gensec_ntlmssp_session_info,
        .have_feature   = gensec_ntlmssp_have_feature,
-       .enabled        = True
+       .enabled        = true,
+       .priority       = GENSEC_NTLMSSP
 };
 
 
-NTSTATUS gensec_ntlmssp_init(void)
+_PUBLIC_ NTSTATUS gensec_ntlmssp_init(void)
 {
        NTSTATUS ret;
+
        ret = gensec_register(&gensec_ntlmssp_security_ops);
        if (!NT_STATUS_IS_OK(ret)) {
                DEBUG(0,("Failed to register '%s' gensec backend!\n",