2 Unix SMB/Netbios implementation.
4 handle NLTMSSP, client server side parsing
6 Copyright (C) Andrew Tridgell 2001
7 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2001-2005
8 Copyright (C) Stefan Metzmacher 2005
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.
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.
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/>.
25 #include "auth/ntlmssp/ntlmssp.h"
26 #include "auth/ntlmssp/msrpc_parse.h"
27 #include "../lib/crypto/crypto.h"
28 #include "libcli/auth/libcli_auth.h"
29 #include "auth/credentials/credentials.h"
30 #include "auth/gensec/gensec.h"
31 #include "param/param.h"
33 /*********************************************************************
35 *********************************************************************/
38 * Next state function for the Initial packet
40 * @param ntlmssp_state NTLMSSP State
41 * @param out_mem_ctx The DATA_BLOB *out will be allocated on this context
42 * @param in A NULL data blob (input ignored)
43 * @param out The initial negotiate request to the server, as an talloc()ed DATA_BLOB, on out_mem_ctx
44 * @return Errors or NT_STATUS_OK.
47 NTSTATUS ntlmssp_client_initial(struct gensec_security *gensec_security,
48 TALLOC_CTX *out_mem_ctx,
49 DATA_BLOB in, DATA_BLOB *out)
51 struct gensec_ntlmssp_state *gensec_ntlmssp_state = (struct gensec_ntlmssp_state *)gensec_security->private_data;
52 const char *domain = gensec_ntlmssp_state->domain;
53 const char *workstation = cli_credentials_get_workstation(gensec_security->credentials);
55 /* These don't really matter in the initial packet, so don't panic if they are not set */
64 if (gensec_ntlmssp_state->unicode) {
65 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_UNICODE;
67 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_OEM;
70 if (gensec_ntlmssp_state->use_ntlmv2) {
71 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_NTLM2;
74 /* generate the ntlmssp negotiate packet */
75 msrpc_gen(out_mem_ctx,
79 gensec_ntlmssp_state->neg_flags,
83 gensec_ntlmssp_state->expected_state = NTLMSSP_CHALLENGE;
85 return NT_STATUS_MORE_PROCESSING_REQUIRED;
89 * Next state function for the Challenge Packet. Generate an auth packet.
91 * @param gensec_security GENSEC state
92 * @param out_mem_ctx Memory context for *out
93 * @param in The server challnege, as a DATA_BLOB. reply.data must be NULL
94 * @param out The next request (auth packet) to the server, as an allocated DATA_BLOB, on the out_mem_ctx context
95 * @return Errors or NT_STATUS_OK.
98 NTSTATUS ntlmssp_client_challenge(struct gensec_security *gensec_security,
99 TALLOC_CTX *out_mem_ctx,
100 const DATA_BLOB in, DATA_BLOB *out)
102 struct gensec_ntlmssp_state *gensec_ntlmssp_state = (struct gensec_ntlmssp_state *)gensec_security->private_data;
103 uint32_t chal_flags, ntlmssp_command, unkn1, unkn2;
104 DATA_BLOB server_domain_blob;
105 DATA_BLOB challenge_blob;
106 DATA_BLOB target_info = data_blob(NULL, 0);
108 const char *chal_parse_string;
109 const char *auth_gen_string;
110 DATA_BLOB lm_response = data_blob(NULL, 0);
111 DATA_BLOB nt_response = data_blob(NULL, 0);
112 DATA_BLOB session_key = data_blob(NULL, 0);
113 DATA_BLOB lm_session_key = data_blob(NULL, 0);
114 DATA_BLOB encrypted_session_key = data_blob(NULL, 0);
117 const char *user, *domain;
119 TALLOC_CTX *mem_ctx = talloc_new(out_mem_ctx);
121 return NT_STATUS_NO_MEMORY;
124 if (!msrpc_parse(mem_ctx,
130 DEBUG(1, ("Failed to parse the NTLMSSP Challenge: (#1)\n"));
131 dump_data(2, in.data, in.length);
132 talloc_free(mem_ctx);
134 return NT_STATUS_INVALID_PARAMETER;
137 data_blob_free(&server_domain_blob);
139 DEBUG(3, ("Got challenge flags:\n"));
140 debug_ntlmssp_flags(chal_flags);
142 ntlmssp_handle_neg_flags(gensec_ntlmssp_state, chal_flags, gensec_ntlmssp_state->allow_lm_key);
144 if (gensec_ntlmssp_state->unicode) {
145 if (chal_flags & NTLMSSP_CHAL_TARGET_INFO) {
146 chal_parse_string = "CdUdbddB";
148 chal_parse_string = "CdUdbdd";
150 auth_gen_string = "CdBBUUUBd";
152 if (chal_flags & NTLMSSP_CHAL_TARGET_INFO) {
153 chal_parse_string = "CdAdbddB";
155 chal_parse_string = "CdAdbdd";
158 auth_gen_string = "CdBBAAABd";
161 if (!msrpc_parse(mem_ctx,
162 &in, chal_parse_string,
170 DEBUG(1, ("Failed to parse the NTLMSSP Challenge: (#2)\n"));
171 dump_data(2, in.data, in.length);
172 talloc_free(mem_ctx);
173 return NT_STATUS_INVALID_PARAMETER;
176 gensec_ntlmssp_state->server_domain = server_domain;
178 if (challenge_blob.length != 8) {
179 talloc_free(mem_ctx);
180 return NT_STATUS_INVALID_PARAMETER;
183 cli_credentials_get_ntlm_username_domain(gensec_security->credentials, mem_ctx,
186 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
187 flags |= CLI_CRED_NTLM2;
189 if (gensec_ntlmssp_state->use_ntlmv2) {
190 flags |= CLI_CRED_NTLMv2_AUTH;
192 if (gensec_ntlmssp_state->use_nt_response) {
193 flags |= CLI_CRED_NTLM_AUTH;
195 if (lp_client_lanman_auth(gensec_security->settings->lp_ctx)) {
196 flags |= CLI_CRED_LANMAN_AUTH;
199 nt_status = cli_credentials_get_ntlm_response(gensec_security->credentials, mem_ctx,
200 &flags, challenge_blob, target_info,
201 &lm_response, &nt_response,
202 &lm_session_key, &session_key);
204 if (!NT_STATUS_IS_OK(nt_status)) {
208 if (!(flags & CLI_CRED_LANMAN_AUTH)) {
209 /* LM Key is still possible, just silly. Fortunetly
210 * we require command line options to end up here */
211 /* gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_LM_KEY; */
214 if (!(flags & CLI_CRED_NTLM2)) {
215 /* NTLM2 is incompatible... */
216 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
219 if ((gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_LM_KEY)
220 && lp_client_lanman_auth(gensec_security->settings->lp_ctx) && lm_session_key.length == 16) {
221 DATA_BLOB new_session_key = data_blob_talloc(mem_ctx, NULL, 16);
222 if (lm_response.length == 24) {
223 SMBsesskeygen_lm_sess_key(lm_session_key.data, lm_response.data,
224 new_session_key.data);
226 static const uint8_t zeros[24];
227 SMBsesskeygen_lm_sess_key(lm_session_key.data, zeros,
228 new_session_key.data);
230 session_key = new_session_key;
231 dump_data_pw("LM session key\n", session_key.data, session_key.length);
235 /* Key exchange encryptes a new client-generated session key with
236 the password-derived key */
237 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH) {
238 /* Make up a new session key */
239 uint8_t client_session_key[16];
240 generate_secret_buffer(client_session_key, sizeof(client_session_key));
242 /* Encrypt the new session key with the old one */
243 encrypted_session_key = data_blob_talloc(gensec_ntlmssp_state,
244 client_session_key, sizeof(client_session_key));
245 dump_data_pw("KEY_EXCH session key:\n", encrypted_session_key.data, encrypted_session_key.length);
246 arcfour_crypt(encrypted_session_key.data, session_key.data, encrypted_session_key.length);
247 dump_data_pw("KEY_EXCH session key (enc):\n", encrypted_session_key.data, encrypted_session_key.length);
249 /* Mark the new session key as the 'real' session key */
250 session_key = data_blob_talloc(mem_ctx, client_session_key, sizeof(client_session_key));
253 DEBUG(3, ("NTLMSSP: Set final flags:\n"));
254 debug_ntlmssp_flags(gensec_ntlmssp_state->neg_flags);
256 /* this generates the actual auth packet */
257 if (!msrpc_gen(mem_ctx,
258 out, auth_gen_string,
261 lm_response.data, lm_response.length,
262 nt_response.data, nt_response.length,
265 cli_credentials_get_workstation(gensec_security->credentials),
266 encrypted_session_key.data, encrypted_session_key.length,
267 gensec_ntlmssp_state->neg_flags)) {
268 talloc_free(mem_ctx);
269 return NT_STATUS_NO_MEMORY;
272 gensec_ntlmssp_state->session_key = session_key;
273 talloc_steal(gensec_ntlmssp_state, session_key.data);
275 talloc_steal(out_mem_ctx, out->data);
277 gensec_ntlmssp_state->chal = challenge_blob;
278 gensec_ntlmssp_state->lm_resp = lm_response;
279 talloc_steal(gensec_ntlmssp_state->lm_resp.data, lm_response.data);
280 gensec_ntlmssp_state->nt_resp = nt_response;
281 talloc_steal(gensec_ntlmssp_state->nt_resp.data, nt_response.data);
283 gensec_ntlmssp_state->expected_state = NTLMSSP_DONE;
285 if (gensec_security->want_features & (GENSEC_FEATURE_SIGN|GENSEC_FEATURE_SEAL)) {
286 nt_status = ntlmssp_sign_init(gensec_ntlmssp_state);
287 if (!NT_STATUS_IS_OK(nt_status)) {
288 DEBUG(1, ("Could not setup NTLMSSP signing/sealing system (error was: %s)\n",
289 nt_errstr(nt_status)));
290 talloc_free(mem_ctx);
295 talloc_free(mem_ctx);
299 NTSTATUS gensec_ntlmssp_client_start(struct gensec_security *gensec_security)
301 struct gensec_ntlmssp_state *gensec_ntlmssp_state;
304 nt_status = gensec_ntlmssp_start(gensec_security);
305 NT_STATUS_NOT_OK_RETURN(nt_status);
307 gensec_ntlmssp_state = (struct gensec_ntlmssp_state *)gensec_security->private_data;
309 gensec_ntlmssp_state->role = NTLMSSP_CLIENT;
311 gensec_ntlmssp_state->domain = lp_workgroup(gensec_security->settings->lp_ctx);
313 gensec_ntlmssp_state->unicode = gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "unicode", true);
315 gensec_ntlmssp_state->use_nt_response = gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "send_nt_reponse", true);
317 gensec_ntlmssp_state->allow_lm_key = (lp_client_lanman_auth(gensec_security->settings->lp_ctx)
318 && (gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "allow_lm_key", false)
319 || gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "lm_key", false)));
321 gensec_ntlmssp_state->use_ntlmv2 = lp_client_ntlmv2_auth(gensec_security->settings->lp_ctx);
323 gensec_ntlmssp_state->expected_state = NTLMSSP_INITIAL;
325 gensec_ntlmssp_state->neg_flags =
326 NTLMSSP_NEGOTIATE_NTLM |
327 NTLMSSP_REQUEST_TARGET;
329 if (gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "128bit", true)) {
330 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_128;
333 if (gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "56bit", false)) {
334 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_56;
337 if (gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "lm_key", false)) {
338 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_LM_KEY;
341 if (gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "keyexchange", true)) {
342 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_KEY_EXCH;
345 if (gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "alwayssign", true)) {
346 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_ALWAYS_SIGN;
349 if (gensec_setting_bool(gensec_security->settings, "ntlmssp_client", "ntlm2", true)) {
350 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_NTLM2;
352 /* apparently we can't do ntlmv2 if we don't do ntlm2 */
353 gensec_ntlmssp_state->use_ntlmv2 = false;
356 if (gensec_security->want_features & GENSEC_FEATURE_SESSION_KEY) {
358 * We need to set this to allow a later SetPassword
359 * via the SAMR pipe to succeed. Strange.... We could
360 * also add NTLMSSP_NEGOTIATE_SEAL here. JRA.
362 * Without this, Windows will not create the master key
363 * that it thinks is only used for NTLMSSP signing and
364 * sealing. (It is actually pulled out and used directly)
366 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_SIGN;
368 if (gensec_security->want_features & GENSEC_FEATURE_SIGN) {
369 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_SIGN;
371 if (gensec_security->want_features & GENSEC_FEATURE_SEAL) {
372 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_SEAL;
375 gensec_security->private_data = gensec_ntlmssp_state;