source4/auth/auth.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Standardised Authentication types
   4    Copyright (C) Andrew Bartlett 2001
   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 2 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, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #ifndef _SAMBA_AUTH_H
  22 #define _SAMBA_AUTH_H
  23
  24 /* modules can use the following to determine if the interface has changed
  25  * please increment the version number after each interface change
  26  * with a comment and maybe update struct auth_critical_sizes.
  27  */
  28 /* version 1 - version from samba 3.0 - metze */
  29 /* version 2 - initial samba4 version - metze */
  30 /* version 3 - subsequent samba4 version - abartlet */
  31 #define AUTH_INTERFACE_VERSION 3
  32
  33 /* AUTH_STR - string */
  34 typedef struct auth_str
  35 {
  36         int len;
  37         char *str;
  38 } AUTH_STR;
  39
  40 typedef struct auth_usersupplied_info
  41 {
  42
  43         DATA_BLOB lm_resp;
  44         DATA_BLOB nt_resp;
  45         DATA_BLOB lm_interactive_pwd;
  46         DATA_BLOB nt_interactive_pwd;
  47         DATA_BLOB plaintext_password;
  48
  49         BOOL encrypted;
  50
  51         AUTH_STR           client_domain;          /* domain name string */
  52         AUTH_STR           domain;               /* domain name after mapping */
  53         AUTH_STR           internal_username;    /* username after mapping */
  54         AUTH_STR           smb_name;        /* username before mapping */
  55         AUTH_STR           wksta_name;           /* workstation name (netbios calling name) unicode string */
  56
  57 } auth_usersupplied_info;
  58
  59 #define SAM_FILL_NAME  0x01
  60 #define SAM_FILL_INFO3 0x02
  61 #define SAM_FILL_SAM   0x04
  62 #define SAM_FILL_UNIX  0x08
  63 #define SAM_FILL_ALL (SAM_FILL_NAME | SAM_FILL_INFO3 | SAM_FILL_SAM | SAM_FILL_UNIX)
  64
  65 typedef struct auth_serversupplied_info
  66 {
  67         TALLOC_CTX *mem_ctx;
  68
  69         BOOL guest;
  70
  71         /* NT group information taken from the info3 structure */
  72
  73         NT_USER_TOKEN *ptok;
  74
  75         DATA_BLOB user_session_key;
  76         DATA_BLOB lm_session_key;
  77
  78 } auth_serversupplied_info;
  79
  80 struct auth_context {
  81         DATA_BLOB challenge;
  82
  83         /* Who set this up in the first place? */
  84         const char *challenge_set_by;
  85
  86         BOOL challenge_may_be_modified;
  87
  88         struct auth_methods *challenge_set_method;
  89         /* What order are the various methods in?   Try to stop it changing under us */
  90         struct auth_methods *auth_method_list;
  91
  92         TALLOC_CTX *mem_ctx;
  93         const uint8 *(*get_ntlm_challenge)(struct auth_context *auth_context);
  94         NTSTATUS (*check_ntlm_password)(const struct auth_context *auth_context,
  95                                         const struct auth_usersupplied_info *user_info,
  96                                         struct auth_serversupplied_info **server_info);
  97         NTSTATUS (*nt_status_squash)(NTSTATUS nt_status);
  98         void (*free)(struct auth_context **auth_context);
  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                          auth_serversupplied_info **server_info);
 111
 112         DATA_BLOB (*get_chal)(const struct auth_context *auth_context,
 113                               void **my_private_data,
 114                               TALLOC_CTX *mem_ctx);
 115
 116         /* Used to keep tabs on things like the cli for SMB server authentication */
 117         void *private_data;
 118
 119         /* Function to clean up the above arbitary structure */
 120         void (*free_private_data)(void **private_data);
 121
 122         /* Function to send a keepalive message on the above structure */
 123         void (*send_keepalive)(void **private_data);
 124
 125 } auth_methods;
 126
 127 typedef NTSTATUS (*auth_init_function)(struct auth_context *, const char *, struct auth_methods **);
 128
 129 struct auth_init_function_entry {
 130         const char *name;
 131         /* Function to create a member of the authmethods list */
 132
 133         auth_init_function init;
 134
 135         struct auth_init_function_entry *prev, *next;
 136 };
 137
 138 typedef struct auth_ntlmssp_state
 139 {
 140         TALLOC_CTX *mem_ctx;
 141         struct auth_context *auth_context;
 142         struct auth_serversupplied_info *server_info;
 143         struct ntlmssp_state *ntlmssp_state;
 144 } AUTH_NTLMSSP_STATE;
 145
 146 #define auth_ops __XXX_ERROR_BLA
 147 struct auth_operations {
 148         /* the name of the backend */
 149         const char *name;
 150
 151         /* Function to create a member of the authmethods list */
 152         NTSTATUS (*init)(struct auth_context *, const char *, struct auth_methods **);
 153 };
 154
 155 /* this structure is used by backends to determine the size of some critical types */
 156 struct auth_critical_sizes {
 157         int interface_version;
 158         int sizeof_auth_operations;
 159         int sizeof_auth_methods;
 160         int sizeof_auth_context;
 161         int sizeof_auth_ntlmssp_state;
 162         int sizeof_auth_usersupplied_info;
 163         int sizeof_auth_serversupplied_info;
 164         int sizeof_auth_str;
 165         int sizeof_auth_unistr;
 166 };
 167
 168 #endif /* _SMBAUTH_H_ */