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 "auth/ntlmssp/msrpc_parse.h"
  27 #include "librpc/gen_ndr/ndr_dcerpc.h"
  28 #include "auth/credentials/credentials.h"
  29 #include "auth/gensec/gensec.h"
  30 #include "auth/auth.h"
  31 #include "param/param.h"
  32
  33 /**
  34  * Callbacks for NTLMSSP - for both client and server operating modes
  35  *
  36  */
  37
  38 static const struct ntlmssp_callbacks {
  39         enum ntlmssp_role role;
  40         enum ntlmssp_message_type command;
  41         NTSTATUS (*sync_fn)(struct gensec_security *gensec_security,
  42                             TALLOC_CTX *out_mem_ctx,
  43                             DATA_BLOB in, DATA_BLOB *out);
  44 } ntlmssp_callbacks[] = {
  45         {
  46                 .role           = NTLMSSP_CLIENT,
  47                 .command        = NTLMSSP_INITIAL,
  48                 .sync_fn        = ntlmssp_client_initial,
  49         },{
  50                 .role           = NTLMSSP_SERVER,
  51                 .command        = NTLMSSP_NEGOTIATE,
  52                 .sync_fn        = ntlmssp_server_negotiate,
  53         },{
  54                 .role           = NTLMSSP_CLIENT,
  55                 .command        = NTLMSSP_CHALLENGE,
  56                 .sync_fn        = ntlmssp_client_challenge,
  57         },{
  58                 .role           = NTLMSSP_SERVER,
  59                 .command        = NTLMSSP_AUTH,
  60                 .sync_fn        = ntlmssp_server_auth,
  61         }
  62 };
  63
  64
  65 /**
  66  * Print out the NTLMSSP flags for debugging
  67  * @param neg_flags The flags from the packet
  68  */
  69
  70 void debug_ntlmssp_flags(uint32_t neg_flags)
  71 {
  72         DEBUG(3,("Got NTLMSSP neg_flags=0x%08x\n", neg_flags));
  73
  74         if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE)
  75                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_UNICODE\n"));
  76         if (neg_flags & NTLMSSP_NEGOTIATE_OEM)
  77                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_OEM\n"));
  78         if (neg_flags & NTLMSSP_REQUEST_TARGET)
  79                 DEBUGADD(4, ("  NTLMSSP_REQUEST_TARGET\n"));
  80         if (neg_flags & NTLMSSP_NEGOTIATE_SIGN)
  81                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_SIGN\n"));
  82         if (neg_flags & NTLMSSP_NEGOTIATE_SEAL)
  83                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_SEAL\n"));
  84         if (neg_flags & NTLMSSP_NEGOTIATE_DATAGRAM_STYLE)
  85                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_DATAGRAM_STYLE\n"));
  86         if (neg_flags & NTLMSSP_NEGOTIATE_LM_KEY)
  87                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_LM_KEY\n"));
  88         if (neg_flags & NTLMSSP_NEGOTIATE_NETWARE)
  89                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_NETWARE\n"));
  90         if (neg_flags & NTLMSSP_NEGOTIATE_NTLM)
  91                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_NTLM\n"));
  92         if (neg_flags & NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED)
  93                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED\n"));
  94         if (neg_flags & NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED)
  95                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED\n"));
  96         if (neg_flags & NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL)
  97                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL\n"));
  98         if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN)
  99                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_ALWAYS_SIGN\n"));
 100         if (neg_flags & NTLMSSP_CHAL_ACCEPT_RESPONSE)
 101                 DEBUGADD(4, ("  NTLMSSP_CHAL_ACCEPT_RESPONSE\n"));
 102         if (neg_flags & NTLMSSP_CHAL_NON_NT_SESSION_KEY)
 103                 DEBUGADD(4, ("  NTLMSSP_CHAL_NON_NT_SESSION_KEY\n"));
 104         if (neg_flags & NTLMSSP_NEGOTIATE_NTLM2)
 105                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_NTLM2\n"));
 106         if (neg_flags & NTLMSSP_CHAL_TARGET_INFO)
 107                 DEBUGADD(4, ("  NTLMSSP_CHAL_TARGET_INFO\n"));
 108         if (neg_flags & NTLMSSP_NEGOTIATE_128)
 109                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_128\n"));
 110         if (neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)
 111                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_KEY_EXCH\n"));
 112         if (neg_flags & NTLMSSP_NEGOTIATE_56)
 113                 DEBUGADD(4, ("  NTLMSSP_NEGOTIATE_56\n"));
 114 }
 115
 116 static NTSTATUS gensec_ntlmssp_magic(struct gensec_security *gensec_security,
 117                                      const DATA_BLOB *first_packet)
 118 {
 119         if (first_packet->length > 8 && memcmp("NTLMSSP\0", first_packet->data, 8) == 0) {
 120                 return NT_STATUS_OK;
 121         } else {
 122                 return NT_STATUS_INVALID_PARAMETER;
 123         }
 124 }
 125
 126 static NTSTATUS gensec_ntlmssp_update_find(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
 127                                            const DATA_BLOB input, uint32_t *idx)
 128 {
 129         struct gensec_security *gensec_security = gensec_ntlmssp_state->gensec_security;
 130         uint32_t ntlmssp_command;
 131         uint32_t i;
 132
 133         if (gensec_ntlmssp_state->expected_state == NTLMSSP_DONE) {
 134                 /* We are strict here because other modules, which we
 135                  * don't fully control (such as GSSAPI) are also
 136                  * strict, but are tested less often */
 137
 138                 DEBUG(1, ("Called NTLMSSP after state machine was 'done'\n"));
 139                 return NT_STATUS_INVALID_PARAMETER;
 140         }
 141
 142         if (!input.length) {
 143                 switch (gensec_ntlmssp_state->role) {
 144                 case NTLMSSP_CLIENT:
 145                         ntlmssp_command = NTLMSSP_INITIAL;
 146                         break;
 147                 case NTLMSSP_SERVER:
 148                         if (gensec_security->want_features & GENSEC_FEATURE_DATAGRAM_MODE) {
 149                                 /* 'datagram' mode - no neg packet */
 150                                 ntlmssp_command = NTLMSSP_NEGOTIATE;
 151                         } else {
 152                                 /* This is normal in SPNEGO mech negotiation fallback */
 153                                 DEBUG(2, ("Failed to parse NTLMSSP packet: zero length\n"));
 154                                 return NT_STATUS_INVALID_PARAMETER;
 155                         }
 156                         break;
 157                 }
 158         } else {
 159                 if (!msrpc_parse(gensec_ntlmssp_state,
 160                                  lp_iconv_convenience(gensec_security->lp_ctx),
 161                                  &input, "Cd",
 162                                  "NTLMSSP",
 163                                  &ntlmssp_command)) {
 164                         DEBUG(1, ("Failed to parse NTLMSSP packet, could not extract NTLMSSP command\n"));
 165                         dump_data(2, input.data, input.length);
 166                         return NT_STATUS_INVALID_PARAMETER;
 167                 }
 168         }
 169
 170         if (ntlmssp_command != gensec_ntlmssp_state->expected_state) {
 171                 DEBUG(2, ("got NTLMSSP command %u, expected %u\n", ntlmssp_command, gensec_ntlmssp_state->expected_state));
 172                 return NT_STATUS_INVALID_PARAMETER;
 173         }
 174
 175         for (i=0; i < ARRAY_SIZE(ntlmssp_callbacks); i++) {
 176                 if (ntlmssp_callbacks[i].role == gensec_ntlmssp_state->role &&
 177                     ntlmssp_callbacks[i].command == ntlmssp_command) {
 178                         *idx = i;
 179                         return NT_STATUS_OK;
 180                 }
 181         }
 182
 183         DEBUG(1, ("failed to find NTLMSSP callback for NTLMSSP mode %u, command %u\n",
 184                   gensec_ntlmssp_state->role, ntlmssp_command));
 185
 186         return NT_STATUS_INVALID_PARAMETER;
 187 }
 188
 189 /**
 190  * Next state function for the wrapped NTLMSSP state machine
 191  *
 192  * @param gensec_security GENSEC state, initialised to NTLMSSP
 193  * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
 194  * @param in The request, as a DATA_BLOB
 195  * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
 196  * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
 197  *                or NT_STATUS_OK if the user is authenticated.
 198  */
 199
 200 static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
 201                                       TALLOC_CTX *out_mem_ctx,
 202                                       const DATA_BLOB input, DATA_BLOB *out)
 203 {
 204         struct gensec_ntlmssp_state *gensec_ntlmssp_state = (struct gensec_ntlmssp_state *)gensec_security->private_data;
 205         NTSTATUS status;
 206         uint32_t i;
 207
 208         *out = data_blob(NULL, 0);
 209
 210         if (!out_mem_ctx) {
 211                 /* if the caller doesn't want to manage/own the memory,
 212                    we can put it on our context */
 213                 out_mem_ctx = gensec_ntlmssp_state;
 214         }
 215
 216         status = gensec_ntlmssp_update_find(gensec_ntlmssp_state, input, &i);
 217         NT_STATUS_NOT_OK_RETURN(status);
 218
 219         status = ntlmssp_callbacks[i].sync_fn(gensec_security, out_mem_ctx, input, out);
 220         NT_STATUS_NOT_OK_RETURN(status);
 221
 222         return NT_STATUS_OK;
 223 }
 224
 225 /**
 226  * Return the NTLMSSP master session key
 227  *
 228  * @param gensec_ntlmssp_state NTLMSSP State
 229  */
 230
 231 NTSTATUS gensec_ntlmssp_session_key(struct gensec_security *gensec_security,
 232                                     DATA_BLOB *session_key)
 233 {
 234         struct gensec_ntlmssp_state *gensec_ntlmssp_state = (struct gensec_ntlmssp_state *)gensec_security->private_data;
 235
 236         if (!gensec_ntlmssp_state->session_key.data) {
 237                 return NT_STATUS_NO_USER_SESSION_KEY;
 238         }
 239         *session_key = gensec_ntlmssp_state->session_key;
 240
 241         return NT_STATUS_OK;
 242 }
 243
 244 void ntlmssp_handle_neg_flags(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
 245                               uint32_t neg_flags, bool allow_lm)
 246 {
 247         if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE) {
 248                 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_UNICODE;
 249                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_OEM;
 250                 gensec_ntlmssp_state->unicode = true;
 251         } else {
 252                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_UNICODE;
 253                 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_OEM;
 254                 gensec_ntlmssp_state->unicode = false;
 255         }
 256
 257         if ((neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) && allow_lm && !gensec_ntlmssp_state->use_ntlmv2) {
 258                 /* other end forcing us to use LM */
 259                 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_LM_KEY;
 260                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
 261         } else {
 262                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_LM_KEY;
 263         }
 264
 265         if (!(neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN)) {
 266                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_ALWAYS_SIGN;
 267         }
 268
 269         if (!(neg_flags & NTLMSSP_NEGOTIATE_SIGN)) {
 270                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SIGN;
 271         }
 272
 273         if (!(neg_flags & NTLMSSP_NEGOTIATE_SEAL)) {
 274                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SEAL;
 275         }
 276
 277         if (!(neg_flags & NTLMSSP_NEGOTIATE_NTLM2)) {
 278                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
 279         }
 280
 281         if (!(neg_flags & NTLMSSP_NEGOTIATE_128)) {
 282                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_128;
 283         }
 284
 285         if (!(neg_flags & NTLMSSP_NEGOTIATE_56)) {
 286                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_56;
 287         }
 288
 289         if (!(neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)) {
 290                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_KEY_EXCH;
 291         }
 292
 293         /* Woop Woop - unknown flag for Windows compatibility...
 294            What does this really do ? JRA. */
 295         if (!(neg_flags & NTLMSSP_UNKNOWN_02000000)) {
 296                 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_UNKNOWN_02000000;
 297         }
 298
 299         if ((neg_flags & NTLMSSP_REQUEST_TARGET)) {
 300                 gensec_ntlmssp_state->neg_flags |= NTLMSSP_REQUEST_TARGET;
 301         }
 302
 303 }
 304
 305 /**
 306    Weaken NTLMSSP keys to cope with down-level clients and servers.
 307
 308    We probably should have some parameters to control this, but as
 309    it only occours for LM_KEY connections, and this is controlled
 310    by the client lanman auth/lanman auth parameters, it isn't too bad.
 311 */
 312
 313 DATA_BLOB ntlmssp_weakend_key(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
 314                               TALLOC_CTX *mem_ctx)
 315 {
 316         DATA_BLOB weakened_key = data_blob_talloc(mem_ctx,
 317                                                   gensec_ntlmssp_state->session_key.data,
 318                                                   gensec_ntlmssp_state->session_key.length);
 319         /* Nothing to weaken.  We certainly don't want to 'extend' the length... */
 320         if (weakened_key.length < 16) {
 321                 /* perhaps there was no key? */
 322                 return weakened_key;
 323         }
 324
 325         /* Key weakening not performed on the master key for NTLM2
 326            and does not occour for NTLM1.  Therefore we only need
 327            to do this for the LM_KEY.
 328         */
 329         if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) {
 330                 /* LM key doesn't support 128 bit crypto, so this is
 331                  * the best we can do.  If you negotiate 128 bit, but
 332                  * not 56, you end up with 40 bit... */
 333                 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_56) {
 334                         weakened_key.data[7] = 0xa0;
 335                         weakened_key.length = 8;
 336                 } else { /* forty bits */
 337                         weakened_key.data[5] = 0xe5;
 338                         weakened_key.data[6] = 0x38;
 339                         weakened_key.data[7] = 0xb0;
 340                         weakened_key.length = 8;
 341                 }
 342         }
 343         return weakened_key;
 344 }
 345
 346 static bool gensec_ntlmssp_have_feature(struct gensec_security *gensec_security,
 347                                         uint32_t feature)
 348 {
 349         struct gensec_ntlmssp_state *gensec_ntlmssp_state = (struct gensec_ntlmssp_state *)gensec_security->private_data;
 350         if (feature & GENSEC_FEATURE_SIGN) {
 351                 if (!gensec_ntlmssp_state->session_key.length) {
 352                         return false;
 353                 }
 354                 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SIGN) {
 355                         return true;
 356                 }
 357         }
 358         if (feature & GENSEC_FEATURE_SEAL) {
 359                 if (!gensec_ntlmssp_state->session_key.length) {
 360                         return false;
 361                 }
 362                 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SEAL) {
 363                         return true;
 364                 }
 365         }
 366         if (feature & GENSEC_FEATURE_SESSION_KEY) {
 367                 if (gensec_ntlmssp_state->session_key.length) {
 368                         return true;
 369                 }
 370         }
 371         if (feature & GENSEC_FEATURE_DCE_STYLE) {
 372                 return true;
 373         }
 374         if (feature & GENSEC_FEATURE_ASYNC_REPLIES) {
 375                 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
 376                         return true;
 377                 }
 378         }
 379         return false;
 380 }
 381
 382 NTSTATUS gensec_ntlmssp_start(struct gensec_security *gensec_security)
 383 {
 384         struct gensec_ntlmssp_state *gensec_ntlmssp_state;
 385
 386         gensec_ntlmssp_state = talloc_zero(gensec_security, struct gensec_ntlmssp_state);
 387         if (!gensec_ntlmssp_state) {
 388                 return NT_STATUS_NO_MEMORY;
 389         }
 390
 391         gensec_ntlmssp_state->gensec_security = gensec_security;
 392         gensec_ntlmssp_state->auth_context = NULL;
 393         gensec_ntlmssp_state->server_info = NULL;
 394
 395         gensec_security->private_data = gensec_ntlmssp_state;
 396         return NT_STATUS_OK;
 397 }
 398
 399 static const char *gensec_ntlmssp_oids[] = {
 400         GENSEC_OID_NTLMSSP,
 401         NULL
 402 };
 403
 404 static const struct gensec_security_ops gensec_ntlmssp_security_ops = {
 405         .name           = "ntlmssp",
 406         .sasl_name      = "NTLM",
 407         .auth_type      = DCERPC_AUTH_TYPE_NTLMSSP,
 408         .oid            = gensec_ntlmssp_oids,
 409         .client_start   = gensec_ntlmssp_client_start,
 410         .server_start   = gensec_ntlmssp_server_start,
 411         .magic          = gensec_ntlmssp_magic,
 412         .update         = gensec_ntlmssp_update,
 413         .sig_size       = gensec_ntlmssp_sig_size,
 414         .sign_packet    = gensec_ntlmssp_sign_packet,
 415         .check_packet   = gensec_ntlmssp_check_packet,
 416         .seal_packet    = gensec_ntlmssp_seal_packet,
 417         .unseal_packet  = gensec_ntlmssp_unseal_packet,
 418         .wrap           = gensec_ntlmssp_wrap,
 419         .unwrap         = gensec_ntlmssp_unwrap,
 420         .session_key    = gensec_ntlmssp_session_key,
 421         .session_info   = gensec_ntlmssp_session_info,
 422         .have_feature   = gensec_ntlmssp_have_feature,
 423         .enabled        = true,
 424         .priority       = GENSEC_NTLMSSP
 425 };
 426
 427
 428 NTSTATUS gensec_ntlmssp_init(void)
 429 {
 430         NTSTATUS ret;
 431
 432         auth_init();
 433
 434         ret = gensec_register(&gensec_ntlmssp_security_ops);
 435         if (!NT_STATUS_IS_OK(ret)) {
 436                 DEBUG(0,("Failed to register '%s' gensec backend!\n",
 437                         gensec_ntlmssp_security_ops.name));
 438                 return ret;
 439         }
 440
 441         return ret;
 442 }