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 "auth/ntlmssp/ntlmssp.h"
30 * Callbacks for NTLMSSP - for both client and server operating modes
34 static const struct ntlmssp_callbacks {
35 enum ntlmssp_role role;
36 enum ntlmssp_message_type ntlmssp_command;
37 NTSTATUS (*fn)(struct gensec_security *gensec_security,
38 TALLOC_CTX *out_mem_ctx,
39 DATA_BLOB in, DATA_BLOB *out);
40 } ntlmssp_callbacks[] = {
41 {NTLMSSP_CLIENT, NTLMSSP_INITIAL, ntlmssp_client_initial},
42 {NTLMSSP_SERVER, NTLMSSP_NEGOTIATE, ntlmssp_server_negotiate},
43 {NTLMSSP_CLIENT, NTLMSSP_CHALLENGE, ntlmssp_client_challenge},
44 {NTLMSSP_SERVER, NTLMSSP_AUTH, ntlmssp_server_auth},
49 * Print out the NTLMSSP flags for debugging
50 * @param neg_flags The flags from the packet
53 void debug_ntlmssp_flags(uint32_t neg_flags)
55 DEBUG(3,("Got NTLMSSP neg_flags=0x%08x\n", neg_flags));
57 if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE)
58 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_UNICODE\n"));
59 if (neg_flags & NTLMSSP_NEGOTIATE_OEM)
60 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_OEM\n"));
61 if (neg_flags & NTLMSSP_REQUEST_TARGET)
62 DEBUGADD(4, (" NTLMSSP_REQUEST_TARGET\n"));
63 if (neg_flags & NTLMSSP_NEGOTIATE_SIGN)
64 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_SIGN\n"));
65 if (neg_flags & NTLMSSP_NEGOTIATE_SEAL)
66 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_SEAL\n"));
67 if (neg_flags & NTLMSSP_NEGOTIATE_LM_KEY)
68 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_LM_KEY\n"));
69 if (neg_flags & NTLMSSP_NEGOTIATE_NETWARE)
70 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NETWARE\n"));
71 if (neg_flags & NTLMSSP_NEGOTIATE_NTLM)
72 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NTLM\n"));
73 if (neg_flags & NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED)
74 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED\n"));
75 if (neg_flags & NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED)
76 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED\n"));
77 if (neg_flags & NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL)
78 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL\n"));
79 if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN)
80 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_ALWAYS_SIGN\n"));
81 if (neg_flags & NTLMSSP_NEGOTIATE_NTLM2)
82 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_NTLM2\n"));
83 if (neg_flags & NTLMSSP_CHAL_TARGET_INFO)
84 DEBUGADD(4, (" NTLMSSP_CHAL_TARGET_INFO\n"));
85 if (neg_flags & NTLMSSP_NEGOTIATE_128)
86 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_128\n"));
87 if (neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)
88 DEBUGADD(4, (" NTLMSSP_NEGOTIATE_KEY_EXCH\n"));
91 static NTSTATUS gensec_ntlmssp_magic(struct gensec_security *gensec_security,
92 const DATA_BLOB *first_packet)
94 if (first_packet->length > 8 && memcmp("NTLMSSP\0", first_packet->data, 8) == 0) {
97 return NT_STATUS_INVALID_PARAMETER;
102 * Next state function for the wrapped NTLMSSP state machine
104 * @param gensec_security GENSEC state, initialised to NTLMSSP
105 * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
106 * @param in The request, as a DATA_BLOB
107 * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
108 * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
109 * or NT_STATUS_OK if the user is authenticated.
112 static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
113 TALLOC_CTX *out_mem_ctx,
114 const DATA_BLOB input, DATA_BLOB *out)
116 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
119 uint32_t ntlmssp_command;
122 *out = data_blob(NULL, 0);
124 if (gensec_ntlmssp_state->expected_state == NTLMSSP_DONE) {
125 /* We are strict here because other modules, which we
126 * don't fully control (such as GSSAPI) are also
127 * strict, but are tested less often */
129 DEBUG(1, ("Called NTLMSSP after state machine was 'done'\n"));
130 return NT_STATUS_INVALID_PARAMETER;
134 /* if the caller doesn't want to manage/own the memory,
135 we can put it on our context */
136 out_mem_ctx = gensec_ntlmssp_state;
140 switch (gensec_ntlmssp_state->role) {
142 ntlmssp_command = NTLMSSP_INITIAL;
145 if (gensec_security->want_features & GENSEC_FEATURE_DATAGRAM_MODE) {
146 /* 'datagram' mode - no neg packet */
147 ntlmssp_command = NTLMSSP_NEGOTIATE;
149 /* This is normal in SPNEGO mech negotiation fallback */
150 DEBUG(2, ("Failed to parse NTLMSSP packet: zero length\n"));
151 return NT_STATUS_INVALID_PARAMETER;
156 if (!msrpc_parse(gensec_ntlmssp_state,
160 DEBUG(1, ("Failed to parse NTLMSSP packet, could not extract NTLMSSP command\n"));
161 dump_data(2, input.data, input.length);
162 return NT_STATUS_INVALID_PARAMETER;
166 if (ntlmssp_command != gensec_ntlmssp_state->expected_state) {
167 DEBUG(2, ("got NTLMSSP command %u, expected %u\n", ntlmssp_command, gensec_ntlmssp_state->expected_state));
168 return NT_STATUS_INVALID_PARAMETER;
171 for (i=0; i < ARRAY_SIZE(ntlmssp_callbacks); i++) {
172 if (ntlmssp_callbacks[i].role == gensec_ntlmssp_state->role
173 && ntlmssp_callbacks[i].ntlmssp_command == ntlmssp_command) {
174 status = ntlmssp_callbacks[i].fn(gensec_security, out_mem_ctx, input, out);
179 if (i == ARRAY_SIZE(ntlmssp_callbacks)) {
181 DEBUG(1, ("failed to find NTLMSSP callback for NTLMSSP mode %u, command %u\n",
182 gensec_ntlmssp_state->role, ntlmssp_command));
184 return NT_STATUS_INVALID_PARAMETER;
187 if (!NT_STATUS_IS_OK(status)) {
188 /* error or more processing required */
196 * Return the NTLMSSP master session key
198 * @param gensec_ntlmssp_state NTLMSSP State
201 NTSTATUS gensec_ntlmssp_session_key(struct gensec_security *gensec_security,
202 DATA_BLOB *session_key)
204 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
206 if (!gensec_ntlmssp_state->session_key.data) {
207 return NT_STATUS_NO_USER_SESSION_KEY;
209 *session_key = gensec_ntlmssp_state->session_key;
214 void ntlmssp_handle_neg_flags(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
215 uint32_t neg_flags, BOOL allow_lm)
217 if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE) {
218 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_UNICODE;
219 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_OEM;
220 gensec_ntlmssp_state->unicode = True;
222 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_UNICODE;
223 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_OEM;
224 gensec_ntlmssp_state->unicode = False;
227 if ((neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) && allow_lm && !gensec_ntlmssp_state->use_ntlmv2) {
228 /* other end forcing us to use LM */
229 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_LM_KEY;
230 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
232 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_LM_KEY;
235 if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN) {
236 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_ALWAYS_SIGN;
239 if (!(neg_flags & NTLMSSP_NEGOTIATE_SIGN)) {
240 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SIGN;
243 if (!(neg_flags & NTLMSSP_NEGOTIATE_SEAL)) {
244 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SEAL;
247 if (!(neg_flags & NTLMSSP_NEGOTIATE_NTLM2)) {
248 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
251 if (!(neg_flags & NTLMSSP_NEGOTIATE_128)) {
252 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_128;
253 if (neg_flags & NTLMSSP_NEGOTIATE_56) {
254 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_56;
258 if (!(neg_flags & NTLMSSP_NEGOTIATE_56)) {
259 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_56;
262 if (!(neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)) {
263 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_KEY_EXCH;
266 if ((neg_flags & NTLMSSP_REQUEST_TARGET)) {
267 gensec_ntlmssp_state->neg_flags |= NTLMSSP_REQUEST_TARGET;
273 Weaken NTLMSSP keys to cope with down-level clients and servers.
275 We probably should have some parameters to control this, but as
276 it only occours for LM_KEY connections, and this is controlled
277 by the client lanman auth/lanman auth parameters, it isn't too bad.
280 void ntlmssp_weaken_keys(struct gensec_ntlmssp_state *gensec_ntlmssp_state)
282 /* Key weakening not performed on the master key for NTLM2
283 and does not occour for NTLM1. Therefore we only need
284 to do this for the LM_KEY.
287 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) {
288 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_128) {
290 } else if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_56) {
291 gensec_ntlmssp_state->session_key.data[7] = 0xa0;
292 } else { /* forty bits */
293 gensec_ntlmssp_state->session_key.data[5] = 0xe5;
294 gensec_ntlmssp_state->session_key.data[6] = 0x38;
295 gensec_ntlmssp_state->session_key.data[7] = 0xb0;
297 gensec_ntlmssp_state->session_key.length = 8;
301 static BOOL gensec_ntlmssp_have_feature(struct gensec_security *gensec_security,
304 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
305 if (feature & GENSEC_FEATURE_SIGN) {
306 if (!gensec_ntlmssp_state->session_key.length) {
309 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SIGN) {
313 if (feature & GENSEC_FEATURE_SEAL) {
314 if (!gensec_ntlmssp_state->session_key.length) {
317 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SEAL) {
321 if (feature & GENSEC_FEATURE_SESSION_KEY) {
322 if (gensec_ntlmssp_state->session_key.length) {
326 if (feature & GENSEC_FEATURE_DCE_STYLE) {
329 if (feature & GENSEC_FEATURE_ASYNC_REPLIES) {
330 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_NTLM2) {
337 NTSTATUS gensec_ntlmssp_start(struct gensec_security *gensec_security)
339 struct gensec_ntlmssp_state *gensec_ntlmssp_state;
341 gensec_ntlmssp_state = talloc_zero(gensec_security, struct gensec_ntlmssp_state);
342 if (!gensec_ntlmssp_state) {
343 return NT_STATUS_NO_MEMORY;
346 gensec_ntlmssp_state->auth_context = NULL;
347 gensec_ntlmssp_state->server_info = NULL;
349 gensec_security->private_data = gensec_ntlmssp_state;
353 static const char *gensec_ntlmssp_oids[] = {
358 static const struct gensec_security_ops gensec_ntlmssp_security_ops = {
361 .auth_type = DCERPC_AUTH_TYPE_NTLMSSP,
362 .oid = gensec_ntlmssp_oids,
363 .client_start = gensec_ntlmssp_client_start,
364 .server_start = gensec_ntlmssp_server_start,
365 .magic = gensec_ntlmssp_magic,
366 .update = gensec_ntlmssp_update,
367 .sig_size = gensec_ntlmssp_sig_size,
368 .sign_packet = gensec_ntlmssp_sign_packet,
369 .check_packet = gensec_ntlmssp_check_packet,
370 .seal_packet = gensec_ntlmssp_seal_packet,
371 .unseal_packet = gensec_ntlmssp_unseal_packet,
372 .wrap = gensec_ntlmssp_wrap,
373 .unwrap = gensec_ntlmssp_unwrap,
374 .session_key = gensec_ntlmssp_session_key,
375 .session_info = gensec_ntlmssp_session_info,
376 .have_feature = gensec_ntlmssp_have_feature,
381 NTSTATUS gensec_ntlmssp_init(void)
384 ret = gensec_register(&gensec_ntlmssp_security_ops);
385 if (!NT_STATUS_IS_OK(ret)) {
386 DEBUG(0,("Failed to register '%s' gensec backend!\n",
387 gensec_ntlmssp_security_ops.name));