s3:smbd: change blocking.c to use fsp_fnum_dbg() for fsp->fnum logging.
[Samba/gebeck_regimport.git] / source3 / include / auth.h
blob693a0df383cdced777504769c75a6178f0a4a97b
1 #ifndef _SMBAUTH_H_
2 #define _SMBAUTH_H_
3 /*
4 Unix SMB/CIFS implementation.
5 Standardised Authentication types
6 Copyright (C) Andrew Bartlett 2001
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 "../auth/common_auth.h"
24 struct gensec_security;
26 struct extra_auth_info {
27 struct dom_sid user_sid;
28 struct dom_sid pgid_sid;
31 struct auth_serversupplied_info {
32 bool guest;
33 bool system;
35 struct security_unix_token utok;
37 /* NT group information taken from the info3 structure */
39 struct security_token *security_token;
41 /* These are the intermediate session keys, as provided by a
42 * NETLOGON server and used by NTLMSSP to negotiate key
43 * exchange etc (which will provide the session_key in the
44 * auth_session_info). It is usually the same as the keys in
45 * the info3, but is a variable length structure here to allow
46 * it to be omitted if the auth module does not know it.
49 DATA_BLOB session_key;
50 DATA_BLOB lm_session_key;
52 struct netr_SamInfo3 *info3;
54 /* this structure is filled *only* in pathological cases where the user
55 * sid or the primary group sid are not sids of the domain. Normally
56 * this happens only for unix accounts that have unix domain sids.
57 * This is checked only when info3.rid and/or info3.primary_gid are set
58 * to the special invalid value of 0xFFFFFFFF */
59 struct extra_auth_info extra;
62 * This is a token from /etc/passwd and /etc/group
64 bool nss_token;
66 char *unix_name;
69 typedef NTSTATUS (*prepare_gensec_fn)(TALLOC_CTX *mem_ctx,
70 struct gensec_security **gensec_context);
72 typedef NTSTATUS (*make_auth4_context_fn)(TALLOC_CTX *mem_ctx,
73 struct auth4_context **auth4_context);
75 struct auth_context {
76 DATA_BLOB challenge;
78 /* Who set this up in the first place? */
79 const char *challenge_set_by;
81 bool challenge_may_be_modified;
83 struct auth_methods *challenge_set_method;
84 /* What order are the various methods in? Try to stop it changing under us */
85 struct auth_methods *auth_method_list;
87 prepare_gensec_fn prepare_gensec;
88 make_auth4_context_fn make_auth4_context;
91 typedef struct auth_methods
93 struct auth_methods *prev, *next;
94 const char *name; /* What name got this module */
96 NTSTATUS (*auth)(const struct auth_context *auth_context,
97 void *my_private_data,
98 TALLOC_CTX *mem_ctx,
99 const struct auth_usersupplied_info *user_info,
100 struct auth_serversupplied_info **server_info);
102 /* If you are using this interface, then you are probably
103 * getting something wrong. This interface is only for
104 * security=server, and makes a number of compromises to allow
105 * that. It is not compatible with being a PDC. */
106 DATA_BLOB (*get_chal)(const struct auth_context *auth_context,
107 void **my_private_data,
108 TALLOC_CTX *mem_ctx);
110 /* Optional methods allowing this module to provide a way to get a gensec context and an auth4_context */
111 prepare_gensec_fn prepare_gensec;
112 make_auth4_context_fn make_auth4_context;
113 /* Used to keep tabs on things like the cli for SMB server authentication */
114 void *private_data;
116 } auth_methods;
118 typedef NTSTATUS (*auth_init_function)(struct auth_context *, const char *, struct auth_methods **);
120 struct auth_init_function_entry {
121 const char *name;
122 /* Function to create a member of the authmethods list */
124 auth_init_function init;
126 struct auth_init_function_entry *prev, *next;
129 extern const struct gensec_security_ops gensec_ntlmssp3_server_ops;
131 /* Intent of use for session key. LSA and SAMR pipes use 16 bytes of session key when doing create/modify calls */
132 enum session_key_use_intent {
133 KEY_USE_FULL = 0,
134 KEY_USE_16BYTES
137 /* Changed from 1 -> 2 to add the logon_parameters field. */
138 /* Changed from 2 -> 3 when we reworked many auth structures to use IDL or be in common with Samba4 */
139 #define AUTH_INTERFACE_VERSION 3
141 #include "auth/proto.h"
143 #endif /* _SMBAUTH_H_ */