source3/include/auth.h

   1 #ifndef _SMBAUTH_H_
   2 #define _SMBAUTH_H_
   3 /*
   4    Unix SMB/CIFS implementation.
   5    Standardised Authentication types
   6    Copyright (C) Andrew Bartlett 2001
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "../auth/common_auth.h"
  23
  24 struct gensec_security;
  25
  26 struct extra_auth_info {
  27         struct dom_sid user_sid;
  28         struct dom_sid pgid_sid;
  29 };
  30
  31 struct auth_serversupplied_info {
  32         bool guest;
  33         bool system;
  34
  35         struct security_unix_token utok;
  36
  37         /* NT group information taken from the info3 structure */
  38
  39         struct security_token *security_token;
  40
  41         /* These are the intermediate session keys, as provided by a
  42          * NETLOGON server and used by NTLMSSP to negotiate key
  43          * exchange etc (which will provide the session_key in the
  44          * auth_session_info).  It is usually the same as the keys in
  45          * the info3, but is a variable length structure here to allow
  46          * it to be omitted if the auth module does not know it.
  47          */
  48
  49         DATA_BLOB session_key;
  50         DATA_BLOB lm_session_key;
  51
  52         struct netr_SamInfo3 *info3;
  53
  54         /* this structure is filled *only* in pathological cases where the user
  55          * sid or the primary group sid are not sids of the domain. Normally
  56          * this happens only for unix accounts that have unix domain sids.
  57          * This is checked only when info3.rid and/or info3.primary_gid are set
  58          * to the special invalid value of 0xFFFFFFFF */
  59         struct extra_auth_info extra;
  60
  61         /*
  62          * This is a token from /etc/passwd and /etc/group
  63          */
  64         bool nss_token;
  65
  66         char *unix_name;
  67 };
  68
  69 typedef NTSTATUS (*prepare_gensec_fn)(TALLOC_CTX *mem_ctx,
  70                                       struct gensec_security **gensec_context);
  71 typedef NTSTATUS (*gensec_start_mech_by_oid_fn)(struct gensec_security *gensec_context,
  72                                                 const char *oid_string);
  73 typedef NTSTATUS (*gensec_start_mech_by_authtype_fn)(struct gensec_security *gensec_context,
  74                                                      uint8_t auth_type,
  75                                                      uint8_t auth_level);
  76
  77 struct auth_context {
  78         DATA_BLOB challenge;
  79
  80         /* Who set this up in the first place? */
  81         const char *challenge_set_by;
  82
  83         bool challenge_may_be_modified;
  84
  85         struct auth_methods *challenge_set_method;
  86         /* What order are the various methods in?   Try to stop it changing under us */
  87         struct auth_methods *auth_method_list;
  88
  89         NTSTATUS (*get_ntlm_challenge)(struct auth_context *auth_context,
  90                                        uint8_t chal[8]);
  91         NTSTATUS (*check_ntlm_password)(const struct auth_context *auth_context,
  92                                         const struct auth_usersupplied_info *user_info,
  93                                         struct auth_serversupplied_info **server_info);
  94         NTSTATUS (*nt_status_squash)(NTSTATUS nt_status);
  95
  96         prepare_gensec_fn prepare_gensec;
  97         gensec_start_mech_by_oid_fn gensec_start_mech_by_oid;
  98         gensec_start_mech_by_authtype_fn gensec_start_mech_by_authtype;
  99 };
 100
 101 typedef struct auth_methods
 102 {
 103         struct auth_methods *prev, *next;
 104         const char *name; /* What name got this module */
 105
 106         NTSTATUS (*auth)(const struct auth_context *auth_context,
 107                          void *my_private_data,
 108                          TALLOC_CTX *mem_ctx,
 109                          const struct auth_usersupplied_info *user_info,
 110                          struct auth_serversupplied_info **server_info);
 111
 112         /* If you are using this interface, then you are probably
 113          * getting something wrong.  This interface is only for
 114          * security=server, and makes a number of compromises to allow
 115          * that.  It is not compatible with being a PDC.  */
 116         DATA_BLOB (*get_chal)(const struct auth_context *auth_context,
 117                               void **my_private_data,
 118                               TALLOC_CTX *mem_ctx);
 119
 120         /* Optional methods allowing this module to provide a way to get a gensec context */
 121         prepare_gensec_fn prepare_gensec;
 122         gensec_start_mech_by_oid_fn gensec_start_mech_by_oid;
 123         gensec_start_mech_by_authtype_fn gensec_start_mech_by_authtype;
 124         /* Used to keep tabs on things like the cli for SMB server authentication */
 125         void *private_data;
 126
 127 } auth_methods;
 128
 129 typedef NTSTATUS (*auth_init_function)(struct auth_context *, const char *, struct auth_methods **);
 130
 131 struct auth_init_function_entry {
 132         const char *name;
 133         /* Function to create a member of the authmethods list */
 134
 135         auth_init_function init;
 136
 137         struct auth_init_function_entry *prev, *next;
 138 };
 139
 140 struct auth_ntlmssp_state;
 141
 142 /* Changed from 1 -> 2 to add the logon_parameters field. */
 143 /* Changed from 2 -> 3 when we reworked many auth structures to use IDL or be in common with Samba4 */
 144 #define AUTH_INTERFACE_VERSION 3
 145
 146 #include "auth/proto.h"
 147
 148 #endif /* _SMBAUTH_H_ */