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 2 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, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "auth/auth.h"
27 #include "lib/crypto/crypto.h"
28 #include "auth/ntlmssp/ntlmssp.h"
31 * Callbacks for NTLMSSP - for both client and server operating modes
35 static const struct ntlmssp_callbacks {
36 enum ntlmssp_role role;
37 enum ntlmssp_message_type ntlmssp_command;
38 NTSTATUS (*fn)(struct gensec_security *gensec_security,
39 TALLOC_CTX *out_mem_ctx,
40 DATA_BLOB in, DATA_BLOB *out);
41 } ntlmssp_callbacks[] = {
42 {NTLMSSP_CLIENT, NTLMSSP_INITIAL, ntlmssp_client_initial},
43 {NTLMSSP_SERVER, NTLMSSP_NEGOTIATE, ntlmssp_server_negotiate},
44 {NTLMSSP_CLIENT, NTLMSSP_CHALLENGE, ntlmssp_client_challenge},
45 {NTLMSSP_SERVER, NTLMSSP_AUTH, ntlmssp_server_auth},
50 * Print out the NTLMSSP flags for debugging
51 * @param neg_flags The flags from the packet
54 void debug_ntlmssp_flags(uint32_t neg_flags)
56 DEBUG(3,("Got NTLMSSP neg_flags=0x%08x\n", neg_flags));
58 if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE)
59 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_UNICODE\n"));
60 if (neg_flags & NTLMSSP_NEGOTIATE_OEM)
61 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_OEM\n"));
62 if (neg_flags & NTLMSSP_REQUEST_TARGET)
63 DEBUGADD(4, (" NTLMSSP_REQUEST_TARGET\n"));
64 if (neg_flags & NTLMSSP_NEGOTIATE_SIGN)
65 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_SIGN\n"));
66 if (neg_flags & NTLMSSP_NEGOTIATE_SEAL)
67 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_SEAL\n"));
68 if (neg_flags & NTLMSSP_NEGOTIATE_LM_KEY)
69 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_LM_KEY\n"));
70 if (neg_flags & NTLMSSP_NEGOTIATE_NETWARE)
71 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NETWARE\n"));
72 if (neg_flags & NTLMSSP_NEGOTIATE_NTLM)
73 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NTLM\n"));
74 if (neg_flags & NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED)
75 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED\n"));
76 if (neg_flags & NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED)
77 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED\n"));
78 if (neg_flags & NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL)
79 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL\n"));
80 if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN)
81 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_ALWAYS_SIGN\n"));
82 if (neg_flags & NTLMSSP_NEGOTIATE_NTLM2)
83 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NTLM2\n"));
84 if (neg_flags & NTLMSSP_CHAL_TARGET_INFO)
85 DEBUGADD(4, (" NTLMSSP_CHAL_TARGET_INFO\n"));
86 if (neg_flags & NTLMSSP_NEGOTIATE_128)
87 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_128\n"));
88 if (neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)
89 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_KEY_EXCH\n"));
92 static NTSTATUS gensec_ntlmssp_magic(struct gensec_security *gensec_security,
93 const DATA_BLOB *first_packet)
95 if (first_packet->length > 8 && memcmp("NTLMSSP\0", first_packet->data, 8) == 0) {
98 return NT_STATUS_INVALID_PARAMETER;
103 * Next state function for the wrapped NTLMSSP state machine
105 * @param gensec_security GENSEC state, initialised to NTLMSSP
106 * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
107 * @param in The request, as a DATA_BLOB
108 * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
109 * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
110 * or NT_STATUS_OK if the user is authenticated.
113 static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
114 TALLOC_CTX *out_mem_ctx,
115 const DATA_BLOB input, DATA_BLOB *out)
117 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
120 uint32_t ntlmssp_command;
123 *out = data_blob(NULL, 0);
125 if (gensec_ntlmssp_state->expected_state == NTLMSSP_DONE) {
130 /* if the caller doesn't want to manage/own the memory,
131 we can put it on our context */
132 out_mem_ctx = gensec_ntlmssp_state;
136 switch (gensec_ntlmssp_state->role) {
138 ntlmssp_command = NTLMSSP_INITIAL;
141 if (gensec_security->want_features & GENSEC_FEATURE_DATAGRAM_MODE) {
142 /* 'datagram' mode - no neg packet */
143 ntlmssp_command = NTLMSSP_NEGOTIATE;
145 /* This is normal in SPNEGO mech negotiation fallback */
146 DEBUG(2, ("Failed to parse NTLMSSP packet: zero length\n"));
147 return NT_STATUS_INVALID_PARAMETER;
152 if (!msrpc_parse(gensec_ntlmssp_state,
156 DEBUG(1, ("Failed to parse NTLMSSP packet, could not extract NTLMSSP command\n"));
157 dump_data(2, input.data, input.length);
158 return NT_STATUS_INVALID_PARAMETER;
162 if (ntlmssp_command != gensec_ntlmssp_state->expected_state) {
163 DEBUG(2, ("got NTLMSSP command %u, expected %u\n", ntlmssp_command, gensec_ntlmssp_state->expected_state));
164 return NT_STATUS_INVALID_PARAMETER;
167 for (i=0; i < ARRAY_SIZE(ntlmssp_callbacks); i++) {
168 if (ntlmssp_callbacks[i].role == gensec_ntlmssp_state->role
169 && ntlmssp_callbacks[i].ntlmssp_command == ntlmssp_command) {
170 status = ntlmssp_callbacks[i].fn(gensec_security, out_mem_ctx, input, out);
175 if (i == ARRAY_SIZE(ntlmssp_callbacks)) {
177 DEBUG(1, ("failed to find NTLMSSP callback for NTLMSSP mode %u, command %u\n",
178 gensec_ntlmssp_state->role, ntlmssp_command));
180 return NT_STATUS_INVALID_PARAMETER;
183 if (!NT_STATUS_IS_OK(status)) {
184 /* error or more processing required */
188 gensec_ntlmssp_state->have_features = 0;
190 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SIGN) {
191 gensec_ntlmssp_state->have_features |= GENSEC_FEATURE_SIGN;
194 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SEAL) {
195 gensec_ntlmssp_state->have_features |= GENSEC_FEATURE_SEAL;
198 if (gensec_ntlmssp_state->session_key.data) {
199 gensec_ntlmssp_state->have_features |= GENSEC_FEATURE_SESSION_KEY;
202 /* only NTLMv2 can handle async replies */
203 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
204 gensec_ntlmssp_state->have_features |= GENSEC_FEATURE_ASYNC_REPLIES;
211 * Return the NTLMSSP master session key
213 * @param gensec_ntlmssp_state NTLMSSP State
216 NTSTATUS gensec_ntlmssp_session_key(struct gensec_security *gensec_security,
217 DATA_BLOB *session_key)
219 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
221 if (!gensec_ntlmssp_state->session_key.data) {
222 return NT_STATUS_NO_USER_SESSION_KEY;
224 *session_key = gensec_ntlmssp_state->session_key;
229 void ntlmssp_handle_neg_flags(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
230 uint32_t neg_flags, BOOL allow_lm)
232 if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE) {
233 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_UNICODE;
234 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_OEM;
235 gensec_ntlmssp_state->unicode = True;
237 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_UNICODE;
238 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_OEM;
239 gensec_ntlmssp_state->unicode = False;
242 if ((neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) && allow_lm && !gensec_ntlmssp_state->use_ntlmv2) {
243 /* other end forcing us to use LM */
244 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_LM_KEY;
245 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
247 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_LM_KEY;
250 if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN) {
251 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_ALWAYS_SIGN;
254 if (!(neg_flags & NTLMSSP_NEGOTIATE_SIGN)) {
255 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SIGN;
258 if (!(neg_flags & NTLMSSP_NEGOTIATE_SEAL)) {
259 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SEAL;
262 if (!(neg_flags & NTLMSSP_NEGOTIATE_NTLM2)) {
263 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
266 if (!(neg_flags & NTLMSSP_NEGOTIATE_128)) {
267 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_128;
268 if (neg_flags & NTLMSSP_NEGOTIATE_56) {
269 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_56;
273 if (!(neg_flags & NTLMSSP_NEGOTIATE_56)) {
274 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_56;
277 if (!(neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)) {
278 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_KEY_EXCH;
281 if ((neg_flags & NTLMSSP_REQUEST_TARGET)) {
282 gensec_ntlmssp_state->neg_flags |= NTLMSSP_REQUEST_TARGET;
288 Weaken NTLMSSP keys to cope with down-level clients and servers.
290 We probably should have some parameters to control this, but as
291 it only occours for LM_KEY connections, and this is controlled
292 by the client lanman auth/lanman auth parameters, it isn't too bad.
295 void ntlmssp_weaken_keys(struct gensec_ntlmssp_state *gensec_ntlmssp_state)
297 /* Key weakening not performed on the master key for NTLM2
298 and does not occour for NTLM1. Therefore we only need
299 to do this for the LM_KEY.
302 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) {
303 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_128) {
305 } else if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_56) {
306 gensec_ntlmssp_state->session_key.data[7] = 0xa0;
307 } else { /* forty bits */
308 gensec_ntlmssp_state->session_key.data[5] = 0xe5;
309 gensec_ntlmssp_state->session_key.data[6] = 0x38;
310 gensec_ntlmssp_state->session_key.data[7] = 0xb0;
312 gensec_ntlmssp_state->session_key.length = 8;
316 static BOOL gensec_ntlmssp_have_feature(struct gensec_security *gensec_security,
319 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
320 if (gensec_ntlmssp_state->have_features & feature) {
327 NTSTATUS gensec_ntlmssp_start(struct gensec_security *gensec_security)
329 struct gensec_ntlmssp_state *gensec_ntlmssp_state;
331 gensec_ntlmssp_state = talloc_zero(gensec_security, struct gensec_ntlmssp_state);
332 if (!gensec_ntlmssp_state) {
333 return NT_STATUS_NO_MEMORY;
336 gensec_ntlmssp_state->auth_context = NULL;
337 gensec_ntlmssp_state->server_info = NULL;
338 gensec_ntlmssp_state->have_features = 0;
340 gensec_security->private_data = gensec_ntlmssp_state;
344 static const char *gensec_ntlmssp_oids[] = {
349 static const struct gensec_security_ops gensec_ntlmssp_security_ops = {
352 .auth_type = DCERPC_AUTH_TYPE_NTLMSSP,
353 .oid = gensec_ntlmssp_oids,
354 .client_start = gensec_ntlmssp_client_start,
355 .server_start = gensec_ntlmssp_server_start,
356 .magic = gensec_ntlmssp_magic,
357 .update = gensec_ntlmssp_update,
358 .sig_size = gensec_ntlmssp_sig_size,
359 .sign_packet = gensec_ntlmssp_sign_packet,
360 .check_packet = gensec_ntlmssp_check_packet,
361 .seal_packet = gensec_ntlmssp_seal_packet,
362 .unseal_packet = gensec_ntlmssp_unseal_packet,
363 .wrap = gensec_ntlmssp_wrap,
364 .unwrap = gensec_ntlmssp_unwrap,
365 .session_key = gensec_ntlmssp_session_key,
366 .session_info = gensec_ntlmssp_session_info,
367 .have_feature = gensec_ntlmssp_have_feature,
372 NTSTATUS gensec_ntlmssp_init(void)
375 ret = gensec_register(&gensec_ntlmssp_security_ops);
376 if (!NT_STATUS_IS_OK(ret)) {
377 DEBUG(0,("Failed to register '%s' gensec backend!\n",
378 gensec_ntlmssp_security_ops.name));