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