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 3 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, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _PASSDB_H
  24 #define _PASSDB_H
  25
  26 /**********************************************************************
  27  * Masks for mappings between unix uid and gid types and
  28  * NT RIDS.
  29  **********************************************************************/
  30
  31 /* Take the bottom bit. */
  32 #define RID_TYPE_MASK           1
  33 #define RID_MULTIPLIER          2
  34
  35 /* The two common types. */
  36 #define USER_RID_TYPE           0
  37 #define GROUP_RID_TYPE          1
  38
  39 /*
  40  * bit flags representing initialized fields in struct samu
  41  */
  42 enum pdb_elements {
  43         PDB_UNINIT,
  44         PDB_SMBHOME,
  45         PDB_PROFILE,
  46         PDB_DRIVE,
  47         PDB_LOGONSCRIPT,
  48         PDB_LOGONTIME,
  49         PDB_LOGOFFTIME,
  50         PDB_KICKOFFTIME,
  51         PDB_BAD_PASSWORD_TIME,
  52         PDB_CANCHANGETIME,
  53         PDB_MUSTCHANGETIME,
  54         PDB_PLAINTEXT_PW,
  55         PDB_USERNAME,
  56         PDB_FULLNAME,
  57         PDB_DOMAIN,
  58         PDB_NTUSERNAME,
  59         PDB_HOURSLEN,
  60         PDB_LOGONDIVS,
  61         PDB_USERSID,
  62         PDB_GROUPSID,
  63         PDB_ACCTCTRL,
  64         PDB_PASSLASTSET,
  65         PDB_ACCTDESC,
  66         PDB_WORKSTATIONS,
  67         PDB_COMMENT,
  68         PDB_MUNGEDDIAL,
  69         PDB_HOURS,
  70         PDB_FIELDS_PRESENT,
  71         PDB_BAD_PASSWORD_COUNT,
  72         PDB_LOGON_COUNT,
  73         PDB_UNKNOWN6,
  74         PDB_LMPASSWD,
  75         PDB_NTPASSWD,
  76         PDB_PWHISTORY,
  77         PDB_BACKEND_PRIVATE_DATA,
  78
  79         /* this must be the last element */
  80         PDB_COUNT
  81 };
  82
  83 enum pdb_group_elements {
  84         PDB_GROUP_NAME,
  85         PDB_GROUP_SID,
  86         PDB_GROUP_SID_NAME_USE,
  87         PDB_GROUP_MEMBERS,
  88
  89         /* this must be the last element */
  90         PDB_GROUP_COUNT
  91 };
  92
  93
  94 enum pdb_value_state {
  95         PDB_DEFAULT=0,
  96         PDB_SET,
  97         PDB_CHANGED
  98 };
  99
 100 #define IS_SAM_SET(x, flag)     (pdb_get_init_flags(x, flag) == PDB_SET)
 101 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
 102 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
 103
 104 /* cache for bad password lockout data, to be used on replicated SAMs */
 105 struct login_cache {
 106         time_t entry_timestamp;
 107         uint32 acct_ctrl;
 108         uint16 bad_password_count;
 109         time_t bad_password_time;
 110 };
 111
 112 #define SAMU_BUFFER_V0          0
 113 #define SAMU_BUFFER_V1          1
 114 #define SAMU_BUFFER_V2          2
 115 #define SAMU_BUFFER_V3          3
 116 /* nothing changed from V3 to V4 */
 117 #define SAMU_BUFFER_V4          4
 118 #define SAMU_BUFFER_LATEST      SAMU_BUFFER_V4
 119
 120 struct samu {
 121         struct pdb_methods *methods;
 122
 123         /* initialization flags */
 124         struct bitmap *change_flags;
 125         struct bitmap *set_flags;
 126
 127         time_t logon_time;            /* logon time */
 128         time_t logoff_time;           /* logoff time */
 129         time_t kickoff_time;          /* kickoff time */
 130         time_t bad_password_time;     /* last bad password entered */
 131         time_t pass_last_set_time;    /* password last set time */
 132         time_t pass_can_change_time;  /* password can change time */
 133         time_t pass_must_change_time; /* password must change time */
 134
 135         const char *username;     /* UNIX username string */
 136         const char *domain;       /* Windows Domain name */
 137         const char *nt_username;  /* Windows username string */
 138         const char *full_name;    /* user's full name string */
 139         const char *home_dir;     /* home directory string */
 140         const char *dir_drive;    /* home directory drive string */
 141         const char *logon_script; /* logon script string */
 142         const char *profile_path; /* profile path string */
 143         const char *acct_desc;    /* user description string */
 144         const char *workstations; /* login from workstations string */
 145         const char *comment;
 146         const char *munged_dial;  /* munged path name and dial-back tel number */
 147
 148         DOM_SID user_sid;
 149         DOM_SID *group_sid;
 150
 151         DATA_BLOB lm_pw; /* .data is Null if no password */
 152         DATA_BLOB nt_pw; /* .data is Null if no password */
 153         DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
 154         char* plaintext_pw; /* is Null if not available */
 155
 156         uint32 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
 157         uint32 fields_present; /* 0x00ff ffff */
 158
 159         uint16 logon_divs; /* 168 - number of hours in a week */
 160         uint32 hours_len; /* normally 21 bytes */
 161         uint8 hours[MAX_HOURS_LEN];
 162
 163         /* Was unknown_5. */
 164         uint16 bad_password_count;
 165         uint16 logon_count;
 166
 167         uint32 unknown_6; /* 0x0000 04ec */
 168
 169         /* a tag for who added the private methods */
 170
 171         const struct pdb_methods *backend_private_methods;
 172         void *backend_private_data;
 173         void (*backend_private_data_free_fn)(void **);
 174
 175         /* maintain a copy of the user's struct passwd */
 176
 177         struct passwd *unix_pw;
 178 };
 179
 180 struct acct_info {
 181         fstring acct_name; /* account name */
 182         fstring acct_desc; /* account name */
 183         uint32 rid; /* domain-relative RID */
 184 };
 185
 186 struct samr_displayentry {
 187         uint32 idx;
 188         uint32 rid;
 189         uint32 acct_flags;
 190         const char *account_name;
 191         const char *fullname;
 192         const char *description;
 193 };
 194
 195 enum pdb_search_type {
 196         PDB_USER_SEARCH,
 197         PDB_GROUP_SEARCH,
 198         PDB_ALIAS_SEARCH
 199 };
 200
 201 struct pdb_search {
 202         enum pdb_search_type type;
 203         struct samr_displayentry *cache;
 204         uint32 num_entries;
 205         ssize_t cache_size;
 206         bool search_ended;
 207         void *private_data;
 208         bool (*next_entry)(struct pdb_search *search,
 209                            struct samr_displayentry *entry);
 210         void (*search_end)(struct pdb_search *search);
 211 };
 212
 213 struct pdb_domain_info {
 214         char *name;
 215         char *dns_domain;
 216         char *dns_forest;
 217         struct dom_sid sid;
 218         struct GUID guid;
 219 };
 220
 221 /*
 222  * Types of account policy.
 223  */
 224 enum pdb_policy_type {
 225         PDB_POLICY_MIN_PASSWORD_LEN = 1,
 226         PDB_POLICY_PASSWORD_HISTORY = 2,
 227         PDB_POLICY_USER_MUST_LOGON_TO_CHG_PASS  = 3,
 228         PDB_POLICY_MAX_PASSWORD_AGE = 4,
 229         PDB_POLICY_MIN_PASSWORD_AGE = 5,
 230         PDB_POLICY_LOCK_ACCOUNT_DURATION = 6,
 231         PDB_POLICY_RESET_COUNT_TIME = 7,
 232         PDB_POLICY_BAD_ATTEMPT_LOCKOUT = 8,
 233         PDB_POLICY_TIME_TO_LOGOUT = 9,
 234         PDB_POLICY_REFUSE_MACHINE_PW_CHANGE = 10
 235 };
 236
 237 #define PDB_CAP_STORE_RIDS      0x0001
 238 #define PDB_CAP_ADS             0x0002
 239
 240 /*****************************************************************
 241  Functions to be implemented by the new (v2) passdb API
 242 ****************************************************************/
 243
 244 /*
 245  * This next constant specifies the version number of the PASSDB interface
 246  * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
 247  * Changed interface to fix int -> size_t problems. JRA.
 248  * There's no point in allocating arrays in
 249  * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
 250  * the pdb module. Remove the latter, this might happen more often. VL.
 251  * changed to version 14 to move lookup_rids and lookup_names to return
 252  * enum lsa_SidType rather than uint32.
 253  * Changed to 16 for access to the trusted domain passwords (obnox).
 254  * Changed to 17, the sampwent interface is gone.
 255  * Changed to 18, pdb_rid_algorithm -> pdb_capabilities
 256  * Changed to 19, removed uid_to_rid
 257  */
 258
 259 #define PASSDB_INTERFACE_VERSION 19
 260
 261 struct pdb_methods
 262 {
 263         const char *name; /* What name got this module */
 264
 265         struct pdb_domain_info *(*get_domain_info)(struct pdb_methods *,
 266                                                    TALLOC_CTX *mem_ctx);
 267
 268         NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
 269
 270         NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const DOM_SID *sid);
 271
 272         NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
 273                                 const char *name, uint32 acct_flags,
 274                                 uint32 *rid);
 275
 276         NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
 277                                 struct samu *sam_acct);
 278
 279         NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
 280
 281         NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
 282
 283         NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
 284
 285         NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
 286
 287         NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
 288
 289         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
 290
 291         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
 292
 293         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
 294
 295         NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
 296                                      TALLOC_CTX *mem_ctx, const char *name,
 297                                      uint32 *rid);
 298
 299         NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
 300                                      TALLOC_CTX *mem_ctx, uint32 rid);
 301
 302         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
 303                                             GROUP_MAP *map);
 304
 305         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
 306                                                GROUP_MAP *map);
 307
 308         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
 309                                                DOM_SID sid);
 310
 311         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
 312                                        const DOM_SID *sid, enum lsa_SidType sid_name_use,
 313                                        GROUP_MAP **pp_rmap, size_t *p_num_entries,
 314                                        bool unix_only);
 315
 316         NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
 317                                        TALLOC_CTX *mem_ctx,
 318                                        const DOM_SID *group,
 319                                        uint32 **pp_member_rids,
 320                                        size_t *p_num_members);
 321
 322         NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
 323                                            TALLOC_CTX *mem_ctx,
 324                                            struct samu *user,
 325                                            DOM_SID **pp_sids, gid_t **pp_gids,
 326                                            size_t *p_num_groups);
 327
 328         NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
 329                                            TALLOC_CTX *mem_ctx,
 330                                            struct samu *user);
 331
 332         NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
 333                                  TALLOC_CTX *mem_ctx,
 334                                  uint32 group_rid, uint32 member_rid);
 335
 336         NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
 337                                  TALLOC_CTX *mem_ctx,
 338                                  uint32 group_rid, uint32 member_rid);
 339
 340         NTSTATUS (*create_alias)(struct pdb_methods *methods,
 341                                  const char *name, uint32 *rid);
 342
 343         NTSTATUS (*delete_alias)(struct pdb_methods *methods,
 344                                  const DOM_SID *sid);
 345
 346         NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
 347                                   const DOM_SID *sid,
 348                                   struct acct_info *info);
 349
 350         NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
 351                                   const DOM_SID *sid,
 352                                   struct acct_info *info);
 353
 354         NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
 355                                  const DOM_SID *alias, const DOM_SID *member);
 356         NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
 357                                  const DOM_SID *alias, const DOM_SID *member);
 358         NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
 359                                   const DOM_SID *alias, TALLOC_CTX *mem_ctx,
 360                                   DOM_SID **members, size_t *p_num_members);
 361         NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
 362                                            TALLOC_CTX *mem_ctx,
 363                                            const DOM_SID *domain_sid,
 364                                            const DOM_SID *members,
 365                                            size_t num_members,
 366                                            uint32 **pp_alias_rids,
 367                                            size_t *p_num_alias_rids);
 368
 369         NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
 370                                 const DOM_SID *domain_sid,
 371                                 int num_rids,
 372                                 uint32 *rids,
 373                                 const char **pp_names,
 374                                 enum lsa_SidType *attrs);
 375
 376         NTSTATUS (*lookup_names)(struct pdb_methods *methods,
 377                                  const DOM_SID *domain_sid,
 378                                  int num_names,
 379                                  const char **pp_names,
 380                                  uint32 *rids,
 381                                  enum lsa_SidType *attrs);
 382
 383         NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
 384                                        enum pdb_policy_type type,
 385                                        uint32_t *value);
 386
 387         NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
 388                                        enum pdb_policy_type type,
 389                                        uint32_t value);
 390
 391         NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
 392
 393         bool (*search_users)(struct pdb_methods *methods,
 394                              struct pdb_search *search,
 395                              uint32 acct_flags);
 396         bool (*search_groups)(struct pdb_methods *methods,
 397                               struct pdb_search *search);
 398         bool (*search_aliases)(struct pdb_methods *methods,
 399                                struct pdb_search *search,
 400                                const DOM_SID *sid);
 401
 402         bool (*uid_to_sid)(struct pdb_methods *methods, uid_t uid,
 403                            DOM_SID *sid);
 404         bool (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
 405                            DOM_SID *sid);
 406         bool (*sid_to_id)(struct pdb_methods *methods, const DOM_SID *sid,
 407                           union unid_t *id, enum lsa_SidType *type);
 408
 409         uint32_t (*capabilities)(struct pdb_methods *methods);
 410         bool (*new_rid)(struct pdb_methods *methods, uint32 *rid);
 411
 412
 413         bool (*get_trusteddom_pw)(struct pdb_methods *methods,
 414                                   const char *domain, char** pwd,
 415                                   DOM_SID *sid, time_t *pass_last_set_time);
 416         bool (*set_trusteddom_pw)(struct pdb_methods *methods,
 417                                   const char* domain, const char* pwd,
 418                                   const DOM_SID *sid);
 419         bool (*del_trusteddom_pw)(struct pdb_methods *methods,
 420                                   const char *domain);
 421         NTSTATUS (*enum_trusteddoms)(struct pdb_methods *methods,
 422                                      TALLOC_CTX *mem_ctx, uint32 *num_domains,
 423                                      struct trustdom_info ***domains);
 424
 425         void *private_data;  /* Private data of some kind */
 426
 427         void (*free_private_data)(void **);
 428 };
 429
 430 typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
 431
 432 struct pdb_init_function_entry {
 433         const char *name;
 434
 435         /* Function to create a member of the pdb_methods list */
 436         pdb_init_function init;
 437
 438         struct pdb_init_function_entry *prev, *next;
 439 };
 440
 441 #endif /* _PASSDB_H */