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