2 Unix SMB/CIFS implementation.
3 SMB parameters and setup
4 Copyright (C) Andrew Tridgell 1992-1997
5 Copyright (C) Luke Kenneth Casson Leighton 1996-1997
6 Copyright (C) Paul Ashton 1997
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "librpc/gen_ndr/samr.h"
31 /* NTLMSSP message types */
32 enum ntlmssp_message_type
34 NTLMSSP_INITIAL = 0 /* samba internal state */,
35 NTLMSSP_NEGOTIATE = 1,
36 NTLMSSP_CHALLENGE = 2,
39 NTLMSSP_DONE = 5 /* samba final state */
42 /* NTLMSSP negotiation flags */
43 #define NTLMSSP_NEGOTIATE_UNICODE 0x00000001
44 #define NTLMSSP_NEGOTIATE_OEM 0x00000002
45 #define NTLMSSP_REQUEST_TARGET 0x00000004
46 #define NTLMSSP_NEGOTIATE_SIGN 0x00000010 /* Message integrity */
47 #define NTLMSSP_NEGOTIATE_SEAL 0x00000020 /* Message confidentiality */
48 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE 0x00000040
49 #define NTLMSSP_NEGOTIATE_LM_KEY 0x00000080
50 #define NTLMSSP_NEGOTIATE_NETWARE 0x00000100
51 #define NTLMSSP_NEGOTIATE_NTLM 0x00000200
52 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED 0x00001000
53 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED 0x00002000
54 #define NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL 0x00004000
55 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN 0x00008000
56 #define NTLMSSP_TARGET_TYPE_DOMAIN 0x10000
57 #define NTLMSSP_TARGET_TYPE_SERVER 0x20000
58 #define NTLMSSP_CHAL_INIT_RESPONSE 0x00010000
60 #define NTLMSSP_CHAL_ACCEPT_RESPONSE 0x00020000
61 #define NTLMSSP_CHAL_NON_NT_SESSION_KEY 0x00040000
62 #define NTLMSSP_NEGOTIATE_NTLM2 0x00080000
63 #define NTLMSSP_CHAL_TARGET_INFO 0x00800000
64 #define NTLMSSP_UNKNOWN_02000000 0x02000000
65 #define NTLMSSP_NEGOTIATE_128 0x20000000 /* 128-bit encryption */
66 #define NTLMSSP_NEGOTIATE_KEY_EXCH 0x40000000
67 #define NTLMSSP_NEGOTIATE_56 0x80000000
69 #define NTLMSSP_NAME_TYPE_SERVER 0x01
70 #define NTLMSSP_NAME_TYPE_DOMAIN 0x02
71 #define NTLMSSP_NAME_TYPE_SERVER_DNS 0x03
72 #define NTLMSSP_NAME_TYPE_DOMAIN_DNS 0x04
74 #define NTLMSSP_SIGN_VERSION 1
76 #define NTLMSSP_SIG_SIZE 16
78 struct gensec_ntlmssp_state
80 struct gensec_security *gensec_security;
82 enum ntlmssp_role role;
83 enum samr_Role server_role;
84 uint32_t expected_state;
88 bool use_nt_response; /* Set to 'False' to debug what happens when the NT response is omited */
89 bool allow_lm_key; /* The LM_KEY code is not functional at this point, and it's not
92 bool server_multiple_authentications; /* Set to 'True' to allow squid 2.5
93 style 'challenge caching' */
97 const char *workstation;
100 DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
102 DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
105 DATA_BLOB session_key;
107 uint32_t neg_flags; /* the current state of negotiation with the NTLMSSP partner */
109 /* internal variables used by KEY_EXCH (client-supplied user session key */
110 DATA_BLOB encrypted_session_key;
113 * Callback to get the 'challenge' used for NTLM authentication.
115 * @param ntlmssp_state This structure
116 * @return 8 bytes of challenge data, determined by the server to be the challenge for NTLM authentication
119 const uint8_t *(*get_challenge)(const struct gensec_ntlmssp_state *);
122 * Callback to find if the challenge used by NTLM authentication may be modified
124 * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
125 * current 'security=server' implementation..
127 * @param ntlmssp_state This structure
128 * @return Can the challenge be set to arbitary values?
131 bool (*may_set_challenge)(const struct gensec_ntlmssp_state *);
134 * Callback to set the 'challenge' used for NTLM authentication.
136 * The callback may use the void *auth_context to store state information, but the same value is always available
137 * from the DATA_BLOB chal on this structure.
139 * @param ntlmssp_state This structure
140 * @param challenge 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
143 NTSTATUS (*set_challenge)(struct gensec_ntlmssp_state *, DATA_BLOB *challenge);
146 * Callback to check the user's password.
148 * The callback must reads the feilds of this structure for the information it needs on the user
149 * @param ntlmssp_state This structure
150 * @param nt_session_key If an NT session key is returned by the authentication process, return it here
151 * @param lm_session_key If an LM session key is returned by the authentication process, return it here
154 NTSTATUS (*check_password)(struct gensec_ntlmssp_state *,
156 DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
158 const char *server_name;
159 const char *(*get_domain)(void);
167 struct arcfour_state *arcfour_state;
172 uint32_t send_seq_num;
173 uint32_t recv_seq_num;
174 DATA_BLOB send_sign_key;
175 DATA_BLOB recv_sign_key;
176 struct arcfour_state *send_seal_arcfour_state;
177 struct arcfour_state *recv_seal_arcfour_state;
179 /* internal variables used by NTLM2 */
180 uint8_t session_nonce[16];
184 struct auth_context *auth_context;
185 struct auth_serversupplied_info *server_info;
188 struct auth_session_info;
189 #include "auth/ntlmssp/proto.h"