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"));
93 * Next state function for the wrapped NTLMSSP state machine
95 * @param gensec_security GENSEC state, initialised to NTLMSSP
96 * @param out_mem_ctx The TALLOC_CTX for *out to be allocated on
97 * @param in The request, as a DATA_BLOB
98 * @param out The reply, as an talloc()ed DATA_BLOB, on *out_mem_ctx
99 * @return Error, MORE_PROCESSING_REQUIRED if a reply is sent,
100 * or NT_STATUS_OK if the user is authenticated.
103 static NTSTATUS gensec_ntlmssp_update(struct gensec_security *gensec_security,
104 TALLOC_CTX *out_mem_ctx,
105 const DATA_BLOB input, DATA_BLOB *out)
107 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
110 uint32_t ntlmssp_command;
113 *out = data_blob(NULL, 0);
115 if (gensec_ntlmssp_state->expected_state == NTLMSSP_DONE) {
120 /* if the caller doesn't want to manage/own the memory,
121 we can put it on our context */
122 out_mem_ctx = gensec_ntlmssp_state;
126 switch (gensec_ntlmssp_state->role) {
128 ntlmssp_command = NTLMSSP_INITIAL;
131 /* 'datagram' mode - no neg packet */
132 ntlmssp_command = NTLMSSP_NEGOTIATE;
136 if (!msrpc_parse(gensec_ntlmssp_state,
140 DEBUG(1, ("Failed to parse NTLMSSP packet, could not extract NTLMSSP command\n"));
141 dump_data(2, input.data, input.length);
142 return NT_STATUS_INVALID_PARAMETER;
146 if (ntlmssp_command != gensec_ntlmssp_state->expected_state) {
147 DEBUG(1, ("got NTLMSSP command %u, expected %u\n", ntlmssp_command, gensec_ntlmssp_state->expected_state));
148 return NT_STATUS_INVALID_PARAMETER;
151 for (i=0; i < ARRAY_SIZE(ntlmssp_callbacks); i++) {
152 if (ntlmssp_callbacks[i].role == gensec_ntlmssp_state->role
153 && ntlmssp_callbacks[i].ntlmssp_command == ntlmssp_command) {
154 status = ntlmssp_callbacks[i].fn(gensec_security, out_mem_ctx, input, out);
159 if (i == ARRAY_SIZE(ntlmssp_callbacks)) {
161 DEBUG(1, ("failed to find NTLMSSP callback for NTLMSSP mode %u, command %u\n",
162 gensec_ntlmssp_state->role, ntlmssp_command));
164 return NT_STATUS_INVALID_PARAMETER;
167 if (!NT_STATUS_IS_OK(status)) {
168 /* error or more processing required */
172 gensec_ntlmssp_state->have_features = 0;
174 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SIGN) {
175 gensec_ntlmssp_state->have_features |= GENSEC_FEATURE_SIGN;
178 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_SEAL) {
179 gensec_ntlmssp_state->have_features |= GENSEC_FEATURE_SEAL;
182 if (gensec_ntlmssp_state->session_key.data) {
183 gensec_ntlmssp_state->have_features |= GENSEC_FEATURE_SESSION_KEY;
190 * Return the NTLMSSP master session key
192 * @param gensec_ntlmssp_state NTLMSSP State
195 NTSTATUS gensec_ntlmssp_session_key(struct gensec_security *gensec_security,
196 DATA_BLOB *session_key)
198 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
200 if (!gensec_ntlmssp_state->session_key.data) {
201 return NT_STATUS_NO_USER_SESSION_KEY;
203 *session_key = gensec_ntlmssp_state->session_key;
208 void ntlmssp_handle_neg_flags(struct gensec_ntlmssp_state *gensec_ntlmssp_state,
209 uint32_t neg_flags, BOOL allow_lm)
211 if (neg_flags & NTLMSSP_NEGOTIATE_UNICODE) {
212 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_UNICODE;
213 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_OEM;
214 gensec_ntlmssp_state->unicode = True;
216 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_UNICODE;
217 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_OEM;
218 gensec_ntlmssp_state->unicode = False;
221 if ((neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) && allow_lm && !gensec_ntlmssp_state->use_ntlmv2) {
222 /* other end forcing us to use LM */
223 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_LM_KEY;
224 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
226 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_LM_KEY;
229 if (neg_flags & NTLMSSP_NEGOTIATE_ALWAYS_SIGN) {
230 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_ALWAYS_SIGN;
233 if (!(neg_flags & NTLMSSP_NEGOTIATE_SIGN)) {
234 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SIGN;
237 if (!(neg_flags & NTLMSSP_NEGOTIATE_SEAL)) {
238 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_SEAL;
241 if (!(neg_flags & NTLMSSP_NEGOTIATE_NTLM2)) {
242 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_NTLM2;
245 if (!(neg_flags & NTLMSSP_NEGOTIATE_128)) {
246 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_128;
247 if (neg_flags & NTLMSSP_NEGOTIATE_56) {
248 gensec_ntlmssp_state->neg_flags |= NTLMSSP_NEGOTIATE_56;
252 if (!(neg_flags & NTLMSSP_NEGOTIATE_56)) {
253 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_56;
256 if (!(neg_flags & NTLMSSP_NEGOTIATE_KEY_EXCH)) {
257 gensec_ntlmssp_state->neg_flags &= ~NTLMSSP_NEGOTIATE_KEY_EXCH;
260 if ((neg_flags & NTLMSSP_REQUEST_TARGET)) {
261 gensec_ntlmssp_state->neg_flags |= NTLMSSP_REQUEST_TARGET;
267 Weaken NTLMSSP keys to cope with down-level clients and servers.
269 We probably should have some parameters to control this, but as
270 it only occours for LM_KEY connections, and this is controlled
271 by the client lanman auth/lanman auth parameters, it isn't too bad.
274 void ntlmssp_weaken_keys(struct gensec_ntlmssp_state *gensec_ntlmssp_state)
276 /* Key weakening not performed on the master key for NTLM2
277 and does not occour for NTLM1. Therefore we only need
278 to do this for the LM_KEY.
281 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_LM_KEY) {
282 if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_128) {
284 } else if (gensec_ntlmssp_state->neg_flags & NTLMSSP_NEGOTIATE_56) {
285 gensec_ntlmssp_state->session_key.data[7] = 0xa0;
286 } else { /* forty bits */
287 gensec_ntlmssp_state->session_key.data[5] = 0xe5;
288 gensec_ntlmssp_state->session_key.data[6] = 0x38;
289 gensec_ntlmssp_state->session_key.data[7] = 0xb0;
291 gensec_ntlmssp_state->session_key.length = 8;
295 static BOOL gensec_ntlmssp_have_feature(struct gensec_security *gensec_security,
298 struct gensec_ntlmssp_state *gensec_ntlmssp_state = gensec_security->private_data;
299 if (gensec_ntlmssp_state->have_features & feature) {
306 NTSTATUS gensec_ntlmssp_start(struct gensec_security *gensec_security)
308 struct gensec_ntlmssp_state *gensec_ntlmssp_state;
310 gensec_ntlmssp_state = talloc(gensec_security, struct gensec_ntlmssp_state);
311 if (!gensec_ntlmssp_state) {
312 return NT_STATUS_NO_MEMORY;
315 gensec_ntlmssp_state->auth_context = NULL;
316 gensec_ntlmssp_state->server_info = NULL;
317 gensec_ntlmssp_state->have_features = 0;
319 gensec_security->private_data = gensec_ntlmssp_state;
323 static const struct gensec_security_ops gensec_ntlmssp_security_ops = {
326 .auth_type = DCERPC_AUTH_TYPE_NTLMSSP,
327 .oid = GENSEC_OID_NTLMSSP,
328 .client_start = gensec_ntlmssp_client_start,
329 .server_start = gensec_ntlmssp_server_start,
330 .update = gensec_ntlmssp_update,
331 .sig_size = gensec_ntlmssp_sig_size,
332 .sign_packet = gensec_ntlmssp_sign_packet,
333 .check_packet = gensec_ntlmssp_check_packet,
334 .seal_packet = gensec_ntlmssp_seal_packet,
335 .unseal_packet = gensec_ntlmssp_unseal_packet,
336 .wrap = gensec_ntlmssp_wrap,
337 .unwrap = gensec_ntlmssp_unwrap,
338 .session_key = gensec_ntlmssp_session_key,
339 .session_info = gensec_ntlmssp_session_info,
340 .have_feature = gensec_ntlmssp_have_feature,
345 NTSTATUS gensec_ntlmssp_init(void)
348 ret = gensec_register(&gensec_ntlmssp_security_ops);
349 if (!NT_STATUS_IS_OK(ret)) {
350 DEBUG(0,("Failed to register '%s' gensec backend!\n",
351 gensec_ntlmssp_security_ops.name));