source3/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_PWHISTORY,
 103         PDB_BACKEND_PRIVATE_DATA,
 104
 105         /* this must be the last element */
 106         PDB_COUNT
 107 };
 108
 109 enum pdb_group_elements {
 110         PDB_GROUP_NAME,
 111         PDB_GROUP_SID,
 112         PDB_GROUP_SID_NAME_USE,
 113         PDB_GROUP_MEMBERS,
 114
 115         /* this must be the last element */
 116         PDB_GROUP_COUNT
 117 };
 118
 119
 120 enum pdb_value_state {
 121         PDB_DEFAULT=0,
 122         PDB_SET,
 123         PDB_CHANGED
 124 };
 125
 126 #define IS_SAM_SET(x, flag)     (pdb_get_init_flags(x, flag) == PDB_SET)
 127 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
 128 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
 129
 130 /* cache for bad password lockout data, to be used on replicated SAMs */
 131 typedef struct logon_cache_struct
 132 {
 133         time_t entry_timestamp;
 134         uint16 acct_ctrl;
 135         uint16 bad_password_count;
 136         time_t bad_password_time;
 137 } LOGIN_CACHE;
 138
 139 typedef struct sam_passwd
 140 {
 141         TALLOC_CTX *mem_ctx;
 142
 143         void (*free_fn)(struct sam_passwd **);
 144
 145         struct pdb_methods *methods;
 146
 147         struct user_data {
 148                 /* initialization flags */
 149                 struct bitmap *change_flags;
 150                 struct bitmap *set_flags;
 151
 152                 time_t logon_time;            /* logon time */
 153                 time_t logoff_time;           /* logoff time */
 154                 time_t kickoff_time;          /* kickoff time */
 155                 time_t bad_password_time;     /* last bad password entered */
 156                 time_t pass_last_set_time;    /* password last set time */
 157                 time_t pass_can_change_time;  /* password can change time */
 158                 time_t pass_must_change_time; /* password must change time */
 159
 160                 const char * username;     /* UNIX username string */
 161                 const char * domain;       /* Windows Domain name */
 162                 const char * nt_username;  /* Windows username string */
 163                 const char * full_name;    /* user's full name string */
 164                 const char * unix_home_dir;     /* UNIX home directory string */
 165                 const char * home_dir;     /* home directory string */
 166                 const char * dir_drive;    /* home directory drive string */
 167                 const char * logon_script; /* logon script string */
 168                 const char * profile_path; /* profile path string */
 169                 const char * acct_desc;    /* user description string */
 170                 const char * workstations; /* login from workstations string */
 171                 const char * unknown_str;  /* don't know what this is, yet. */
 172                 const char * munged_dial;  /* munged path name and dial-back tel number */
 173
 174                 DOM_SID user_sid;    /* Primary User SID */
 175                 DOM_SID group_sid;   /* Primary Group SID */
 176
 177                 DATA_BLOB lm_pw; /* .data is Null if no password */
 178                 DATA_BLOB nt_pw; /* .data is Null if no password */
 179                 DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
 180                 char* plaintext_pw; /* is Null if not available */
 181
 182                 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
 183                 uint32 fields_present; /* 0x00ff ffff */
 184
 185                 uint16 logon_divs; /* 168 - number of hours in a week */
 186                 uint32 hours_len; /* normally 21 bytes */
 187                 uint8 hours[MAX_HOURS_LEN];
 188
 189                 /* Was unknown_5. */
 190                 uint16 bad_password_count;
 191                 uint16 logon_count;
 192
 193                 uint32 unknown_6; /* 0x0000 04ec */
 194                 /* a tag for who added the private methods */
 195                 const struct pdb_methods *backend_private_methods;
 196                 void *backend_private_data;
 197                 void (*backend_private_data_free_fn)(void **);
 198         } private_u;
 199
 200         /* Lets see if the remaining code can get the hint that you
 201            are meant to use the pdb_...() functions. */
 202
 203 } SAM_ACCOUNT;
 204
 205 typedef struct sam_group {
 206         TALLOC_CTX *mem_ctx;
 207
 208         void (*free_fn)(struct sam_group **);
 209
 210         struct pdb_methods *methods;
 211
 212         struct group_data {
 213                 /* initialization flags */
 214                 struct bitmap *change_flags;
 215                 struct bitmap *set_flags;
 216
 217                 const char *name;               /* Windows group name string */
 218
 219                 DOM_SID sid;                    /* Group SID */
 220                 enum SID_NAME_USE sid_name_use; /* Group type */
 221
 222                 uint32 mem_num;                 /* Number of member SIDs */
 223                 DOM_SID *members;               /* SID array */
 224         } private_g;
 225
 226 } SAM_GROUP;
 227
 228 struct acct_info
 229 {
 230     fstring acct_name; /* account name */
 231     fstring acct_desc; /* account name */
 232     uint32 rid; /* domain-relative RID */
 233 };
 234
 235 struct samr_displayentry {
 236         uint32 idx;
 237         uint32 rid;
 238         uint16 acct_flags;
 239         const char *account_name;
 240         const char *fullname;
 241         const char *description;
 242 };
 243
 244 enum pdb_search_type {
 245         PDB_USER_SEARCH,
 246         PDB_GROUP_SEARCH,
 247         PDB_ALIAS_SEARCH
 248 };
 249
 250 struct pdb_search {
 251         TALLOC_CTX *mem_ctx;
 252         enum pdb_search_type type;
 253         struct samr_displayentry *cache;
 254         uint32 num_entries;
 255         ssize_t cache_size;
 256         BOOL search_ended;
 257         void *private_data;
 258         BOOL (*next_entry)(struct pdb_search *search,
 259                            struct samr_displayentry *entry);
 260         void (*search_end)(struct pdb_search *search);
 261 };
 262
 263 /*****************************************************************
 264  Functions to be implemented by the new (v2) passdb API
 265 ****************************************************************/
 266
 267 /*
 268  * This next constant specifies the version number of the PASSDB interface
 269  * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
 270  */
 271
 272 #define PASSDB_INTERFACE_VERSION 9
 273
 274 typedef struct pdb_context
 275 {
 276         struct pdb_methods *pdb_methods;
 277         struct pdb_methods *pwent_methods;
 278
 279         /* These functions are wrappers for the functions listed above.
 280            They may do extra things like re-reading a SAM_ACCOUNT on update */
 281
 282         NTSTATUS (*pdb_setsampwent)(struct pdb_context *, BOOL update, uint16 acb_mask);
 283
 284         void (*pdb_endsampwent)(struct pdb_context *);
 285
 286         NTSTATUS (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
 287
 288         NTSTATUS (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
 289
 290         NTSTATUS (*pdb_getsampwsid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
 291
 292         NTSTATUS (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
 293
 294         NTSTATUS (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
 295
 296         NTSTATUS (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
 297
 298         NTSTATUS (*pdb_update_login_attempts)(struct pdb_context *context, SAM_ACCOUNT *sam_acct, BOOL success);
 299
 300         NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map, DOM_SID sid);
 301
 302         NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map, gid_t gid);
 303
 304         NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map, const char *name);
 305
 306         NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
 307                                                 GROUP_MAP *map);
 308
 309         NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
 310                                                    GROUP_MAP *map);
 311
 312         NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
 313                                                    DOM_SID sid);
 314
 315         NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
 316                                            enum SID_NAME_USE sid_name_use,
 317                                            GROUP_MAP **rmap, int *num_entries,
 318                                            BOOL unix_only);
 319
 320         NTSTATUS (*pdb_enum_group_members)(struct pdb_context *context,
 321                                            TALLOC_CTX *mem_ctx,
 322                                            const DOM_SID *group,
 323                                            uint32 **member_rids,
 324                                            int *num_members);
 325
 326         NTSTATUS (*pdb_enum_group_memberships)(struct pdb_context *context,
 327                                                const char *username,
 328                                                gid_t primary_gid,
 329                                                DOM_SID **sids, gid_t **gids,
 330                                                int *num_groups);
 331
 332         NTSTATUS (*pdb_find_alias)(struct pdb_context *context,
 333                                    const char *name, DOM_SID *sid);
 334
 335         NTSTATUS (*pdb_create_alias)(struct pdb_context *context,
 336                                      const char *name, uint32 *rid);
 337
 338         NTSTATUS (*pdb_delete_alias)(struct pdb_context *context,
 339                                      const DOM_SID *sid);
 340
 341         NTSTATUS (*pdb_get_aliasinfo)(struct pdb_context *context,
 342                                       const DOM_SID *sid,
 343                                       struct acct_info *info);
 344
 345         NTSTATUS (*pdb_set_aliasinfo)(struct pdb_context *context,
 346                                       const DOM_SID *sid,
 347                                       struct acct_info *info);
 348
 349         NTSTATUS (*pdb_add_aliasmem)(struct pdb_context *context,
 350                                      const DOM_SID *alias,
 351                                      const DOM_SID *member);
 352
 353         NTSTATUS (*pdb_del_aliasmem)(struct pdb_context *context,
 354                                      const DOM_SID *alias,
 355                                      const DOM_SID *member);
 356
 357         NTSTATUS (*pdb_enum_aliasmem)(struct pdb_context *context,
 358                                       const DOM_SID *alias,
 359                                       DOM_SID **members, int *num_members);
 360
 361         NTSTATUS (*pdb_enum_alias_memberships)(struct pdb_context *context,
 362                                                TALLOC_CTX *mem_ctx,
 363                                                const DOM_SID *domain_sid,
 364                                                const DOM_SID *members,
 365                                                int num_members,
 366                                                uint32 **alias_rids,
 367                                                int *num_alias_rids);
 368
 369         NTSTATUS (*pdb_lookup_rids)(struct pdb_context *context,
 370                                     TALLOC_CTX *mem_ctx,
 371                                     const DOM_SID *domain_sid,
 372                                     int num_rids,
 373                                     uint32 *rids,
 374                                     const char ***names,
 375                                     uint32 **attrs);
 376
 377         NTSTATUS (*pdb_get_account_policy)(struct pdb_context *context,
 378                                            int policy_index, uint32 *value);
 379
 380         NTSTATUS (*pdb_set_account_policy)(struct pdb_context *context,
 381                                            int policy_index, uint32 value);
 382
 383         NTSTATUS (*pdb_get_seq_num)(struct pdb_context *context, time_t *seq_num);
 384
 385         BOOL (*pdb_search_users)(struct pdb_context *context,
 386                                  struct pdb_search *search,
 387                                  uint16 acct_flags);
 388         BOOL (*pdb_search_groups)(struct pdb_context *context,
 389                                   struct pdb_search *search);
 390         BOOL (*pdb_search_aliases)(struct pdb_context *context,
 391                                    struct pdb_search *search,
 392                                    const DOM_SID *sid);
 393
 394         void (*free_fn)(struct pdb_context **);
 395
 396         TALLOC_CTX *mem_ctx;
 397
 398 } PDB_CONTEXT;
 399
 400 typedef struct pdb_methods
 401 {
 402         const char *name; /* What name got this module */
 403         struct pdb_context *parent;
 404
 405         /* Use macros from dlinklist.h on these two */
 406         struct pdb_methods *next;
 407         struct pdb_methods *prev;
 408
 409         NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update, uint16 acb_mask);
 410
 411         void (*endsampwent)(struct pdb_methods *);
 412
 413         NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
 414
 415         NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
 416
 417         NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
 418
 419         NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 420
 421         NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
 422
 423         NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
 424
 425         NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, SAM_ACCOUNT *sam_acct, BOOL success);
 426
 427         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
 428
 429         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
 430
 431         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
 432
 433         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
 434                                             GROUP_MAP *map);
 435
 436         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
 437                                                GROUP_MAP *map);
 438
 439         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
 440                                                DOM_SID sid);
 441
 442         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
 443                                        enum SID_NAME_USE sid_name_use,
 444                                        GROUP_MAP **rmap, int *num_entries,
 445                                        BOOL unix_only);
 446
 447         NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
 448                                        TALLOC_CTX *mem_ctx,
 449                                        const DOM_SID *group,
 450                                        uint32 **member_rids,
 451                                        int *num_members);
 452
 453         NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
 454                                            const char *username,
 455                                            gid_t primary_gid,
 456                                            DOM_SID **sids, gid_t **gids,
 457                                            int *num_groups);
 458
 459         NTSTATUS (*find_alias)(struct pdb_methods *methods,
 460                                const char *name, DOM_SID *sid);
 461
 462         NTSTATUS (*create_alias)(struct pdb_methods *methods,
 463                                  const char *name, uint32 *rid);
 464
 465         NTSTATUS (*delete_alias)(struct pdb_methods *methods,
 466                                  const DOM_SID *sid);
 467
 468         NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
 469                                   const DOM_SID *sid,
 470                                   struct acct_info *info);
 471
 472         NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
 473                                   const DOM_SID *sid,
 474                                   struct acct_info *info);
 475
 476         NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
 477                                  const DOM_SID *alias, const DOM_SID *member);
 478         NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
 479                                  const DOM_SID *alias, const DOM_SID *member);
 480         NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
 481                                   const DOM_SID *alias, DOM_SID **members,
 482                                   int *num_members);
 483         NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
 484                                            TALLOC_CTX *mem_ctx,
 485                                            const DOM_SID *domain_sid,
 486                                            const DOM_SID *members,
 487                                            int num_members,
 488                                            uint32 **alias_rids,
 489                                            int *num_alias_rids);
 490
 491         NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
 492                                 TALLOC_CTX *mem_ctx,
 493                                 const DOM_SID *domain_sid,
 494                                 int num_rids,
 495                                 uint32 *rids,
 496                                 const char ***names,
 497                                 uint32 **attrs);
 498
 499         NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
 500                                        int policy_index, uint32 *value);
 501
 502         NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
 503                                        int policy_index, uint32 value);
 504
 505         NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
 506
 507         BOOL (*search_users)(struct pdb_methods *methods,
 508                              struct pdb_search *search,
 509                              uint16 acct_flags);
 510         BOOL (*search_groups)(struct pdb_methods *methods,
 511                               struct pdb_search *search);
 512         BOOL (*search_aliases)(struct pdb_methods *methods,
 513                                struct pdb_search *search,
 514                                const DOM_SID *sid);
 515
 516         void *private_data;  /* Private data of some kind */
 517
 518         void (*free_private_data)(void **);
 519
 520 } PDB_METHODS;
 521
 522 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
 523                          struct pdb_methods **,
 524                          const char *);
 525
 526 struct pdb_init_function_entry {
 527         const char *name;
 528         /* Function to create a member of the pdb_methods list */
 529         pdb_init_function init;
 530         struct pdb_init_function_entry *prev, *next;
 531 };
 532
 533 enum sql_search_field { SQL_SEARCH_NONE = 0, SQL_SEARCH_USER_SID = 1, SQL_SEARCH_USER_NAME = 2};
 534
 535 #endif /* _PASSDB_H */