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