s3: Add NTLMSSP_FEATURE_CCACHE
[ira/wip.git] / source3 / include / 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 3 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, see <http://www.gnu.org/licenses/>.
20 */
21
22 /* NTLMSSP mode */
23 enum ntlmssp_role
24 {
25         NTLMSSP_SERVER,
26         NTLMSSP_CLIENT
27 };
28
29 /* NTLMSSP message types */
30 enum ntlmssp_message_type
31 {
32         NTLMSSP_INITIAL = 0 /* samba internal state */,
33         NTLMSSP_NEGOTIATE = 1,
34         NTLMSSP_CHALLENGE = 2,
35         NTLMSSP_AUTH      = 3,
36         NTLMSSP_UNKNOWN   = 4,
37         NTLMSSP_DONE      = 5 /* samba final state */
38 };
39
40 #define NTLMSSP_FEATURE_SESSION_KEY        0x00000001
41 #define NTLMSSP_FEATURE_SIGN               0x00000002
42 #define NTLMSSP_FEATURE_SEAL               0x00000004
43 #define NTLMSSP_FEATURE_CCACHE             0x00000008
44
45 struct ntlmssp_state
46 {
47         enum ntlmssp_role role;
48         enum server_types server_role;
49         uint32_t expected_state;
50
51         bool unicode;
52         bool use_ntlmv2;
53         bool use_ccache;
54         char *user;
55         char *domain;
56         char *workstation;
57         unsigned char *nt_hash;
58         unsigned char *lm_hash;
59         char *server_domain;
60
61         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
62
63         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
64         DATA_BLOB lm_resp;
65         DATA_BLOB nt_resp;
66         DATA_BLOB session_key;
67
68         uint32_t neg_flags; /* the current state of negotiation with the NTLMSSP partner */
69
70         void *auth_context;
71
72         /**
73          * Callback to get the 'challenge' used for NTLM authentication.
74          *
75          * @param ntlmssp_state This structure
76          * @return 8 bytes of challenge data, determined by the server to be the challenge for NTLM authentication
77          *
78          */
79         NTSTATUS (*get_challenge)(const struct ntlmssp_state *ntlmssp_state,
80                                   uint8_t challenge[8]);
81
82         /**
83          * Callback to find if the challenge used by NTLM authentication may be modified
84          *
85          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
86          * current 'security=server' implementation..
87          *
88          * @param ntlmssp_state This structure
89          * @return Can the challenge be set to arbitary values?
90          *
91          */
92         bool (*may_set_challenge)(const struct ntlmssp_state *ntlmssp_state);
93
94         /**
95          * Callback to set the 'challenge' used for NTLM authentication.
96          *
97          * The callback may use the void *auth_context to store state information, but the same value is always available
98          * from the DATA_BLOB chal on this structure.
99          *
100          * @param ntlmssp_state This structure
101          * @param challenge 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
102          *
103          */
104         NTSTATUS (*set_challenge)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *challenge);
105
106         /**
107          * Callback to check the user's password.
108          *
109          * The callback must reads the feilds of this structure for the information it needs on the user
110          * @param ntlmssp_state This structure
111          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
112          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
113          *
114          */
115         NTSTATUS (*check_password)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
116
117         const char *(*get_global_myname)(void);
118         const char *(*get_domain)(void);
119
120         /* ntlmv2 */
121
122         unsigned char send_sign_key[16];
123         unsigned char send_seal_key[16];
124         unsigned char recv_sign_key[16];
125         unsigned char recv_seal_key[16];
126
127         struct arcfour_state send_seal_arc4_state;
128         struct arcfour_state recv_seal_arc4_state;
129
130         uint32_t ntlm2_send_seq_num;
131         uint32_t ntlm2_recv_seq_num;
132
133         /* ntlmv1 */
134         struct arcfour_state ntlmv1_arc4_state;
135         uint32_t ntlmv1_seq_num;
136 };