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