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 /*
  28  * fields_present flags meanings
  29  * same names as found in samba4 idl files
  30  */
  31
  32 #define ACCT_USERNAME           0x00000001
  33 #define ACCT_FULL_NAME          0x00000002
  34 #define ACCT_RID                0x00000004
  35 #define ACCT_PRIMARY_GID        0x00000008
  36 #define ACCT_DESCRIPTION        0x00000010
  37 #define ACCT_COMMENT            0x00000020
  38 #define ACCT_HOME_DIR           0x00000040
  39 #define ACCT_HOME_DRIVE         0x00000080
  40 #define ACCT_LOGON_SCRIPT       0x00000100
  41 #define ACCT_PROFILE            0x00000200
  42 #define ACCT_WORKSTATIONS       0x00000400
  43 #define ACCT_LAST_LOGON         0x00000800
  44 #define ACCT_LAST_LOGOFF        0x00001000
  45 #define ACCT_LOGON_HOURS        0x00002000
  46 #define ACCT_BAD_PWD_COUNT      0x00004000
  47 #define ACCT_NUM_LOGONS         0x00008000
  48 #define ACCT_ALLOW_PWD_CHANGE   0x00010000
  49 #define ACCT_FORCE_PWD_CHANGE   0x00020000
  50 #define ACCT_LAST_PWD_CHANGE    0x00040000
  51 #define ACCT_EXPIRY             0x00080000
  52 #define ACCT_FLAGS              0x00100000
  53 #define ACCT_CALLBACK           0x00200000
  54 #define ACCT_COUNTRY_CODE       0x00400000
  55 #define ACCT_CODE_PAGE          0x00800000
  56 #define ACCT_NT_PWD_SET         0x01000000
  57 #define ACCT_LM_PWD_SET         0x02000000
  58 #define ACCT_PRIVATEDATA        0x04000000
  59 #define ACCT_EXPIRED_FLAG       0x08000000
  60 #define ACCT_SEC_DESC           0x10000000
  61 #define ACCT_OWF_PWD            0x20000000
  62
  63 /*
  64  * bit flags representing initialized fields in struct samu
  65  */
  66 enum pdb_elements {
  67         PDB_UNINIT,
  68         PDB_SMBHOME,
  69         PDB_PROFILE,
  70         PDB_DRIVE,
  71         PDB_LOGONSCRIPT,
  72         PDB_LOGONTIME,
  73         PDB_LOGOFFTIME,
  74         PDB_KICKOFFTIME,
  75         PDB_BAD_PASSWORD_TIME,
  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_COMMENT,
  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_PWHISTORY,
 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
 119 enum pdb_value_state {
 120         PDB_DEFAULT=0,
 121         PDB_SET,
 122         PDB_CHANGED
 123 };
 124
 125 #define IS_SAM_SET(x, flag)     (pdb_get_init_flags(x, flag) == PDB_SET)
 126 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
 127 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
 128
 129 /* cache for bad password lockout data, to be used on replicated SAMs */
 130 typedef struct logon_cache_struct {
 131         time_t entry_timestamp;
 132         uint32 acct_ctrl;
 133         uint16 bad_password_count;
 134         time_t bad_password_time;
 135 } LOGIN_CACHE;
 136
 137 struct samu {
 138         struct pdb_methods *methods;
 139
 140         /* initialization flags */
 141         struct bitmap *change_flags;
 142         struct bitmap *set_flags;
 143
 144         time_t logon_time;            /* logon time */
 145         time_t logoff_time;           /* logoff time */
 146         time_t kickoff_time;          /* kickoff time */
 147         time_t bad_password_time;     /* last bad password entered */
 148         time_t pass_last_set_time;    /* password last set time */
 149         time_t pass_can_change_time;  /* password can change time */
 150         time_t pass_must_change_time; /* password must change time */
 151
 152         const char *username;     /* UNIX username string */
 153         const char *domain;       /* Windows Domain name */
 154         const char *nt_username;  /* Windows username string */
 155         const char *full_name;    /* user's full name string */
 156         const char *home_dir;     /* home directory string */
 157         const char *dir_drive;    /* home directory drive string */
 158         const char *logon_script; /* logon script string */
 159         const char *profile_path; /* profile path string */
 160         const char *acct_desc;    /* user description string */
 161         const char *workstations; /* login from workstations string */
 162         const char *comment;
 163         const char *munged_dial;  /* munged path name and dial-back tel number */
 164
 165         DOM_SID user_sid;
 166         DOM_SID *group_sid;
 167
 168         DATA_BLOB lm_pw; /* .data is Null if no password */
 169         DATA_BLOB nt_pw; /* .data is Null if no password */
 170         DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
 171         char* plaintext_pw; /* is Null if not available */
 172
 173         uint32 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
 174         uint32 fields_present; /* 0x00ff ffff */
 175
 176         uint16 logon_divs; /* 168 - number of hours in a week */
 177         uint32 hours_len; /* normally 21 bytes */
 178         uint8 hours[MAX_HOURS_LEN];
 179
 180         /* Was unknown_5. */
 181         uint16 bad_password_count;
 182         uint16 logon_count;
 183
 184         uint32 unknown_6; /* 0x0000 04ec */
 185
 186         /* a tag for who added the private methods */
 187
 188         const struct pdb_methods *backend_private_methods;
 189         void *backend_private_data;
 190         void (*backend_private_data_free_fn)(void **);
 191
 192         /* maintain a copy of the user's struct passwd */
 193
 194         struct passwd *unix_pw;
 195 };
 196
 197 struct acct_info {
 198         fstring acct_name; /* account name */
 199         fstring acct_desc; /* account name */
 200         uint32 rid; /* domain-relative RID */
 201 };
 202
 203 struct samr_displayentry {
 204         uint32 idx;
 205         uint32 rid;
 206         uint32 acct_flags;
 207         const char *account_name;
 208         const char *fullname;
 209         const char *description;
 210 };
 211
 212 enum pdb_search_type {
 213         PDB_USER_SEARCH,
 214         PDB_GROUP_SEARCH,
 215         PDB_ALIAS_SEARCH
 216 };
 217
 218 struct pdb_search {
 219         TALLOC_CTX *mem_ctx;
 220         enum pdb_search_type type;
 221         struct samr_displayentry *cache;
 222         uint32 num_entries;
 223         ssize_t cache_size;
 224         bool search_ended;
 225         void *private_data;
 226         bool (*next_entry)(struct pdb_search *search,
 227                            struct samr_displayentry *entry);
 228         void (*search_end)(struct pdb_search *search);
 229 };
 230
 231 /*****************************************************************
 232  Functions to be implemented by the new (v2) passdb API
 233 ****************************************************************/
 234
 235 /*
 236  * This next constant specifies the version number of the PASSDB interface
 237  * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
 238  * Changed interface to fix int -> size_t problems. JRA.
 239  * There's no point in allocating arrays in
 240  * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
 241  * the pdb module. Remove the latter, this might happen more often. VL.
 242  * changed to version 14 to move lookup_rids and lookup_names to return
 243  * enum lsa_SidType rather than uint32.
 244  * Changed to 16 for access to the trusted domain passwords (obnox).
 245  * Changed to 17, the sampwent interface is gone.
 246  */
 247
 248 #define PASSDB_INTERFACE_VERSION 17
 249
 250 struct pdb_methods
 251 {
 252         const char *name; /* What name got this module */
 253
 254         NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
 255
 256         NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const DOM_SID *sid);
 257
 258         NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
 259                                 const char *name, uint32 acct_flags,
 260                                 uint32 *rid);
 261
 262         NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
 263                                 struct samu *sam_acct);
 264
 265         NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
 266
 267         NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
 268
 269         NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
 270
 271         NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
 272
 273         NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
 274
 275         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
 276
 277         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
 278
 279         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
 280
 281         NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
 282                                      TALLOC_CTX *mem_ctx, const char *name,
 283                                      uint32 *rid);
 284
 285         NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
 286                                      TALLOC_CTX *mem_ctx, uint32 rid);
 287
 288         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
 289                                             GROUP_MAP *map);
 290
 291         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
 292                                                GROUP_MAP *map);
 293
 294         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
 295                                                DOM_SID sid);
 296
 297         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
 298                                        const DOM_SID *sid, enum lsa_SidType sid_name_use,
 299                                        GROUP_MAP **pp_rmap, size_t *p_num_entries,
 300                                        bool unix_only);
 301
 302         NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
 303                                        TALLOC_CTX *mem_ctx,
 304                                        const DOM_SID *group,
 305                                        uint32 **pp_member_rids,
 306                                        size_t *p_num_members);
 307
 308         NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
 309                                            TALLOC_CTX *mem_ctx,
 310                                            struct samu *user,
 311                                            DOM_SID **pp_sids, gid_t **pp_gids,
 312                                            size_t *p_num_groups);
 313
 314         NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
 315                                            TALLOC_CTX *mem_ctx,
 316                                            struct samu *user);
 317
 318         NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
 319                                  TALLOC_CTX *mem_ctx,
 320                                  uint32 group_rid, uint32 member_rid);
 321
 322         NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
 323                                  TALLOC_CTX *mem_ctx,
 324                                  uint32 group_rid, uint32 member_rid);
 325
 326         NTSTATUS (*create_alias)(struct pdb_methods *methods,
 327                                  const char *name, uint32 *rid);
 328
 329         NTSTATUS (*delete_alias)(struct pdb_methods *methods,
 330                                  const DOM_SID *sid);
 331
 332         NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
 333                                   const DOM_SID *sid,
 334                                   struct acct_info *info);
 335
 336         NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
 337                                   const DOM_SID *sid,
 338                                   struct acct_info *info);
 339
 340         NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
 341                                  const DOM_SID *alias, const DOM_SID *member);
 342         NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
 343                                  const DOM_SID *alias, const DOM_SID *member);
 344         NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
 345                                   const DOM_SID *alias, DOM_SID **members,
 346                                   size_t *p_num_members);
 347         NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
 348                                            TALLOC_CTX *mem_ctx,
 349                                            const DOM_SID *domain_sid,
 350                                            const DOM_SID *members,
 351                                            size_t num_members,
 352                                            uint32 **pp_alias_rids,
 353                                            size_t *p_num_alias_rids);
 354
 355         NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
 356                                 const DOM_SID *domain_sid,
 357                                 int num_rids,
 358                                 uint32 *rids,
 359                                 const char **pp_names,
 360                                 enum lsa_SidType *attrs);
 361
 362         NTSTATUS (*lookup_names)(struct pdb_methods *methods,
 363                                  const DOM_SID *domain_sid,
 364                                  int num_names,
 365                                  const char **pp_names,
 366                                  uint32 *rids,
 367                                  enum lsa_SidType *attrs);
 368
 369         NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
 370                                        int policy_index, uint32 *value);
 371
 372         NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
 373                                        int policy_index, uint32 value);
 374
 375         NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
 376
 377         bool (*search_users)(struct pdb_methods *methods,
 378                              struct pdb_search *search,
 379                              uint32 acct_flags);
 380         bool (*search_groups)(struct pdb_methods *methods,
 381                               struct pdb_search *search);
 382         bool (*search_aliases)(struct pdb_methods *methods,
 383                                struct pdb_search *search,
 384                                const DOM_SID *sid);
 385
 386         bool (*uid_to_rid)(struct pdb_methods *methods, uid_t uid,
 387                            uint32 *rid);
 388         bool (*uid_to_sid)(struct pdb_methods *methods, uid_t uid,
 389                            DOM_SID *sid);
 390         bool (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
 391                            DOM_SID *sid);
 392         bool (*sid_to_id)(struct pdb_methods *methods, const DOM_SID *sid,
 393                           union unid_t *id, enum lsa_SidType *type);
 394
 395         bool (*rid_algorithm)(struct pdb_methods *methods);
 396         bool (*new_rid)(struct pdb_methods *methods, uint32 *rid);
 397
 398
 399         bool (*get_trusteddom_pw)(struct pdb_methods *methods,
 400                                   const char *domain, char** pwd,
 401                                   DOM_SID *sid, time_t *pass_last_set_time);
 402         bool (*set_trusteddom_pw)(struct pdb_methods *methods,
 403                                   const char* domain, const char* pwd,
 404                                   const DOM_SID *sid);
 405         bool (*del_trusteddom_pw)(struct pdb_methods *methods,
 406                                   const char *domain);
 407         NTSTATUS (*enum_trusteddoms)(struct pdb_methods *methods,
 408                                      TALLOC_CTX *mem_ctx, uint32 *num_domains,
 409                                      struct trustdom_info ***domains);
 410
 411         void *private_data;  /* Private data of some kind */
 412
 413         void (*free_private_data)(void **);
 414 };
 415
 416 typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
 417
 418 struct pdb_init_function_entry {
 419         const char *name;
 420
 421         /* Function to create a member of the pdb_methods list */
 422         pdb_init_function init;
 423
 424         struct pdb_init_function_entry *prev, *next;
 425 };
 426
 427 #endif /* _PASSDB_H */