82ed42a7594383814eae6b8efb93c5cec517127a
[samba.git] / 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    Copyright (C) Andrew Bartlett 2010
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 */
22
23 #include "../librpc/gen_ndr/ntlmssp.h"
24
25 struct auth_context;
26 struct auth_serversupplied_info;
27 struct tsocket_address;
28 struct auth_user_info_dc;
29 struct gensec_security;
30 struct ntlmssp_state;
31
32 /* NTLMSSP mode */
33 enum ntlmssp_role
34 {
35         NTLMSSP_SERVER,
36         NTLMSSP_CLIENT
37 };
38
39 /* NTLMSSP message types */
40 enum ntlmssp_message_type
41 {
42         NTLMSSP_INITIAL = 0 /* samba internal state */,
43         NTLMSSP_NEGOTIATE = 1,
44         NTLMSSP_CHALLENGE = 2,
45         NTLMSSP_AUTH      = 3,
46         NTLMSSP_UNKNOWN   = 4,
47         NTLMSSP_DONE      = 5 /* samba final state */
48 };
49
50 #define NTLMSSP_FEATURE_SESSION_KEY        0x00000001
51 #define NTLMSSP_FEATURE_SIGN               0x00000002
52 #define NTLMSSP_FEATURE_SEAL               0x00000004
53 #define NTLMSSP_FEATURE_CCACHE             0x00000008
54
55 union ntlmssp_crypt_state;
56
57 struct ntlmssp_state
58 {
59         enum ntlmssp_role role;
60         uint32_t expected_state;
61
62         bool unicode;
63         bool use_ntlmv2;
64         bool use_ccache;
65         bool use_nt_response;  /* Set to 'False' to debug what happens when the NT response is omited */
66         bool allow_lm_key;     /* The LM_KEY code is not very secure... */
67
68         const char *user;
69         const char *domain;
70         uint8_t *nt_hash;
71         uint8_t *lm_hash;
72
73         struct {
74                 const char *netbios_name;
75                 const char *netbios_domain;
76         } client;
77
78         struct {
79                 bool is_standalone;
80                 const char *netbios_name;
81                 const char *netbios_domain;
82                 const char *dns_name;
83                 const char *dns_domain;
84         } server;
85
86         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
87
88         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
89         DATA_BLOB lm_resp;
90         DATA_BLOB nt_resp;
91         DATA_BLOB session_key;
92
93         uint32_t neg_flags; /* the current state of negotiation with the NTLMSSP partner */
94
95         /**
96          * Private data for the callback functions
97          */
98         void *callback_private;
99
100         /**
101          * Callback to get the 'challenge' used for NTLM authentication.
102          *
103          * @param ntlmssp_state This structure
104          * @return 8 bytes of challenge data, determined by the server to be the challenge for NTLM authentication
105          *
106          */
107         NTSTATUS (*get_challenge)(const struct ntlmssp_state *ntlmssp_state,
108                                   uint8_t challenge[8]);
109
110         /**
111          * Callback to find if the challenge used by NTLM authentication may be modified
112          *
113          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
114          * current 'security=server' implementation..
115          *
116          * @param ntlmssp_state This structure
117          * @return Can the challenge be set to arbitary values?
118          *
119          */
120         bool (*may_set_challenge)(const struct ntlmssp_state *ntlmssp_state);
121
122         /**
123          * Callback to set the 'challenge' used for NTLM authentication.
124          *
125          * The callback may use the void *auth_context to store state information, but the same value is always available
126          * from the DATA_BLOB chal on this structure.
127          *
128          * @param ntlmssp_state This structure
129          * @param challenge 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
130          *
131          */
132         NTSTATUS (*set_challenge)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *challenge);
133
134         /**
135          * Callback to check the user's password.
136          *
137          * The callback must reads the feilds of this structure for the information it needs on the user
138          * @param ntlmssp_state This structure
139          * @param mem_ctx Talloc context for LM and NT session key to be returned on
140          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
141          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
142          *
143          */
144         NTSTATUS (*check_password)(struct ntlmssp_state *ntlmssp_state, TALLOC_CTX *mem_ctx,
145                                    DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
146
147         union ntlmssp_crypt_state *crypt;
148 };
149
150 /* The following definitions come from libcli/auth/ntlmssp_sign.c  */
151
152 NTSTATUS ntlmssp_sign_packet(struct ntlmssp_state *ntlmssp_state,
153                              TALLOC_CTX *sig_mem_ctx,
154                              const uint8_t *data, size_t length,
155                              const uint8_t *whole_pdu, size_t pdu_length,
156                              DATA_BLOB *sig);
157 NTSTATUS ntlmssp_check_packet(struct ntlmssp_state *ntlmssp_state,
158                               const uint8_t *data, size_t length,
159                               const uint8_t *whole_pdu, size_t pdu_length,
160                               const DATA_BLOB *sig) ;
161 NTSTATUS ntlmssp_seal_packet(struct ntlmssp_state *ntlmssp_state,
162                              TALLOC_CTX *sig_mem_ctx,
163                              uint8_t *data, size_t length,
164                              const uint8_t *whole_pdu, size_t pdu_length,
165                              DATA_BLOB *sig);
166 NTSTATUS ntlmssp_unseal_packet(struct ntlmssp_state *ntlmssp_state,
167                                uint8_t *data, size_t length,
168                                const uint8_t *whole_pdu, size_t pdu_length,
169                                const DATA_BLOB *sig);
170 NTSTATUS ntlmssp_wrap(struct ntlmssp_state *ntlmssp_state,
171                       TALLOC_CTX *out_mem_ctx,
172                       const DATA_BLOB *in,
173                       DATA_BLOB *out);
174 NTSTATUS ntlmssp_unwrap(struct ntlmssp_state *ntlmssp_stae,
175                         TALLOC_CTX *out_mem_ctx,
176                         const DATA_BLOB *in,
177                         DATA_BLOB *out);
178 NTSTATUS ntlmssp_sign_init(struct ntlmssp_state *ntlmssp_state);
179
180 bool ntlmssp_blob_matches_magic(const DATA_BLOB *blob);
181
182 /* The following definitions come from auth/ntlmssp/gensec_ntlmssp.c  */
183
184 NTSTATUS gensec_ntlmssp_init(void);
185
186 uint32_t gensec_ntlmssp_neg_flags(struct gensec_security *gensec_security);