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         /*
  38          * NT group information taken from the info3 structure
  39          *
  40          * This is not normally filled in, during the typical
  41          * authentication process.  If filled in, it has already been
  42          * finalised by a nasty hack to support a cached guest/system
  43          * session_info
  44          */
  45
  46         struct security_token *security_token;
  47
  48         /* These are the intermediate session keys, as provided by a
  49          * NETLOGON server and used by NTLMSSP to negotiate key
  50          * exchange etc (which will provide the session_key in the
  51          * auth_session_info).  It is usually the same as the keys in
  52          * the info3, but is a variable length structure here to allow
  53          * it to be omitted if the auth module does not know it.
  54          */
  55
  56         DATA_BLOB session_key;
  57         DATA_BLOB lm_session_key;
  58
  59         struct netr_SamInfo3 *info3;
  60
  61         /* this structure is filled *only* in pathological cases where the user
  62          * sid or the primary group sid are not sids of the domain. Normally
  63          * this happens only for unix accounts that have unix domain sids.
  64          * This is checked only when info3.rid and/or info3.primary_gid are set
  65          * to the special invalid value of 0xFFFFFFFF */
  66         struct extra_auth_info extra;
  67
  68         /*
  69          * This is a token from /etc/passwd and /etc/group
  70          */
  71         bool nss_token;
  72
  73         char *unix_name;
  74 };
  75
  76 struct auth_context;
  77
  78 typedef NTSTATUS (*prepare_gensec_fn)(const struct auth_context *auth_context,
  79                                       TALLOC_CTX *mem_ctx,
  80                                       struct gensec_security **gensec_context);
  81
  82 typedef NTSTATUS (*make_auth4_context_fn)(const struct auth_context *auth_context,
  83                                           TALLOC_CTX *mem_ctx,
  84                                           struct auth4_context **auth4_context);
  85
  86 struct auth_context {
  87         DATA_BLOB challenge;
  88
  89         /* Who set this up in the first place? */
  90         const char *challenge_set_by;
  91
  92         /* What order are the various methods in?   Try to stop it changing under us */
  93         struct auth_methods *auth_method_list;
  94
  95         prepare_gensec_fn prepare_gensec;
  96         make_auth4_context_fn make_auth4_context;
  97         const char *forced_samba4_methods;
  98 };
  99
 100 typedef struct auth_methods
 101 {
 102         struct auth_methods *prev, *next;
 103         const char *name; /* What name got this module */
 104
 105         NTSTATUS (*auth)(const struct auth_context *auth_context,
 106                          void *my_private_data,
 107                          TALLOC_CTX *mem_ctx,
 108                          const struct auth_usersupplied_info *user_info,
 109                          struct auth_serversupplied_info **server_info);
 110
 111         /* Optional methods allowing this module to provide a way to get a gensec context and an auth4_context */
 112         prepare_gensec_fn prepare_gensec;
 113         make_auth4_context_fn make_auth4_context;
 114         /* Used to keep tabs on things like the cli for SMB server authentication */
 115         void *private_data;
 116
 117         uint32_t flags;
 118
 119 } auth_methods;
 120
 121 typedef NTSTATUS (*auth_init_function)(struct auth_context *, const char *, struct auth_methods **);
 122
 123 struct auth_init_function_entry {
 124         const char *name;
 125         /* Function to create a member of the authmethods list */
 126
 127         auth_init_function init;
 128
 129         struct auth_init_function_entry *prev, *next;
 130 };
 131
 132 extern const struct gensec_security_ops gensec_ntlmssp3_server_ops;
 133
 134 /* Intent of use for session key. LSA and SAMR pipes use 16 bytes of session key when doing create/modify calls */
 135 enum session_key_use_intent {
 136         KEY_USE_FULL = 0,
 137         KEY_USE_16BYTES
 138 };
 139
 140 /* Changed from 1 -> 2 to add the logon_parameters field. */
 141 /* Changed from 2 -> 3 when we reworked many auth structures to use IDL or be in common with Samba4 */
 142 /* Changed from 3 -> 4 when we reworked added the flags */
 143 /* Changed from 4 -> 5 as module init functions now take a TALLOC_CTX * */
 144 #define AUTH_INTERFACE_VERSION 5
 145
 146 #include "auth/proto.h"
 147
 148 #endif /* _SMBAUTH_H_ */