lib/param: Rename "socket address" to "nbt client socket address" to clarify role
[kai/samba.git] / 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 #ifndef NT_HASH_LEN
27 #define NT_HASH_LEN 16
28 #endif
29
30 #ifndef LM_HASH_LEN
31 #define LM_HASH_LEN 16
32 #endif
33
34 #include "../librpc/gen_ndr/lsa.h"
35 #include <tevent.h>
36 struct unixid;
37
38 /* group mapping headers */
39
40 #define ENUM_ONLY_MAPPED True
41 #define ENUM_ALL_MAPPED False
42
43 typedef struct _GROUP_MAP {
44         struct pdb_methods *methods;
45         gid_t gid;
46         struct dom_sid sid;
47         enum lsa_SidType sid_name_use;
48         char *nt_name;
49         char *comment;
50 } GROUP_MAP;
51
52 struct acct_info {
53         char *acct_name; /* account name */
54         char *acct_desc; /* account name */
55         uint32_t rid; /* domain-relative RID */
56 };
57
58 /* The following definitions come from groupdb/mapping.c  */
59
60 NTSTATUS add_initial_entry(gid_t gid, const char *sid, enum lsa_SidType sid_name_use, const char *nt_name, const char *comment);
61 bool get_domain_group_from_sid(struct dom_sid sid, GROUP_MAP *map);
62 int smb_create_group(const char *unix_group, gid_t *new_gid);
63 int smb_delete_group(const char *unix_group);
64 int smb_set_primary_group(const char *unix_group, const char* unix_user);
65 int smb_add_user_group(const char *unix_group, const char *unix_user);
66 int smb_delete_user_group(const char *unix_group, const char *unix_user);
67 NTSTATUS pdb_default_getgrsid(struct pdb_methods *methods, GROUP_MAP *map,
68                                  struct dom_sid sid);
69 NTSTATUS pdb_default_getgrgid(struct pdb_methods *methods, GROUP_MAP *map,
70                                  gid_t gid);
71 NTSTATUS pdb_default_getgrnam(struct pdb_methods *methods, GROUP_MAP *map,
72                                  const char *name);
73 NTSTATUS pdb_default_add_group_mapping_entry(struct pdb_methods *methods,
74                                                 GROUP_MAP *map);
75 NTSTATUS pdb_default_update_group_mapping_entry(struct pdb_methods *methods,
76                                                    GROUP_MAP *map);
77 NTSTATUS pdb_default_delete_group_mapping_entry(struct pdb_methods *methods,
78                                                    struct dom_sid sid);
79 NTSTATUS pdb_default_enum_group_mapping(struct pdb_methods *methods,
80                                         const struct dom_sid *sid,
81                                         enum lsa_SidType sid_name_use,
82                                         GROUP_MAP ***pp_rmap,
83                                         size_t *p_num_entries,
84                                         bool unix_only);
85 NTSTATUS pdb_default_create_alias(struct pdb_methods *methods,
86                                   const char *name, uint32_t *rid);
87 NTSTATUS pdb_default_delete_alias(struct pdb_methods *methods,
88                                   const struct dom_sid *sid);
89 NTSTATUS pdb_default_get_aliasinfo(struct pdb_methods *methods,
90                                    const struct dom_sid *sid,
91                                    struct acct_info *info);
92 NTSTATUS pdb_default_set_aliasinfo(struct pdb_methods *methods,
93                                    const struct dom_sid *sid,
94                                    struct acct_info *info);
95 NTSTATUS pdb_default_add_aliasmem(struct pdb_methods *methods,
96                                   const struct dom_sid *alias, const struct dom_sid *member);
97 NTSTATUS pdb_default_del_aliasmem(struct pdb_methods *methods,
98                                   const struct dom_sid *alias, const struct dom_sid *member);
99 NTSTATUS pdb_default_enum_aliasmem(struct pdb_methods *methods,
100                                    const struct dom_sid *alias, TALLOC_CTX *mem_ctx,
101                                    struct dom_sid **pp_members,
102                                    size_t *p_num_members);
103 NTSTATUS pdb_default_alias_memberships(struct pdb_methods *methods,
104                                        TALLOC_CTX *mem_ctx,
105                                        const struct dom_sid *domain_sid,
106                                        const struct dom_sid *members,
107                                        size_t num_members,
108                                        uint32_t **pp_alias_rids,
109                                        size_t *p_num_alias_rids);
110 NTSTATUS pdb_nop_getgrsid(struct pdb_methods *methods, GROUP_MAP *map,
111                                  struct dom_sid sid);
112 NTSTATUS pdb_nop_getgrgid(struct pdb_methods *methods, GROUP_MAP *map,
113                                  gid_t gid);
114 NTSTATUS pdb_nop_getgrnam(struct pdb_methods *methods, GROUP_MAP *map,
115                                  const char *name);
116 NTSTATUS pdb_nop_add_group_mapping_entry(struct pdb_methods *methods,
117                                                 GROUP_MAP *map);
118 NTSTATUS pdb_nop_update_group_mapping_entry(struct pdb_methods *methods,
119                                                    GROUP_MAP *map);
120 NTSTATUS pdb_nop_delete_group_mapping_entry(struct pdb_methods *methods,
121                                                    struct dom_sid sid);
122 NTSTATUS pdb_nop_enum_group_mapping(struct pdb_methods *methods,
123                                            enum lsa_SidType sid_name_use,
124                                            GROUP_MAP **rmap, size_t *num_entries,
125                                            bool unix_only);
126 NTSTATUS pdb_create_builtin_alias(uint32_t rid);
127
128
129 /* passdb headers */
130
131 /**********************************************************************
132  * Masks for mappings between unix uid and gid types and
133  * NT RIDS.
134  **********************************************************************/
135
136 /* Take the bottom bit. */
137 #define RID_TYPE_MASK           1
138 #define RID_MULTIPLIER          2
139
140 /* The two common types. */
141 #define USER_RID_TYPE           0
142 #define GROUP_RID_TYPE          1
143
144 /*
145  * Flags for local user manipulation.
146  */
147
148 #define LOCAL_ADD_USER 0x1
149 #define LOCAL_DELETE_USER 0x2
150 #define LOCAL_DISABLE_USER 0x4
151 #define LOCAL_ENABLE_USER 0x8
152 #define LOCAL_TRUST_ACCOUNT 0x10
153 #define LOCAL_SET_NO_PASSWORD 0x20
154 #define LOCAL_SET_PASSWORD 0x40
155 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
156 #define LOCAL_INTERDOM_ACCOUNT 0x100
157 #define LOCAL_AM_ROOT 0x200  /* Act as root */
158
159 /*
160  * Size of new password account encoding string.  This is enough space to
161  * hold 11 ACB characters, plus the surrounding [] and a terminating null.
162  * Do not change unless you are adding new ACB bits!
163  */
164
165 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
166
167 /* Password history contants. */
168 #define PW_HISTORY_SALT_LEN 16
169 #define SALTED_MD5_HASH_LEN 16
170 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
171 #define MAX_PW_HISTORY_LEN 24
172
173 /*
174  * bit flags representing initialized fields in struct samu
175  */
176 enum pdb_elements {
177         PDB_UNINIT,
178         PDB_SMBHOME,
179         PDB_PROFILE,
180         PDB_DRIVE,
181         PDB_LOGONSCRIPT,
182         PDB_LOGONTIME,
183         PDB_LOGOFFTIME,
184         PDB_KICKOFFTIME,
185         PDB_BAD_PASSWORD_TIME,
186         PDB_CANCHANGETIME,
187         PDB_PLAINTEXT_PW,
188         PDB_USERNAME,
189         PDB_FULLNAME,
190         PDB_DOMAIN,
191         PDB_NTUSERNAME,
192         PDB_HOURSLEN,
193         PDB_LOGONDIVS,
194         PDB_USERSID,
195         PDB_GROUPSID,
196         PDB_ACCTCTRL,
197         PDB_PASSLASTSET,
198         PDB_ACCTDESC,
199         PDB_WORKSTATIONS,
200         PDB_COMMENT,
201         PDB_MUNGEDDIAL,
202         PDB_HOURS,
203         PDB_FIELDS_PRESENT,
204         PDB_BAD_PASSWORD_COUNT,
205         PDB_LOGON_COUNT,
206         PDB_COUNTRY_CODE,
207         PDB_CODE_PAGE,
208         PDB_UNKNOWN6,
209         PDB_LMPASSWD,
210         PDB_NTPASSWD,
211         PDB_PWHISTORY,
212         PDB_BACKEND_PRIVATE_DATA,
213
214         /* this must be the last element */
215         PDB_COUNT
216 };
217
218 enum pdb_group_elements {
219         PDB_GROUP_NAME,
220         PDB_GROUP_SID,
221         PDB_GROUP_SID_NAME_USE,
222         PDB_GROUP_MEMBERS,
223
224         /* this must be the last element */
225         PDB_GROUP_COUNT
226 };
227
228
229 enum pdb_value_state {
230         PDB_DEFAULT=0,
231         PDB_SET,
232         PDB_CHANGED
233 };
234
235 #define IS_SAM_SET(x, flag)     (pdb_get_init_flags(x, flag) == PDB_SET)
236 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
237 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
238
239 /* cache for bad password lockout data, to be used on replicated SAMs */
240 struct login_cache {
241         time_t entry_timestamp;
242         uint32_t acct_ctrl;
243         uint16_t bad_password_count;
244         time_t bad_password_time;
245 };
246
247 #define SAMU_BUFFER_V0          0
248 #define SAMU_BUFFER_V1          1
249 #define SAMU_BUFFER_V2          2
250 #define SAMU_BUFFER_V3          3
251 /* nothing changed from V3 to V4 */
252 #define SAMU_BUFFER_V4          4
253 #define SAMU_BUFFER_LATEST      SAMU_BUFFER_V4
254
255 #define MAX_HOURS_LEN 32
256
257 struct samu {
258         struct pdb_methods *methods;
259
260         /* initialization flags */
261         struct bitmap *change_flags;
262         struct bitmap *set_flags;
263
264         time_t logon_time;            /* logon time */
265         time_t logoff_time;           /* logoff time */
266         time_t kickoff_time;          /* kickoff time */
267         time_t bad_password_time;     /* last bad password entered */
268         time_t pass_last_set_time;    /* password last set time */
269         time_t pass_can_change_time;  /* password can change time */
270
271         const char *username;     /* UNIX username string */
272         const char *domain;       /* Windows Domain name */
273         const char *nt_username;  /* Windows username string */
274         const char *full_name;    /* user's full name string */
275         const char *home_dir;     /* home directory string */
276         const char *dir_drive;    /* home directory drive string */
277         const char *logon_script; /* logon script string */
278         const char *profile_path; /* profile path string */
279         const char *acct_desc;    /* user description string */
280         const char *workstations; /* login from workstations string */
281         const char *comment;
282         const char *munged_dial;  /* munged path name and dial-back tel number */
283
284         struct dom_sid user_sid;
285         struct dom_sid *group_sid;
286
287         DATA_BLOB lm_pw; /* .data is Null if no password */
288         DATA_BLOB nt_pw; /* .data is Null if no password */
289         DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
290         char* plaintext_pw; /* is Null if not available */
291
292         uint32_t acct_ctrl; /* account info (ACB_xxxx bit-mask) */
293         uint32_t fields_present; /* 0x00ff ffff */
294
295         uint16_t logon_divs; /* 168 - number of hours in a week */
296         uint32_t hours_len; /* normally 21 bytes */
297         uint8_t hours[MAX_HOURS_LEN];
298
299         /* Was unknown_5. */
300         uint16_t bad_password_count;
301         uint16_t logon_count;
302
303         uint16_t country_code;
304         uint16_t code_page;
305
306         uint32_t unknown_6; /* 0x0000 04ec */
307
308         /* a tag for who added the private methods */
309
310         const struct pdb_methods *backend_private_methods;
311         void *backend_private_data; 
312         void (*backend_private_data_free_fn)(void **);
313
314         /* maintain a copy of the user's struct passwd */
315
316         struct passwd *unix_pw;
317 };
318
319 struct samr_displayentry {
320         uint32_t idx;
321         uint32_t rid;
322         uint32_t acct_flags;
323         const char *account_name;
324         const char *fullname;
325         const char *description;
326 };
327
328 enum pdb_search_type {
329         PDB_USER_SEARCH,
330         PDB_GROUP_SEARCH,
331         PDB_ALIAS_SEARCH
332 };
333
334 struct pdb_search {
335         enum pdb_search_type type;
336         struct samr_displayentry *cache;
337         uint32_t num_entries;
338         ssize_t cache_size;
339         bool search_ended;
340         void *private_data;
341         bool (*next_entry)(struct pdb_search *search,
342                            struct samr_displayentry *entry);
343         void (*search_end)(struct pdb_search *search);
344 };
345
346 struct pdb_domain_info {
347         char *name;
348         char *dns_domain;
349         char *dns_forest;
350         struct dom_sid sid;
351         struct GUID guid;
352 };
353
354 struct pdb_trusted_domain {
355         char *domain_name;
356         char *netbios_name;
357         struct dom_sid security_identifier;
358         DATA_BLOB trust_auth_incoming;
359         DATA_BLOB trust_auth_outgoing;
360         uint32_t trust_direction;
361         uint32_t trust_type;
362         uint32_t trust_attributes;
363         uint32_t *trust_posix_offset;
364         uint32_t *supported_enc_type;
365         DATA_BLOB trust_forest_trust_info;
366 };
367
368 /*
369  * trusted domain entry/entries returned by secrets_get_trusted_domains
370  * (used in _lsa_enum_trust_dom call)
371  */
372 struct trustdom_info {
373         char *name;
374         struct dom_sid sid;
375 };
376
377 /*
378  * Types of account policy.
379  */
380 enum pdb_policy_type {
381         PDB_POLICY_MIN_PASSWORD_LEN = 1,
382         PDB_POLICY_PASSWORD_HISTORY = 2,
383         PDB_POLICY_USER_MUST_LOGON_TO_CHG_PASS  = 3,
384         PDB_POLICY_MAX_PASSWORD_AGE = 4,
385         PDB_POLICY_MIN_PASSWORD_AGE = 5,
386         PDB_POLICY_LOCK_ACCOUNT_DURATION = 6,
387         PDB_POLICY_RESET_COUNT_TIME = 7,
388         PDB_POLICY_BAD_ATTEMPT_LOCKOUT = 8,
389         PDB_POLICY_TIME_TO_LOGOUT = 9,
390         PDB_POLICY_REFUSE_MACHINE_PW_CHANGE = 10
391 };
392
393 #define PDB_CAP_STORE_RIDS              0x0001
394 #define PDB_CAP_ADS                     0x0002
395 #define PDB_CAP_TRUSTED_DOMAINS_EX      0x0004
396
397 /*****************************************************************
398  Functions to be implemented by the new (v2) passdb API 
399 ****************************************************************/
400
401 /*
402  * This next constant specifies the version number of the PASSDB interface
403  * this SAMBA will load. Increment this if *ANY* changes are made to the interface. 
404  * Changed interface to fix int -> size_t problems. JRA.
405  * There's no point in allocating arrays in
406  * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
407  * the pdb module. Remove the latter, this might happen more often. VL.
408  * changed to version 14 to move lookup_rids and lookup_names to return
409  * enum lsa_SidType rather than uint32_t.
410  * Changed to 16 for access to the trusted domain passwords (obnox).
411  * Changed to 17, the sampwent interface is gone.
412  * Changed to 18, pdb_rid_algorithm -> pdb_capabilities
413  * Changed to 19, removed uid_to_rid
414  * Changed to 20, pdb_secret calls
415  */
416
417 #define PASSDB_INTERFACE_VERSION 20
418
419 struct pdb_methods 
420 {
421         const char *name; /* What name got this module */
422
423         struct pdb_domain_info *(*get_domain_info)(struct pdb_methods *,
424                                                    TALLOC_CTX *mem_ctx);
425
426         NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
427
428         NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const struct dom_sid *sid);
429
430         NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
431                                 const char *name, uint32_t acct_flags,
432                                 uint32_t *rid);
433
434         NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
435                                 struct samu *sam_acct);
436
437         NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
438
439         NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
440
441         NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
442
443         NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
444
445         NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
446
447         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, struct dom_sid sid);
448
449         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
450
451         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
452
453         NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
454                                      TALLOC_CTX *mem_ctx, const char *name,
455                                      uint32_t *rid);
456
457         NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
458                                      TALLOC_CTX *mem_ctx, uint32_t rid);
459
460         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
461                                             GROUP_MAP *map);
462
463         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
464                                                GROUP_MAP *map);
465
466         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
467                                                struct dom_sid sid);
468
469         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
470                                        const struct dom_sid *sid, enum lsa_SidType sid_name_use,
471                                        GROUP_MAP ***pp_rmap, size_t *p_num_entries,
472                                        bool unix_only);
473
474         NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
475                                        TALLOC_CTX *mem_ctx,
476                                        const struct dom_sid *group,
477                                        uint32_t **pp_member_rids,
478                                        size_t *p_num_members);
479
480         NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
481                                            TALLOC_CTX *mem_ctx,
482                                            struct samu *user,
483                                            struct dom_sid **pp_sids, gid_t **pp_gids,
484                                            uint32_t *p_num_groups);
485
486         NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
487                                            TALLOC_CTX *mem_ctx,
488                                            struct samu *user);
489
490         NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
491                                  TALLOC_CTX *mem_ctx,
492                                  uint32_t group_rid, uint32_t member_rid);
493
494         NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
495                                  TALLOC_CTX *mem_ctx,
496                                  uint32_t group_rid, uint32_t member_rid);
497
498         NTSTATUS (*create_alias)(struct pdb_methods *methods,
499                                  const char *name, uint32_t *rid);
500
501         NTSTATUS (*delete_alias)(struct pdb_methods *methods,
502                                  const struct dom_sid *sid);
503
504         NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
505                                   const struct dom_sid *sid,
506                                   struct acct_info *info);
507
508         NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
509                                   const struct dom_sid *sid,
510                                   struct acct_info *info);
511
512         NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
513                                  const struct dom_sid *alias, const struct dom_sid *member);
514         NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
515                                  const struct dom_sid *alias, const struct dom_sid *member);
516         NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
517                                   const struct dom_sid *alias, TALLOC_CTX *mem_ctx,
518                                   struct dom_sid **members, size_t *p_num_members);
519         NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
520                                            TALLOC_CTX *mem_ctx,
521                                            const struct dom_sid *domain_sid,
522                                            const struct dom_sid *members,
523                                            size_t num_members,
524                                            uint32_t **pp_alias_rids,
525                                            size_t *p_num_alias_rids);
526
527         NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
528                                 const struct dom_sid *domain_sid,
529                                 int num_rids,
530                                 uint32_t *rids,
531                                 const char **pp_names,
532                                 enum lsa_SidType *attrs);
533
534         NTSTATUS (*lookup_names)(struct pdb_methods *methods,
535                                  const struct dom_sid *domain_sid,
536                                  int num_names,
537                                  const char **pp_names,
538                                  uint32_t *rids,
539                                  enum lsa_SidType *attrs);
540
541         NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
542                                        enum pdb_policy_type type,
543                                        uint32_t *value);
544
545         NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
546                                        enum pdb_policy_type type,
547                                        uint32_t value);
548
549         NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
550
551         bool (*search_users)(struct pdb_methods *methods,
552                              struct pdb_search *search,
553                              uint32_t acct_flags);
554         bool (*search_groups)(struct pdb_methods *methods,
555                               struct pdb_search *search);
556         bool (*search_aliases)(struct pdb_methods *methods,
557                                struct pdb_search *search,
558                                const struct dom_sid *sid);
559
560         bool (*uid_to_sid)(struct pdb_methods *methods, uid_t uid,
561                            struct dom_sid *sid);
562         bool (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
563                            struct dom_sid *sid);
564         bool (*sid_to_id)(struct pdb_methods *methods, const struct dom_sid *sid,
565                           struct unixid *id);
566
567         uint32_t (*capabilities)(struct pdb_methods *methods);
568         bool (*new_rid)(struct pdb_methods *methods, uint32_t *rid);
569
570
571         bool (*get_trusteddom_pw)(struct pdb_methods *methods,
572                                   const char *domain, char** pwd, 
573                                   struct dom_sid *sid, time_t *pass_last_set_time);
574         bool (*set_trusteddom_pw)(struct pdb_methods *methods, 
575                                   const char* domain, const char* pwd,
576                                   const struct dom_sid *sid);
577         bool (*del_trusteddom_pw)(struct pdb_methods *methods, 
578                                   const char *domain);
579         NTSTATUS (*enum_trusteddoms)(struct pdb_methods *methods,
580                                      TALLOC_CTX *mem_ctx, uint32_t *num_domains,
581                                      struct trustdom_info ***domains);
582
583         NTSTATUS (*get_trusted_domain)(struct pdb_methods *methods,
584                                        TALLOC_CTX *mem_ctx,
585                                        const char *domain,
586                                        struct pdb_trusted_domain **td);
587         NTSTATUS (*get_trusted_domain_by_sid)(struct pdb_methods *methods,
588                                               TALLOC_CTX *mem_ctx,
589                                               struct dom_sid *sid,
590                                               struct pdb_trusted_domain **td);
591         NTSTATUS (*set_trusted_domain)(struct pdb_methods *methods,
592                                        const char* domain,
593                                        const struct pdb_trusted_domain *td);
594         NTSTATUS (*del_trusted_domain)(struct pdb_methods *methods,
595                                        const char *domain);
596         NTSTATUS (*enum_trusted_domains)(struct pdb_methods *methods,
597                                          TALLOC_CTX *mem_ctx,
598                                          uint32_t *num_domains,
599                                          struct pdb_trusted_domain ***domains);
600
601         NTSTATUS (*get_secret)(struct pdb_methods *methods,
602                                TALLOC_CTX *mem_ctx,
603                                const char *secret_name,
604                                DATA_BLOB *secret_current,
605                                NTTIME *secret_current_lastchange,
606                                DATA_BLOB *secret_old,
607                                NTTIME *secret_old_lastchange,
608                                struct security_descriptor **sd);
609         NTSTATUS (*set_secret)(struct pdb_methods *methods,
610                                const char *secret_name,
611                                DATA_BLOB *secret_current,
612                                DATA_BLOB *secret_old,
613                                struct security_descriptor *sd);
614         NTSTATUS (*delete_secret)(struct pdb_methods *methods,
615                                   const char *secret_name);
616
617         void *private_data;  /* Private data of some kind */
618
619         void (*free_private_data)(void **);
620 };
621
622 typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
623
624 struct pdb_init_function_entry {
625         const char *name;
626
627         /* Function to create a member of the pdb_methods list */
628         pdb_init_function init;
629
630         struct pdb_init_function_entry *prev, *next;
631 };
632
633 /* The following definitions come from passdb/account_pol.c  */
634
635 void account_policy_names_list(TALLOC_CTX *mem_ctx, const char ***names, int *num_names);
636 const char *decode_account_policy_name(enum pdb_policy_type type);
637 const char *get_account_policy_attr(enum pdb_policy_type type);
638 const char *account_policy_get_desc(enum pdb_policy_type type);
639 enum pdb_policy_type account_policy_name_to_typenum(const char *name);
640 bool account_policy_get_default(enum pdb_policy_type type, uint32_t *val);
641 bool init_account_policy(void);
642 bool account_policy_get(enum pdb_policy_type type, uint32_t *value);
643 bool account_policy_set(enum pdb_policy_type type, uint32_t value);
644 bool cache_account_policy_set(enum pdb_policy_type type, uint32_t value);
645 bool cache_account_policy_get(enum pdb_policy_type type, uint32_t *value);
646 struct db_context *get_account_pol_db( void );
647
648 /* The following definitions come from passdb/login_cache.c  */
649
650 bool login_cache_init(void);
651 bool login_cache_shutdown(void);
652 bool login_cache_read(struct samu *sampass, struct login_cache *entry);
653 bool login_cache_write(const struct samu *sampass,
654                        const struct login_cache *entry);
655 bool login_cache_delentry(const struct samu *sampass);
656
657 /* The following definitions come from passdb/passdb.c  */
658
659 const char *my_sam_name(void);
660 struct samu *samu_new( TALLOC_CTX *ctx );
661 NTSTATUS samu_set_unix(struct samu *user, const struct passwd *pwd);
662 NTSTATUS samu_alloc_rid_unix(struct pdb_methods *methods,
663                              struct samu *user, const struct passwd *pwd);
664 char *pdb_encode_acct_ctrl(uint32_t acct_ctrl, size_t length);
665 uint32_t pdb_decode_acct_ctrl(const char *p);
666 void pdb_sethexpwd(char p[33], const unsigned char *pwd, uint32_t acct_ctrl);
667 bool pdb_gethexpwd(const char *p, unsigned char *pwd);
668 void pdb_sethexhours(char *p, const unsigned char *hours);
669 bool pdb_gethexhours(const char *p, unsigned char *hours);
670 int algorithmic_rid_base(void);
671 uid_t algorithmic_pdb_user_rid_to_uid(uint32_t user_rid);
672 uid_t max_algorithmic_uid(void);
673 uint32_t algorithmic_pdb_uid_to_user_rid(uid_t uid);
674 gid_t pdb_group_rid_to_gid(uint32_t group_rid);
675 gid_t max_algorithmic_gid(void);
676 uint32_t algorithmic_pdb_gid_to_group_rid(gid_t gid);
677 bool algorithmic_pdb_rid_is_user(uint32_t rid);
678 bool lookup_global_sam_name(const char *name, int flags, uint32_t *rid,
679                             enum lsa_SidType *type);
680 NTSTATUS local_password_change(const char *user_name,
681                                 int local_flags,
682                                 const char *new_passwd,
683                                 char **pp_err_str,
684                                 char **pp_msg_str);
685 bool init_samu_from_buffer(struct samu *sampass, uint32_t level,
686                            uint8_t *buf, uint32_t buflen);
687 uint32_t init_buffer_from_samu (uint8_t **buf, struct samu *sampass, bool size_only);
688 bool pdb_copy_sam_account(struct samu *dst, struct samu *src );
689 bool pdb_update_bad_password_count(struct samu *sampass, bool *updated);
690 bool pdb_update_autolock_flag(struct samu *sampass, bool *updated);
691 bool pdb_increment_bad_password_count(struct samu *sampass);
692 bool is_dc_trusted_domain_situation(const char *domain_name);
693 bool get_trust_pw_clear(const char *domain, char **ret_pwd,
694                         const char **account_name,
695                         enum netr_SchannelType *channel);
696 bool get_trust_pw_hash(const char *domain, uint8_t ret_pwd[16],
697                        const char **account_name,
698                        enum netr_SchannelType *channel);
699
700 /* The following definitions come from passdb/pdb_compat.c  */
701
702 uint32_t pdb_get_user_rid (const struct samu *sampass);
703 uint32_t pdb_get_group_rid (struct samu *sampass);
704 bool pdb_set_user_sid_from_rid (struct samu *sampass, uint32_t rid, enum pdb_value_state flag);
705 bool pdb_set_group_sid_from_rid (struct samu *sampass, uint32_t grid, enum pdb_value_state flag);
706
707 /* The following definitions come from passdb/pdb_get_set.c  */
708
709 bool pdb_is_password_change_time_max(time_t test_time);
710 uint32_t pdb_get_acct_ctrl(const struct samu *sampass);
711 time_t pdb_get_logon_time(const struct samu *sampass);
712 time_t pdb_get_logoff_time(const struct samu *sampass);
713 time_t pdb_get_kickoff_time(const struct samu *sampass);
714 time_t pdb_get_bad_password_time(const struct samu *sampass);
715 time_t pdb_get_pass_last_set_time(const struct samu *sampass);
716 time_t pdb_get_pass_can_change_time(const struct samu *sampass);
717 time_t pdb_get_pass_can_change_time_noncalc(const struct samu *sampass);
718 time_t pdb_get_pass_must_change_time(const struct samu *sampass);
719 bool pdb_get_pass_can_change(const struct samu *sampass);
720 uint16_t pdb_get_logon_divs(const struct samu *sampass);
721 uint32_t pdb_get_hours_len(const struct samu *sampass);
722 const uint8_t *pdb_get_hours(const struct samu *sampass);
723 const uint8_t *pdb_get_nt_passwd(const struct samu *sampass);
724 const uint8_t *pdb_get_lanman_passwd(const struct samu *sampass);
725 const uint8_t *pdb_get_pw_history(const struct samu *sampass, uint32_t *current_hist_len);
726 const char *pdb_get_plaintext_passwd(const struct samu *sampass);
727 const struct dom_sid *pdb_get_user_sid(const struct samu *sampass);
728 const struct dom_sid *pdb_get_group_sid(struct samu *sampass);
729 enum pdb_value_state pdb_get_init_flags(const struct samu *sampass, enum pdb_elements element);
730 const char *pdb_get_username(const struct samu *sampass);
731 const char *pdb_get_domain(const struct samu *sampass);
732 const char *pdb_get_nt_username(const struct samu *sampass);
733 const char *pdb_get_fullname(const struct samu *sampass);
734 const char *pdb_get_homedir(const struct samu *sampass);
735 const char *pdb_get_dir_drive(const struct samu *sampass);
736 const char *pdb_get_logon_script(const struct samu *sampass);
737 const char *pdb_get_profile_path(const struct samu *sampass);
738 const char *pdb_get_acct_desc(const struct samu *sampass);
739 const char *pdb_get_workstations(const struct samu *sampass);
740 const char *pdb_get_comment(const struct samu *sampass);
741 const char *pdb_get_munged_dial(const struct samu *sampass);
742 uint16_t pdb_get_bad_password_count(const struct samu *sampass);
743 uint16_t pdb_get_logon_count(const struct samu *sampass);
744 uint16_t pdb_get_country_code(const struct samu *sampass);
745 uint16_t pdb_get_code_page(const struct samu *sampass);
746 uint32_t pdb_get_unknown_6(const struct samu *sampass);
747 void *pdb_get_backend_private_data(const struct samu *sampass, const struct pdb_methods *my_methods);
748 bool pdb_set_acct_ctrl(struct samu *sampass, uint32_t acct_ctrl, enum pdb_value_state flag);
749 bool pdb_set_logon_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
750 bool pdb_set_logoff_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
751 bool pdb_set_kickoff_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
752 bool pdb_set_bad_password_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
753 bool pdb_set_pass_can_change_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
754 bool pdb_set_pass_last_set_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
755 bool pdb_set_hours_len(struct samu *sampass, uint32_t len, enum pdb_value_state flag);
756 bool pdb_set_logon_divs(struct samu *sampass, uint16_t hours, enum pdb_value_state flag);
757 bool pdb_set_init_flags(struct samu *sampass, enum pdb_elements element, enum pdb_value_state value_flag);
758 bool pdb_set_user_sid(struct samu *sampass, const struct dom_sid *u_sid, enum pdb_value_state flag);
759 bool pdb_set_user_sid_from_string(struct samu *sampass, const char *u_sid, enum pdb_value_state flag);
760 bool pdb_set_group_sid(struct samu *sampass, const struct dom_sid *g_sid, enum pdb_value_state flag);
761 bool pdb_set_username(struct samu *sampass, const char *username, enum pdb_value_state flag);
762 bool pdb_set_domain(struct samu *sampass, const char *domain, enum pdb_value_state flag);
763 bool pdb_set_nt_username(struct samu *sampass, const char *nt_username, enum pdb_value_state flag);
764 bool pdb_set_fullname(struct samu *sampass, const char *full_name, enum pdb_value_state flag);
765 bool pdb_set_logon_script(struct samu *sampass, const char *logon_script, enum pdb_value_state flag);
766 bool pdb_set_profile_path(struct samu *sampass, const char *profile_path, enum pdb_value_state flag);
767 bool pdb_set_dir_drive(struct samu *sampass, const char *dir_drive, enum pdb_value_state flag);
768 bool pdb_set_homedir(struct samu *sampass, const char *home_dir, enum pdb_value_state flag);
769 bool pdb_set_acct_desc(struct samu *sampass, const char *acct_desc, enum pdb_value_state flag);
770 bool pdb_set_workstations(struct samu *sampass, const char *workstations, enum pdb_value_state flag);
771 bool pdb_set_comment(struct samu *sampass, const char *comment, enum pdb_value_state flag);
772 bool pdb_set_munged_dial(struct samu *sampass, const char *munged_dial, enum pdb_value_state flag);
773 bool pdb_set_nt_passwd(struct samu *sampass, const uint8_t pwd[NT_HASH_LEN], enum pdb_value_state flag);
774 bool pdb_set_lanman_passwd(struct samu *sampass, const uint8_t pwd[LM_HASH_LEN], enum pdb_value_state flag);
775 bool pdb_set_pw_history(struct samu *sampass, const uint8_t *pwd, uint32_t historyLen, enum pdb_value_state flag);
776 bool pdb_set_plaintext_pw_only(struct samu *sampass, const char *password, enum pdb_value_state flag);
777 bool pdb_set_bad_password_count(struct samu *sampass, uint16_t bad_password_count, enum pdb_value_state flag);
778 bool pdb_set_logon_count(struct samu *sampass, uint16_t logon_count, enum pdb_value_state flag);
779 bool pdb_set_country_code(struct samu *sampass, uint16_t country_code,
780                           enum pdb_value_state flag);
781 bool pdb_set_code_page(struct samu *sampass, uint16_t code_page,
782                        enum pdb_value_state flag);
783 bool pdb_set_unknown_6(struct samu *sampass, uint32_t unkn, enum pdb_value_state flag);
784 bool pdb_set_hours(struct samu *sampass, const uint8_t *hours, int hours_len,
785                    enum pdb_value_state flag);
786 bool pdb_set_backend_private_data(struct samu *sampass, void *private_data,
787                                    void (*free_fn)(void **),
788                                    const struct pdb_methods *my_methods,
789                                    enum pdb_value_state flag);
790 bool pdb_set_pass_can_change(struct samu *sampass, bool canchange);
791 bool pdb_set_plaintext_passwd(struct samu *sampass, const char *plaintext);
792 uint32_t pdb_build_fields_present(struct samu *sampass);
793 bool pdb_element_is_changed(const struct samu *sampass,
794                             enum pdb_elements element);
795 bool pdb_element_is_set_or_changed(const struct samu *sampass,
796                                    enum pdb_elements element);
797
798 /* The following definitions come from passdb/pdb_interface.c  */
799
800 NTSTATUS smb_register_passdb(int version, const char *name, pdb_init_function init) ;
801 struct pdb_init_function_entry *pdb_find_backend_entry(const char *name);
802 const struct pdb_init_function_entry *pdb_get_backends(void);
803 struct tevent_context *pdb_get_tevent_context(void);
804 NTSTATUS make_pdb_method_name(struct pdb_methods **methods, const char *selected);
805 struct pdb_domain_info *pdb_get_domain_info(TALLOC_CTX *mem_ctx);
806 bool pdb_getsampwnam(struct samu *sam_acct, const char *username) ;
807 bool pdb_getsampwsid(struct samu *sam_acct, const struct dom_sid *sid) ;
808 NTSTATUS pdb_create_user(TALLOC_CTX *mem_ctx, const char *name, uint32_t flags,
809                          uint32_t *rid);
810 NTSTATUS pdb_delete_user(TALLOC_CTX *mem_ctx, struct samu *sam_acct);
811 NTSTATUS pdb_add_sam_account(struct samu *sam_acct) ;
812 NTSTATUS pdb_update_sam_account(struct samu *sam_acct) ;
813 NTSTATUS pdb_delete_sam_account(struct samu *sam_acct) ;
814 NTSTATUS pdb_rename_sam_account(struct samu *oldname, const char *newname);
815 NTSTATUS pdb_update_login_attempts(struct samu *sam_acct, bool success);
816 bool pdb_getgrsid(GROUP_MAP *map, struct dom_sid sid);
817 bool pdb_getgrgid(GROUP_MAP *map, gid_t gid);
818 bool pdb_getgrnam(GROUP_MAP *map, const char *name);
819 NTSTATUS pdb_create_dom_group(TALLOC_CTX *mem_ctx, const char *name,
820                               uint32_t *rid);
821 NTSTATUS pdb_delete_dom_group(TALLOC_CTX *mem_ctx, uint32_t rid);
822 NTSTATUS pdb_add_group_mapping_entry(GROUP_MAP *map);
823 NTSTATUS pdb_update_group_mapping_entry(GROUP_MAP *map);
824 NTSTATUS pdb_delete_group_mapping_entry(struct dom_sid sid);
825 bool pdb_enum_group_mapping(const struct dom_sid *sid,
826                             enum lsa_SidType sid_name_use,
827                             GROUP_MAP ***pp_rmap,
828                             size_t *p_num_entries,
829                             bool unix_only);
830 NTSTATUS pdb_enum_group_members(TALLOC_CTX *mem_ctx,
831                                 const struct dom_sid *sid,
832                                 uint32_t **pp_member_rids,
833                                 size_t *p_num_members);
834 NTSTATUS pdb_enum_group_memberships(TALLOC_CTX *mem_ctx, struct samu *user,
835                                     struct dom_sid **pp_sids, gid_t **pp_gids,
836                                     uint32_t *p_num_groups);
837 NTSTATUS pdb_set_unix_primary_group(TALLOC_CTX *mem_ctx, struct samu *user);
838 NTSTATUS pdb_add_groupmem(TALLOC_CTX *mem_ctx, uint32_t group_rid,
839                           uint32_t member_rid);
840 NTSTATUS pdb_del_groupmem(TALLOC_CTX *mem_ctx, uint32_t group_rid,
841                           uint32_t member_rid);
842 NTSTATUS pdb_create_alias(const char *name, uint32_t *rid);
843 NTSTATUS pdb_delete_alias(const struct dom_sid *sid);
844 NTSTATUS pdb_get_aliasinfo(const struct dom_sid *sid, struct acct_info *info);
845 NTSTATUS pdb_set_aliasinfo(const struct dom_sid *sid, struct acct_info *info);
846 NTSTATUS pdb_add_aliasmem(const struct dom_sid *alias, const struct dom_sid *member);
847 NTSTATUS pdb_del_aliasmem(const struct dom_sid *alias, const struct dom_sid *member);
848 NTSTATUS pdb_enum_aliasmem(const struct dom_sid *alias, TALLOC_CTX *mem_ctx,
849                            struct dom_sid **pp_members, size_t *p_num_members);
850 NTSTATUS pdb_enum_alias_memberships(TALLOC_CTX *mem_ctx,
851                                     const struct dom_sid *domain_sid,
852                                     const struct dom_sid *members, size_t num_members,
853                                     uint32_t **pp_alias_rids,
854                                     size_t *p_num_alias_rids);
855 NTSTATUS pdb_lookup_rids(const struct dom_sid *domain_sid,
856                          int num_rids,
857                          uint32_t *rids,
858                          const char **names,
859                          enum lsa_SidType *attrs);
860 NTSTATUS pdb_lookup_names(const struct dom_sid *domain_sid,
861                           int num_names,
862                           const char **names,
863                           uint32_t *rids,
864                           enum lsa_SidType *attrs);
865 bool pdb_get_account_policy(enum pdb_policy_type type, uint32_t *value);
866 bool pdb_set_account_policy(enum pdb_policy_type type, uint32_t value);
867 bool pdb_get_seq_num(time_t *seq_num);
868 bool pdb_uid_to_sid(uid_t uid, struct dom_sid *sid);
869 bool pdb_gid_to_sid(gid_t gid, struct dom_sid *sid);
870 bool pdb_sid_to_id(const struct dom_sid *sid, struct unixid *id);
871 uint32_t pdb_capabilities(void);
872 bool pdb_new_rid(uint32_t *rid);
873 bool initialize_password_db(bool reload, struct tevent_context *tevent_ctx);
874 struct pdb_search *pdb_search_init(TALLOC_CTX *mem_ctx,
875                                    enum pdb_search_type type);
876 struct pdb_search *pdb_search_users(TALLOC_CTX *mem_ctx, uint32_t acct_flags);
877 struct pdb_search *pdb_search_groups(TALLOC_CTX *mem_ctx);
878 struct pdb_search *pdb_search_aliases(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
879 uint32_t pdb_search_entries(struct pdb_search *search,
880                           uint32_t start_idx, uint32_t max_entries,
881                           struct samr_displayentry **result);
882 bool pdb_get_trusteddom_pw(const char *domain, char** pwd, struct dom_sid *sid,
883                            time_t *pass_last_set_time);
884 bool pdb_set_trusteddom_pw(const char* domain, const char* pwd,
885                            const struct dom_sid *sid);
886 bool pdb_del_trusteddom_pw(const char *domain);
887 NTSTATUS pdb_enum_trusteddoms(TALLOC_CTX *mem_ctx, uint32_t *num_domains,
888                               struct trustdom_info ***domains);
889 NTSTATUS pdb_get_trusted_domain(TALLOC_CTX *mem_ctx, const char *domain,
890                                 struct pdb_trusted_domain **td);
891 NTSTATUS pdb_get_trusted_domain_by_sid(TALLOC_CTX *mem_ctx, struct dom_sid *sid,
892                                 struct pdb_trusted_domain **td);
893 NTSTATUS pdb_set_trusted_domain(const char* domain,
894                                 const struct pdb_trusted_domain *td);
895 NTSTATUS pdb_del_trusted_domain(const char *domain);
896 NTSTATUS pdb_enum_trusted_domains(TALLOC_CTX *mem_ctx, uint32_t *num_domains,
897                                   struct pdb_trusted_domain ***domains);
898 NTSTATUS make_pdb_method( struct pdb_methods **methods ) ;
899 NTSTATUS pdb_get_secret(TALLOC_CTX *mem_ctx,
900                         const char *secret_name,
901                         DATA_BLOB *secret_current,
902                         NTTIME *secret_current_lastchange,
903                         DATA_BLOB *secret_old,
904                         NTTIME *secret_old_lastchange,
905                         struct security_descriptor **sd);
906 NTSTATUS pdb_set_secret(const char *secret_name,
907                         DATA_BLOB *secret_current,
908                         DATA_BLOB *secret_old,
909                         struct security_descriptor *sd);
910 NTSTATUS pdb_delete_secret(const char *secret_name);
911
912 /* The following definitions come from passdb/pdb_util.c  */
913
914 NTSTATUS create_builtin_users(const struct dom_sid *sid);
915 NTSTATUS create_builtin_administrators(const struct dom_sid *sid);
916
917 #include "passdb/machine_sid.h"
918 #include "passdb/lookup_sid.h"
919
920 /* The following definitions come from passdb/pdb_unixid.c */
921 void unixid_from_uid(struct unixid *id, uint32_t some_uid);
922 void unixid_from_gid(struct unixid *id, uint32_t some_gid);
923 void unixid_from_both(struct unixid *id, uint32_t some_id);
924
925 #endif /* _PASSDB_H */