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 #define AUTH_SESSION_INFO_DEFAULT_GROUPS     0x01 /* Add the user to the default world and network groups */
  49 #define AUTH_SESSION_INFO_AUTHENTICATED      0x02 /* Add the user to the 'authenticated users' group */
  50 #define AUTH_SESSION_INFO_SIMPLE_PRIVILEGES  0x04 /* Use a trivial map between users and privilages, rather than a DB */
  51 #define AUTH_SESSION_INFO_UNIX_TOKEN         0x08 /* The returned token must have the unix_token and unix_info elements provided */
  52
  53 struct auth_method_context;
  54 struct auth_check_password_request;
  55 struct auth4_context;
  56 struct auth_session_info;
  57 struct ldb_dn;
  58
  59 struct auth_operations {
  60         const char *name;
  61
  62         /* If you are using this interface, then you are probably
  63          * getting something wrong.  This interface is only for
  64          * security=server, and makes a number of compromises to allow
  65          * that.  It is not compatible with being a PDC.  */
  66
  67         NTSTATUS (*get_challenge)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx, uint8_t chal[8]);
  68
  69         /* Given the user supplied info, check if this backend want to handle the password checking */
  70
  71         NTSTATUS (*want_check)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx,
  72                                const struct auth_usersupplied_info *user_info);
  73
  74         /* Given the user supplied info, check a password */
  75
  76         NTSTATUS (*check_password)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx,
  77                                    const struct auth_usersupplied_info *user_info,
  78                                    struct auth_user_info_dc **interim_info);
  79
  80         /* Lookup a 'session info interim' return based only on the principal or DN */
  81         NTSTATUS (*get_user_info_dc_principal)(TALLOC_CTX *mem_ctx,
  82                                                        struct auth4_context *auth_context,
  83                                                        const char *principal,
  84                                                        struct ldb_dn *user_dn,
  85                                                        struct auth_user_info_dc **interim_info);
  86 };
  87
  88 struct auth_method_context {
  89         struct auth_method_context *prev, *next;
  90         struct auth4_context *auth_ctx;
  91         const struct auth_operations *ops;
  92         int depth;
  93         void *private_data;
  94 };
  95
  96 struct auth4_context {
  97         struct {
  98                 /* Who set this up in the first place? */
  99                 const char *set_by;
 100
 101                 bool may_be_modified;
 102
 103                 DATA_BLOB data;
 104         } challenge;
 105
 106         /* methods, in the order they should be called */
 107         struct auth_method_context *methods;
 108
 109         /* the event context to use for calls that can block */
 110         struct tevent_context *event_ctx;
 111
 112         /* the messaging context which can be used by backends */
 113         struct imessaging_context *msg_ctx;
 114
 115         /* loadparm context */
 116         struct loadparm_context *lp_ctx;
 117
 118         /* SAM database for this local machine - to fill in local groups, or to authenticate local NTLM users */
 119         struct ldb_context *sam_ctx;
 120
 121         NTSTATUS (*check_password)(struct auth4_context *auth_ctx,
 122                                    TALLOC_CTX *mem_ctx,
 123                                    const struct auth_usersupplied_info *user_info,
 124                                    struct auth_user_info_dc **user_info_dc);
 125
 126         NTSTATUS (*get_challenge)(struct auth4_context *auth_ctx, uint8_t chal[8]);
 127
 128         bool (*challenge_may_be_modified)(struct auth4_context *auth_ctx);
 129
 130         NTSTATUS (*set_challenge)(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
 131
 132         NTSTATUS (*get_user_info_dc_principal)(TALLOC_CTX *mem_ctx,
 133                                                        struct auth4_context *auth_ctx,
 134                                                        const char *principal,
 135                                                        struct ldb_dn *user_dn,
 136                                                        struct auth_user_info_dc **user_info_dc);
 137
 138         NTSTATUS (*generate_session_info)(TALLOC_CTX *mem_ctx,
 139                                           struct auth4_context *auth_context,
 140                                           struct auth_user_info_dc *user_info_dc,
 141                                           uint32_t session_info_flags,
 142                                           struct auth_session_info **session_info);
 143 };
 144
 145 /* this structure is used by backends to determine the size of some critical types */
 146 struct auth_critical_sizes {
 147         int interface_version;
 148         int sizeof_auth_operations;
 149         int sizeof_auth_methods;
 150         int sizeof_auth_context;
 151         int sizeof_auth_usersupplied_info;
 152         int sizeof_auth_user_info_dc;
 153 };
 154
 155  NTSTATUS encrypt_user_info(TALLOC_CTX *mem_ctx, struct auth4_context *auth_context,
 156                            enum auth_password_state to_state,
 157                            const struct auth_usersupplied_info *user_info_in,
 158                            const struct auth_usersupplied_info **user_info_encrypted);
 159
 160 struct wbc_context;
 161 #include "auth/session.h"
 162 #include "auth/unix_token_proto.h"
 163 #include "auth/system_session_proto.h"
 164 #include "libcli/security/security.h"
 165
 166 struct ldb_message;
 167 struct ldb_context;
 168 struct gensec_security;
 169 struct cli_credentials;
 170
 171 NTSTATUS auth_get_challenge(struct auth4_context *auth_ctx, uint8_t chal[8]);
 172 NTSTATUS authsam_account_ok(TALLOC_CTX *mem_ctx,
 173                             struct ldb_context *sam_ctx,
 174                             uint32_t logon_parameters,
 175                             struct ldb_dn *domain_dn,
 176                             struct ldb_message *msg,
 177                             const char *logon_workstation,
 178                             const char *name_for_logs,
 179                             bool allow_domain_trust,
 180                             bool password_change);
 181
 182 struct auth_session_info *system_session(struct loadparm_context *lp_ctx);
 183 NTSTATUS authsam_make_user_info_dc(TALLOC_CTX *mem_ctx, struct ldb_context *sam_ctx,
 184                                            const char *netbios_name,
 185                                            const char *domain_name,
 186                                            struct ldb_dn *domain_dn,
 187                                            struct ldb_message *msg,
 188                                            DATA_BLOB user_sess_key, DATA_BLOB lm_sess_key,
 189                                   struct auth_user_info_dc **_user_info_dc);
 190 NTSTATUS auth_system_session_info(TALLOC_CTX *parent_ctx,
 191                                            struct loadparm_context *lp_ctx,
 192                                            struct auth_session_info **_session_info) ;
 193
 194 NTSTATUS auth_context_create_methods(TALLOC_CTX *mem_ctx, const char **methods,
 195                                      struct tevent_context *ev,
 196                                      struct imessaging_context *msg,
 197                                      struct loadparm_context *lp_ctx,
 198                                      struct ldb_context *sam_ctx,
 199                                      struct auth4_context **auth_ctx);
 200 const char **auth_methods_from_lp(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx);
 201
 202 NTSTATUS auth_context_create(TALLOC_CTX *mem_ctx,
 203                              struct tevent_context *ev,
 204                              struct imessaging_context *msg,
 205                              struct loadparm_context *lp_ctx,
 206                              struct auth4_context **auth_ctx);
 207 NTSTATUS auth_context_create_from_ldb(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, struct auth4_context **auth_ctx);
 208
 209 NTSTATUS auth_check_password(struct auth4_context *auth_ctx,
 210                              TALLOC_CTX *mem_ctx,
 211                              const struct auth_usersupplied_info *user_info,
 212                              struct auth_user_info_dc **user_info_dc);
 213 NTSTATUS auth4_init(void);
 214 NTSTATUS auth_register(const struct auth_operations *ops);
 215 NTSTATUS server_service_auth_init(void);
 216 NTSTATUS authenticate_username_pw(TALLOC_CTX *mem_ctx,
 217                                   struct tevent_context *ev,
 218                                   struct imessaging_context *msg,
 219                                   struct loadparm_context *lp_ctx,
 220                                   const char *nt4_domain,
 221                                   const char *nt4_username,
 222                                   const char *password,
 223                                   const uint32_t logon_parameters,
 224                                   struct auth_session_info **session_info);
 225
 226 struct tevent_req *auth_check_password_send(TALLOC_CTX *mem_ctx,
 227                                             struct tevent_context *ev,
 228                                             struct auth4_context *auth_ctx,
 229                                             const struct auth_usersupplied_info *user_info);
 230 NTSTATUS auth_check_password_recv(struct tevent_req *req,
 231                                   TALLOC_CTX *mem_ctx,
 232                                   struct auth_user_info_dc **user_info_dc);
 233
 234 bool auth_challenge_may_be_modified(struct auth4_context *auth_ctx);
 235 NTSTATUS auth_context_set_challenge(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
 236
 237 NTSTATUS auth_get_user_info_dc_principal(TALLOC_CTX *mem_ctx,
 238                                         struct auth4_context *auth_ctx,
 239                                         const char *principal,
 240                                         struct ldb_dn *user_dn,
 241                                         struct auth_user_info_dc **user_info_dc);
 242
 243 NTSTATUS samba_server_gensec_start(TALLOC_CTX *mem_ctx,
 244                                    struct tevent_context *event_ctx,
 245                                    struct imessaging_context *msg_ctx,
 246                                    struct loadparm_context *lp_ctx,
 247                                    struct cli_credentials *server_credentials,
 248                                    const char *target_service,
 249                                    struct gensec_security **gensec_context);
 250
 251 #endif /* _SMBAUTH_H_ */