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