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           0x00200001
  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 enum pdb_trust_passwd_elements {
 119         PDB_TRUST_PASS,
 120         PDB_TRUST_SID,
 121         PDB_TRUST_NAME,
 122         PDB_TRUST_MODTIME,
 123         PDB_TRUST_FLAGS,
 124
 125         PDB_TRUST_COUNT
 126 };
 127
 128 enum pdb_value_state {
 129         PDB_DEFAULT=0,
 130         PDB_SET,
 131         PDB_CHANGED
 132 };
 133
 134 #define IS_SAM_SET(x, flag)     (pdb_get_init_flags(x, flag) == PDB_SET)
 135 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
 136 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
 137
 138 typedef struct sam_passwd
 139 {
 140         TALLOC_CTX *mem_ctx;
 141
 142         void (*free_fn)(struct sam_passwd **);
 143
 144         struct pdb_methods *methods;
 145
 146         struct user_data {
 147                 /* initialization flags */
 148                 struct bitmap *change_flags;
 149                 struct bitmap *set_flags;
 150
 151                 time_t logon_time;            /* logon time */
 152                 time_t logoff_time;           /* logoff time */
 153                 time_t kickoff_time;          /* kickoff time */
 154                 time_t bad_password_time;     /* last bad password entered */
 155                 time_t pass_last_set_time;    /* password last set time */
 156                 time_t pass_can_change_time;  /* password can change time */
 157                 time_t pass_must_change_time; /* password must change time */
 158
 159                 const char * username;     /* UNIX username string */
 160                 const char * domain;       /* Windows Domain name */
 161                 const char * nt_username;  /* Windows username string */
 162                 const char * full_name;    /* user's full name string */
 163                 const char * unix_home_dir;     /* UNIX home directory string */
 164                 const char * home_dir;     /* home directory string */
 165                 const char * dir_drive;    /* home directory drive string */
 166                 const char * logon_script; /* logon script string */
 167                 const char * profile_path; /* profile path string */
 168                 const char * acct_desc  ;  /* user description string */
 169                 const char * workstations; /* login from workstations string */
 170                 const char * unknown_str ; /* don't know what this is, yet. */
 171                 const char * munged_dial ; /* munged path name and dial-back tel number */
 172
 173                 DOM_SID user_sid;    /* Primary User SID */
 174                 DOM_SID group_sid;   /* Primary Group SID */
 175
 176                 DATA_BLOB lm_pw; /* .data is Null if no password */
 177                 DATA_BLOB nt_pw; /* .data is Null if no password */
 178                 char* plaintext_pw; /* is Null if not available */
 179
 180                 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
 181                 uint32 fields_present; /* 0x00ff ffff */
 182
 183                 uint16 logon_divs; /* 168 - number of hours in a week */
 184                 uint32 hours_len; /* normally 21 bytes */
 185                 uint8 hours[MAX_HOURS_LEN];
 186
 187                 /* Was unknown_5. */
 188                 uint16 bad_password_count;
 189                 uint16 logon_count;
 190
 191                 uint32 unknown_6; /* 0x0000 04ec */
 192                 /* a tag for who added the private methods */
 193                 const struct pdb_methods *backend_private_methods;
 194                 void *backend_private_data;
 195                 void (*backend_private_data_free_fn)(void **);
 196         } private;
 197
 198         /* Lets see if the remaining code can get the hint that you
 199            are meant to use the pdb_...() functions. */
 200
 201 } SAM_ACCOUNT;
 202
 203 typedef struct sam_group {
 204         TALLOC_CTX *mem_ctx;
 205
 206         void (*free_fn)(struct sam_group **);
 207
 208         struct pdb_methods *methods;
 209
 210         struct group_data {
 211                 /* initialization flags */
 212                 struct bitmap *change_flags;
 213                 struct bitmap *set_flags;
 214
 215                 const char *name;               /* Windows group name string */
 216
 217                 DOM_SID sid;                    /* Group SID */
 218                 enum SID_NAME_USE sid_name_use; /* Group type */
 219
 220                 uint32 mem_num;                 /* Number of member SIDs */
 221                 DOM_SID *members;               /* SID array */
 222         } private;
 223
 224 } SAM_GROUP;
 225
 226
 227 typedef struct _GROUP_INFO {
 228         struct pdb_methods *methods;
 229         DOM_SID sid;
 230         enum SID_NAME_USE sid_name_use;
 231         fstring nt_name;
 232         fstring comment;
 233 } GROUP_INFO;
 234
 235
 236 typedef struct sam_trust_passwd {
 237         TALLOC_CTX *mem_ctx;
 238
 239         void (*free_fn)(struct sam_trust_passwd **);
 240
 241         struct pdb_methods *methods;
 242
 243         struct trust_passwd_data {
 244                 uint16 flags;                   /* flags */
 245                 size_t uni_name_len;            /* unicode name length */
 246                 smb_ucs2_t uni_name[32];        /* unicode domain name */
 247                 fstring pass;                   /* trust password */
 248                 time_t mod_time;                /* last change time */
 249                 DOM_SID domain_sid;             /* trusted domain sid */
 250         } private;
 251
 252 } SAM_TRUST_PASSWD;
 253
 254
 255
 256 /*****************************************************************
 257  Functions to be implemented by the new (v2) passdb API
 258 ****************************************************************/
 259
 260 /*
 261  * This next constant specifies the version number of the PASSDB interface
 262  * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
 263  */
 264
 265 #define PASSDB_INTERFACE_VERSION 5
 266
 267 typedef struct pdb_context
 268 {
 269         struct pdb_methods *pdb_methods;
 270         struct pdb_methods *pwent_methods;
 271
 272         /* These functions are wrappers for the functions listed above.
 273            They may do extra things like re-reading a SAM_ACCOUNT on update */
 274
 275         NTSTATUS (*pdb_setsampwent)(struct pdb_context *, BOOL update);
 276
 277         void (*pdb_endsampwent)(struct pdb_context *);
 278
 279         NTSTATUS (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
 280
 281         NTSTATUS (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
 282
 283         NTSTATUS (*pdb_getsampwsid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
 284
 285         NTSTATUS (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
 286
 287         NTSTATUS (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
 288
 289         NTSTATUS (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
 290
 291         /* group mapping functions: to be removed */
 292
 293         NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map, DOM_SID sid);
 294
 295         NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map, gid_t gid);
 296
 297         NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map, const char *name);
 298
 299         NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
 300                                                 GROUP_MAP *map);
 301
 302         NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
 303                                                    GROUP_MAP *map);
 304
 305         NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
 306                                                    DOM_SID sid);
 307
 308         NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
 309                                            enum SID_NAME_USE sid_name_use,
 310                                            GROUP_MAP **rmap, int *num_entries,
 311                                            BOOL unix_only);
 312
 313         /* group functions */
 314
 315         NTSTATUS (*pdb_get_group_info_by_sid)(struct pdb_context *context, GROUP_INFO *info, const DOM_SID *group);
 316
 317         NTSTATUS (*pdb_get_group_list)(struct pdb_context *context, GROUP_INFO **info, const enum SID_NAME_USE sid_name_use, int *num_groups);
 318
 319         NTSTATUS (*pdb_get_group_sids)(struct pdb_context *context, const DOM_SID *group, DOM_SID **members, int *num_members);
 320
 321         NTSTATUS (*pdb_add_group)(struct pdb_context *context, const SAM_GROUP *group);
 322
 323         NTSTATUS (*pdb_update_group)(struct pdb_context *context, const SAM_GROUP *group);
 324
 325         NTSTATUS (*pdb_delete_group)(struct pdb_context *context, const DOM_SID *group);
 326
 327         NTSTATUS (*pdb_add_sid_to_group)(struct pdb_context *context, const DOM_SID *group, const DOM_SID *member);
 328
 329         NTSTATUS (*pdb_remove_sid_from_group)(struct pdb_context *context, const DOM_SID *group, const DOM_SID *member);
 330
 331         NTSTATUS (*pdb_get_group_info_by_name)(struct pdb_context *context, GROUP_INFO *info, const char *name);
 332
 333         NTSTATUS (*pdb_get_group_info_by_nt_name)(struct pdb_context *context, GROUP_INFO *info, const char *nt_name);
 334
 335         NTSTATUS (*pdb_get_group_uids)(struct pdb_context *context, const DOM_SID *group, uid_t **members, int *num_members);
 336
 337         /* trust password functions */
 338
 339         NTSTATUS (*pdb_gettrustpwent)(struct pdb_context *context, SAM_TRUST_PASSWD *trust);
 340
 341         NTSTATUS (*pdb_gettrustpwsid)(struct pdb_context *context, SAM_TRUST_PASSWD *trust, const DOM_SID *sid);
 342
 343         NTSTATUS (*pdb_add_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
 344
 345         NTSTATUS (*pdb_update_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
 346
 347         NTSTATUS (*pdb_delete_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
 348
 349         void (*free_fn)(struct pdb_context **);
 350
 351         TALLOC_CTX *mem_ctx;
 352
 353 } PDB_CONTEXT;
 354
 355 typedef struct pdb_methods
 356 {
 357         const char *name; /* What name got this module */
 358         struct pdb_context *parent;
 359
 360         /* Use macros from dlinklist.h on these two */
 361         struct pdb_methods *next;
 362         struct pdb_methods *prev;
 363
 364         NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update);
 365
 366         void (*endsampwent)(struct pdb_methods *);
 367
 368         NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
 369
 370         NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
 371
 372         NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
 373
 374         NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 375
 376         NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 377
 378         NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
 379
 380         /* group mapping functions: to be removed */
 381
 382         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
 383
 384         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
 385
 386         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
 387
 388         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
 389                                             GROUP_MAP *map);
 390
 391         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
 392                                                GROUP_MAP *map);
 393
 394         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
 395                                                DOM_SID sid);
 396
 397         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
 398                                        enum SID_NAME_USE sid_name_use,
 399                                        GROUP_MAP **rmap, int *num_entries,
 400                                        BOOL unix_only);
 401
 402         /* group functions */
 403
 404         NTSTATUS (*get_group_info_by_sid)(struct pdb_methods *methods, GROUP_INFO *info, const DOM_SID *group);
 405
 406         NTSTATUS (*get_group_list)(struct pdb_methods *methods, GROUP_INFO **info, const enum SID_NAME_USE sid_name_use, int *num_groups);
 407
 408         NTSTATUS (*get_group_sids)(struct pdb_methods *methods, const DOM_SID *group, DOM_SID **members, int *num_members);
 409
 410         NTSTATUS (*add_group)(struct pdb_methods *methods, const SAM_GROUP *group);
 411
 412         NTSTATUS (*update_group)(struct pdb_methods *methods, const SAM_GROUP *group);
 413
 414         NTSTATUS (*delete_group)(struct pdb_methods *methods, const DOM_SID *group);
 415
 416         NTSTATUS (*add_sid_to_group)(struct pdb_methods *methods, const DOM_SID *group, const DOM_SID *member);
 417
 418         NTSTATUS (*remove_sid_from_group)(struct pdb_methods *methods, const DOM_SID *group, const DOM_SID *member);
 419
 420         NTSTATUS (*get_group_info_by_name)(struct pdb_methods *methods, GROUP_INFO *info, const char *name);
 421
 422         NTSTATUS (*get_group_info_by_nt_name)(struct pdb_methods *methods, GROUP_INFO *info, const char *nt_name);
 423
 424         NTSTATUS (*get_group_uids)(struct pdb_methods *methods, const DOM_SID *group, uid_t **members, int *num_members);
 425
 426         void *private_data;  /* Private data of some kind */
 427
 428         void (*free_private_data)(void **);
 429
 430         /* trust password functions */
 431
 432         NTSTATUS (*gettrustpwent)(struct pdb_methods *methods, SAM_TRUST_PASSWD *trust);
 433
 434         NTSTATUS (*gettrustpwsid)(struct pdb_methods *methods, SAM_TRUST_PASSWD *trust, const DOM_SID *sid);
 435
 436         NTSTATUS (*add_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
 437
 438         NTSTATUS (*update_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
 439
 440         NTSTATUS (*delete_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
 441
 442 } PDB_METHODS;
 443
 444 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
 445                          struct pdb_methods **,
 446                          const char *);
 447
 448 struct pdb_init_function_entry {
 449         const char *name;
 450         /* Function to create a member of the pdb_methods list */
 451         pdb_init_function init;
 452         struct pdb_init_function_entry *prev, *next;
 453 };
 454
 455 enum sql_search_field { SQL_SEARCH_NONE = 0, SQL_SEARCH_USER_SID = 1, SQL_SEARCH_USER_NAME = 2};
 456
 457 #endif /* _PASSDB_H */