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