auth/common_auth.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Standardised Authentication types
   4    Copyright (C) Andrew Bartlett 2001-2010
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef AUTH_COMMON_AUTH_H
  21 #define AUTH_COMMON_AUTH_H
  22
  23 #include "librpc/gen_ndr/auth.h"
  24
  25 #define USER_INFO_CASE_INSENSITIVE_USERNAME 0x01 /* username may be in any case */
  26 #define USER_INFO_CASE_INSENSITIVE_PASSWORD 0x02 /* password may be in any case */
  27 #define USER_INFO_DONT_CHECK_UNIX_ACCOUNT   0x04 /* don't check unix account status */
  28 #define USER_INFO_INTERACTIVE_LOGON         0x08 /* Interactive logon */
  29 /*unused #define USER_INFO_LOCAL_SAM_ONLY   0x10    Only authenticate against the local SAM, do not map missing passwords to NO_SUCH_USER */
  30 #define USER_INFO_INFO3_AND_NO_AUTHZ        0x20 /* Only fill in server_info->info3 and do not do any authorization steps */
  31
  32 enum auth_password_state {
  33         AUTH_PASSWORD_PLAIN = 1,
  34         AUTH_PASSWORD_HASH = 2,
  35         AUTH_PASSWORD_RESPONSE = 3
  36 };
  37
  38 #define AUTH_SESSION_INFO_DEFAULT_GROUPS     0x01 /* Add the user to the default world and network groups */
  39 #define AUTH_SESSION_INFO_AUTHENTICATED      0x02 /* Add the user to the 'authenticated users' group */
  40 #define AUTH_SESSION_INFO_SIMPLE_PRIVILEGES  0x04 /* Use a trivial map between users and privilages, rather than a DB */
  41 #define AUTH_SESSION_INFO_UNIX_TOKEN         0x08 /* The returned token must have the unix_token and unix_info elements provided */
  42 #define AUTH_SESSION_INFO_NTLM               0x10 /* The returned token must have authenticated-with-NTLM flag set */
  43
  44 struct auth_usersupplied_info
  45 {
  46         const char *workstation_name;
  47         const struct tsocket_address *remote_host;
  48         const struct tsocket_address *local_host;
  49
  50         uint32_t logon_parameters;
  51
  52         bool mapped_state;
  53         bool was_mapped;
  54         uint64_t logon_id;
  55         /* the values the client gives us */
  56         struct {
  57                 const char *account_name;
  58                 const char *domain_name;
  59         } client, mapped;
  60
  61         enum auth_password_state password_state;
  62
  63         struct {
  64                 struct {
  65                         DATA_BLOB lanman;
  66                         DATA_BLOB nt;
  67                 } response;
  68                 struct {
  69                         struct samr_Password *lanman;
  70                         struct samr_Password *nt;
  71                 } hash;
  72
  73                 char *plaintext;
  74         } password;
  75         uint32_t flags;
  76
  77         struct {
  78                 uint32_t negotiate_flags;
  79                 enum netr_SchannelType secure_channel_type;
  80                 const char *computer_name; /* [charset(UTF8)] */
  81                 const char *account_name; /* [charset(UTF8)] */
  82                 struct dom_sid *sid; /* [unique] */
  83         } netlogon_trust_account;
  84
  85         const char *service_description;
  86         const char *auth_description;
  87
  88         /*
  89          * for logging only, normally worked out from the password but
  90          * for krb5 logging only (krb5 normally doesn't use this) we
  91          * record the enc type here
  92          */
  93         const char *password_type;
  94 };
  95
  96 struct auth_method_context;
  97 struct tevent_context;
  98 struct imessaging_context;
  99 struct loadparm_context;
 100 struct ldb_context;
 101 struct smb_krb5_context;
 102
 103 struct auth4_context {
 104         struct {
 105                 /* Who set this up in the first place? */
 106                 const char *set_by;
 107
 108                 DATA_BLOB data;
 109         } challenge;
 110
 111         /* methods, in the order they should be called */
 112         struct auth_method_context *methods;
 113
 114         /* the event context to use for calls that can block */
 115         struct tevent_context *event_ctx;
 116
 117         /* the messaging context which can be used by backends */
 118         struct imessaging_context *msg_ctx;
 119
 120         /* loadparm context */
 121         struct loadparm_context *lp_ctx;
 122
 123         /* SAM database for this local machine - to fill in local groups, or to authenticate local NTLM users */
 124         struct ldb_context *sam_ctx;
 125
 126         /* The time this authentication started */
 127         struct timeval start_time;
 128
 129         /* Private data for the callbacks on this auth context */
 130         void *private_data;
 131
 132         struct tevent_req *(*check_ntlm_password_send)(TALLOC_CTX *mem_ctx,
 133                                         struct tevent_context *ev,
 134                                         struct auth4_context *auth_ctx,
 135                                         const struct auth_usersupplied_info *user_info);
 136         NTSTATUS (*check_ntlm_password_recv)(struct tevent_req *req,
 137                                         TALLOC_CTX *mem_ctx,
 138                                         uint8_t *pauthoritative,
 139                                         void **server_returned_info,
 140                                         DATA_BLOB *nt_session_key,
 141                                         DATA_BLOB *lm_session_key);
 142
 143         NTSTATUS (*get_ntlm_challenge)(struct auth4_context *auth_ctx, uint8_t chal[8]);
 144
 145         NTSTATUS (*set_ntlm_challenge)(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
 146
 147         NTSTATUS (*generate_session_info)(struct auth4_context *auth_context,
 148                                           TALLOC_CTX *mem_ctx,
 149                                           void *server_returned_info,
 150                                           const char *original_user_name,
 151                                           uint32_t session_info_flags,
 152                                           struct auth_session_info **session_info);
 153
 154         NTSTATUS (*generate_session_info_pac)(struct auth4_context *auth_ctx,
 155                                               TALLOC_CTX *mem_ctx,
 156                                               struct smb_krb5_context *smb_krb5_context,
 157                                               DATA_BLOB *pac_blob,
 158                                               const char *principal_name,
 159                                               const struct tsocket_address *remote_address,
 160                                               uint32_t session_info_flags,
 161                                               struct auth_session_info **session_info);
 162 };
 163
 164 #define AUTHZ_TRANSPORT_PROTECTION_NONE "NONE"
 165 #define AUTHZ_TRANSPORT_PROTECTION_SMB "SMB"
 166 #define AUTHZ_TRANSPORT_PROTECTION_TLS "TLS"
 167 #define AUTHZ_TRANSPORT_PROTECTION_SEAL "SEAL"
 168 #define AUTHZ_TRANSPORT_PROTECTION_SIGN "SIGN"
 169
 170 /*
 171  * Log details of an authentication attempt.
 172  * Successful and unsuccessful attempts are logged.
 173  *
 174  * NOTE: msg_ctx and lp_ctx is optional, but when supplied allows streaming the
 175  * authentication events over the message bus.
 176  */
 177 void log_authentication_event(struct imessaging_context *msg_ctx,
 178                               struct loadparm_context *lp_ctx,
 179                               const struct timeval *start_time,
 180                               const struct auth_usersupplied_info *ui,
 181                               NTSTATUS status,
 182                               const char *account_name,
 183                               const char *domain_name,
 184                               struct dom_sid *sid);
 185
 186 /*
 187  * Log details of a successful authorization to a service.
 188  *
 189  * Only successful authorizations are logged.  For clarity:
 190  * - NTLM bad passwords will be recorded by log_authentication_event
 191  * - Kerberos decrypt failures need to be logged in gensec_gssapi et al
 192  *
 193  * The service may later refuse authorization due to an ACL.
 194  *
 195  *
 196  * NOTE: msg_ctx and lp_ctx is optional, but when supplied allows streaming the
 197  * authorization events over the message bus.
 198  */
 199 void log_successful_authz_event(struct imessaging_context *msg_ctx,
 200                                 struct loadparm_context *lp_ctx,
 201                                 const struct tsocket_address *remote,
 202                                 const struct tsocket_address *local,
 203                                 const char *service_description,
 204                                 const char *auth_type,
 205                                 const char *transport_protection,
 206                                 struct auth_session_info *session_info);
 207 #endif