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