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