source/include/passdb.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    passdb structures and parameters
   4    Copyright (C) Gerald Carter 2001
   5    Copyright (C) Luke Kenneth Casson Leighton 1998 - 2000
   6    Copyright (C) Andrew Bartlett 2002
   7    Copyright (C) Simo Sorce 2003
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #ifndef _PASSDB_H
  25 #define _PASSDB_H
  26
  27
  28 /*
  29  * fields_present flags meanings
  30  * same names as found in samba4 idl files
  31  */
  32
  33 #define ACCT_USERNAME           0x00000001
  34 #define ACCT_FULL_NAME          0x00000002
  35 #define ACCT_RID                0x00000004
  36 #define ACCT_PRIMARY_GID        0x00000008
  37 #define ACCT_ADMIN_DESC         0x00000010
  38 #define ACCT_DESCRIPTION        0x00000020
  39 #define ACCT_HOME_DIR           0x00000040
  40 #define ACCT_HOME_DRIVE         0x00000080
  41 #define ACCT_LOGON_SCRIPT       0x00000100
  42 #define ACCT_PROFILE            0x00000200
  43 #define ACCT_WORKSTATIONS       0x00000400
  44 #define ACCT_LAST_LOGON         0x00000800
  45 #define ACCT_LAST_LOGOFF        0x00001000
  46 #define ACCT_LOGON_HOURS        0x00002000
  47 #define ACCT_BAD_PWD_COUNT      0x00004000
  48 #define ACCT_NUM_LOGONS         0x00008000
  49 #define ACCT_ALLOW_PWD_CHANGE   0x00010000
  50 #define ACCT_FORCE_PWD_CHANGE   0x00020000
  51 #define ACCT_LAST_PWD_CHANGE    0x00040000
  52 #define ACCT_EXPIRY             0x00080000
  53 #define ACCT_FLAGS              0x00100000
  54 #define ACCT_CALLBACK           0x00200000
  55 #define ACCT_COUNTRY_CODE       0x00400000
  56 #define ACCT_CODE_PAGE          0x00800000
  57 #define ACCT_NT_PWD_SET         0x01000000
  58 #define ACCT_LM_PWD_SET         0x02000000
  59 #define ACCT_PRIVATEDATA        0x04000000
  60 #define ACCT_EXPIRED_FLAG       0x08000000
  61 #define ACCT_SEC_DESC           0x10000000
  62 #define ACCT_OWF_PWD            0x20000000
  63
  64 /*
  65  * bit flags representing initialized fields in SAM_ACCOUNT
  66  */
  67 enum pdb_elements {
  68         PDB_UNINIT,
  69         PDB_SMBHOME,
  70         PDB_PROFILE,
  71         PDB_DRIVE,
  72         PDB_LOGONSCRIPT,
  73         PDB_LOGONTIME,
  74         PDB_LOGOFFTIME,
  75         PDB_KICKOFFTIME,
  76         PDB_BAD_PASSWORD_TIME,
  77         PDB_CANCHANGETIME,
  78         PDB_MUSTCHANGETIME,
  79         PDB_PLAINTEXT_PW,
  80         PDB_USERNAME,
  81         PDB_FULLNAME,
  82         PDB_DOMAIN,
  83         PDB_NTUSERNAME,
  84         PDB_HOURSLEN,
  85         PDB_LOGONDIVS,
  86         PDB_USERSID,
  87         PDB_GROUPSID,
  88         PDB_ACCTCTRL,
  89         PDB_PASSLASTSET,
  90         PDB_UNIXHOMEDIR,
  91         PDB_ACCTDESC,
  92         PDB_WORKSTATIONS,
  93         PDB_UNKNOWNSTR,
  94         PDB_MUNGEDDIAL,
  95         PDB_HOURS,
  96         PDB_FIELDS_PRESENT,
  97         PDB_BAD_PASSWORD_COUNT,
  98         PDB_LOGON_COUNT,
  99         PDB_UNKNOWN6,
 100         PDB_LMPASSWD,
 101         PDB_NTPASSWD,
 102         PDB_BACKEND_PRIVATE_DATA,
 103
 104         /* this must be the last element */
 105         PDB_COUNT
 106 };
 107
 108 enum pdb_group_elements {
 109         PDB_GROUP_NAME,
 110         PDB_GROUP_SID,
 111         PDB_GROUP_SID_NAME_USE,
 112         PDB_GROUP_MEMBERS,
 113
 114         /* this must be the last element */
 115         PDB_GROUP_COUNT
 116 };
 117
 118
 119 enum pdb_value_state {
 120         PDB_DEFAULT=0,
 121         PDB_SET,
 122         PDB_CHANGED
 123 };
 124
 125 #define IS_SAM_SET(x, flag)     (pdb_get_init_flags(x, flag) == PDB_SET)
 126 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
 127 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
 128
 129 typedef struct sam_passwd
 130 {
 131         TALLOC_CTX *mem_ctx;
 132
 133         void (*free_fn)(struct sam_passwd **);
 134
 135         struct pdb_methods *methods;
 136
 137         struct user_data {
 138                 /* initialization flags */
 139                 struct bitmap *change_flags;
 140                 struct bitmap *set_flags;
 141
 142                 time_t logon_time;            /* logon time */
 143                 time_t logoff_time;           /* logoff time */
 144                 time_t kickoff_time;          /* kickoff time */
 145                 time_t bad_password_time;     /* last bad password entered */
 146                 time_t pass_last_set_time;    /* password last set time */
 147                 time_t pass_can_change_time;  /* password can change time */
 148                 time_t pass_must_change_time; /* password must change time */
 149
 150                 const char * username;     /* UNIX username string */
 151                 const char * domain;       /* Windows Domain name */
 152                 const char * nt_username;  /* Windows username string */
 153                 const char * full_name;    /* user's full name string */
 154                 const char * unix_home_dir;     /* UNIX home directory string */
 155                 const char * home_dir;     /* home directory string */
 156                 const char * dir_drive;    /* home directory drive string */
 157                 const char * logon_script; /* logon script string */
 158                 const char * profile_path; /* profile path string */
 159                 const char * acct_desc  ;  /* user description string */
 160                 const char * workstations; /* login from workstations string */
 161                 const char * unknown_str ; /* don't know what this is, yet. */
 162                 const char * munged_dial ; /* munged path name and dial-back tel number */
 163
 164                 DOM_SID user_sid;    /* Primary User SID */
 165                 DOM_SID group_sid;   /* Primary Group SID */
 166
 167                 DATA_BLOB lm_pw; /* .data is Null if no password */
 168                 DATA_BLOB nt_pw; /* .data is Null if no password */
 169                 char* plaintext_pw; /* is Null if not available */
 170
 171                 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
 172                 uint32 fields_present; /* 0x00ff ffff */
 173
 174                 uint16 logon_divs; /* 168 - number of hours in a week */
 175                 uint32 hours_len; /* normally 21 bytes */
 176                 uint8 hours[MAX_HOURS_LEN];
 177
 178                 /* Was unknown_5. */
 179                 uint16 bad_password_count;
 180                 uint16 logon_count;
 181
 182                 uint32 unknown_6; /* 0x0000 04ec */
 183                 /* a tag for who added the private methods */
 184                 const struct pdb_methods *backend_private_methods;
 185                 void *backend_private_data;
 186                 void (*backend_private_data_free_fn)(void **);
 187         } private;
 188
 189         /* Lets see if the remaining code can get the hint that you
 190            are meant to use the pdb_...() functions. */
 191
 192 } SAM_ACCOUNT;
 193
 194 typedef struct sam_group {
 195         TALLOC_CTX *mem_ctx;
 196
 197         void (*free_fn)(struct sam_group **);
 198
 199         struct pdb_methods *methods;
 200
 201         struct group_data {
 202                 /* initialization flags */
 203                 struct bitmap *change_flags;
 204                 struct bitmap *set_flags;
 205
 206                 const char *name;               /* Windows group name string */
 207
 208                 DOM_SID sid;                    /* Group SID */
 209                 enum SID_NAME_USE sid_name_use; /* Group type */
 210
 211                 uint32 mem_num;                 /* Number of member SIDs */
 212                 DOM_SID *members;               /* SID array */
 213         } private;
 214
 215 } SAM_GROUP;
 216
 217
 218 /*****************************************************************
 219  Functions to be implemented by the new (v2) passdb API
 220 ****************************************************************/
 221
 222 /*
 223  * This next constant specifies the version number of the PASSDB interface
 224  * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
 225  */
 226
 227 #define PASSDB_INTERFACE_VERSION 4
 228
 229 typedef struct pdb_context
 230 {
 231         struct pdb_methods *pdb_methods;
 232         struct pdb_methods *pwent_methods;
 233
 234         /* These functions are wrappers for the functions listed above.
 235            They may do extra things like re-reading a SAM_ACCOUNT on update */
 236
 237         NTSTATUS (*pdb_setsampwent)(struct pdb_context *, BOOL update);
 238
 239         void (*pdb_endsampwent)(struct pdb_context *);
 240
 241         NTSTATUS (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
 242
 243         NTSTATUS (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
 244
 245         NTSTATUS (*pdb_getsampwsid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
 246
 247         NTSTATUS (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
 248
 249         NTSTATUS (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
 250
 251         NTSTATUS (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
 252
 253         NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map, DOM_SID sid);
 254
 255         NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map, gid_t gid);
 256
 257         NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map, const char *name);
 258
 259         NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
 260                                                 GROUP_MAP *map);
 261
 262         NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
 263                                                    GROUP_MAP *map);
 264
 265         NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
 266                                                    DOM_SID sid);
 267
 268         NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
 269                                            enum SID_NAME_USE sid_name_use,
 270                                            GROUP_MAP **rmap, int *num_entries,
 271                                            BOOL unix_only);
 272
 273         void (*free_fn)(struct pdb_context **);
 274
 275         TALLOC_CTX *mem_ctx;
 276
 277 } PDB_CONTEXT;
 278
 279 typedef struct pdb_methods
 280 {
 281         const char *name; /* What name got this module */
 282         struct pdb_context *parent;
 283
 284         /* Use macros from dlinklist.h on these two */
 285         struct pdb_methods *next;
 286         struct pdb_methods *prev;
 287
 288         NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update);
 289
 290         void (*endsampwent)(struct pdb_methods *);
 291
 292         NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
 293
 294         NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
 295
 296         NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
 297
 298         NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 299
 300         NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 301
 302         NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
 303
 304         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
 305
 306         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
 307
 308         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
 309
 310         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
 311                                             GROUP_MAP *map);
 312
 313         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
 314                                                GROUP_MAP *map);
 315
 316         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
 317                                                DOM_SID sid);
 318
 319         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
 320                                        enum SID_NAME_USE sid_name_use,
 321                                        GROUP_MAP **rmap, int *num_entries,
 322                                        BOOL unix_only);
 323
 324         void *private_data;  /* Private data of some kind */
 325
 326         void (*free_private_data)(void **);
 327
 328 } PDB_METHODS;
 329
 330 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
 331                          struct pdb_methods **,
 332                          const char *);
 333
 334 struct pdb_init_function_entry {
 335         const char *name;
 336         /* Function to create a member of the pdb_methods list */
 337         pdb_init_function init;
 338         struct pdb_init_function_entry *prev, *next;
 339 };
 340
 341 enum sql_search_field { SQL_SEARCH_NONE = 0, SQL_SEARCH_USER_SID = 1, SQL_SEARCH_USER_NAME = 2};
 342
 343 #endif /* _PASSDB_H */