gensec: clarify memory ownership for gensec_session_info() and gensec_session_key()
[amitay/samba.git] / source3 / auth / proto.h
1 /*
2  *  Unix SMB/CIFS implementation.
3  *  Password and authentication handling
4  *
5  *  Copyright (C) Andrew Tridgell               1992-2001
6  *  Copyright (C) Luke Kenneth Casson Leighton  1996-2000
7  *  Copyright (C) Jeremy Allison                1997-2001
8  *  Copyright (C) John H Terpsta                1999-2001
9  *  Copyright (C) Tim Potter                    2000
10  *  Copyright (C) Andrew Bartlett               2001-2003
11  *  Copyright (C) Jelmer Vernooij               2002
12  *  Copyright (C) Rafal Szczesniak              2002
13  *  Copyright (C) Gerald Carter                 2003
14  *  Copyright (C) Volker Lendecke               2006,2010
15  *  Copyright (C) Michael Adam                  2007
16  *  Copyright (C) Dan Sledz                     2009
17  *  Copyright (C) Simo Sorce                    2010
18  *
19  *  This program is free software; you can redistribute it and/or modify
20  *  it under the terms of the GNU General Public License as published by
21  *  the Free Software Foundation; either version 3 of the License, or
22  *  (at your option) any later version.
23  *
24  *  This program is distributed in the hope that it will be useful,
25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27  *  GNU General Public License for more details.
28  *
29  *  You should have received a copy of the GNU General Public License
30  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
31  */
32
33 #ifndef _AUTH_PROTO_H_
34 #define _AUTH_PROTO_H_
35
36 /* The following definitions come from auth/auth.c  */
37
38 NTSTATUS smb_register_auth(int version, const char *name, auth_init_function init);
39 bool load_auth_module(struct auth_context *auth_context,
40                       const char *module, auth_methods **ret) ;
41 NTSTATUS make_auth_context_subsystem(TALLOC_CTX *mem_ctx,
42                                      struct auth_context **auth_context);
43 NTSTATUS make_auth_context_fixed(TALLOC_CTX *mem_ctx,
44                                  struct auth_context **auth_context,
45                                  uchar chal[8]) ;
46
47 /* The following definitions come from auth/auth_builtin.c  */
48
49 NTSTATUS auth_builtin_init(void);
50
51 /* The following definitions come from auth/auth_compat.c  */
52
53 NTSTATUS check_plaintext_password(const char *smb_name,
54                                   const struct tsocket_address *remote_address,
55                                   DATA_BLOB plaintext_password,
56                                   struct auth_serversupplied_info **server_info);
57 bool password_ok(struct auth_context *actx, bool global_encrypted,
58                  const char *session_workgroup,
59                  const char *smb_name,
60                  const struct tsocket_address *remote_address,
61                  DATA_BLOB password_blob);
62
63 /* The following definitions come from auth/auth_domain.c  */
64
65 void attempt_machine_password_change(void);
66 NTSTATUS auth_domain_init(void);
67
68 NTSTATUS auth_netlogond_init(void);
69
70 /* The following definitions come from auth/auth_ntlmssp.c  */
71
72 NTSTATUS auth_ntlmssp_steal_session_info(TALLOC_CTX *mem_ctx,
73                                 struct auth_ntlmssp_state *auth_ntlmssp_state,
74                                 struct auth_session_info **session_info);
75 NTSTATUS auth_ntlmssp_start(const struct tsocket_address *remote_address,
76                             struct auth_ntlmssp_state **auth_ntlmssp_state);
77
78
79 /* The following definitions come from auth/auth_sam.c  */
80
81 NTSTATUS check_sam_security(const DATA_BLOB *challenge,
82                             TALLOC_CTX *mem_ctx,
83                             const struct auth_usersupplied_info *user_info,
84                             struct auth_serversupplied_info **server_info);
85 NTSTATUS check_sam_security_info3(const DATA_BLOB *challenge,
86                                   TALLOC_CTX *mem_ctx,
87                                   const struct auth_usersupplied_info *user_info,
88                                   struct netr_SamInfo3 **pinfo3);
89 NTSTATUS auth_sam_init(void);
90
91 /* The following definitions come from auth/auth_server.c  */
92
93 NTSTATUS auth_server_init(void);
94
95 /* The following definitions come from auth/auth_unix.c  */
96
97 NTSTATUS auth_unix_init(void);
98
99 /* The following definitions come from auth/auth_util.c  */
100 struct tsocket_address;
101
102 NTSTATUS make_user_info_map(struct auth_usersupplied_info **user_info,
103                             const char *smb_name,
104                             const char *client_domain,
105                             const char *workstation_name,
106                             const struct tsocket_address *remote_address,
107                             DATA_BLOB *lm_pwd,
108                             DATA_BLOB *nt_pwd,
109                             const struct samr_Password *lm_interactive_pwd,
110                             const struct samr_Password *nt_interactive_pwd,
111                             const char *plaintext,
112                             enum auth_password_state password_state);
113 bool make_user_info_netlogon_network(struct auth_usersupplied_info **user_info,
114                                      const char *smb_name,
115                                      const char *client_domain,
116                                      const char *workstation_name,
117                                      const struct tsocket_address *remote_address,
118                                      uint32 logon_parameters,
119                                      const uchar *lm_network_pwd,
120                                      int lm_pwd_len,
121                                      const uchar *nt_network_pwd,
122                                      int nt_pwd_len);
123 bool make_user_info_netlogon_interactive(struct auth_usersupplied_info **user_info,
124                                          const char *smb_name,
125                                          const char *client_domain,
126                                          const char *workstation_name,
127                                          const struct tsocket_address *remote_address,
128                                          uint32 logon_parameters,
129                                          const uchar chal[8],
130                                          const uchar lm_interactive_pwd[16],
131                                          const uchar nt_interactive_pwd[16],
132                                          const uchar *dc_sess_key);
133 bool make_user_info_for_reply(struct auth_usersupplied_info **user_info,
134                               const char *smb_name,
135                               const char *client_domain,
136                               const struct tsocket_address *remote_address,
137                               const uint8 chal[8],
138                               DATA_BLOB plaintext_password);
139 NTSTATUS make_user_info_for_reply_enc(struct auth_usersupplied_info **user_info,
140                                       const char *smb_name,
141                                       const char *client_domain,
142                                       const struct tsocket_address *remote_address,
143                                       DATA_BLOB lm_resp, DATA_BLOB nt_resp);
144 bool make_user_info_guest(const struct tsocket_address *remote_address,
145                           struct auth_usersupplied_info **user_info);
146
147 struct samu;
148 NTSTATUS make_server_info_sam(struct auth_serversupplied_info **server_info,
149                               struct samu *sampass);
150 NTSTATUS create_local_token(TALLOC_CTX *mem_ctx,
151                             const struct auth_serversupplied_info *server_info,
152                             DATA_BLOB *session_key,
153                             struct auth_session_info **session_info_out);
154 NTSTATUS create_token_from_username(TALLOC_CTX *mem_ctx, const char *username,
155                                     bool is_guest,
156                                     uid_t *uid, gid_t *gid,
157                                     char **found_username,
158                                     struct security_token **token);
159 bool user_in_group_sid(const char *username, const struct dom_sid *group_sid);
160 bool user_in_group(const char *username, const char *groupname);
161 struct passwd;
162 NTSTATUS make_server_info_pw(struct auth_serversupplied_info **server_info,
163                              char *unix_username,
164                              struct passwd *pwd);
165 NTSTATUS make_session_info_from_username(TALLOC_CTX *mem_ctx,
166                                          const char *username,
167                                          bool is_guest,
168                                          struct auth_session_info **session_info);
169 struct auth_session_info *copy_session_info(TALLOC_CTX *mem_ctx,
170                                              const struct auth_session_info *src);
171 bool init_guest_info(void);
172 NTSTATUS init_system_info(void);
173 bool session_info_set_session_key(struct auth_session_info *info,
174                                  DATA_BLOB session_key);
175 NTSTATUS make_server_info_guest(TALLOC_CTX *mem_ctx,
176                                 struct auth_serversupplied_info **server_info);
177 NTSTATUS make_session_info_guest(TALLOC_CTX *mem_ctx,
178                                 struct auth_session_info **server_info);
179 NTSTATUS make_session_info_system(TALLOC_CTX *mem_ctx,
180                                  struct auth_session_info **session_info);
181 const struct auth_session_info *get_session_info_system(void);
182 bool copy_current_user(struct current_user *dst, struct current_user *src);
183 struct passwd *smb_getpwnam( TALLOC_CTX *mem_ctx, const char *domuser,
184                              char **p_save_username, bool create );
185 NTSTATUS make_server_info_info3(TALLOC_CTX *mem_ctx,
186                                 const char *sent_nt_username,
187                                 const char *domain,
188                                 struct auth_serversupplied_info **server_info,
189                                 struct netr_SamInfo3 *info3);
190 struct wbcAuthUserInfo;
191 NTSTATUS make_server_info_wbcAuthUserInfo(TALLOC_CTX *mem_ctx,
192                                           const char *sent_nt_username,
193                                           const char *domain,
194                                           const struct wbcAuthUserInfo *info,
195                                           struct auth_serversupplied_info **server_info);
196 void free_user_info(struct auth_usersupplied_info **user_info);
197 bool make_auth_methods(struct auth_context *auth_context, auth_methods **auth_method) ;
198 bool is_trusted_domain(const char* dom_name);
199
200 /* The following definitions come from auth/user_info.c  */
201
202 NTSTATUS make_user_info(struct auth_usersupplied_info **ret_user_info,
203                         const char *smb_name,
204                         const char *internal_username,
205                         const char *client_domain,
206                         const char *domain,
207                         const char *workstation_name,
208                         const struct tsocket_address *remote_address,
209                         const DATA_BLOB *lm_pwd,
210                         const DATA_BLOB *nt_pwd,
211                         const struct samr_Password *lm_interactive_pwd,
212                         const struct samr_Password *nt_interactive_pwd,
213                         const char *plaintext_password,
214                         enum auth_password_state password_state);
215 void free_user_info(struct auth_usersupplied_info **user_info);
216
217 /* The following definitions come from auth/auth_winbind.c  */
218
219 NTSTATUS auth_winbind_init(void);
220
221 /* The following definitions come from auth/server_info.c  */
222
223 struct netr_SamInfo2;
224 struct netr_SamInfo3;
225 struct netr_SamInfo6;
226
227 struct auth_serversupplied_info *make_server_info(TALLOC_CTX *mem_ctx);
228 NTSTATUS serverinfo_to_SamInfo2(struct auth_serversupplied_info *server_info,
229                                 uint8_t *pipe_session_key,
230                                 size_t pipe_session_key_len,
231                                 struct netr_SamInfo2 *sam2);
232 NTSTATUS serverinfo_to_SamInfo3(const struct auth_serversupplied_info *server_info,
233                                 uint8_t *pipe_session_key,
234                                 size_t pipe_session_key_len,
235                                 struct netr_SamInfo3 *sam3);
236 NTSTATUS serverinfo_to_SamInfo6(struct auth_serversupplied_info *server_info,
237                                 uint8_t *pipe_session_key,
238                                 size_t pipe_session_key_len,
239                                 struct netr_SamInfo6 *sam6);
240 NTSTATUS samu_to_SamInfo3(TALLOC_CTX *mem_ctx,
241                           struct samu *samu,
242                           const char *login_server,
243                           struct netr_SamInfo3 **_info3,
244                           struct extra_auth_info *extra);
245 struct netr_SamInfo3 *copy_netr_SamInfo3(TALLOC_CTX *mem_ctx,
246                                          struct netr_SamInfo3 *orig);
247 struct netr_SamInfo3 *wbcAuthUserInfo_to_netr_SamInfo3(TALLOC_CTX *mem_ctx,
248                                         const struct wbcAuthUserInfo *info);
249
250 /* The following definitions come from auth/auth_wbc.c  */
251
252 NTSTATUS auth_wbc_init(void);
253
254 /* The following definitions come from auth/pampass.c  */
255
256 bool smb_pam_claim_session(char *user, char *tty, char *rhost);
257 bool smb_pam_close_session(char *user, char *tty, char *rhost);
258 NTSTATUS smb_pam_accountcheck(const char *user, const char *rhost);
259 NTSTATUS smb_pam_passcheck(const char * user, const char * rhost,
260                            const char * password);
261 bool smb_pam_passchange(const char *user, const char *rhost,
262                         const char *oldpassword, const char *newpassword);
263 bool smb_pam_claim_session(char *user, char *tty, char *rhost);
264 bool smb_pam_close_session(char *in_user, char *tty, char *rhost);
265
266 /* The following definitions come from auth/pass_check.c  */
267
268 void dfs_unlogin(void);
269 NTSTATUS pass_check(const struct passwd *pass,
270                     const char *user,
271                     const char *rhost,
272                     const char *password,
273                     bool run_cracker);
274
275 /* The following definitions come from auth/token_util.c  */
276
277 bool nt_token_check_sid ( const struct dom_sid *sid, const struct security_token *token );
278 bool nt_token_check_domain_rid( struct security_token *token, uint32 rid );
279 struct security_token *get_root_nt_token( void );
280 NTSTATUS add_aliases(const struct dom_sid *domain_sid,
281                      struct security_token *token);
282 struct security_token *create_local_nt_token(TALLOC_CTX *mem_ctx,
283                                             const struct dom_sid *user_sid,
284                                             bool is_guest,
285                                             int num_groupsids,
286                                             const struct dom_sid *groupsids);
287 NTSTATUS create_local_nt_token_from_info3(TALLOC_CTX *mem_ctx,
288                                           bool is_guest,
289                                           const struct netr_SamInfo3 *info3,
290                                           const struct extra_auth_info *extra,
291                                           struct security_token **ntok);
292 void debug_unix_user_token(int dbg_class, int dbg_lev, uid_t uid, gid_t gid,
293                            int n_groups, gid_t *groups);
294
295 /* The following definitions come from auth/user_util.c  */
296
297 bool map_username(TALLOC_CTX *ctx, const char *user_in, char **p_user_out);
298 bool user_in_netgroup(TALLOC_CTX *ctx, const char *user, const char *ngname);
299 bool user_in_list(TALLOC_CTX *ctx, const char *user,const char **list);
300
301 /* The following definitions come from auth/user_krb5.c  */
302 struct PAC_LOGON_INFO;
303 NTSTATUS get_user_from_kerberos_info(TALLOC_CTX *mem_ctx,
304                                      const char *cli_name,
305                                      const char *princ_name,
306                                      struct PAC_LOGON_INFO *logon_info,
307                                      bool *is_mapped,
308                                      bool *mapped_to_guest,
309                                      char **ntuser,
310                                      char **ntdomain,
311                                      char **username,
312                                      struct passwd **_pw);
313 NTSTATUS make_session_info_krb5(TALLOC_CTX *mem_ctx,
314                                 char *ntuser,
315                                 char *ntdomain,
316                                 char *username,
317                                 struct passwd *pw,
318                                 struct PAC_LOGON_INFO *logon_info,
319                                 bool mapped_to_guest, bool username_was_mapped,
320                                 DATA_BLOB *session_key,
321                                 struct auth_session_info **session_info);
322
323 #endif /* _AUTH_PROTO_H_ */