s3-auth: Provide helper routine to check password and return session_info
[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_generic.c  */
71
72 NTSTATUS make_auth4_context(TALLOC_CTX *mem_ctx, struct auth4_context **auth4_context_out);
73 NTSTATUS auth_generic_prepare(TALLOC_CTX *mem_ctx, const struct tsocket_address *remote_address,
74                               struct gensec_security **gensec_security_out);
75
76 NTSTATUS auth_check_password_session_info(struct auth4_context *auth_context,
77                                           TALLOC_CTX *mem_ctx,
78                                           struct auth_usersupplied_info *user_info,
79                                           struct auth_session_info **session_info);
80
81 /* The following definitions come from auth/auth_ntlmssp.c  */
82
83 NTSTATUS auth3_generate_session_info(struct auth4_context *auth_context,
84                                      TALLOC_CTX *mem_ctx,
85                                      void *server_returned_info,
86                                      const char *original_user_name,
87                                      uint32_t session_info_flags,
88                                      struct auth_session_info **session_info);
89
90 NTSTATUS auth3_get_challenge(struct auth4_context *auth4_context,
91                              uint8_t chal[8]);
92
93 bool auth3_may_set_challenge(struct auth4_context *auth4_context);
94 NTSTATUS auth3_set_challenge(struct auth4_context *auth4_context, const uint8_t *chal,
95                              const char *challenge_set_by);
96
97 NTSTATUS auth3_check_password(struct auth4_context *auth4_context,
98                               TALLOC_CTX *mem_ctx,
99                               const struct auth_usersupplied_info *user_info,
100                               void **server_returned_info,
101                               DATA_BLOB *session_key, DATA_BLOB *lm_session_key);
102
103 /* The following definitions come from auth/auth_sam.c  */
104
105 NTSTATUS check_sam_security(const DATA_BLOB *challenge,
106                             TALLOC_CTX *mem_ctx,
107                             const struct auth_usersupplied_info *user_info,
108                             struct auth_serversupplied_info **server_info);
109 NTSTATUS check_sam_security_info3(const DATA_BLOB *challenge,
110                                   TALLOC_CTX *mem_ctx,
111                                   const struct auth_usersupplied_info *user_info,
112                                   struct netr_SamInfo3 **pinfo3);
113 NTSTATUS auth_sam_init(void);
114
115 /* The following definitions come from auth/auth_server.c  */
116
117 NTSTATUS auth_server_init(void);
118
119 /* The following definitions come from auth/auth_unix.c  */
120
121 NTSTATUS auth_unix_init(void);
122
123 /* The following definitions come from auth/auth_util.c  */
124 struct tsocket_address;
125
126 NTSTATUS make_user_info_map(struct auth_usersupplied_info **user_info,
127                             const char *smb_name,
128                             const char *client_domain,
129                             const char *workstation_name,
130                             const struct tsocket_address *remote_address,
131                             const DATA_BLOB *lm_pwd,
132                             const DATA_BLOB *nt_pwd,
133                             const struct samr_Password *lm_interactive_pwd,
134                             const struct samr_Password *nt_interactive_pwd,
135                             const char *plaintext,
136                             enum auth_password_state password_state);
137 bool make_user_info_netlogon_network(struct auth_usersupplied_info **user_info,
138                                      const char *smb_name,
139                                      const char *client_domain,
140                                      const char *workstation_name,
141                                      const struct tsocket_address *remote_address,
142                                      uint32 logon_parameters,
143                                      const uchar *lm_network_pwd,
144                                      int lm_pwd_len,
145                                      const uchar *nt_network_pwd,
146                                      int nt_pwd_len);
147 bool make_user_info_netlogon_interactive(struct auth_usersupplied_info **user_info,
148                                          const char *smb_name,
149                                          const char *client_domain,
150                                          const char *workstation_name,
151                                          const struct tsocket_address *remote_address,
152                                          uint32 logon_parameters,
153                                          const uchar chal[8],
154                                          const uchar lm_interactive_pwd[16],
155                                          const uchar nt_interactive_pwd[16],
156                                          const uchar *dc_sess_key);
157 bool make_user_info_for_reply(struct auth_usersupplied_info **user_info,
158                               const char *smb_name,
159                               const char *client_domain,
160                               const struct tsocket_address *remote_address,
161                               const uint8 chal[8],
162                               DATA_BLOB plaintext_password);
163 NTSTATUS make_user_info_for_reply_enc(struct auth_usersupplied_info **user_info,
164                                       const char *smb_name,
165                                       const char *client_domain,
166                                       const struct tsocket_address *remote_address,
167                                       DATA_BLOB lm_resp, DATA_BLOB nt_resp);
168 bool make_user_info_guest(const struct tsocket_address *remote_address,
169                           struct auth_usersupplied_info **user_info);
170
171 struct samu;
172 NTSTATUS make_server_info_sam(struct auth_serversupplied_info **server_info,
173                               struct samu *sampass);
174 NTSTATUS create_local_token(TALLOC_CTX *mem_ctx,
175                             const struct auth_serversupplied_info *server_info,
176                             DATA_BLOB *session_key,
177                             const char *smb_name,
178                             struct auth_session_info **session_info_out);
179 NTSTATUS create_token_from_username(TALLOC_CTX *mem_ctx, const char *username,
180                                     bool is_guest,
181                                     uid_t *uid, gid_t *gid,
182                                     char **found_username,
183                                     struct security_token **token);
184 bool user_in_group_sid(const char *username, const struct dom_sid *group_sid);
185 bool user_in_group(const char *username, const char *groupname);
186 struct passwd;
187 NTSTATUS make_server_info_pw(struct auth_serversupplied_info **server_info,
188                              char *unix_username,
189                              struct passwd *pwd);
190 NTSTATUS make_session_info_from_username(TALLOC_CTX *mem_ctx,
191                                          const char *username,
192                                          bool is_guest,
193                                          struct auth_session_info **session_info);
194 struct auth_session_info *copy_session_info(TALLOC_CTX *mem_ctx,
195                                              const struct auth_session_info *src);
196 bool init_guest_info(void);
197 NTSTATUS init_system_info(void);
198 bool session_info_set_session_key(struct auth_session_info *info,
199                                  DATA_BLOB session_key);
200 NTSTATUS make_server_info_guest(TALLOC_CTX *mem_ctx,
201                                 struct auth_serversupplied_info **server_info);
202 NTSTATUS make_session_info_guest(TALLOC_CTX *mem_ctx,
203                                 struct auth_session_info **server_info);
204 NTSTATUS make_session_info_system(TALLOC_CTX *mem_ctx,
205                                  struct auth_session_info **session_info);
206 const struct auth_session_info *get_session_info_system(void);
207 bool copy_current_user(struct current_user *dst, struct current_user *src);
208 struct passwd *smb_getpwnam( TALLOC_CTX *mem_ctx, const char *domuser,
209                              char **p_save_username, bool create );
210 NTSTATUS make_server_info_info3(TALLOC_CTX *mem_ctx,
211                                 const char *sent_nt_username,
212                                 const char *domain,
213                                 struct auth_serversupplied_info **server_info,
214                                 struct netr_SamInfo3 *info3);
215 struct wbcAuthUserInfo;
216 NTSTATUS make_server_info_wbcAuthUserInfo(TALLOC_CTX *mem_ctx,
217                                           const char *sent_nt_username,
218                                           const char *domain,
219                                           const struct wbcAuthUserInfo *info,
220                                           struct auth_serversupplied_info **server_info);
221 void free_user_info(struct auth_usersupplied_info **user_info);
222 bool is_trusted_domain(const char* dom_name);
223
224 /* The following definitions come from auth/user_info.c  */
225
226 NTSTATUS make_user_info(struct auth_usersupplied_info **ret_user_info,
227                         const char *smb_name,
228                         const char *internal_username,
229                         const char *client_domain,
230                         const char *domain,
231                         const char *workstation_name,
232                         const struct tsocket_address *remote_address,
233                         const DATA_BLOB *lm_pwd,
234                         const DATA_BLOB *nt_pwd,
235                         const struct samr_Password *lm_interactive_pwd,
236                         const struct samr_Password *nt_interactive_pwd,
237                         const char *plaintext_password,
238                         enum auth_password_state password_state);
239 void free_user_info(struct auth_usersupplied_info **user_info);
240
241 NTSTATUS do_map_to_guest_server_info(NTSTATUS status,
242                                      struct auth_serversupplied_info **server_info,
243                                      const char *user, const char *domain);
244
245 /* The following definitions come from auth/auth_winbind.c  */
246
247 NTSTATUS auth_winbind_init(void);
248
249 /* The following definitions come from auth/server_info.c  */
250
251 struct netr_SamInfo2;
252 struct netr_SamInfo3;
253 struct netr_SamInfo6;
254
255 struct auth_serversupplied_info *make_server_info(TALLOC_CTX *mem_ctx);
256 NTSTATUS serverinfo_to_SamInfo2(struct auth_serversupplied_info *server_info,
257                                 uint8_t *pipe_session_key,
258                                 size_t pipe_session_key_len,
259                                 struct netr_SamInfo2 *sam2);
260 NTSTATUS serverinfo_to_SamInfo3(const struct auth_serversupplied_info *server_info,
261                                 uint8_t *pipe_session_key,
262                                 size_t pipe_session_key_len,
263                                 struct netr_SamInfo3 *sam3);
264 NTSTATUS serverinfo_to_SamInfo6(struct auth_serversupplied_info *server_info,
265                                 uint8_t *pipe_session_key,
266                                 size_t pipe_session_key_len,
267                                 struct netr_SamInfo6 *sam6);
268 NTSTATUS samu_to_SamInfo3(TALLOC_CTX *mem_ctx,
269                           struct samu *samu,
270                           const char *login_server,
271                           struct netr_SamInfo3 **_info3,
272                           struct extra_auth_info *extra);
273 struct netr_SamInfo3 *copy_netr_SamInfo3(TALLOC_CTX *mem_ctx,
274                                          struct netr_SamInfo3 *orig);
275 struct netr_SamInfo3 *wbcAuthUserInfo_to_netr_SamInfo3(TALLOC_CTX *mem_ctx,
276                                         const struct wbcAuthUserInfo *info);
277
278 /* The following definitions come from auth/auth_wbc.c  */
279
280 NTSTATUS auth_wbc_init(void);
281
282 /* The following definitions come from auth/pampass.c  */
283
284 bool smb_pam_claim_session(char *user, char *tty, char *rhost);
285 bool smb_pam_close_session(char *user, char *tty, char *rhost);
286 NTSTATUS smb_pam_accountcheck(const char *user, const char *rhost);
287 NTSTATUS smb_pam_passcheck(const char * user, const char * rhost,
288                            const char * password);
289 bool smb_pam_passchange(const char *user, const char *rhost,
290                         const char *oldpassword, const char *newpassword);
291 bool smb_pam_claim_session(char *user, char *tty, char *rhost);
292 bool smb_pam_close_session(char *in_user, char *tty, char *rhost);
293
294 /* The following definitions come from auth/pass_check.c  */
295
296 void dfs_unlogin(void);
297 NTSTATUS pass_check(const struct passwd *pass,
298                     const char *user,
299                     const char *rhost,
300                     const char *password,
301                     bool run_cracker);
302
303 /* The following definitions come from auth/token_util.c  */
304
305 bool nt_token_check_sid ( const struct dom_sid *sid, const struct security_token *token );
306 bool nt_token_check_domain_rid( struct security_token *token, uint32 rid );
307 struct security_token *get_root_nt_token( void );
308 NTSTATUS add_aliases(const struct dom_sid *domain_sid,
309                      struct security_token *token);
310 struct security_token *create_local_nt_token(TALLOC_CTX *mem_ctx,
311                                             const struct dom_sid *user_sid,
312                                             bool is_guest,
313                                             int num_groupsids,
314                                             const struct dom_sid *groupsids);
315 NTSTATUS create_local_nt_token_from_info3(TALLOC_CTX *mem_ctx,
316                                           bool is_guest,
317                                           const struct netr_SamInfo3 *info3,
318                                           const struct extra_auth_info *extra,
319                                           struct security_token **ntok);
320 void debug_unix_user_token(int dbg_class, int dbg_lev, uid_t uid, gid_t gid,
321                            int n_groups, gid_t *groups);
322
323 /* The following definitions come from auth/user_util.c  */
324
325 bool map_username(TALLOC_CTX *ctx, const char *user_in, char **p_user_out);
326 bool user_in_netgroup(TALLOC_CTX *ctx, const char *user, const char *ngname);
327 bool user_in_list(TALLOC_CTX *ctx, const char *user,const char **list);
328
329 /* The following definitions come from auth/user_krb5.c  */
330 struct PAC_LOGON_INFO;
331 NTSTATUS get_user_from_kerberos_info(TALLOC_CTX *mem_ctx,
332                                      const char *cli_name,
333                                      const char *princ_name,
334                                      struct PAC_LOGON_INFO *logon_info,
335                                      bool *is_mapped,
336                                      bool *mapped_to_guest,
337                                      char **ntuser,
338                                      char **ntdomain,
339                                      char **username,
340                                      struct passwd **_pw);
341 NTSTATUS make_session_info_krb5(TALLOC_CTX *mem_ctx,
342                                 char *ntuser,
343                                 char *ntdomain,
344                                 char *username,
345                                 struct passwd *pw,
346                                 struct PAC_LOGON_INFO *logon_info,
347                                 bool mapped_to_guest, bool username_was_mapped,
348                                 DATA_BLOB *session_key,
349                                 struct auth_session_info **session_info);
350
351
352 #endif /* _AUTH_PROTO_H_ */