source4/auth/auth.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Standardised Authentication types
   4    Copyright (C) Andrew Bartlett   2001
   5    Copyright (C) Stefan Metzmacher 2005
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef _SAMBA_AUTH_H
  22 #define _SAMBA_AUTH_H
  23
  24 #include "librpc/gen_ndr/ndr_krb5pac.h"
  25 #include "librpc/gen_ndr/auth.h"
  26 #include "../auth/common_auth.h"
  27
  28 extern const char *krbtgt_attrs[];
  29 extern const char *server_attrs[];
  30 extern const char *user_attrs[];
  31
  32 union netr_Validation;
  33 struct netr_SamBaseInfo;
  34 struct netr_SamInfo3;
  35 struct loadparm_context;
  36
  37 /* modules can use the following to determine if the interface has changed
  38  * please increment the version number after each interface change
  39  * with a comment and maybe update struct auth_critical_sizes.
  40  */
  41 /* version 1 - version from samba 3.0 - metze */
  42 /* version 2 - initial samba4 version - metze */
  43 /* version 3 - subsequent samba4 version - abartlet */
  44 /* version 4 - subsequent samba4 version - metze */
  45 /* version 0 - till samba4 is stable - metze */
  46 #define AUTH4_INTERFACE_VERSION 0
  47
  48 struct auth_method_context;
  49 struct auth_check_password_request;
  50 struct auth4_context;
  51 struct auth_session_info;
  52 struct ldb_dn;
  53 struct smb_krb5_context;
  54
  55 struct auth_operations {
  56         const char *name;
  57
  58         /* Given the user supplied info, check if this backend want to handle the password checking */
  59
  60         NTSTATUS (*want_check)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx,
  61                                const struct auth_usersupplied_info *user_info);
  62
  63         /* Given the user supplied info, check a password */
  64
  65         NTSTATUS (*check_password)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx,
  66                                    const struct auth_usersupplied_info *user_info,
  67                                    struct auth_user_info_dc **interim_info);
  68
  69         /* Lookup a 'session info interim' return based only on the principal or DN */
  70         NTSTATUS (*get_user_info_dc_principal)(TALLOC_CTX *mem_ctx,
  71                                                        struct auth4_context *auth_context,
  72                                                        const char *principal,
  73                                                        struct ldb_dn *user_dn,
  74                                                        struct auth_user_info_dc **interim_info);
  75 };
  76
  77 struct auth_method_context {
  78         struct auth_method_context *prev, *next;
  79         struct auth4_context *auth_ctx;
  80         const struct auth_operations *ops;
  81         int depth;
  82         void *private_data;
  83 };
  84
  85 /* this structure is used by backends to determine the size of some critical types */
  86 struct auth_critical_sizes {
  87         int interface_version;
  88         int sizeof_auth_operations;
  89         int sizeof_auth_methods;
  90         int sizeof_auth_context;
  91         int sizeof_auth_usersupplied_info;
  92         int sizeof_auth_user_info_dc;
  93 };
  94
  95  NTSTATUS encrypt_user_info(TALLOC_CTX *mem_ctx, struct auth4_context *auth_context,
  96                            enum auth_password_state to_state,
  97                            const struct auth_usersupplied_info *user_info_in,
  98                            const struct auth_usersupplied_info **user_info_encrypted);
  99
 100 #include "auth/session.h"
 101 #include "auth/unix_token_proto.h"
 102 #include "auth/system_session_proto.h"
 103 #include "libcli/security/security.h"
 104
 105 struct ldb_message;
 106 struct ldb_context;
 107 struct gensec_security;
 108 struct cli_credentials;
 109
 110 NTSTATUS auth_get_challenge(struct auth4_context *auth_ctx, uint8_t chal[8]);
 111 NTSTATUS authsam_account_ok(TALLOC_CTX *mem_ctx,
 112                             struct ldb_context *sam_ctx,
 113                             uint32_t logon_parameters,
 114                             struct ldb_dn *domain_dn,
 115                             struct ldb_message *msg,
 116                             const char *logon_workstation,
 117                             const char *name_for_logs,
 118                             bool allow_domain_trust,
 119                             bool password_change);
 120
 121 struct auth_session_info *system_session(struct loadparm_context *lp_ctx);
 122 NTSTATUS authsam_make_user_info_dc(TALLOC_CTX *mem_ctx, struct ldb_context *sam_ctx,
 123                                            const char *netbios_name,
 124                                            const char *domain_name,
 125                                            struct ldb_dn *domain_dn,
 126                                            struct ldb_message *msg,
 127                                            DATA_BLOB user_sess_key, DATA_BLOB lm_sess_key,
 128                                   struct auth_user_info_dc **_user_info_dc);
 129 NTSTATUS auth_system_session_info(TALLOC_CTX *parent_ctx,
 130                                            struct loadparm_context *lp_ctx,
 131                                            struct auth_session_info **_session_info) ;
 132
 133 NTSTATUS auth_context_create_methods(TALLOC_CTX *mem_ctx, const char **methods,
 134                                      struct tevent_context *ev,
 135                                      struct imessaging_context *msg,
 136                                      struct loadparm_context *lp_ctx,
 137                                      struct ldb_context *sam_ctx,
 138                                      struct auth4_context **auth_ctx);
 139 const char **auth_methods_from_lp(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx);
 140
 141 NTSTATUS auth_context_create(TALLOC_CTX *mem_ctx,
 142                              struct tevent_context *ev,
 143                              struct imessaging_context *msg,
 144                              struct loadparm_context *lp_ctx,
 145                              struct auth4_context **auth_ctx);
 146
 147 NTSTATUS auth_check_password_wrapper(struct auth4_context *auth_ctx,
 148                              TALLOC_CTX *mem_ctx,
 149                              const struct auth_usersupplied_info *user_info,
 150                              void **server_returned_info,
 151                              DATA_BLOB *user_session_key, DATA_BLOB *lm_session_key);
 152
 153 NTSTATUS auth_check_password(struct auth4_context *auth_ctx,
 154                              TALLOC_CTX *mem_ctx,
 155                              const struct auth_usersupplied_info *user_info,
 156                              struct auth_user_info_dc **user_info_dc);
 157 NTSTATUS auth4_init(void);
 158 NTSTATUS auth_register(const struct auth_operations *ops);
 159 NTSTATUS server_service_auth_init(void);
 160 NTSTATUS authenticate_username_pw(TALLOC_CTX *mem_ctx,
 161                                   struct tevent_context *ev,
 162                                   struct imessaging_context *msg,
 163                                   struct loadparm_context *lp_ctx,
 164                                   const char *nt4_domain,
 165                                   const char *nt4_username,
 166                                   const char *password,
 167                                   const uint32_t logon_parameters,
 168                                   struct auth_session_info **session_info);
 169
 170 struct tevent_req *auth_check_password_send(TALLOC_CTX *mem_ctx,
 171                                             struct tevent_context *ev,
 172                                             struct auth4_context *auth_ctx,
 173                                             const struct auth_usersupplied_info *user_info);
 174 NTSTATUS auth_check_password_recv(struct tevent_req *req,
 175                                   TALLOC_CTX *mem_ctx,
 176                                   struct auth_user_info_dc **user_info_dc);
 177
 178 bool auth_challenge_may_be_modified(struct auth4_context *auth_ctx);
 179 NTSTATUS auth_context_set_challenge(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
 180
 181 NTSTATUS auth_get_user_info_dc_principal(TALLOC_CTX *mem_ctx,
 182                                         struct auth4_context *auth_ctx,
 183                                         const char *principal,
 184                                         struct ldb_dn *user_dn,
 185                                         struct auth_user_info_dc **user_info_dc);
 186
 187 NTSTATUS samba_server_gensec_start(TALLOC_CTX *mem_ctx,
 188                                    struct tevent_context *event_ctx,
 189                                    struct imessaging_context *msg_ctx,
 190                                    struct loadparm_context *lp_ctx,
 191                                    struct cli_credentials *server_credentials,
 192                                    const char *target_service,
 193                                    struct gensec_security **gensec_context);
 194
 195 #endif /* _SMBAUTH_H_ */