python/samba: adapt ms_forest_updates_markdown.py to the latest Forest-Wide-Updates.md
[Samba.git] / source4 / auth / auth.h
blobc03eba4ca672ef318694e4e6147012cfe1795605
1 /*
2 Unix SMB/CIFS implementation.
3 Standardised Authentication types
4 Copyright (C) Andrew Bartlett 2001
5 Copyright (C) Stefan Metzmacher 2005
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef _SAMBA_AUTH_H
22 #define _SAMBA_AUTH_H
24 #include "librpc/gen_ndr/ndr_krb5pac.h"
25 #include "librpc/gen_ndr/auth.h"
26 #include "../auth/common_auth.h"
28 extern const char *krbtgt_attrs[];
29 extern const char *server_attrs[];
30 extern const char *user_attrs[];
32 union netr_Validation;
33 struct netr_SamBaseInfo;
34 struct netr_SamInfo3;
35 struct loadparm_context;
37 /* modules can use the following to determine if the interface has changed
38 * please increment the version number after each interface change
39 * with a comment and maybe update struct auth_critical_sizes.
41 /* version 1 - version from samba 3.0 - metze */
42 /* version 2 - initial samba4 version - metze */
43 /* version 3 - subsequent samba4 version - abartlet */
44 /* version 4 - subsequent samba4 version - metze */
45 /* version 0 - till samba4 is stable - metze */
46 #define AUTH4_INTERFACE_VERSION 0
48 struct auth_method_context;
49 struct auth4_context;
50 struct auth_session_info;
51 struct ldb_dn;
52 struct smb_krb5_context;
54 struct auth_operations {
55 const char *name;
57 /* Given the user supplied info, check if this backend want to handle the password checking */
59 NTSTATUS (*want_check)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx,
60 const struct auth_usersupplied_info *user_info);
62 /* Given the user supplied info, check a password */
64 struct tevent_req *(*check_password_send)(TALLOC_CTX *mem_ctx,
65 struct tevent_context *ev,
66 struct auth_method_context *ctx,
67 const struct auth_usersupplied_info *user_info);
68 NTSTATUS (*check_password_recv)(struct tevent_req *subreq,
69 TALLOC_CTX *mem_ctx,
70 struct auth_user_info_dc **interim_info,
71 bool *authoritative);
74 struct auth_method_context {
75 struct auth_method_context *prev, *next;
76 struct auth4_context *auth_ctx;
77 const struct auth_operations *ops;
78 int depth;
79 void *private_data;
82 /* this structure is used by backends to determine the size of some critical types */
83 struct auth_critical_sizes {
84 int interface_version;
85 int sizeof_auth_operations;
86 int sizeof_auth_methods;
87 int sizeof_auth_context;
88 int sizeof_auth_usersupplied_info;
89 int sizeof_auth_user_info_dc;
92 NTSTATUS encrypt_user_info(TALLOC_CTX *mem_ctx, struct auth4_context *auth_context,
93 enum auth_password_state to_state,
94 const struct auth_usersupplied_info *user_info_in,
95 const struct auth_usersupplied_info **user_info_encrypted);
97 #include "auth/session.h"
98 #include "auth/unix_token_proto.h"
99 #include "auth/system_session_proto.h"
100 #include "libcli/security/security.h"
102 struct ldb_message;
103 struct ldb_context;
104 struct gensec_security;
105 struct cli_credentials;
107 NTSTATUS auth_get_challenge(struct auth4_context *auth_ctx, uint8_t chal[8]);
108 NTSTATUS authsam_account_ok(TALLOC_CTX *mem_ctx,
109 struct ldb_context *sam_ctx,
110 uint32_t logon_parameters,
111 struct ldb_dn *domain_dn,
112 struct ldb_message *msg,
113 const char *logon_workstation,
114 const char *name_for_logs,
115 bool allow_domain_trust,
116 bool password_change);
118 struct auth_session_info *system_session(struct loadparm_context *lp_ctx);
119 NTSTATUS authsam_make_user_info_dc(TALLOC_CTX *mem_ctx, struct ldb_context *sam_ctx,
120 const char *netbios_name,
121 const char *domain_name,
122 const char *dns_domain_name,
123 struct ldb_dn *domain_dn,
124 const struct ldb_message *msg,
125 DATA_BLOB user_sess_key, DATA_BLOB lm_sess_key,
126 struct auth_user_info_dc **_user_info_dc);
127 NTSTATUS authsam_update_user_info_dc(TALLOC_CTX *mem_ctx,
128 struct ldb_context *sam_ctx,
129 struct auth_user_info_dc *user_info_dc);
130 NTSTATUS auth_system_session_info(TALLOC_CTX *parent_ctx,
131 struct loadparm_context *lp_ctx,
132 struct auth_session_info **_session_info) ;
134 NTSTATUS auth_context_create_methods(TALLOC_CTX *mem_ctx, const char * const *methods,
135 struct tevent_context *ev,
136 struct imessaging_context *msg,
137 struct loadparm_context *lp_ctx,
138 struct ldb_context *sam_ctx,
139 struct auth4_context **auth_ctx);
140 const char **auth_methods_from_lp(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx);
142 NTSTATUS auth_context_create(TALLOC_CTX *mem_ctx,
143 struct tevent_context *ev,
144 struct imessaging_context *msg,
145 struct loadparm_context *lp_ctx,
146 struct auth4_context **auth_ctx);
147 NTSTATUS auth_context_create_for_netlogon(TALLOC_CTX *mem_ctx,
148 struct tevent_context *ev,
149 struct imessaging_context *msg,
150 struct loadparm_context *lp_ctx,
151 struct auth4_context **auth_ctx);
153 NTSTATUS auth_check_password(struct auth4_context *auth_ctx,
154 TALLOC_CTX *mem_ctx,
155 const struct auth_usersupplied_info *user_info,
156 struct auth_user_info_dc **user_info_dc,
157 uint8_t *pauthoritative);
158 NTSTATUS auth4_init(void);
159 NTSTATUS auth_register(TALLOC_CTX *mem_ctx, const struct auth_operations *ops);
160 NTSTATUS server_service_auth_init(TALLOC_CTX *ctx);
161 struct tevent_req *authenticate_ldap_simple_bind_send(TALLOC_CTX *mem_ctx,
162 struct tevent_context *ev,
163 struct imessaging_context *msg,
164 struct loadparm_context *lp_ctx,
165 struct tsocket_address *remote_address,
166 struct tsocket_address *local_address,
167 bool using_tls,
168 const char *dn,
169 const char *password);
170 NTSTATUS authenticate_ldap_simple_bind_recv(struct tevent_req *req,
171 TALLOC_CTX *mem_ctx,
172 struct auth_session_info **session_info);
173 NTSTATUS authenticate_ldap_simple_bind(TALLOC_CTX *mem_ctx,
174 struct tevent_context *ev,
175 struct imessaging_context *msg,
176 struct loadparm_context *lp_ctx,
177 struct tsocket_address *remote_address,
178 struct tsocket_address *local_address,
179 bool using_tls,
180 const char *dn,
181 const char *password,
182 struct auth_session_info **session_info);
184 struct tevent_req *auth_check_password_send(TALLOC_CTX *mem_ctx,
185 struct tevent_context *ev,
186 struct auth4_context *auth_ctx,
187 const struct auth_usersupplied_info *user_info);
188 NTSTATUS auth_check_password_recv(struct tevent_req *req,
189 TALLOC_CTX *mem_ctx,
190 struct auth_user_info_dc **user_info_dc,
191 uint8_t *pauthoritative);
193 NTSTATUS auth_context_set_challenge(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
195 NTSTATUS samba_server_gensec_start(TALLOC_CTX *mem_ctx,
196 struct tevent_context *event_ctx,
197 struct imessaging_context *msg_ctx,
198 struct loadparm_context *lp_ctx,
199 struct cli_credentials *server_credentials,
200 const char *target_service,
201 struct gensec_security **gensec_context);
202 NTSTATUS samba_server_gensec_krb5_start(TALLOC_CTX *mem_ctx,
203 struct tevent_context *event_ctx,
204 struct imessaging_context *msg_ctx,
205 struct loadparm_context *lp_ctx,
206 struct cli_credentials *server_credentials,
207 const char *target_service,
208 struct gensec_security **gensec_context);
210 #endif /* _SMBAUTH_H_ */