r6463: Move NTLM2 and NTLM (v1) specific variables into a union for DCE/RPC.
[samba.git] / source / auth / ntlmssp / ntlmssp.h
1 /* 
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
7    
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 2 of the License, or
11    (at your option) any later version.
12    
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.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include "librpc/gen_ndr/ndr_samr.h"
24
25 /* NTLMSSP mode */
26 enum ntlmssp_role
27 {
28         NTLMSSP_SERVER,
29         NTLMSSP_CLIENT
30 };
31
32 /* NTLMSSP message types */
33 enum ntlmssp_message_type
34 {
35         NTLMSSP_INITIAL = 0 /* samba internal state */,
36         NTLMSSP_NEGOTIATE = 1,
37         NTLMSSP_CHALLENGE = 2,
38         NTLMSSP_AUTH      = 3,
39         NTLMSSP_UNKNOWN   = 4,
40         NTLMSSP_DONE   = 5 /* samba final state */
41 };
42
43 /* NTLMSSP negotiation flags */
44 #define NTLMSSP_NEGOTIATE_UNICODE          0x00000001
45 #define NTLMSSP_NEGOTIATE_OEM              0x00000002
46 #define NTLMSSP_REQUEST_TARGET             0x00000004
47 #define NTLMSSP_NEGOTIATE_SIGN             0x00000010 /* Message integrity */
48 #define NTLMSSP_NEGOTIATE_SEAL             0x00000020 /* Message confidentiality */
49 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE   0x00000040
50 #define NTLMSSP_NEGOTIATE_LM_KEY           0x00000080
51 #define NTLMSSP_NEGOTIATE_NETWARE          0x00000100
52 #define NTLMSSP_NEGOTIATE_NTLM             0x00000200
53 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED  0x00001000
54 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED 0x00002000
55 #define NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL  0x00004000
56 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN      0x00008000
57 #define NTLMSSP_TARGET_TYPE_DOMAIN            0x10000
58 #define NTLMSSP_TARGET_TYPE_SERVER            0x20000
59 #define NTLMSSP_CHAL_INIT_RESPONSE         0x00010000
60
61 #define NTLMSSP_CHAL_ACCEPT_RESPONSE       0x00020000
62 #define NTLMSSP_CHAL_NON_NT_SESSION_KEY    0x00040000
63 #define NTLMSSP_NEGOTIATE_NTLM2            0x00080000
64 #define NTLMSSP_CHAL_TARGET_INFO           0x00800000
65 #define NTLMSSP_NEGOTIATE_128              0x20000000 /* 128-bit encryption */
66 #define NTLMSSP_NEGOTIATE_KEY_EXCH         0x40000000
67 #define NTLMSSP_NEGOTIATE_56               0x80000000
68
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
73
74 #define NTLMSSP_SIGN_VERSION 1
75
76 #define NTLMSSP_SIG_SIZE 16
77
78 struct ntlmssp_state 
79 {
80         enum ntlmssp_role role;
81         enum samr_Role server_role;
82         uint32_t expected_state;
83
84         BOOL unicode;
85         BOOL use_ntlmv2;
86         BOOL use_nt_response;  /* Set to 'False' to debug what happens when the NT response is omited */
87         BOOL allow_lm_key;     /* The LM_KEY code is not functional at this point, and it's not 
88                                   very secure anyway */
89
90         BOOL server_use_session_keys; /* Set to 'False' for authentication only, 
91                                          that will never return a session key */
92         BOOL server_multiple_authentications;  /* Set to 'True' to allow squid 2.5 
93                                                   style 'challenge caching' */
94
95         char *user;
96         char *domain;
97         const char *workstation;
98         char *server_domain;
99
100         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
101
102         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
103         DATA_BLOB lm_resp;
104         DATA_BLOB nt_resp;
105         DATA_BLOB session_key;
106         
107         uint32_t neg_flags; /* the current state of negotiation with the NTLMSSP partner */
108
109         /* internal variables used by KEY_EXCH (client-supplied user session key */
110         DATA_BLOB encrypted_session_key;
111         
112         void *auth_context;
113
114         /**
115          * Callback to get the 'challenge' used for NTLM authentication.  
116          *
117          * @param ntlmssp_state This structure
118          * @return 8 bytes of challenge data, determined by the server to be the challenge for NTLM authentication
119          *
120          */
121         const uint8_t *(*get_challenge)(const struct ntlmssp_state *ntlmssp_state);
122
123         /**
124          * Callback to find if the challenge used by NTLM authentication may be modified 
125          *
126          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
127          * current 'security=server' implementation..  
128          *
129          * @param ntlmssp_state This structure
130          * @return Can the challenge be set to arbitary values?
131          *
132          */
133         BOOL (*may_set_challenge)(const struct ntlmssp_state *ntlmssp_state);
134
135         /**
136          * Callback to set the 'challenge' used for NTLM authentication.  
137          *
138          * The callback may use the void *auth_context to store state information, but the same value is always available
139          * from the DATA_BLOB chal on this structure.
140          *
141          * @param ntlmssp_state This structure
142          * @param challange 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
143          *
144          */
145         NTSTATUS (*set_challenge)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *challenge);
146
147         /**
148          * Callback to check the user's password.  
149          *
150          * The callback must reads the feilds of this structure for the information it needs on the user 
151          * @param ntlmssp_state This structure
152          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
153          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
154          *
155          */
156         NTSTATUS (*check_password)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
157
158         const char *server_name;
159         const char *(*get_domain)(void);
160
161         BOOL doing_ntlm2; 
162
163         union {
164                 /* NTLM */
165                 struct {
166                         uint32_t seq_num;
167                         struct arcfour_state *arcfour_state;
168                 } ntlm;
169
170                 /* NTLM2 */
171                 struct {
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;
178
179                         /* internal variables used by NTLM2 */
180                         uint8_t session_nonce[16];
181                 } ntlm2;
182         };
183 };
184
185 struct gensec_ntlmssp_state {
186         struct auth_context *auth_context;
187         struct auth_serversupplied_info *server_info;
188         struct ntlmssp_state *ntlmssp_state;
189         uint32_t have_features;
190 };
191
192