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