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