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  * bit flags representing initialized fields in SAM_ACCOUNT
  30  */
  31 enum pdb_elements {
  32         PDB_UNINIT,
  33         PDB_SMBHOME,
  34         PDB_PROFILE,
  35         PDB_DRIVE,
  36         PDB_LOGONSCRIPT,
  37         PDB_LOGONTIME,
  38         PDB_LOGOFFTIME,
  39         PDB_KICKOFFTIME,
  40         PDB_CANCHANGETIME,
  41         PDB_MUSTCHANGETIME,
  42         PDB_PLAINTEXT_PW,
  43         PDB_USERNAME,
  44         PDB_FULLNAME,
  45         PDB_DOMAIN,
  46         PDB_NTUSERNAME,
  47         PDB_HOURSLEN,
  48         PDB_LOGONDIVS,
  49         PDB_USERSID,
  50         PDB_GROUPSID,
  51         PDB_ACCTCTRL,
  52         PDB_PASSLASTSET,
  53         PDB_UNIXHOMEDIR,
  54         PDB_ACCTDESC,
  55         PDB_WORKSTATIONS,
  56         PDB_UNKNOWNSTR,
  57         PDB_MUNGEDDIAL,
  58         PDB_HOURS,
  59         PDB_UNKNOWN3,
  60         PDB_BAD_PASSWORD_COUNT,
  61         PDB_LOGON_COUNT,
  62         PDB_UNKNOWN6,
  63         PDB_LMPASSWD,
  64         PDB_NTPASSWD,
  65         PDB_BACKEND_PRIVATE_DATA,
  66
  67         /* this must be the last element */
  68         PDB_COUNT
  69 };
  70
  71 enum pdb_group_elements {
  72         PDB_GROUP_NAME,
  73         PDB_GROUP_SID,
  74         PDB_GROUP_SID_NAME_USE,
  75         PDB_GROUP_MEMBERS,
  76
  77         /* this must be the last element */
  78         PDB_GROUP_COUNT
  79 };
  80
  81 enum pdb_trust_passwd_elements {
  82         PDB_TRUST_PASS,
  83         PDB_TRUST_SID,
  84         PDB_TRUST_NAME,
  85         PDB_TRUST_MODTIME,
  86         PDB_TRUST_FLAGS,
  87
  88         PDB_TRUST_COUNT
  89 };
  90
  91 enum pdb_value_state {
  92         PDB_DEFAULT=0,
  93         PDB_SET,
  94         PDB_CHANGED
  95 };
  96
  97 #define IS_SAM_SET(x, flag)     (pdb_get_init_flags(x, flag) == PDB_SET)
  98 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
  99 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
 100
 101 typedef struct sam_passwd
 102 {
 103         TALLOC_CTX *mem_ctx;
 104
 105         void (*free_fn)(struct sam_passwd **);
 106
 107         struct pdb_methods *methods;
 108
 109         struct user_data {
 110                 /* initialization flags */
 111                 struct bitmap *change_flags;
 112                 struct bitmap *set_flags;
 113
 114                 time_t logon_time;            /* logon time */
 115                 time_t logoff_time;           /* logoff time */
 116                 time_t kickoff_time;          /* kickoff time */
 117                 time_t pass_last_set_time;    /* password last set time */
 118                 time_t pass_can_change_time;  /* password can change time */
 119                 time_t pass_must_change_time; /* password must change time */
 120
 121                 const char * username;     /* UNIX username string */
 122                 const char * domain;       /* Windows Domain name */
 123                 const char * nt_username;  /* Windows username string */
 124                 const char * full_name;    /* user's full name string */
 125                 const char * unix_home_dir;     /* UNIX home directory string */
 126                 const char * home_dir;     /* home directory string */
 127                 const char * dir_drive;    /* home directory drive string */
 128                 const char * logon_script; /* logon script string */
 129                 const char * profile_path; /* profile path string */
 130                 const char * acct_desc  ;  /* user description string */
 131                 const char * workstations; /* login from workstations string */
 132                 const char * unknown_str ; /* don't know what this is, yet. */
 133                 const char * munged_dial ; /* munged path name and dial-back tel number */
 134
 135                 DOM_SID user_sid;    /* Primary User SID */
 136                 DOM_SID group_sid;   /* Primary Group SID */
 137
 138                 DATA_BLOB lm_pw; /* .data is Null if no password */
 139                 DATA_BLOB nt_pw; /* .data is Null if no password */
 140                 char* plaintext_pw; /* is Null if not available */
 141
 142                 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
 143                 uint32 unknown_3; /* 0x00ff ffff */
 144
 145                 uint16 logon_divs; /* 168 - number of hours in a week */
 146                 uint32 hours_len; /* normally 21 bytes */
 147                 uint8 hours[MAX_HOURS_LEN];
 148
 149                 /* Was unknown_5. */
 150                 uint16 bad_password_count;
 151                 uint16 logon_count;
 152
 153                 uint32 unknown_6; /* 0x0000 04ec */
 154                 /* a tag for who added the private methods */
 155                 const struct pdb_methods *backend_private_methods;
 156                 void *backend_private_data;
 157                 void (*backend_private_data_free_fn)(void **);
 158         } private;
 159
 160         /* Lets see if the remaining code can get the hint that you
 161            are meant to use the pdb_...() functions. */
 162
 163 } SAM_ACCOUNT;
 164
 165 typedef struct sam_group {
 166         TALLOC_CTX *mem_ctx;
 167
 168         void (*free_fn)(struct sam_group **);
 169
 170         struct pdb_methods *methods;
 171
 172         struct group_data {
 173                 /* initialization flags */
 174                 struct bitmap *change_flags;
 175                 struct bitmap *set_flags;
 176
 177                 const char *name;               /* Windows group name string */
 178
 179                 DOM_SID sid;                    /* Group SID */
 180                 enum SID_NAME_USE sid_name_use; /* Group type */
 181
 182                 uint32 mem_num;                 /* Number of member SIDs */
 183                 DOM_SID *members;               /* SID array */
 184         } private;
 185
 186 } SAM_GROUP;
 187
 188
 189 typedef struct _GROUP_INFO {
 190         struct pdb_methods *methods;
 191         DOM_SID sid;
 192         enum SID_NAME_USE sid_name_use;
 193         fstring nt_name;
 194         fstring comment;
 195 } GROUP_INFO;
 196
 197
 198 typedef struct sam_trust_passwd {
 199         TALLOC_CTX *mem_ctx;
 200
 201         void (*free_fn)(struct sam_trust_passwd **);
 202
 203         struct pdb_methods *methods;
 204
 205         struct trust_passwd_data {
 206                 uint16 flags;                   /* flags */
 207                 size_t uni_name_len;            /* unicode name length */
 208                 smb_ucs2_t uni_name[32];        /* unicode domain name */
 209                 fstring pass;                   /* trust password */
 210                 time_t mod_time;                /* last change time */
 211                 DOM_SID domain_sid;             /* trusted domain sid */
 212         } private;
 213
 214 } SAM_TRUST_PASSWD;
 215
 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 5
 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         /* group mapping functions: to be removed */
 254
 255         NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map, DOM_SID sid);
 256
 257         NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map, gid_t gid);
 258
 259         NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map, const char *name);
 260
 261         NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
 262                                                 GROUP_MAP *map);
 263
 264         NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
 265                                                    GROUP_MAP *map);
 266
 267         NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
 268                                                    DOM_SID sid);
 269
 270         NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
 271                                            enum SID_NAME_USE sid_name_use,
 272                                            GROUP_MAP **rmap, int *num_entries,
 273                                            BOOL unix_only);
 274
 275         /* group functions */
 276
 277         NTSTATUS (*pdb_get_group_info_by_sid)(struct pdb_context *context, GROUP_INFO *info, const DOM_SID *group);
 278
 279         NTSTATUS (*pdb_get_group_list)(struct pdb_context *context, GROUP_INFO **info, const enum SID_NAME_USE sid_name_use, int *num_groups);
 280
 281         NTSTATUS (*pdb_get_group_sids)(struct pdb_context *context, const DOM_SID *group, DOM_SID **members, int *num_members);
 282
 283         NTSTATUS (*pdb_add_group)(struct pdb_context *context, const SAM_GROUP *group);
 284
 285         NTSTATUS (*pdb_update_group)(struct pdb_context *context, const SAM_GROUP *group);
 286
 287         NTSTATUS (*pdb_delete_group)(struct pdb_context *context, const DOM_SID *group);
 288
 289         NTSTATUS (*pdb_add_sid_to_group)(struct pdb_context *context, const DOM_SID *group, const DOM_SID *member);
 290
 291         NTSTATUS (*pdb_remove_sid_from_group)(struct pdb_context *context, const DOM_SID *group, const DOM_SID *member);
 292
 293         NTSTATUS (*pdb_get_group_info_by_name)(struct pdb_context *context, GROUP_INFO *info, const char *name);
 294
 295         NTSTATUS (*pdb_get_group_info_by_nt_name)(struct pdb_context *context, GROUP_INFO *info, const char *nt_name);
 296
 297         NTSTATUS (*pdb_get_group_uids)(struct pdb_context *context, const DOM_SID *group, uid_t **members, int *num_members);
 298
 299         /* trust password functions */
 300
 301         NTSTATUS (*pdb_gettrustpwent)(struct pdb_context *context, SAM_TRUST_PASSWD *trust);
 302
 303         NTSTATUS (*pdb_gettrustpwsid)(struct pdb_context *context, SAM_TRUST_PASSWD *trust, const DOM_SID *sid);
 304
 305         NTSTATUS (*pdb_add_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
 306
 307         NTSTATUS (*pdb_update_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
 308
 309         NTSTATUS (*pdb_delete_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
 310
 311         void (*free_fn)(struct pdb_context **);
 312
 313         TALLOC_CTX *mem_ctx;
 314
 315 } PDB_CONTEXT;
 316
 317 typedef struct pdb_methods
 318 {
 319         const char *name; /* What name got this module */
 320         struct pdb_context *parent;
 321
 322         /* Use macros from dlinklist.h on these two */
 323         struct pdb_methods *next;
 324         struct pdb_methods *prev;
 325
 326         NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update);
 327
 328         void (*endsampwent)(struct pdb_methods *);
 329
 330         NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
 331
 332         NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
 333
 334         NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
 335
 336         NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 337
 338         NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 339
 340         NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
 341
 342         /* group mapping functions: to be removed */
 343
 344         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
 345
 346         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
 347
 348         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
 349
 350         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
 351                                             GROUP_MAP *map);
 352
 353         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
 354                                                GROUP_MAP *map);
 355
 356         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
 357                                                DOM_SID sid);
 358
 359         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
 360                                        enum SID_NAME_USE sid_name_use,
 361                                        GROUP_MAP **rmap, int *num_entries,
 362                                        BOOL unix_only);
 363
 364         /* group functions */
 365
 366         NTSTATUS (*get_group_info_by_sid)(struct pdb_methods *methods, GROUP_INFO *info, const DOM_SID *group);
 367
 368         NTSTATUS (*get_group_list)(struct pdb_methods *methods, GROUP_INFO **info, const enum SID_NAME_USE sid_name_use, int *num_groups);
 369
 370         NTSTATUS (*get_group_sids)(struct pdb_methods *methods, const DOM_SID *group, DOM_SID **members, int *num_members);
 371
 372         NTSTATUS (*add_group)(struct pdb_methods *methods, const SAM_GROUP *group);
 373
 374         NTSTATUS (*update_group)(struct pdb_methods *methods, const SAM_GROUP *group);
 375
 376         NTSTATUS (*delete_group)(struct pdb_methods *methods, const DOM_SID *group);
 377
 378         NTSTATUS (*add_sid_to_group)(struct pdb_methods *methods, const DOM_SID *group, const DOM_SID *member);
 379
 380         NTSTATUS (*remove_sid_from_group)(struct pdb_methods *methods, const DOM_SID *group, const DOM_SID *member);
 381
 382         NTSTATUS (*get_group_info_by_name)(struct pdb_methods *methods, GROUP_INFO *info, const char *name);
 383
 384         NTSTATUS (*get_group_info_by_nt_name)(struct pdb_methods *methods, GROUP_INFO *info, const char *nt_name);
 385
 386         NTSTATUS (*get_group_uids)(struct pdb_methods *methods, const DOM_SID *group, uid_t **members, int *num_members);
 387
 388         void *private_data;  /* Private data of some kind */
 389
 390         void (*free_private_data)(void **);
 391
 392         /* trust password functions */
 393
 394         NTSTATUS (*gettrustpwent)(struct pdb_methods *methods, SAM_TRUST_PASSWD *trust);
 395
 396         NTSTATUS (*gettrustpwsid)(struct pdb_methods *methods, SAM_TRUST_PASSWD *trust, const DOM_SID *sid);
 397
 398         NTSTATUS (*add_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
 399
 400         NTSTATUS (*update_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
 401
 402         NTSTATUS (*delete_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
 403
 404 } PDB_METHODS;
 405
 406 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
 407                          struct pdb_methods **,
 408                          const char *);
 409
 410 struct pdb_init_function_entry {
 411         const char *name;
 412         /* Function to create a member of the pdb_methods list */
 413         pdb_init_function init;
 414         struct pdb_init_function_entry *prev, *next;
 415 };
 416
 417 enum sql_search_field { SQL_SEARCH_NONE = 0, SQL_SEARCH_USER_SID = 1, SQL_SEARCH_USER_NAME = 2};
 418
 419 #endif /* _PASSDB_H */