Remove unused include param/param.h.
[kai/samba.git] / source4 / libcli / auth / smbencrypt.c
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB parameters and setup
4    Copyright (C) Andrew Tridgell 1992-1998
5    Modified by Jeremy Allison 1995.
6    Copyright (C) Jeremy Allison 1995-2000.
7    Copyright (C) Luke Kennethc Casson Leighton 1996-2000.
8    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2002-2003
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 "system/time.h"
26 #include "auth/ntlmssp/ntlmssp.h"
27 #include "auth/ntlmssp/msrpc_parse.h"
28 #include "../lib/crypto/crypto.h"
29 #include "libcli/auth/libcli_auth.h"
30
31 /*
32    This implements the X/Open SMB password encryption
33    It takes a password ('unix' string), a 8 byte "crypt key" 
34    and puts 24 bytes of encrypted password into p24 
35
36    Returns false if password must have been truncated to create LM hash
37 */
38 bool SMBencrypt(const char *passwd, const uint8_t *c8, uint8_t p24[24])
39 {
40         bool ret;
41         uint8_t p21[21];
42
43         memset(p21,'\0',21);
44         ret = E_deshash(passwd, p21); 
45
46         SMBOWFencrypt(p21, c8, p24);
47
48 #ifdef DEBUG_PASSWORD
49         DEBUG(100,("SMBencrypt: lm#, challenge, response\n"));
50         dump_data(100, p21, 16);
51         dump_data(100, c8, 8);
52         dump_data(100, p24, 24);
53 #endif
54
55         return ret;
56 }
57
58 /**
59  * Creates the MD4 Hash of the users password in NT UNICODE.
60  * @param passwd password in 'unix' charset.
61  * @param p16 return password hashed with md4, caller allocated 16 byte buffer
62  */
63  
64 bool E_md4hash(const char *passwd, uint8_t p16[16])
65 {
66         int len;
67         void *wpwd;
68
69         len = push_ucs2_talloc(NULL, &wpwd, passwd);
70         if (len < 2) {
71                 /* We don't want to return fixed data, as most callers
72                  * don't check */
73                 mdfour(p16, (const uint8_t *)passwd, strlen(passwd));
74                 return false;
75         }
76         
77         len -= 2;
78         mdfour(p16, wpwd, len);
79
80         talloc_free(wpwd);
81         return true;
82 }
83
84 /**
85  * Creates the DES forward-only Hash of the users password in DOS ASCII charset
86  * @param passwd password in 'unix' charset.
87  * @param p16 return password hashed with DES, caller allocated 16 byte buffer
88  * @return false if password was > 14 characters, and therefore may be incorrect, otherwise true
89  * @note p16 is filled in regardless
90  */
91  
92 bool E_deshash(const char *passwd, uint8_t p16[16])
93 {
94         bool ret = true;
95         char dospwd[256];
96         ZERO_STRUCT(dospwd);
97
98         /* Password must be converted to DOS charset - null terminated, uppercase. */
99         push_string(dospwd, passwd, sizeof(dospwd), STR_ASCII|STR_UPPER|STR_TERMINATE);
100
101         /* Only the first 14 chars are considered, password need not be null terminated. */
102         E_P16((const uint8_t *)dospwd, p16);
103
104         if (strlen(dospwd) > 14) {
105                 ret = false;
106         }
107
108         ZERO_STRUCT(dospwd);    
109
110         return ret;
111 }
112
113 /* Does both the NTLMv2 owfs of a user's password */
114 bool ntv2_owf_gen(const uint8_t owf[16],
115                   const char *user_in, const char *domain_in,
116                   bool upper_case_domain, /* Transform the domain into UPPER case */
117                   uint8_t kr_buf[16])
118 {
119         void *user;
120         void *domain;   
121         size_t user_byte_len;
122         size_t domain_byte_len;
123
124         HMACMD5Context ctx;
125         TALLOC_CTX *mem_ctx = talloc_init("ntv2_owf_gen for %s\\%s", domain_in, user_in); 
126
127         if (!mem_ctx) {
128                 return false;
129         }
130
131         if (!user_in) {
132                 user_in = "";
133         }
134
135         if (!domain_in) {
136                 domain_in = "";
137         }
138
139         user_in = strupper_talloc(mem_ctx, user_in);
140         if (user_in == NULL) {
141                 talloc_free(mem_ctx);
142                 return false;
143         }
144
145         if (upper_case_domain) {
146                 domain_in = strupper_talloc(mem_ctx, domain_in);
147                 if (domain_in == NULL) {
148                         talloc_free(mem_ctx);
149                         return false;
150                 }
151         }
152
153         user_byte_len = push_ucs2_talloc(mem_ctx, &user, user_in);
154         if (user_byte_len == (ssize_t)-1) {
155                 DEBUG(0, ("push_uss2_talloc() for user returned -1 (probably talloc() failure)\n"));
156                 talloc_free(mem_ctx);
157                 return false;
158         }
159
160         domain_byte_len = push_ucs2_talloc(mem_ctx, &domain, domain_in);
161         if (domain_byte_len == (ssize_t)-1) {
162                 DEBUG(0, ("push_ucs2_talloc() for domain returned -1 (probably talloc() failure)\n"));
163                 talloc_free(mem_ctx);
164                 return false;
165         }
166
167         SMB_ASSERT(user_byte_len >= 2);
168         SMB_ASSERT(domain_byte_len >= 2);
169
170         /* We don't want null termination */
171         user_byte_len = user_byte_len - 2;
172         domain_byte_len = domain_byte_len - 2;
173         
174         hmac_md5_init_limK_to_64(owf, 16, &ctx);
175         hmac_md5_update(user, user_byte_len, &ctx);
176         hmac_md5_update(domain, domain_byte_len, &ctx);
177         hmac_md5_final(kr_buf, &ctx);
178
179 #ifdef DEBUG_PASSWORD
180         DEBUG(100, ("ntv2_owf_gen: user, domain, owfkey, kr\n"));
181         dump_data(100, user, user_byte_len);
182         dump_data(100, domain, domain_byte_len);
183         dump_data(100, owf, 16);
184         dump_data(100, kr_buf, 16);
185 #endif
186
187         talloc_free(mem_ctx);
188         return true;
189 }
190
191 /* Does the des encryption from the NT or LM MD4 hash. */
192 void SMBOWFencrypt(const uint8_t passwd[16], const uint8_t *c8, uint8_t p24[24])
193 {
194         uint8_t p21[21];
195
196         ZERO_STRUCT(p21);
197  
198         memcpy(p21, passwd, 16);    
199         E_P24(p21, c8, p24);
200 }
201
202 /* Does the NT MD4 hash then des encryption. */
203  
204 void SMBNTencrypt(const char *passwd, uint8_t *c8, uint8_t *p24)
205 {
206         uint8_t p21[21];
207  
208         memset(p21,'\0',21);
209  
210         E_md4hash(passwd, p21);    
211         SMBOWFencrypt(p21, c8, p24);
212
213 #ifdef DEBUG_PASSWORD
214         DEBUG(100,("SMBNTencrypt: nt#, challenge, response\n"));
215         dump_data(100, p21, 16);
216         dump_data(100, c8, 8);
217         dump_data(100, p24, 24);
218 #endif
219 }
220
221 /* Does the md5 encryption from the Key Response for NTLMv2. */
222 void SMBOWFencrypt_ntv2(const uint8_t kr[16],
223                         const DATA_BLOB *srv_chal,
224                         const DATA_BLOB *smbcli_chal,
225                         uint8_t resp_buf[16])
226 {
227         HMACMD5Context ctx;
228
229         hmac_md5_init_limK_to_64(kr, 16, &ctx);
230         hmac_md5_update(srv_chal->data, srv_chal->length, &ctx);
231         hmac_md5_update(smbcli_chal->data, smbcli_chal->length, &ctx);
232         hmac_md5_final(resp_buf, &ctx);
233
234 #ifdef DEBUG_PASSWORD
235         DEBUG(100, ("SMBOWFencrypt_ntv2: srv_chal, smbcli_chal, resp_buf\n"));
236         dump_data(100, srv_chal->data, srv_chal->length);
237         dump_data(100, smbcli_chal->data, smbcli_chal->length);
238         dump_data(100, resp_buf, 16);
239 #endif
240 }
241
242 void SMBsesskeygen_ntv2(const uint8_t kr[16],
243                         const uint8_t * nt_resp, uint8_t sess_key[16])
244 {
245         /* a very nice, 128 bit, variable session key */
246         
247         HMACMD5Context ctx;
248
249         hmac_md5_init_limK_to_64(kr, 16, &ctx);
250         hmac_md5_update(nt_resp, 16, &ctx);
251         hmac_md5_final((uint8_t *)sess_key, &ctx);
252
253 #ifdef DEBUG_PASSWORD
254         DEBUG(100, ("SMBsesskeygen_ntv2:\n"));
255         dump_data(100, sess_key, 16);
256 #endif
257 }
258
259 void SMBsesskeygen_ntv1(const uint8_t kr[16], uint8_t sess_key[16])
260 {
261         /* yes, this session key does not change - yes, this 
262            is a problem - but it is 128 bits */
263         
264         mdfour((uint8_t *)sess_key, kr, 16);
265
266 #ifdef DEBUG_PASSWORD
267         DEBUG(100, ("SMBsesskeygen_ntv1:\n"));
268         dump_data(100, sess_key, 16);
269 #endif
270 }
271
272 void SMBsesskeygen_lm_sess_key(const uint8_t lm_hash[16],
273                                const uint8_t lm_resp[24], /* only uses 8 */ 
274                                uint8_t sess_key[16])
275 {
276         /* Calculate the LM session key (effective length 40 bits,
277            but changes with each session) */
278         uint8_t p24[24];
279         uint8_t partial_lm_hash[14];
280  
281         memcpy(partial_lm_hash, lm_hash, 8);    
282         memset(partial_lm_hash + 8, 0xbd, 6);
283
284         des_crypt56(p24,   lm_resp, partial_lm_hash,     1);
285         des_crypt56(p24+8, lm_resp, partial_lm_hash + 7, 1);
286
287         memcpy(sess_key, p24, 16);
288
289 #ifdef DEBUG_PASSWORD
290         DEBUG(100, ("SMBsesskeygen_lm_sess_key: \n"));
291         dump_data(100, sess_key, 16);
292 #endif
293 }
294
295 DATA_BLOB NTLMv2_generate_names_blob(TALLOC_CTX *mem_ctx, 
296                                      const char *hostname, 
297                                      const char *domain)
298 {
299         DATA_BLOB names_blob = data_blob_talloc(mem_ctx, NULL, 0);
300         
301         msrpc_gen(mem_ctx, &names_blob, 
302                   "aaa", 
303                   NTLMSSP_NAME_TYPE_DOMAIN, domain,
304                   NTLMSSP_NAME_TYPE_SERVER, hostname,
305                   0, "");
306         return names_blob;
307 }
308
309 static DATA_BLOB NTLMv2_generate_client_data(TALLOC_CTX *mem_ctx, const DATA_BLOB *names_blob) 
310 {
311         uint8_t client_chal[8];
312         DATA_BLOB response = data_blob(NULL, 0);
313         uint8_t long_date[8];
314         NTTIME nttime;
315
316         unix_to_nt_time(&nttime, time(NULL));
317
318         generate_random_buffer(client_chal, sizeof(client_chal));
319
320         push_nttime(long_date, 0, nttime);
321
322         /* See http://www.ubiqx.org/cifs/SMB.html#SMB.8.5 */
323
324         msrpc_gen(mem_ctx, &response, "ddbbdb", 
325                   0x00000101,     /* Header  */
326                   0,              /* 'Reserved'  */
327                   long_date, 8,   /* Timestamp */
328                   client_chal, 8, /* client challenge */
329                   0,              /* Unknown */
330                   names_blob->data, names_blob->length);        /* End of name list */
331
332         return response;
333 }
334
335 static DATA_BLOB NTLMv2_generate_response(TALLOC_CTX *out_mem_ctx, 
336                                           const uint8_t ntlm_v2_hash[16],
337                                           const DATA_BLOB *server_chal,
338                                           const DATA_BLOB *names_blob)
339 {
340         uint8_t ntlmv2_response[16];
341         DATA_BLOB ntlmv2_client_data;
342         DATA_BLOB final_response;
343         
344         TALLOC_CTX *mem_ctx = talloc_named(out_mem_ctx, 0, 
345                                            "NTLMv2_generate_response internal context");
346
347         if (!mem_ctx) {
348                 return data_blob(NULL, 0);
349         }
350         
351         /* NTLMv2 */
352         /* generate some data to pass into the response function - including
353            the hostname and domain name of the server */
354         ntlmv2_client_data = NTLMv2_generate_client_data(mem_ctx, names_blob);
355
356         /* Given that data, and the challenge from the server, generate a response */
357         SMBOWFencrypt_ntv2(ntlm_v2_hash, server_chal, &ntlmv2_client_data, ntlmv2_response);
358         
359         final_response = data_blob_talloc(out_mem_ctx, NULL, sizeof(ntlmv2_response) + ntlmv2_client_data.length);
360
361         memcpy(final_response.data, ntlmv2_response, sizeof(ntlmv2_response));
362
363         memcpy(final_response.data+sizeof(ntlmv2_response), 
364                ntlmv2_client_data.data, ntlmv2_client_data.length);
365
366         talloc_free(mem_ctx);
367
368         return final_response;
369 }
370
371 static DATA_BLOB LMv2_generate_response(TALLOC_CTX *mem_ctx, 
372                                         const uint8_t ntlm_v2_hash[16],
373                                         const DATA_BLOB *server_chal)
374 {
375         uint8_t lmv2_response[16];
376         DATA_BLOB lmv2_client_data = data_blob_talloc(mem_ctx, NULL, 8);
377         DATA_BLOB final_response = data_blob_talloc(mem_ctx, NULL,24);
378         
379         /* LMv2 */
380         /* client-supplied random data */
381         generate_random_buffer(lmv2_client_data.data, lmv2_client_data.length); 
382
383         /* Given that data, and the challenge from the server, generate a response */
384         SMBOWFencrypt_ntv2(ntlm_v2_hash, server_chal, &lmv2_client_data, lmv2_response);
385         memcpy(final_response.data, lmv2_response, sizeof(lmv2_response));
386
387         /* after the first 16 bytes is the random data we generated above, 
388            so the server can verify us with it */
389         memcpy(final_response.data+sizeof(lmv2_response), 
390                lmv2_client_data.data, lmv2_client_data.length);
391
392         data_blob_free(&lmv2_client_data);
393
394         return final_response;
395 }
396
397 bool SMBNTLMv2encrypt_hash(TALLOC_CTX *mem_ctx, 
398                            const char *user, const char *domain, const uint8_t nt_hash[16],
399                            const DATA_BLOB *server_chal, 
400                            const DATA_BLOB *names_blob,
401                            DATA_BLOB *lm_response, DATA_BLOB *nt_response, 
402                            DATA_BLOB *lm_session_key, DATA_BLOB *user_session_key) 
403 {
404         uint8_t ntlm_v2_hash[16];
405
406         /* We don't use the NT# directly.  Instead we use it mashed up with
407            the username and domain.
408            This prevents username swapping during the auth exchange
409         */
410         if (!ntv2_owf_gen(nt_hash, user, domain, true, ntlm_v2_hash)) {
411                 return false;
412         }
413         
414         if (nt_response) {
415                 *nt_response = NTLMv2_generate_response(mem_ctx, 
416                                                         ntlm_v2_hash, server_chal,
417                                                         names_blob); 
418                 if (user_session_key) {
419                         *user_session_key = data_blob_talloc(mem_ctx, NULL, 16);
420                         
421                         /* The NTLMv2 calculations also provide a session key, for signing etc later */
422                         /* use only the first 16 bytes of nt_response for session key */
423                         SMBsesskeygen_ntv2(ntlm_v2_hash, nt_response->data, user_session_key->data);
424                 }
425         }
426         
427         /* LMv2 */
428         
429         if (lm_response) {
430                 *lm_response = LMv2_generate_response(mem_ctx, 
431                                                       ntlm_v2_hash, server_chal);
432                 if (lm_session_key) {
433                         *lm_session_key = data_blob_talloc(mem_ctx, NULL, 16);
434                         
435                         /* The NTLMv2 calculations also provide a session key, for signing etc later */
436                         /* use only the first 16 bytes of lm_response for session key */
437                         SMBsesskeygen_ntv2(ntlm_v2_hash, lm_response->data, lm_session_key->data);
438                 }
439         }
440         
441         return true;
442 }
443
444 bool SMBNTLMv2encrypt(TALLOC_CTX *mem_ctx, 
445                       const char *user, const char *domain, 
446                       const char *password, 
447                       const DATA_BLOB *server_chal, 
448                       const DATA_BLOB *names_blob,
449                       DATA_BLOB *lm_response, DATA_BLOB *nt_response, 
450                       DATA_BLOB *lm_session_key, DATA_BLOB *user_session_key) 
451 {
452         uint8_t nt_hash[16];
453         E_md4hash(password, nt_hash);
454
455         return SMBNTLMv2encrypt_hash(mem_ctx, 
456                                      user, domain, nt_hash, server_chal, names_blob,
457                                      lm_response, nt_response, lm_session_key, user_session_key);
458 }
459
460 /***********************************************************
461  encode a password buffer with a unicode password.  The buffer
462  is filled with random data to make it harder to attack.
463 ************************************************************/
464 bool encode_pw_buffer(uint8_t buffer[516], const char *password, int string_flags)
465 {
466         uint8_t new_pw[512];
467         size_t new_pw_len;
468
469         /* the incoming buffer can be any alignment. */
470         string_flags |= STR_NOALIGN;
471
472         new_pw_len = push_string(new_pw,
473                                  password, 
474                                  sizeof(new_pw), string_flags);
475         
476         memcpy(&buffer[512 - new_pw_len], new_pw, new_pw_len);
477
478         generate_random_buffer(buffer, 512 - new_pw_len);
479
480         /* 
481          * The length of the new password is in the last 4 bytes of
482          * the data buffer.
483          */
484         SIVAL(buffer, 512, new_pw_len);
485         ZERO_STRUCT(new_pw);
486         return true;
487 }
488
489
490 /***********************************************************
491  decode a password buffer
492  *new_pw_len is the length in bytes of the possibly mulitbyte
493  returned password including termination.
494 ************************************************************/
495 bool decode_pw_buffer(uint8_t in_buffer[516], char *new_pwrd,
496                       int new_pwrd_size, int string_flags)
497 {
498         int byte_len=0;
499         ssize_t converted_pw_len;
500
501         /* the incoming buffer can be any alignment. */
502         string_flags |= STR_NOALIGN;
503
504         /*
505           Warning !!! : This function is called from some rpc call.
506           The password IN the buffer may be a UNICODE string.
507           The password IN new_pwrd is an ASCII string
508           If you reuse that code somewhere else check first.
509         */
510
511         /* The length of the new password is in the last 4 bytes of the data buffer. */
512
513         byte_len = IVAL(in_buffer, 512);
514
515 #ifdef DEBUG_PASSWORD
516         dump_data(100, in_buffer, 516);
517 #endif
518
519         /* Password cannot be longer than the size of the password buffer */
520         if ( (byte_len < 0) || (byte_len > 512)) {
521                 return false;
522         }
523
524         /* decode into the return buffer.  Buffer length supplied */
525         converted_pw_len = pull_string(new_pwrd, &in_buffer[512 - byte_len], new_pwrd_size, 
526                                   byte_len, string_flags);
527
528         if (converted_pw_len == -1) {
529                 return false;
530         }
531
532 #ifdef DEBUG_PASSWORD
533         DEBUG(100,("decode_pw_buffer: new_pwrd: "));
534         dump_data(100, (const uint8_t *)new_pwrd, converted_pw_len);
535         DEBUG(100,("multibyte len:%d\n", (int)converted_pw_len));
536         DEBUG(100,("original char len:%d\n", byte_len/2));
537 #endif
538         
539         return true;
540 }
541
542 /***********************************************************
543  encode a password buffer with an already unicode password.  The
544  rest of the buffer is filled with random data to make it harder to attack.
545 ************************************************************/
546 bool set_pw_in_buffer(uint8_t buffer[516], DATA_BLOB *password)
547 {
548         if (password->length > 512) {
549                 return false;
550         }
551
552         memcpy(&buffer[512 - password->length], password->data, password->length);
553
554         generate_random_buffer(buffer, 512 - password->length);
555
556         /* 
557          * The length of the new password is in the last 4 bytes of
558          * the data buffer.
559          */
560         SIVAL(buffer, 512, password->length);
561         return true;
562 }
563
564 /***********************************************************
565  decode a password buffer
566  *new_pw_size is the length in bytes of the extracted unicode password
567 ************************************************************/
568 bool extract_pw_from_buffer(TALLOC_CTX *mem_ctx, 
569                             uint8_t in_buffer[516], DATA_BLOB *new_pass)
570 {
571         int byte_len=0;
572
573         /* The length of the new password is in the last 4 bytes of the data buffer. */
574
575         byte_len = IVAL(in_buffer, 512);
576
577 #ifdef DEBUG_PASSWORD
578         dump_data(100, in_buffer, 516);
579 #endif
580
581         /* Password cannot be longer than the size of the password buffer */
582         if ( (byte_len < 0) || (byte_len > 512)) {
583                 return false;
584         }
585
586         *new_pass = data_blob_talloc(mem_ctx, &in_buffer[512 - byte_len], byte_len);
587
588         if (!*new_pass->data) {
589                 return false;
590         }
591
592         return true;
593 }