auth/gensec: finally remove unused gensec_update_ev()
[vlendec/samba-autobuild/.git] / auth / gensec / gensec.h
1 /*
2    Unix SMB/CIFS implementation.
3
4    Generic Authentication Interface
5
6    Copyright (C) Andrew Tridgell 2003
7    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-2005
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 #ifndef __GENSEC_H__
24 #define __GENSEC_H__
25
26 #include "../lib/util/data_blob.h"
27 #include "libcli/util/ntstatus.h"
28
29 #define GENSEC_SASL_NAME_NTLMSSP "NTLM"
30
31 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
32 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
33 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
34 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
35 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
36
37 #define GENSEC_FINAL_AUTH_TYPE_KRB5 "krb5"
38 #define GENSEC_FINAL_AUTH_TYPE_NTLMSSP "NTLMSSP"
39
40 enum gensec_priority {
41         GENSEC_SPNEGO = 90,
42         GENSEC_GSSAPI = 80,
43         GENSEC_KRB5 = 70,
44         GENSEC_SCHANNEL = 60,
45         GENSEC_NTLMSSP = 50,
46         GENSEC_SASL = 20,
47         GENSEC_OTHER = 10,
48         GENSEC_EXTERNAL = 0
49 };
50
51 struct gensec_security;
52 struct gensec_target {
53         const char *principal;
54         const char *hostname;
55         const char *service;
56         const char *service_description;
57 };
58
59 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
60 #define GENSEC_FEATURE_SIGN             0x00000002
61 #define GENSEC_FEATURE_SEAL             0x00000004
62 #define GENSEC_FEATURE_DCE_STYLE        0x00000008
63 #define GENSEC_FEATURE_ASYNC_REPLIES    0x00000010
64 #define GENSEC_FEATURE_DATAGRAM_MODE    0x00000020
65 #define GENSEC_FEATURE_SIGN_PKT_HEADER  0x00000040
66 #define GENSEC_FEATURE_NEW_SPNEGO       0x00000080
67 #define GENSEC_FEATURE_UNIX_TOKEN       0x00000100
68 #define GENSEC_FEATURE_NTLM_CCACHE      0x00000200
69 #define GENSEC_FEATURE_LDAP_STYLE       0x00000400
70 #define GENSEC_FEATURE_NO_AUTHZ_LOG     0x00000800
71 #define GENSEC_FEATURE_SMB_TRANSPORT    0x00001000
72 #define GENSEC_FEATURE_LDAPS_TRANSPORT  0x00002000
73
74 #define GENSEC_EXPIRE_TIME_INFINITY (NTTIME)0x8000000000000000LL
75
76 /* GENSEC mode */
77 enum gensec_role
78 {
79         GENSEC_SERVER,
80         GENSEC_CLIENT
81 };
82
83 struct auth_session_info;
84 struct cli_credentials;
85 struct gensec_settings;
86 struct tevent_context;
87 struct tevent_req;
88 struct smb_krb5_context;
89 struct tsocket_address;
90
91 struct gensec_settings {
92         struct loadparm_context *lp_ctx;
93         const char *target_hostname;
94
95         /* this allows callers to specify a specific set of ops that
96          * should be used, rather than those loaded by the plugin
97          * mechanism */
98         const struct gensec_security_ops * const *backends;
99
100         /* To fill in our own name in the NTLMSSP server */
101         const char *server_dns_domain;
102         const char *server_dns_name;
103         const char *server_netbios_domain;
104         const char *server_netbios_name;
105 };
106
107 struct gensec_security_ops;
108 struct gensec_security_ops_wrapper;
109
110 /* Change to 1, loadable modules now take a TALLOC_CTX * init() parameter. */
111 #define GENSEC_INTERFACE_VERSION 1
112
113 /* this structure is used by backends to determine the size of some critical types */
114 struct gensec_critical_sizes;
115 const struct gensec_critical_sizes *gensec_interface_version(void);
116
117 /* Socket wrapper */
118
119 struct gensec_security;
120 struct auth4_context;
121 struct auth_user_info_dc;
122
123 struct loadparm_context;
124
125 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
126                                  struct gensec_security *parent,
127                                  struct gensec_security **gensec_security);
128 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
129                              struct gensec_security **gensec_security,
130                              struct gensec_settings *settings);
131 NTSTATUS gensec_start_mech_by_ops(struct gensec_security *gensec_security,
132                                   const struct gensec_security_ops *ops);
133 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
134                                                  const char **sasl_names);
135 void gensec_set_max_update_size(struct gensec_security *gensec_security,
136                                 uint32_t max_update_size);
137 size_t gensec_max_update_size(struct gensec_security *gensec_security);
138 NTSTATUS gensec_update(struct gensec_security *gensec_security,
139                        TALLOC_CTX *out_mem_ctx,
140                        const DATA_BLOB in, DATA_BLOB *out);
141 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
142                                       struct tevent_context *ev,
143                                       struct gensec_security *gensec_security,
144                                       const DATA_BLOB in);
145 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
146
147 #define GENSEC_UPDATE_IS_NTERROR(status) ( \
148         !NT_STATUS_IS_OK(status) && \
149         !NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED) \
150         )
151
152 /**
153  * @brief Ask for features for a following authentication
154  *
155  * Typically only one specific feature bit should be passed,
156  * but it also works to ask for more features.
157  *
158  * The features must be requested before starting the
159  * gensec_update*() loop.
160  *
161  * The current expection is GENSEC_FEATURE_SIGN_PKT_HEADER,
162  * it can also be requested once the gensec_update*() loop
163  * returned NT_STATUS_OK.
164  *
165  * The features should not be changed during the gensec_update*()
166  * loop.
167  *
168  * @param[in]  gensec_security The context to be used
169  *
170  * @param[in]  feature         The requested feature[s].
171  *
172  */
173 void gensec_want_feature(struct gensec_security *gensec_security,
174                          uint32_t feature);
175 /**
176  * @brief Ask for one feature after the finished authentication
177  *
178  * Because the return value is bool, the caller can only
179  * ask for one feature at a time.
180  *
181  * The features must be requested after the finished
182  * gensec_update*() loop.
183  *
184  * The current expection is GENSEC_FEATURE_SIGN_PKT_HEADER,
185  * it can also be requested before the gensec_update*() loop,
186  * as the return value only indicates if the backend supports
187  * dcerpc header signing, not if header signing will be used
188  * between client and server. It will be used only if the caller
189  * also used gensec_want_feature(GENSEC_FEATURE_SIGN_PKT_HEADER).
190  *
191  * @param[in]  gensec_security The context to be used.
192  *
193  * @param[in]  feature         The requested feature.
194  *
195  * @return                     true if the feature is supported, false if not.
196  */
197 bool gensec_have_feature(struct gensec_security *gensec_security,
198                          uint32_t feature);
199 NTTIME gensec_expire_time(struct gensec_security *gensec_security);
200 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
201 /**
202  * Set the target service (such as 'http' or 'host') on a GENSEC context - ensures it is talloc()ed
203  *
204  * This is used for Kerberos service principal name resolution.
205  */
206
207 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
208 const char *gensec_get_target_service(struct gensec_security *gensec_security);
209 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
210 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
211 /**
212  * Set the target service (such as 'samr') on an GENSEC context - ensures it is talloc()ed.
213  *
214  * This is not the Kerberos service principal, instead this is a
215  * constant value that can be logged as part of authentication and
216  * authorization logging
217  */
218 const char *gensec_get_target_service_description(struct gensec_security *gensec_security);
219 NTSTATUS gensec_set_target_service_description(struct gensec_security *gensec_security,
220                                                const char *service);
221 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
222                             TALLOC_CTX *mem_ctx,
223                             DATA_BLOB *session_key);
224 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
225                                   const char *mech_oid);
226 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
227 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
228 NTSTATUS gensec_init(void);
229 NTSTATUS gensec_register(TALLOC_CTX *ctx,
230                 const struct gensec_security_ops *ops);
231 const struct gensec_security_ops *gensec_security_by_oid(struct gensec_security *gensec_security,
232                                                          const char *oid_string);
233 const struct gensec_security_ops *gensec_security_by_sasl_name(struct gensec_security *gensec_security,
234                                                                const char *sasl_name);
235 const struct gensec_security_ops *gensec_security_by_auth_type(
236                                 struct gensec_security *gensec_security,
237                                 uint32_t auth_type);
238 const struct gensec_security_ops *gensec_security_by_name(struct gensec_security *gensec_security,
239                                                           const char *name);
240 const struct gensec_security_ops **gensec_security_mechs(struct gensec_security *gensec_security,
241                                                    TALLOC_CTX *mem_ctx);
242 const struct gensec_security_ops_wrapper *gensec_security_by_oid_list(
243                                         struct gensec_security *gensec_security,
244                                         TALLOC_CTX *mem_ctx,
245                                         const char * const *oid_strings,
246                                         const char *skip);
247 const char **gensec_security_oids(struct gensec_security *gensec_security,
248                                   TALLOC_CTX *mem_ctx,
249                                   const char *skip);
250 const char **gensec_security_oids_from_ops_wrapped(TALLOC_CTX *mem_ctx,
251                                 const struct gensec_security_ops_wrapper *wops);
252 size_t gensec_max_input_size(struct gensec_security *gensec_security);
253 size_t gensec_max_wrapped_size(struct gensec_security *gensec_security);
254 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
255                               uint8_t *data, size_t length,
256                               const uint8_t *whole_pdu, size_t pdu_length,
257                               const DATA_BLOB *sig);
258 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
259                              const uint8_t *data, size_t length,
260                              const uint8_t *whole_pdu, size_t pdu_length,
261                              const DATA_BLOB *sig);
262 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
263 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
264                             TALLOC_CTX *mem_ctx,
265                             uint8_t *data, size_t length,
266                             const uint8_t *whole_pdu, size_t pdu_length,
267                             DATA_BLOB *sig);
268 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
269                             TALLOC_CTX *mem_ctx,
270                             const uint8_t *data, size_t length,
271                             const uint8_t *whole_pdu, size_t pdu_length,
272                             DATA_BLOB *sig);
273 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
274                                        uint8_t auth_type, uint8_t auth_level);
275 const char *gensec_get_name_by_authtype(struct gensec_security *gensec_security, uint8_t authtype);
276 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
277                              struct gensec_settings *settings,
278                              struct auth4_context *auth_context,
279                              struct gensec_security **gensec_security);
280 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
281                              TALLOC_CTX *mem_ctx,
282                              struct auth_session_info **session_info);
283
284 NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
285                 const struct tsocket_address *local);
286 NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
287                 const struct tsocket_address *remote);
288 const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security);
289 const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security);
290
291 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
292                                         const char *name);
293
294 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
295                        TALLOC_CTX *mem_ctx,
296                        const DATA_BLOB *in,
297                        DATA_BLOB *out);
298 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
299                      TALLOC_CTX *mem_ctx,
300                      const DATA_BLOB *in,
301                      DATA_BLOB *out);
302
303 const struct gensec_security_ops * const *gensec_security_all(void);
304 bool gensec_security_ops_enabled(const struct gensec_security_ops *ops, struct gensec_security *security);
305 const struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
306                         const struct gensec_security_ops * const *old_gensec_list,
307                         struct cli_credentials *creds);
308
309 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
310                                         const char *sasl_name);
311
312 int gensec_setting_int(struct gensec_settings *settings, const char *mechanism, const char *name, int default_value);
313 bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
314
315 NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal);
316 const char *gensec_get_target_principal(struct gensec_security *gensec_security);
317
318 NTSTATUS gensec_generate_session_info_pac(TALLOC_CTX *mem_ctx,
319                                           struct gensec_security *gensec_security,
320                                           struct smb_krb5_context *smb_krb5_context,
321                                           DATA_BLOB *pac_blob,
322                                           const char *principal_string,
323                                           const struct tsocket_address *remote_address,
324                                           struct auth_session_info **session_info);
325
326 NTSTATUS gensec_magic_check_krb5_oid(struct gensec_security *unused,
327                                         const DATA_BLOB *blob);
328
329 #endif /* __GENSEC_H__ */