source4/auth/ntlmssp/ntlmssp.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 3.0
   4    handle NLTMSSP, client server side parsing
   5
   6    Copyright (C) Andrew Tridgell      2001
   7    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2001-2005
   8    Copyright (C) Stefan Metzmacher 2005
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #include "includes.h"
  25 #include "auth/ntlmssp/ntlmssp.h"
  26 #include "../libcli/auth/libcli_auth.h"
  27 #include "librpc/gen_ndr/ndr_dcerpc.h"
  28 #include "auth/gensec/gensec.h"
  29 #include "auth/gensec/gensec_proto.h"
  30 #include "auth/gensec/gensec_toplevel_proto.h"
  31
  32 /**
  33  * Callbacks for NTLMSSP - for both client and server operating modes
  34  *
  35  */
  36
  37 static const struct ntlmssp_callbacks {
  38         enum ntlmssp_role role;
  39         enum ntlmssp_message_type command;
  40         NTSTATUS (*sync_fn)(struct gensec_security *gensec_security,
  41                             TALLOC_CTX *out_mem_ctx,
  42                             DATA_BLOB in, DATA_BLOB *out);
  43 } ntlmssp_callbacks[] = {
  44         {
  45                 .role           = NTLMSSP_CLIENT,
  46                 .command        = NTLMSSP_INITIAL,
  47                 .sync_fn        = ntlmssp_client_initial,
  48         },{
  49                 .role           = NTLMSSP_SERVER,
  50                 .command        = NTLMSSP_NEGOTIATE,
  51                 .sync_fn        = gensec_ntlmssp_server_negotiate,
  52         },{
  53                 .role           = NTLMSSP_CLIENT,
  54                 .command        = NTLMSSP_CHALLENGE,
  55                 .sync_fn        = ntlmssp_client_challenge,
  56         },{
  57                 .role           = NTLMSSP_SERVER,
  58                 .command        = NTLMSSP_AUTH,
  59                 .sync_fn        = gensec_ntlmssp_server_auth,
  60         }
  61 };
  62
  63
  64 static NTSTATUS gensec_ntlmssp_magic(struct gensec_security *gensec_security,
  65                                      const DATA_BLOB *first_packet)
  66 {
  67         if (ntlmssp_blob_matches_magic(first_packet)) {
  68                 return NT_STATUS_OK;
  69         } else {
  70                 return NT_STATUS_INVALID_PARAMETER;
  71         }
  72 }
  73
  74 static NTSTATUS gensec_ntlmssp_update_find(struct ntlmssp_state *ntlmssp_state,
  75                                            const DATA_BLOB input, uint32_t *idx)
  76 {
  77         struct gensec_ntlmssp_context *gensec_ntlmssp =
  78                 talloc_get_type_abort(ntlmssp_state->callback_private,
  79                                       struct gensec_ntlmssp_context);
  80         struct gensec_security *gensec_security = gensec_ntlmssp->gensec_security;
  81         uint32_t ntlmssp_command;
  82         uint32_t i;
  83
  84         if (ntlmssp_state->expected_state == NTLMSSP_DONE) {
  85                 /* We are strict here because other modules, which we
  86                  * don't fully control (such as GSSAPI) are also
  87                  * strict, but are tested less often */
  88
  89                 DEBUG(1, ("Called NTLMSSP after state machine was 'done'\n"));
  90                 return NT_STATUS_INVALID_PARAMETER;
  91         }
  92
  93         if (!input.length) {
  94                 switch (ntlmssp_state->role) {
  95                 case NTLMSSP_CLIENT:
  96                         ntlmssp_command = NTLMSSP_INITIAL;
  97                         break;
  98                 case NTLMSSP_SERVER:
  99                         if (gensec_security->want_features & GENSEC_FEATURE_DATAGRAM_MODE) {
 100                                 /* 'datagram' mode - no neg packet */
 101                                 ntlmssp_command = NTLMSSP_NEGOTIATE;
 102                         } else {
 103                                 /* This is normal in SPNEGO mech negotiation fallback */
 104                                 DEBUG(2, ("Failed to parse NTLMSSP packet: zero length\n"));
 105                                 return NT_STATUS_INVALID_PARAMETER;
 106                         }
 107                         break;
 108                 }
 109         } else {
 110                 if (!msrpc_parse(ntlmssp_state,
 111                                  &input, "Cd",
 112                                  "NTLMSSP",
 113                                  &ntlmssp_command)) {
 114                         DEBUG(1, ("Failed to parse NTLMSSP packet, could not extract NTLMSSP command\n"));
 115                         dump_data(2, input.data, input.length);
 116                         return NT_STATUS_INVALID_PARAMETER;
 117                 }
 118         }
 119
 120         if (ntlmssp_command != ntlmssp_state->expected_state) {
 121                 DEBUG(2, ("got NTLMSSP command %u, expected %u\n", ntlmssp_command, ntlmssp_state->expected_state));
 122                 return NT_STATUS_INVALID_PARAMETER;
 123         }
 124
 125         for (i=0; i < ARRAY_SIZE(ntlmssp_callbacks); i++) {
 126                 if (ntlmssp_callbacks[i].role == ntlmssp_state->role &&
 127                     ntlmssp_callbacks[i].command == ntlmssp_command) {
 128                         *idx = i;
 129                         return NT_STATUS_OK;
 130                 }
 131         }
 132
 133         DEBUG(1, ("failed to find NTLMSSP callback for NTLMSSP mode %u, command %u\n",
 134                   ntlmssp_state->role, ntlmssp_command));
 135
 136         return NT_STATUS_INVALID_PARAMETER;
 137 }
 138
 139 /**
 140  * Next state function for the wrapped NTLMSSP state machine
 141  *
 142  * @param gensec_security GENSEC state, initialised to NTLMSSP
 143  * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
 144  * @param in The request, as a DATA_BLOB
 145  * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
 146  * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
 147  *                or NT_STATUS_OK if the user is authenticated.
 148  */
 149
 150 static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
 151                                       TALLOC_CTX *out_mem_ctx,
 152                                       const DATA_BLOB input, DATA_BLOB *out)
 153 {
 154         struct gensec_ntlmssp_context *gensec_ntlmssp =
 155                 talloc_get_type_abort(gensec_security->private_data,
 156                                       struct gensec_ntlmssp_context);
 157         struct ntlmssp_state *ntlmssp_state = gensec_ntlmssp->ntlmssp_state;
 158         NTSTATUS status;
 159         uint32_t i;
 160
 161         *out = data_blob(NULL, 0);
 162
 163         if (!out_mem_ctx) {
 164                 /* if the caller doesn't want to manage/own the memory,
 165                    we can put it on our context */
 166                 out_mem_ctx = ntlmssp_state;
 167         }
 168
 169         status = gensec_ntlmssp_update_find(ntlmssp_state, input, &i);
 170         NT_STATUS_NOT_OK_RETURN(status);
 171
 172         status = ntlmssp_callbacks[i].sync_fn(gensec_security, out_mem_ctx, input, out);
 173         NT_STATUS_NOT_OK_RETURN(status);
 174
 175         return NT_STATUS_OK;
 176 }
 177
 178 /**
 179  * Return the NTLMSSP master session key
 180  *
 181  * @param ntlmssp_state NTLMSSP State
 182  */
 183
 184 NTSTATUS gensec_ntlmssp_session_key(struct gensec_security *gensec_security,
 185                                     TALLOC_CTX *mem_ctx,
 186                                     DATA_BLOB *session_key)
 187 {
 188         struct gensec_ntlmssp_context *gensec_ntlmssp =
 189                 talloc_get_type_abort(gensec_security->private_data,
 190                                       struct gensec_ntlmssp_context);
 191         struct ntlmssp_state *ntlmssp_state = gensec_ntlmssp->ntlmssp_state;
 192
 193         if (ntlmssp_state->expected_state != NTLMSSP_DONE) {
 194                 return NT_STATUS_NO_USER_SESSION_KEY;
 195         }
 196
 197         if (!ntlmssp_state->session_key.data) {
 198                 return NT_STATUS_NO_USER_SESSION_KEY;
 199         }
 200         *session_key = data_blob_talloc(mem_ctx, ntlmssp_state->session_key.data, ntlmssp_state->session_key.length);
 201         if (!session_key->data) {
 202                 return NT_STATUS_NO_MEMORY;
 203         }
 204
 205         return NT_STATUS_OK;
 206 }
 207
 208 static bool gensec_ntlmssp_have_feature(struct gensec_security *gensec_security,
 209                                         uint32_t feature)
 210 {
 211         struct gensec_ntlmssp_context *gensec_ntlmssp =
 212                 talloc_get_type_abort(gensec_security->private_data,
 213                                       struct gensec_ntlmssp_context);
 214         struct ntlmssp_state *ntlmssp_state = gensec_ntlmssp->ntlmssp_state;
 215
 216         if (feature & GENSEC_FEATURE_SIGN) {
 217                 if (!ntlmssp_state->session_key.length) {
 218                         return false;
 219                 }
 220                 if (ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SIGN) {
 221                         return true;
 222                 }
 223         }
 224         if (feature & GENSEC_FEATURE_SEAL) {
 225                 if (!ntlmssp_state->session_key.length) {
 226                         return false;
 227                 }
 228                 if (ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SEAL) {
 229                         return true;
 230                 }
 231         }
 232         if (feature & GENSEC_FEATURE_SESSION_KEY) {
 233                 if (ntlmssp_state->session_key.length) {
 234                         return true;
 235                 }
 236         }
 237         if (feature & GENSEC_FEATURE_DCE_STYLE) {
 238                 return true;
 239         }
 240         if (feature & GENSEC_FEATURE_ASYNC_REPLIES) {
 241                 if (ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
 242                         return true;
 243                 }
 244         }
 245         return false;
 246 }
 247
 248 NTSTATUS gensec_ntlmssp_start(struct gensec_security *gensec_security)
 249 {
 250         struct gensec_ntlmssp_context *gensec_ntlmssp;
 251         struct ntlmssp_state *ntlmssp_state;
 252
 253         gensec_ntlmssp = talloc_zero(gensec_security,
 254                                      struct gensec_ntlmssp_context);
 255         if (!gensec_ntlmssp) {
 256                 return NT_STATUS_NO_MEMORY;
 257         }
 258
 259         gensec_ntlmssp->gensec_security = gensec_security;
 260
 261         ntlmssp_state = talloc_zero(gensec_ntlmssp,
 262                                     struct ntlmssp_state);
 263         if (!ntlmssp_state) {
 264                 return NT_STATUS_NO_MEMORY;
 265         }
 266
 267         ntlmssp_state->callback_private = gensec_ntlmssp;
 268
 269         gensec_ntlmssp->ntlmssp_state = ntlmssp_state;
 270
 271         gensec_security->private_data = gensec_ntlmssp;
 272         return NT_STATUS_OK;
 273 }
 274
 275 static const char *gensec_ntlmssp_oids[] = {
 276         GENSEC_OID_NTLMSSP,
 277         NULL
 278 };
 279
 280 static const struct gensec_security_ops gensec_ntlmssp_security_ops = {
 281         .name           = "ntlmssp",
 282         .sasl_name      = GENSEC_SASL_NAME_NTLMSSP, /* "NTLM" */
 283         .auth_type      = DCERPC_AUTH_TYPE_NTLMSSP,
 284         .oid            = gensec_ntlmssp_oids,
 285         .client_start   = gensec_ntlmssp_client_start,
 286         .server_start   = gensec_ntlmssp_server_start,
 287         .magic          = gensec_ntlmssp_magic,
 288         .update         = gensec_ntlmssp_update,
 289         .sig_size       = gensec_ntlmssp_sig_size,
 290         .sign_packet    = gensec_ntlmssp_sign_packet,
 291         .check_packet   = gensec_ntlmssp_check_packet,
 292         .seal_packet    = gensec_ntlmssp_seal_packet,
 293         .unseal_packet  = gensec_ntlmssp_unseal_packet,
 294         .wrap           = gensec_ntlmssp_wrap,
 295         .unwrap         = gensec_ntlmssp_unwrap,
 296         .session_key    = gensec_ntlmssp_session_key,
 297         .session_info   = gensec_ntlmssp_session_info,
 298         .have_feature   = gensec_ntlmssp_have_feature,
 299         .enabled        = true,
 300         .priority       = GENSEC_NTLMSSP
 301 };
 302
 303
 304 _PUBLIC_ NTSTATUS gensec_ntlmssp_init(void)
 305 {
 306         NTSTATUS ret;
 307
 308         ret = gensec_register(&gensec_ntlmssp_security_ops);
 309         if (!NT_STATUS_IS_OK(ret)) {
 310                 DEBUG(0,("Failed to register '%s' gensec backend!\n",
 311                         gensec_ntlmssp_security_ops.name));
 312                 return ret;
 313         }
 314
 315         return ret;
 316 }