2 * Unix SMB/CIFS implementation.
4 * NTLMSSP Signing routines
5 * Copyright (C) Luke Kenneth Casson Leighton 1996-2001
6 * Copyright (C) Andrew Bartlett <abartlet@samba.org> 2003-2005
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 #include "auth/auth.h"
25 #include "auth/ntlmssp/ntlmssp.h"
26 #include "auth/ntlmssp/msrpc_parse.h"
27 #include "lib/crypto/crypto.h"
28 #include "auth/credentials/credentials.h"
29 #include "auth/gensec/gensec.h"
31 #define CLI_SIGN "session key to client-to-server signing key magic constant"
32 #define CLI_SEAL "session key to client-to-server sealing key magic constant"
33 #define SRV_SIGN "session key to server-to-client signing key magic constant"
34 #define SRV_SEAL "session key to server-to-client sealing key magic constant"
37 * Some notes on the NTLM2 code:
39 * NTLM2 is a AEAD system. This means that the data encrypted is not
40 * all the data that is signed. In DCE-RPC case, the headers of the
41 * DCE-RPC packets are also signed. This prevents some of the
42 * fun-and-games one might have by changing them.
46 static void calc_ntlmv2_key(TALLOC_CTX *mem_ctx,
48 DATA_BLOB session_key,
51 struct MD5Context ctx3;
52 *subkey = data_blob_talloc(mem_ctx, NULL, 16);
54 MD5Update(&ctx3, session_key.data, session_key.length);
55 MD5Update(&ctx3, (const uint8_t *)constant, strlen(constant)+1);
56 MD5Final(subkey->data, &ctx3);
59 enum ntlmssp_direction {
64 static NTSTATUS ntlmssp_make_packet_signature(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
65 TALLOC_CTX *sig_mem_ctx,
66 const uint8_t *data, size_t length,
67 const uint8_t *whole_pdu, size_t pdu_length,
68 enum ntlmssp_direction direction,
69 DATA_BLOB *sig, BOOL encrypt_sig)
71 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
77 *sig = data_blob_talloc(sig_mem_ctx, NULL, NTLMSSP_SIG_SIZE);
79 return NT_STATUS_NO_MEMORY;
84 SIVAL(seq_num, 0, gensec_ntlmssp_state->crypt.ntlm2.send_seq_num);
85 gensec_ntlmssp_state->crypt.ntlm2.send_seq_num++;
86 hmac_md5_init_limK_to_64(gensec_ntlmssp_state->crypt.ntlm2.send_sign_key.data,
87 gensec_ntlmssp_state->crypt.ntlm2.send_sign_key.length, &ctx);
90 SIVAL(seq_num, 0, gensec_ntlmssp_state->crypt.ntlm2.recv_seq_num);
91 gensec_ntlmssp_state->crypt.ntlm2.recv_seq_num++;
92 hmac_md5_init_limK_to_64(gensec_ntlmssp_state->crypt.ntlm2.recv_sign_key.data,
93 gensec_ntlmssp_state->crypt.ntlm2.recv_sign_key.length, &ctx);
96 hmac_md5_update(seq_num, sizeof(seq_num), &ctx);
97 hmac_md5_update(whole_pdu, pdu_length, &ctx);
98 hmac_md5_final(digest, &ctx);
100 if (encrypt_sig && gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH) {
103 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state, digest, 8);
105 case NTLMSSP_RECEIVE:
106 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm2.recv_seal_arcfour_state, digest, 8);
111 SIVAL(sig->data, 0, NTLMSSP_SIGN_VERSION);
112 memcpy(sig->data + 4, digest, 8);
113 memcpy(sig->data + 12, seq_num, 4);
115 DEBUG(10, ("NTLM2: created signature over %llu bytes of input:\n", (unsigned long long)pdu_length));
116 dump_data(11, sig->data, sig->length);
120 crc = crc32_calc_buffer(data, length);
121 if (!msrpc_gen(sig_mem_ctx, sig, "dddd", NTLMSSP_SIGN_VERSION, 0, crc, gensec_ntlmssp_state->crypt.ntlm.seq_num)) {
122 return NT_STATUS_NO_MEMORY;
124 gensec_ntlmssp_state->crypt.ntlm.seq_num++;
126 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm.arcfour_state, sig->data+4, sig->length-4);
128 DEBUG(10, ("NTLM1: created signature over %llu bytes of input:\n", (unsigned long long)length));
129 dump_data(11, sig->data, sig->length);
134 /* TODO: make this non-public */
135 _PUBLIC_ NTSTATUS gensec_ntlmssp_sign_packet(struct gensec_security *gensec_security,
136 TALLOC_CTX *sig_mem_ctx,
137 const uint8_t *data, size_t length,
138 const uint8_t *whole_pdu, size_t pdu_length,
141 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
143 return ntlmssp_make_packet_signature(gensec_ntlmssp_state, sig_mem_ctx,
145 whole_pdu, pdu_length,
146 NTLMSSP_SEND, sig, True);
150 * Check the signature of an incoming packet
154 NTSTATUS gensec_ntlmssp_check_packet(struct gensec_security *gensec_security,
155 TALLOC_CTX *sig_mem_ctx,
156 const uint8_t *data, size_t length,
157 const uint8_t *whole_pdu, size_t pdu_length,
158 const DATA_BLOB *sig)
160 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
165 if (!gensec_ntlmssp_state->session_key.length) {
166 DEBUG(3, ("NO session key, cannot check packet signature\n"));
167 return NT_STATUS_NO_USER_SESSION_KEY;
170 nt_status = ntlmssp_make_packet_signature(gensec_ntlmssp_state, sig_mem_ctx,
172 whole_pdu, pdu_length,
173 NTLMSSP_RECEIVE, &local_sig, True);
175 if (!NT_STATUS_IS_OK(nt_status)) {
176 DEBUG(0, ("NTLMSSP packet check failed with %s\n", nt_errstr(nt_status)));
180 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
181 if (local_sig.length != sig->length ||
182 memcmp(local_sig.data,
183 sig->data, sig->length) != 0) {
184 DEBUG(5, ("BAD SIG NTLM2: wanted signature over %llu bytes of input:\n", (unsigned long long)pdu_length));
185 dump_data(5, local_sig.data, local_sig.length);
187 DEBUG(5, ("BAD SIG: got signature over %llu bytes of input:\n", (unsigned long long)pdu_length));
188 dump_data(5, sig->data, sig->length);
190 DEBUG(1, ("NTLMSSP NTLM2 packet check failed due to invalid signature on %llu bytes of input!\n", (unsigned long long)pdu_length));
191 return NT_STATUS_ACCESS_DENIED;
194 if (local_sig.length != sig->length ||
195 memcmp(local_sig.data + 8,
196 sig->data + 8, sig->length - 8) != 0) {
197 DEBUG(5, ("BAD SIG NTLM1: wanted signature of %llu bytes of input:\n", (unsigned long long)length));
198 dump_data(5, local_sig.data, local_sig.length);
200 DEBUG(5, ("BAD SIG: got signature of %llu bytes of input:\n", (unsigned long long)length));
201 dump_data(5, sig->data, sig->length);
203 DEBUG(1, ("NTLMSSP NTLM1 packet check failed due to invalid signature on %llu bytes of input:\n", (unsigned long long)length));
204 return NT_STATUS_ACCESS_DENIED;
207 dump_data_pw("checked ntlmssp signature\n", sig->data, sig->length);
214 * Seal data with the NTLMSSP algorithm
218 NTSTATUS gensec_ntlmssp_seal_packet(struct gensec_security *gensec_security,
219 TALLOC_CTX *sig_mem_ctx,
220 uint8_t *data, size_t length,
221 const uint8_t *whole_pdu, size_t pdu_length,
224 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
226 if (!gensec_ntlmssp_state->session_key.length) {
227 DEBUG(3, ("NO session key, cannot seal packet\n"));
228 return NT_STATUS_NO_USER_SESSION_KEY;
231 DEBUG(10,("ntlmssp_seal_data: seal\n"));
232 dump_data_pw("ntlmssp clear data\n", data, length);
233 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
234 /* The order of these two operations matters - we must first seal the packet,
235 then seal the sequence number - this is becouse the send_seal_hash is not
236 constant, but is is rather updated with each iteration */
237 nt_status = ntlmssp_make_packet_signature(gensec_ntlmssp_state, sig_mem_ctx,
239 whole_pdu, pdu_length,
240 NTLMSSP_SEND, sig, False);
241 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state, data, length);
242 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH) {
243 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state, sig->data+4, 8);
247 crc = crc32_calc_buffer(data, length);
248 if (!msrpc_gen(sig_mem_ctx, sig, "dddd", NTLMSSP_SIGN_VERSION, 0, crc, gensec_ntlmssp_state->crypt.ntlm.seq_num)) {
249 return NT_STATUS_NO_MEMORY;
252 /* The order of these two operations matters - we must
253 first seal the packet, then seal the sequence
254 number - this is becouse the ntlmssp_hash is not
255 constant, but is is rather updated with each
258 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm.arcfour_state, data, length);
259 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm.arcfour_state, sig->data+4, sig->length-4);
260 /* increment counter on send */
261 gensec_ntlmssp_state->crypt.ntlm.seq_num++;
262 nt_status = NT_STATUS_OK;
264 dump_data_pw("ntlmssp signature\n", sig->data, sig->length);
265 dump_data_pw("ntlmssp sealed data\n", data, length);
272 * Unseal data with the NTLMSSP algorithm
277 wrappers for the ntlmssp_*() functions
279 NTSTATUS gensec_ntlmssp_unseal_packet(struct gensec_security *gensec_security,
280 TALLOC_CTX *sig_mem_ctx,
281 uint8_t *data, size_t length,
282 const uint8_t *whole_pdu, size_t pdu_length,
283 const DATA_BLOB *sig)
285 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
286 if (!gensec_ntlmssp_state->session_key.length) {
287 DEBUG(3, ("NO session key, cannot unseal packet\n"));
288 return NT_STATUS_NO_USER_SESSION_KEY;
291 dump_data_pw("ntlmssp sealed data\n", data, length);
292 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
293 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm2.recv_seal_arcfour_state, data, length);
295 arcfour_crypt_sbox(gensec_ntlmssp_state->crypt.ntlm.arcfour_state, data, length);
297 dump_data_pw("ntlmssp clear data\n", data, length);
298 return gensec_ntlmssp_check_packet(gensec_security, sig_mem_ctx, data, length, whole_pdu, pdu_length, sig);
302 Initialise the state for NTLMSSP signing.
304 /* TODO: make this non-public */
305 _PUBLIC_ NTSTATUS ntlmssp_sign_init(struct gensec_ntlmssp_state *gensec_ntlmssp_state)
307 TALLOC_CTX *mem_ctx = talloc_new(gensec_ntlmssp_state);
310 return NT_STATUS_NO_MEMORY;
313 DEBUG(3, ("NTLMSSP Sign/Seal - Initialising with flags:\n"));
314 debug_ntlmssp_flags(gensec_ntlmssp_state->neg_flags);
316 if (gensec_ntlmssp_state->session_key.length < 8) {
317 talloc_free(mem_ctx);
318 DEBUG(3, ("NO session key, cannot intialise signing\n"));
319 return NT_STATUS_NO_USER_SESSION_KEY;
322 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2)
324 DATA_BLOB weak_session_key = gensec_ntlmssp_state->session_key;
325 const char *send_sign_const;
326 const char *send_seal_const;
327 const char *recv_sign_const;
328 const char *recv_seal_const;
330 DATA_BLOB send_seal_key;
331 DATA_BLOB recv_seal_key;
333 switch (gensec_ntlmssp_state->role) {
335 send_sign_const = CLI_SIGN;
336 send_seal_const = CLI_SEAL;
337 recv_sign_const = SRV_SIGN;
338 recv_seal_const = SRV_SEAL;
341 send_sign_const = SRV_SIGN;
342 send_seal_const = SRV_SEAL;
343 recv_sign_const = CLI_SIGN;
344 recv_seal_const = CLI_SEAL;
347 talloc_free(mem_ctx);
348 return NT_STATUS_INTERNAL_ERROR;
351 gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state = talloc(gensec_ntlmssp_state, struct arcfour_state);
352 NT_STATUS_HAVE_NO_MEMORY(gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state);
353 gensec_ntlmssp_state->crypt.ntlm2.recv_seal_arcfour_state = talloc(gensec_ntlmssp_state, struct arcfour_state);
354 NT_STATUS_HAVE_NO_MEMORY(gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state);
357 Weaken NTLMSSP keys to cope with down-level
358 clients, servers and export restrictions.
360 We probably should have some parameters to control
361 this, once we get NTLM2 working.
364 /* Key weakening was not performed on the master key
365 * for NTLM2 (in ntlmssp_weaken_keys()), but must be
366 * done on the encryption subkeys only. That is why
367 * we don't have this code for the ntlmv1 case.
370 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_128) {
372 } else if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_56) {
373 weak_session_key.length = 7;
374 } else { /* forty bits */
375 weak_session_key.length = 5;
377 dump_data_pw("NTLMSSP weakend master key:\n",
378 weak_session_key.data,
379 weak_session_key.length);
382 calc_ntlmv2_key(gensec_ntlmssp_state,
383 &gensec_ntlmssp_state->crypt.ntlm2.send_sign_key,
384 gensec_ntlmssp_state->session_key, send_sign_const);
385 dump_data_pw("NTLMSSP send sign key:\n",
386 gensec_ntlmssp_state->crypt.ntlm2.send_sign_key.data,
387 gensec_ntlmssp_state->crypt.ntlm2.send_sign_key.length);
389 /* SEND: seal ARCFOUR pad */
390 calc_ntlmv2_key(mem_ctx,
392 weak_session_key, send_seal_const);
393 dump_data_pw("NTLMSSP send seal key:\n",
395 send_seal_key.length);
396 arcfour_init(gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state,
398 dump_data_pw("NTLMSSP send sesl hash:\n",
399 gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state->sbox,
400 sizeof(gensec_ntlmssp_state->crypt.ntlm2.send_seal_arcfour_state->sbox));
403 calc_ntlmv2_key(gensec_ntlmssp_state,
404 &gensec_ntlmssp_state->crypt.ntlm2.recv_sign_key,
405 gensec_ntlmssp_state->session_key, recv_sign_const);
406 dump_data_pw("NTLMSSP recv sign key:\n",
407 gensec_ntlmssp_state->crypt.ntlm2.recv_sign_key.data,
408 gensec_ntlmssp_state->crypt.ntlm2.recv_sign_key.length);
410 /* RECV: seal ARCFOUR pad */
411 calc_ntlmv2_key(mem_ctx,
413 weak_session_key, recv_seal_const);
414 dump_data_pw("NTLMSSP recv seal key:\n",
416 recv_seal_key.length);
417 arcfour_init(gensec_ntlmssp_state->crypt.ntlm2.recv_seal_arcfour_state,
419 dump_data_pw("NTLMSSP receive seal hash:\n",
420 gensec_ntlmssp_state->crypt.ntlm2.recv_seal_arcfour_state->sbox,
421 sizeof(gensec_ntlmssp_state->crypt.ntlm2.recv_seal_arcfour_state->sbox));
423 gensec_ntlmssp_state->crypt.ntlm2.send_seq_num = 0;
424 gensec_ntlmssp_state->crypt.ntlm2.recv_seq_num = 0;
427 DATA_BLOB weak_session_key = ntlmssp_weakend_key(gensec_ntlmssp_state, mem_ctx);
428 DEBUG(5, ("NTLMSSP Sign/Seal - using NTLM1\n"));
430 gensec_ntlmssp_state->crypt.ntlm.arcfour_state = talloc(gensec_ntlmssp_state, struct arcfour_state);
431 NT_STATUS_HAVE_NO_MEMORY(gensec_ntlmssp_state->crypt.ntlm.arcfour_state);
433 arcfour_init(gensec_ntlmssp_state->crypt.ntlm.arcfour_state,
435 dump_data_pw("NTLMSSP hash:\n", gensec_ntlmssp_state->crypt.ntlm.arcfour_state->sbox,
436 sizeof(gensec_ntlmssp_state->crypt.ntlm.arcfour_state->sbox));
438 gensec_ntlmssp_state->crypt.ntlm.seq_num = 0;
441 talloc_free(mem_ctx);
445 size_t gensec_ntlmssp_sig_size(struct gensec_security *gensec_security, size_t data_size)
447 return NTLMSSP_SIG_SIZE;
450 NTSTATUS gensec_ntlmssp_wrap(struct gensec_security *gensec_security,
451 TALLOC_CTX *sig_mem_ctx,
458 if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
460 *out = data_blob_talloc(sig_mem_ctx, NULL, in->length + NTLMSSP_SIG_SIZE);
462 return NT_STATUS_NO_MEMORY;
464 memcpy(out->data + NTLMSSP_SIG_SIZE, in->data, in->length);
466 nt_status = gensec_ntlmssp_seal_packet(gensec_security, sig_mem_ctx,
467 out->data + NTLMSSP_SIG_SIZE,
468 out->length - NTLMSSP_SIG_SIZE,
469 out->data + NTLMSSP_SIG_SIZE,
470 out->length - NTLMSSP_SIG_SIZE,
473 if (NT_STATUS_IS_OK(nt_status)) {
474 memcpy(out->data, sig.data, NTLMSSP_SIG_SIZE);
478 } else if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
480 *out = data_blob_talloc(sig_mem_ctx, NULL, in->length + NTLMSSP_SIG_SIZE);
482 return NT_STATUS_NO_MEMORY;
484 memcpy(out->data + NTLMSSP_SIG_SIZE, in->data, in->length);
486 nt_status = gensec_ntlmssp_sign_packet(gensec_security, sig_mem_ctx,
487 out->data + NTLMSSP_SIG_SIZE,
488 out->length - NTLMSSP_SIG_SIZE,
489 out->data + NTLMSSP_SIG_SIZE,
490 out->length - NTLMSSP_SIG_SIZE,
493 if (NT_STATUS_IS_OK(nt_status)) {
494 memcpy(out->data, sig.data, NTLMSSP_SIG_SIZE);
505 NTSTATUS gensec_ntlmssp_unwrap(struct gensec_security *gensec_security,
506 TALLOC_CTX *sig_mem_ctx,
512 if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SEAL)) {
513 if (in->length < NTLMSSP_SIG_SIZE) {
514 return NT_STATUS_INVALID_PARAMETER;
517 sig.length = NTLMSSP_SIG_SIZE;
519 *out = data_blob_talloc(sig_mem_ctx, in->data + NTLMSSP_SIG_SIZE, in->length - NTLMSSP_SIG_SIZE);
521 return gensec_ntlmssp_unseal_packet(gensec_security, sig_mem_ctx,
522 out->data, out->length,
523 out->data, out->length,
526 } else if (gensec_have_feature(gensec_security, GENSEC_FEATURE_SIGN)) {
527 if (in->length < NTLMSSP_SIG_SIZE) {
528 return NT_STATUS_INVALID_PARAMETER;
531 sig.length = NTLMSSP_SIG_SIZE;
533 *out = data_blob_talloc(sig_mem_ctx, in->data + NTLMSSP_SIG_SIZE, in->length - NTLMSSP_SIG_SIZE);
535 return gensec_ntlmssp_check_packet(gensec_security, sig_mem_ctx,
536 out->data, out->length,
537 out->data, out->length,