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