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 /****************************************************************************
  48  Try to get a challenge out of the various authentication modules.
  49  Returns a const char of length 8 bytes.
  50 ****************************************************************************/
  51
  52 NTSTATUS auth_get_ntlm_challenge(struct auth_context *auth_context,
  53                                  uint8_t chal[8]);
  54
  55 /**
  56  * Check a user's Plaintext, LM or NTLM password.
  57  *
  58  * Check a user's password, as given in the user_info struct and return various
  59  * interesting details in the server_info struct.
  60  *
  61  * This function does NOT need to be in a become_root()/unbecome_root() pair
  62  * as it makes the calls itself when needed.
  63  *
  64  * The return value takes precedence over the contents of the server_info
  65  * struct.  When the return is other than NT_STATUS_OK the contents
  66  * of that structure is undefined.
  67  *
  68  * @param user_info Contains the user supplied components, including the passwords.
  69  *                  Must be created with make_user_info() or one of its wrappers.
  70  *
  71  * @param auth_context Supplies the challenges and some other data.
  72  *                  Must be created with make_auth_context(), and the challenges should be
  73  *                  filled in, either at creation or by calling the challenge geneation
  74  *                  function auth_get_challenge().
  75  *
  76  * @param server_info If successful, contains information about the authentication,
  77  *                    including a struct samu struct describing the user.
  78  *
  79  * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
  80  *
  81  **/
  82
  83 NTSTATUS auth_check_ntlm_password(const struct auth_context *auth_context,
  84                                   const struct auth_usersupplied_info *user_info,
  85                                   struct auth_serversupplied_info **server_info);
  86
  87 /* The following definitions come from auth/auth_builtin.c  */
  88
  89 NTSTATUS auth_builtin_init(void);
  90
  91 /* The following definitions come from auth/auth_domain.c  */
  92
  93 void attempt_machine_password_change(void);
  94 NTSTATUS auth_domain_init(void);
  95
  96 NTSTATUS auth_netlogond_init(void);
  97
  98 /* The following definitions come from auth/auth_generic.c  */
  99
 100 NTSTATUS make_auth4_context(TALLOC_CTX *mem_ctx, struct auth4_context **auth4_context_out);
 101 NTSTATUS auth_generic_prepare(TALLOC_CTX *mem_ctx, const struct tsocket_address *remote_address,
 102                               struct gensec_security **gensec_security_out);
 103
 104 NTSTATUS auth_check_password_session_info(struct auth4_context *auth_context,
 105                                           TALLOC_CTX *mem_ctx,
 106                                           struct auth_usersupplied_info *user_info,
 107                                           struct auth_session_info **session_info);
 108
 109 /* The following definitions come from auth/auth_ntlmssp.c  */
 110
 111 NTSTATUS auth3_generate_session_info(struct auth4_context *auth_context,
 112                                      TALLOC_CTX *mem_ctx,
 113                                      void *server_returned_info,
 114                                      const char *original_user_name,
 115                                      uint32_t session_info_flags,
 116                                      struct auth_session_info **session_info);
 117
 118 NTSTATUS auth3_get_challenge(struct auth4_context *auth4_context,
 119                              uint8_t chal[8]);
 120
 121 bool auth3_may_set_challenge(struct auth4_context *auth4_context);
 122 NTSTATUS auth3_set_challenge(struct auth4_context *auth4_context, const uint8_t *chal,
 123                              const char *challenge_set_by);
 124
 125 NTSTATUS auth3_check_password(struct auth4_context *auth4_context,
 126                               TALLOC_CTX *mem_ctx,
 127                               const struct auth_usersupplied_info *user_info,
 128                               void **server_returned_info,
 129                               DATA_BLOB *session_key, DATA_BLOB *lm_session_key);
 130
 131 /* The following definitions come from auth/auth_sam.c  */
 132
 133 NTSTATUS check_sam_security(const DATA_BLOB *challenge,
 134                             TALLOC_CTX *mem_ctx,
 135                             const struct auth_usersupplied_info *user_info,
 136                             struct auth_serversupplied_info **server_info);
 137 NTSTATUS check_sam_security_info3(const DATA_BLOB *challenge,
 138                                   TALLOC_CTX *mem_ctx,
 139                                   const struct auth_usersupplied_info *user_info,
 140                                   struct netr_SamInfo3 **pinfo3);
 141 NTSTATUS auth_sam_init(void);
 142
 143 /* The following definitions come from auth/auth_server.c  */
 144
 145 NTSTATUS auth_server_init(void);
 146
 147 /* The following definitions come from auth/auth_unix.c  */
 148
 149 NTSTATUS auth_unix_init(void);
 150
 151 /* The following definitions come from auth/auth_util.c  */
 152 struct tsocket_address;
 153
 154 NTSTATUS make_user_info_map(struct auth_usersupplied_info **user_info,
 155                             const char *smb_name,
 156                             const char *client_domain,
 157                             const char *workstation_name,
 158                             const struct tsocket_address *remote_address,
 159                             const DATA_BLOB *lm_pwd,
 160                             const DATA_BLOB *nt_pwd,
 161                             const struct samr_Password *lm_interactive_pwd,
 162                             const struct samr_Password *nt_interactive_pwd,
 163                             const char *plaintext,
 164                             enum auth_password_state password_state);
 165 bool make_user_info_netlogon_network(struct auth_usersupplied_info **user_info,
 166                                      const char *smb_name,
 167                                      const char *client_domain,
 168                                      const char *workstation_name,
 169                                      const struct tsocket_address *remote_address,
 170                                      uint32 logon_parameters,
 171                                      const uchar *lm_network_pwd,
 172                                      int lm_pwd_len,
 173                                      const uchar *nt_network_pwd,
 174                                      int nt_pwd_len);
 175 bool make_user_info_netlogon_interactive(struct auth_usersupplied_info **user_info,
 176                                          const char *smb_name,
 177                                          const char *client_domain,
 178                                          const char *workstation_name,
 179                                          const struct tsocket_address *remote_address,
 180                                          uint32 logon_parameters,
 181                                          const uchar chal[8],
 182                                          const uchar lm_interactive_pwd[16],
 183                                          const uchar nt_interactive_pwd[16],
 184                                          const uchar *dc_sess_key);
 185 bool make_user_info_for_reply(struct auth_usersupplied_info **user_info,
 186                               const char *smb_name,
 187                               const char *client_domain,
 188                               const struct tsocket_address *remote_address,
 189                               const uint8 chal[8],
 190                               DATA_BLOB plaintext_password);
 191 NTSTATUS make_user_info_for_reply_enc(struct auth_usersupplied_info **user_info,
 192                                       const char *smb_name,
 193                                       const char *client_domain,
 194                                       const struct tsocket_address *remote_address,
 195                                       DATA_BLOB lm_resp, DATA_BLOB nt_resp);
 196 bool make_user_info_guest(const struct tsocket_address *remote_address,
 197                           struct auth_usersupplied_info **user_info);
 198
 199 struct samu;
 200 NTSTATUS make_server_info_sam(struct auth_serversupplied_info **server_info,
 201                               struct samu *sampass);
 202 NTSTATUS create_local_token(TALLOC_CTX *mem_ctx,
 203                             const struct auth_serversupplied_info *server_info,
 204                             DATA_BLOB *session_key,
 205                             const char *smb_name,
 206                             struct auth_session_info **session_info_out);
 207 NTSTATUS create_token_from_username(TALLOC_CTX *mem_ctx, const char *username,
 208                                     bool is_guest,
 209                                     uid_t *uid, gid_t *gid,
 210                                     char **found_username,
 211                                     struct security_token **token);
 212 bool user_in_group_sid(const char *username, const struct dom_sid *group_sid);
 213 bool user_in_group(const char *username, const char *groupname);
 214 struct passwd;
 215 NTSTATUS make_server_info_pw(struct auth_serversupplied_info **server_info,
 216                              char *unix_username,
 217                              struct passwd *pwd);
 218 NTSTATUS make_session_info_from_username(TALLOC_CTX *mem_ctx,
 219                                          const char *username,
 220                                          bool is_guest,
 221                                          struct auth_session_info **session_info);
 222 struct auth_session_info *copy_session_info(TALLOC_CTX *mem_ctx,
 223                                              const struct auth_session_info *src);
 224 bool init_guest_info(void);
 225 NTSTATUS init_system_info(void);
 226 bool session_info_set_session_key(struct auth_session_info *info,
 227                                  DATA_BLOB session_key);
 228 NTSTATUS make_server_info_guest(TALLOC_CTX *mem_ctx,
 229                                 struct auth_serversupplied_info **server_info);
 230 NTSTATUS make_session_info_guest(TALLOC_CTX *mem_ctx,
 231                                 struct auth_session_info **server_info);
 232 NTSTATUS make_session_info_system(TALLOC_CTX *mem_ctx,
 233                                  struct auth_session_info **session_info);
 234 const struct auth_session_info *get_session_info_system(void);
 235 struct passwd *smb_getpwnam( TALLOC_CTX *mem_ctx, const char *domuser,
 236                              char **p_save_username, bool create );
 237 NTSTATUS make_server_info_info3(TALLOC_CTX *mem_ctx,
 238                                 const char *sent_nt_username,
 239                                 const char *domain,
 240                                 struct auth_serversupplied_info **server_info,
 241                                 struct netr_SamInfo3 *info3);
 242 struct wbcAuthUserInfo;
 243 NTSTATUS make_server_info_wbcAuthUserInfo(TALLOC_CTX *mem_ctx,
 244                                           const char *sent_nt_username,
 245                                           const char *domain,
 246                                           const struct wbcAuthUserInfo *info,
 247                                           struct auth_serversupplied_info **server_info);
 248 void free_user_info(struct auth_usersupplied_info **user_info);
 249 bool is_trusted_domain(const char* dom_name);
 250 NTSTATUS session_extract_session_key(const struct auth_session_info *session_info, DATA_BLOB *session_key, enum session_key_use_intent intent);
 251
 252 /* The following definitions come from auth/user_info.c  */
 253
 254 NTSTATUS make_user_info(struct auth_usersupplied_info **ret_user_info,
 255                         const char *smb_name,
 256                         const char *internal_username,
 257                         const char *client_domain,
 258                         const char *domain,
 259                         const char *workstation_name,
 260                         const struct tsocket_address *remote_address,
 261                         const DATA_BLOB *lm_pwd,
 262                         const DATA_BLOB *nt_pwd,
 263                         const struct samr_Password *lm_interactive_pwd,
 264                         const struct samr_Password *nt_interactive_pwd,
 265                         const char *plaintext_password,
 266                         enum auth_password_state password_state);
 267 void free_user_info(struct auth_usersupplied_info **user_info);
 268
 269 NTSTATUS do_map_to_guest_server_info(NTSTATUS status,
 270                                      struct auth_serversupplied_info **server_info,
 271                                      const char *user, const char *domain);
 272
 273 /* The following definitions come from auth/auth_winbind.c  */
 274
 275 NTSTATUS auth_winbind_init(void);
 276
 277 /* The following definitions come from auth/server_info.c  */
 278
 279 struct netr_SamInfo2;
 280 struct netr_SamInfo3;
 281 struct netr_SamInfo6;
 282
 283 struct auth_serversupplied_info *make_server_info(TALLOC_CTX *mem_ctx);
 284 NTSTATUS serverinfo_to_SamInfo2(struct auth_serversupplied_info *server_info,
 285                                 uint8_t *pipe_session_key,
 286                                 size_t pipe_session_key_len,
 287                                 struct netr_SamInfo2 *sam2);
 288 NTSTATUS serverinfo_to_SamInfo3(const struct auth_serversupplied_info *server_info,
 289                                 uint8_t *pipe_session_key,
 290                                 size_t pipe_session_key_len,
 291                                 struct netr_SamInfo3 *sam3);
 292 NTSTATUS serverinfo_to_SamInfo6(struct auth_serversupplied_info *server_info,
 293                                 uint8_t *pipe_session_key,
 294                                 size_t pipe_session_key_len,
 295                                 struct netr_SamInfo6 *sam6);
 296 NTSTATUS samu_to_SamInfo3(TALLOC_CTX *mem_ctx,
 297                           struct samu *samu,
 298                           const char *login_server,
 299                           struct netr_SamInfo3 **_info3,
 300                           struct extra_auth_info *extra);
 301 struct netr_SamInfo3 *copy_netr_SamInfo3(TALLOC_CTX *mem_ctx,
 302                                          struct netr_SamInfo3 *orig);
 303 struct netr_SamInfo3 *wbcAuthUserInfo_to_netr_SamInfo3(TALLOC_CTX *mem_ctx,
 304                                         const struct wbcAuthUserInfo *info);
 305
 306 /* The following definitions come from auth/auth_wbc.c  */
 307
 308 NTSTATUS auth_wbc_init(void);
 309
 310 /* The following definitions come from auth/pampass.c  */
 311
 312 bool smb_pam_claim_session(char *user, char *tty, char *rhost);
 313 bool smb_pam_close_session(char *user, char *tty, char *rhost);
 314 NTSTATUS smb_pam_accountcheck(const char *user, const char *rhost);
 315 NTSTATUS smb_pam_passcheck(const char * user, const char * rhost,
 316                            const char * password);
 317 bool smb_pam_passchange(const char *user, const char *rhost,
 318                         const char *oldpassword, const char *newpassword);
 319 bool smb_pam_claim_session(char *user, char *tty, char *rhost);
 320 bool smb_pam_close_session(char *in_user, char *tty, char *rhost);
 321
 322 /* The following definitions come from auth/pass_check.c  */
 323
 324 void dfs_unlogin(void);
 325 NTSTATUS pass_check(const struct passwd *pass,
 326                     const char *user,
 327                     const char *rhost,
 328                     const char *password,
 329                     bool run_cracker);
 330
 331 /* The following definitions come from auth/token_util.c  */
 332
 333 bool nt_token_check_sid ( const struct dom_sid *sid, const struct security_token *token );
 334 bool nt_token_check_domain_rid( struct security_token *token, uint32 rid );
 335 struct security_token *get_root_nt_token( void );
 336 NTSTATUS add_aliases(const struct dom_sid *domain_sid,
 337                      struct security_token *token);
 338 struct security_token *create_local_nt_token(TALLOC_CTX *mem_ctx,
 339                                             const struct dom_sid *user_sid,
 340                                             bool is_guest,
 341                                             int num_groupsids,
 342                                             const struct dom_sid *groupsids);
 343 NTSTATUS create_local_nt_token_from_info3(TALLOC_CTX *mem_ctx,
 344                                           bool is_guest,
 345                                           const struct netr_SamInfo3 *info3,
 346                                           const struct extra_auth_info *extra,
 347                                           struct security_token **ntok);
 348 void debug_unix_user_token(int dbg_class, int dbg_lev, uid_t uid, gid_t gid,
 349                            int n_groups, gid_t *groups);
 350
 351 /* The following definitions come from auth/user_util.c  */
 352
 353 bool map_username(TALLOC_CTX *ctx, const char *user_in, char **p_user_out);
 354 bool user_in_netgroup(TALLOC_CTX *ctx, const char *user, const char *ngname);
 355 bool user_in_list(TALLOC_CTX *ctx, const char *user,const char **list);
 356
 357 /* The following definitions come from auth/user_krb5.c  */
 358 struct PAC_LOGON_INFO;
 359 NTSTATUS get_user_from_kerberos_info(TALLOC_CTX *mem_ctx,
 360                                      const char *cli_name,
 361                                      const char *princ_name,
 362                                      struct PAC_LOGON_INFO *logon_info,
 363                                      bool *is_mapped,
 364                                      bool *mapped_to_guest,
 365                                      char **ntuser,
 366                                      char **ntdomain,
 367                                      char **username,
 368                                      struct passwd **_pw);
 369 NTSTATUS make_session_info_krb5(TALLOC_CTX *mem_ctx,
 370                                 char *ntuser,
 371                                 char *ntdomain,
 372                                 char *username,
 373                                 struct passwd *pw,
 374                                 struct PAC_LOGON_INFO *logon_info,
 375                                 bool mapped_to_guest, bool username_was_mapped,
 376                                 DATA_BLOB *session_key,
 377                                 struct auth_session_info **session_info);
 378
 379
 380 #endif /* _AUTH_PROTO_H_ */