doc-xml/smbdotconf: fix server [min|max] protocol documentation
[Samba/gebeck_regimport.git] / source3 / include / passdb.h
blob5e5a7bfa58c473e4c06cd651d0697ccd2d1e2fa2
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
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.
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.
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/>.
23 #ifndef _PASSDB_H
24 #define _PASSDB_H
26 #ifndef NT_HASH_LEN
27 #define NT_HASH_LEN 16
28 #endif
30 #ifndef LM_HASH_LEN
31 #define LM_HASH_LEN 16
32 #endif
34 #include "../librpc/gen_ndr/lsa.h"
35 #include <tevent.h>
36 struct unixid;
38 /* group mapping headers */
40 #define ENUM_ONLY_MAPPED True
41 #define ENUM_ALL_MAPPED False
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;
52 struct acct_info {
53 char *acct_name; /* account name */
54 char *acct_desc; /* account name */
55 uint32_t rid; /* domain-relative RID */
58 /* The following definitions come from groupdb/mapping.c */
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);
129 /* passdb headers */
131 /**********************************************************************
132 * Masks for mappings between unix uid and gid types and
133 * NT RIDS.
134 **********************************************************************/
136 /* Take the bottom bit. */
137 #define RID_TYPE_MASK 1
138 #define RID_MULTIPLIER 2
140 /* The two common types. */
141 #define USER_RID_TYPE 0
142 #define GROUP_RID_TYPE 1
145 * Flags for local user manipulation.
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 */
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!
165 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
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
174 * bit flags representing initialized fields in struct samu
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,
214 /* this must be the last element */
215 PDB_COUNT
218 enum pdb_group_elements {
219 PDB_GROUP_NAME,
220 PDB_GROUP_SID,
221 PDB_GROUP_SID_NAME_USE,
222 PDB_GROUP_MEMBERS,
224 /* this must be the last element */
225 PDB_GROUP_COUNT
229 enum pdb_value_state {
230 PDB_DEFAULT=0,
231 PDB_SET,
232 PDB_CHANGED
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)
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;
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
255 #define MAX_HOURS_LEN 32
257 struct samu {
258 struct pdb_methods *methods;
260 /* initialization flags */
261 struct bitmap *change_flags;
262 struct bitmap *set_flags;
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 */
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 */
284 struct dom_sid user_sid;
285 struct dom_sid *group_sid;
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 */
292 uint32_t acct_ctrl; /* account info (ACB_xxxx bit-mask) */
293 uint32_t fields_present; /* 0x00ff ffff */
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];
299 /* Was unknown_5. */
300 uint16_t bad_password_count;
301 uint16_t logon_count;
303 uint16_t country_code;
304 uint16_t code_page;
306 uint32_t unknown_6; /* 0x0000 04ec */
308 /* a tag for who added the private methods */
310 const struct pdb_methods *backend_private_methods;
311 void *backend_private_data;
312 void (*backend_private_data_free_fn)(void **);
314 /* maintain a copy of the user's struct passwd */
316 struct passwd *unix_pw;
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;
328 enum pdb_search_type {
329 PDB_USER_SEARCH,
330 PDB_GROUP_SEARCH,
331 PDB_ALIAS_SEARCH
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);
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;
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;
369 * trusted domain entry/entries returned by secrets_get_trusted_domains
370 * (used in _lsa_enum_trust_dom call)
372 struct trustdom_info {
373 char *name;
374 struct dom_sid sid;
378 * Types of account policy.
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
393 #define PDB_CAP_STORE_RIDS 0x0001
394 #define PDB_CAP_ADS 0x0002
395 #define PDB_CAP_TRUSTED_DOMAINS_EX 0x0004
397 /*****************************************************************
398 Functions to be implemented by the new (v2) passdb API
399 ****************************************************************/
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 * Changed to 21, set/enum_upn_suffixes. AB.
418 #define PASSDB_INTERFACE_VERSION 21
420 struct pdb_methods
422 const char *name; /* What name got this module */
424 struct pdb_domain_info *(*get_domain_info)(struct pdb_methods *,
425 TALLOC_CTX *mem_ctx);
427 NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
429 NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const struct dom_sid *sid);
431 NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
432 const char *name, uint32_t acct_flags,
433 uint32_t *rid);
435 NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
436 struct samu *sam_acct);
438 NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
440 NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
442 NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
444 NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
446 NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
448 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, struct dom_sid sid);
450 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
452 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
454 NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
455 TALLOC_CTX *mem_ctx, const char *name,
456 uint32_t *rid);
458 NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
459 TALLOC_CTX *mem_ctx, uint32_t rid);
461 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
462 GROUP_MAP *map);
464 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
465 GROUP_MAP *map);
467 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
468 struct dom_sid sid);
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);
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);
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);
487 NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
488 TALLOC_CTX *mem_ctx,
489 struct samu *user);
491 NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
492 TALLOC_CTX *mem_ctx,
493 uint32_t group_rid, uint32_t member_rid);
495 NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
496 TALLOC_CTX *mem_ctx,
497 uint32_t group_rid, uint32_t member_rid);
499 NTSTATUS (*create_alias)(struct pdb_methods *methods,
500 const char *name, uint32_t *rid);
502 NTSTATUS (*delete_alias)(struct pdb_methods *methods,
503 const struct dom_sid *sid);
505 NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
506 const struct dom_sid *sid,
507 struct acct_info *info);
509 NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
510 const struct dom_sid *sid,
511 struct acct_info *info);
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);
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);
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);
542 NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
543 enum pdb_policy_type type,
544 uint32_t *value);
546 NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
547 enum pdb_policy_type type,
548 uint32_t value);
550 NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
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);
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 struct unixid *id);
568 uint32_t (*capabilities)(struct pdb_methods *methods);
569 bool (*new_rid)(struct pdb_methods *methods, uint32_t *rid);
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);
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);
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);
618 NTSTATUS (*enum_upn_suffixes)(struct pdb_methods *methods,
619 TALLOC_CTX *mem_ctx,
620 uint32_t *num_suffixes,
621 char ***suffixes);
623 NTSTATUS (*set_upn_suffixes)(struct pdb_methods *methods,
624 uint32_t num_suffixes,
625 const char **suffixes);
627 void *private_data; /* Private data of some kind */
629 void (*free_private_data)(void **);
632 typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
634 struct pdb_init_function_entry {
635 const char *name;
637 /* Function to create a member of the pdb_methods list */
638 pdb_init_function init;
640 struct pdb_init_function_entry *prev, *next;
643 /* The following definitions come from passdb/account_pol.c */
645 void account_policy_names_list(TALLOC_CTX *mem_ctx, const char ***names, int *num_names);
646 const char *decode_account_policy_name(enum pdb_policy_type type);
647 const char *get_account_policy_attr(enum pdb_policy_type type);
648 const char *account_policy_get_desc(enum pdb_policy_type type);
649 enum pdb_policy_type account_policy_name_to_typenum(const char *name);
650 bool account_policy_get_default(enum pdb_policy_type type, uint32_t *val);
651 bool init_account_policy(void);
652 bool account_policy_get(enum pdb_policy_type type, uint32_t *value);
653 bool account_policy_set(enum pdb_policy_type type, uint32_t value);
654 bool cache_account_policy_set(enum pdb_policy_type type, uint32_t value);
655 bool cache_account_policy_get(enum pdb_policy_type type, uint32_t *value);
656 struct db_context *get_account_pol_db( void );
658 /* The following definitions come from passdb/login_cache.c */
660 bool login_cache_init(void);
661 bool login_cache_shutdown(void);
662 bool login_cache_read(struct samu *sampass, struct login_cache *entry);
663 bool login_cache_write(const struct samu *sampass,
664 const struct login_cache *entry);
665 bool login_cache_delentry(const struct samu *sampass);
667 /* The following definitions come from passdb/passdb.c */
669 const char *my_sam_name(void);
670 struct samu *samu_new( TALLOC_CTX *ctx );
671 NTSTATUS samu_set_unix(struct samu *user, const struct passwd *pwd);
672 NTSTATUS samu_alloc_rid_unix(struct pdb_methods *methods,
673 struct samu *user, const struct passwd *pwd);
674 char *pdb_encode_acct_ctrl(uint32_t acct_ctrl, size_t length);
675 uint32_t pdb_decode_acct_ctrl(const char *p);
676 void pdb_sethexpwd(char p[33], const unsigned char *pwd, uint32_t acct_ctrl);
677 bool pdb_gethexpwd(const char *p, unsigned char *pwd);
678 void pdb_sethexhours(char *p, const unsigned char *hours);
679 bool pdb_gethexhours(const char *p, unsigned char *hours);
680 int algorithmic_rid_base(void);
681 uid_t algorithmic_pdb_user_rid_to_uid(uint32_t user_rid);
682 uid_t max_algorithmic_uid(void);
683 uint32_t algorithmic_pdb_uid_to_user_rid(uid_t uid);
684 gid_t pdb_group_rid_to_gid(uint32_t group_rid);
685 gid_t max_algorithmic_gid(void);
686 uint32_t algorithmic_pdb_gid_to_group_rid(gid_t gid);
687 bool algorithmic_pdb_rid_is_user(uint32_t rid);
688 bool lookup_global_sam_name(const char *name, int flags, uint32_t *rid,
689 enum lsa_SidType *type);
690 NTSTATUS local_password_change(const char *user_name,
691 int local_flags,
692 const char *new_passwd,
693 char **pp_err_str,
694 char **pp_msg_str);
695 bool init_samu_from_buffer(struct samu *sampass, uint32_t level,
696 uint8_t *buf, uint32_t buflen);
697 uint32_t init_buffer_from_samu (uint8_t **buf, struct samu *sampass, bool size_only);
698 bool pdb_copy_sam_account(struct samu *dst, struct samu *src );
699 bool pdb_update_bad_password_count(struct samu *sampass, bool *updated);
700 bool pdb_update_autolock_flag(struct samu *sampass, bool *updated);
701 bool pdb_increment_bad_password_count(struct samu *sampass);
702 bool is_dc_trusted_domain_situation(const char *domain_name);
703 bool get_trust_pw_clear(const char *domain, char **ret_pwd,
704 const char **account_name,
705 enum netr_SchannelType *channel);
706 bool get_trust_pw_hash(const char *domain, uint8_t ret_pwd[16],
707 const char **account_name,
708 enum netr_SchannelType *channel);
710 /* The following definitions come from passdb/pdb_compat.c */
712 uint32_t pdb_get_user_rid (const struct samu *sampass);
713 uint32_t pdb_get_group_rid (struct samu *sampass);
714 bool pdb_set_user_sid_from_rid (struct samu *sampass, uint32_t rid, enum pdb_value_state flag);
715 bool pdb_set_group_sid_from_rid (struct samu *sampass, uint32_t grid, enum pdb_value_state flag);
717 /* The following definitions come from passdb/pdb_get_set.c */
719 bool pdb_is_password_change_time_max(time_t test_time);
720 uint32_t pdb_get_acct_ctrl(const struct samu *sampass);
721 time_t pdb_get_logon_time(const struct samu *sampass);
722 time_t pdb_get_logoff_time(const struct samu *sampass);
723 time_t pdb_get_kickoff_time(const struct samu *sampass);
724 time_t pdb_get_bad_password_time(const struct samu *sampass);
725 time_t pdb_get_pass_last_set_time(const struct samu *sampass);
726 time_t pdb_get_pass_can_change_time(const struct samu *sampass);
727 time_t pdb_get_pass_can_change_time_noncalc(const struct samu *sampass);
728 time_t pdb_get_pass_must_change_time(const struct samu *sampass);
729 bool pdb_get_pass_can_change(const struct samu *sampass);
730 uint16_t pdb_get_logon_divs(const struct samu *sampass);
731 uint32_t pdb_get_hours_len(const struct samu *sampass);
732 const uint8_t *pdb_get_hours(const struct samu *sampass);
733 const uint8_t *pdb_get_nt_passwd(const struct samu *sampass);
734 const uint8_t *pdb_get_lanman_passwd(const struct samu *sampass);
735 const uint8_t *pdb_get_pw_history(const struct samu *sampass, uint32_t *current_hist_len);
736 const char *pdb_get_plaintext_passwd(const struct samu *sampass);
737 const struct dom_sid *pdb_get_user_sid(const struct samu *sampass);
738 const struct dom_sid *pdb_get_group_sid(struct samu *sampass);
739 enum pdb_value_state pdb_get_init_flags(const struct samu *sampass, enum pdb_elements element);
740 const char *pdb_get_username(const struct samu *sampass);
741 const char *pdb_get_domain(const struct samu *sampass);
742 const char *pdb_get_nt_username(const struct samu *sampass);
743 const char *pdb_get_fullname(const struct samu *sampass);
744 const char *pdb_get_homedir(const struct samu *sampass);
745 const char *pdb_get_dir_drive(const struct samu *sampass);
746 const char *pdb_get_logon_script(const struct samu *sampass);
747 const char *pdb_get_profile_path(const struct samu *sampass);
748 const char *pdb_get_acct_desc(const struct samu *sampass);
749 const char *pdb_get_workstations(const struct samu *sampass);
750 const char *pdb_get_comment(const struct samu *sampass);
751 const char *pdb_get_munged_dial(const struct samu *sampass);
752 uint16_t pdb_get_bad_password_count(const struct samu *sampass);
753 uint16_t pdb_get_logon_count(const struct samu *sampass);
754 uint16_t pdb_get_country_code(const struct samu *sampass);
755 uint16_t pdb_get_code_page(const struct samu *sampass);
756 uint32_t pdb_get_unknown_6(const struct samu *sampass);
757 void *pdb_get_backend_private_data(const struct samu *sampass, const struct pdb_methods *my_methods);
758 bool pdb_set_acct_ctrl(struct samu *sampass, uint32_t acct_ctrl, enum pdb_value_state flag);
759 bool pdb_set_logon_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
760 bool pdb_set_logoff_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
761 bool pdb_set_kickoff_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
762 bool pdb_set_bad_password_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
763 bool pdb_set_pass_can_change_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
764 bool pdb_set_pass_last_set_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
765 bool pdb_set_hours_len(struct samu *sampass, uint32_t len, enum pdb_value_state flag);
766 bool pdb_set_logon_divs(struct samu *sampass, uint16_t hours, enum pdb_value_state flag);
767 bool pdb_set_init_flags(struct samu *sampass, enum pdb_elements element, enum pdb_value_state value_flag);
768 bool pdb_set_user_sid(struct samu *sampass, const struct dom_sid *u_sid, enum pdb_value_state flag);
769 bool pdb_set_user_sid_from_string(struct samu *sampass, const char *u_sid, enum pdb_value_state flag);
770 bool pdb_set_group_sid(struct samu *sampass, const struct dom_sid *g_sid, enum pdb_value_state flag);
771 bool pdb_set_username(struct samu *sampass, const char *username, enum pdb_value_state flag);
772 bool pdb_set_domain(struct samu *sampass, const char *domain, enum pdb_value_state flag);
773 bool pdb_set_nt_username(struct samu *sampass, const char *nt_username, enum pdb_value_state flag);
774 bool pdb_set_fullname(struct samu *sampass, const char *full_name, enum pdb_value_state flag);
775 bool pdb_set_logon_script(struct samu *sampass, const char *logon_script, enum pdb_value_state flag);
776 bool pdb_set_profile_path(struct samu *sampass, const char *profile_path, enum pdb_value_state flag);
777 bool pdb_set_dir_drive(struct samu *sampass, const char *dir_drive, enum pdb_value_state flag);
778 bool pdb_set_homedir(struct samu *sampass, const char *home_dir, enum pdb_value_state flag);
779 bool pdb_set_acct_desc(struct samu *sampass, const char *acct_desc, enum pdb_value_state flag);
780 bool pdb_set_workstations(struct samu *sampass, const char *workstations, enum pdb_value_state flag);
781 bool pdb_set_comment(struct samu *sampass, const char *comment, enum pdb_value_state flag);
782 bool pdb_set_munged_dial(struct samu *sampass, const char *munged_dial, enum pdb_value_state flag);
783 bool pdb_set_nt_passwd(struct samu *sampass, const uint8_t pwd[NT_HASH_LEN], enum pdb_value_state flag);
784 bool pdb_set_lanman_passwd(struct samu *sampass, const uint8_t pwd[LM_HASH_LEN], enum pdb_value_state flag);
785 bool pdb_set_pw_history(struct samu *sampass, const uint8_t *pwd, uint32_t historyLen, enum pdb_value_state flag);
786 bool pdb_set_plaintext_pw_only(struct samu *sampass, const char *password, enum pdb_value_state flag);
787 bool pdb_set_bad_password_count(struct samu *sampass, uint16_t bad_password_count, enum pdb_value_state flag);
788 bool pdb_set_logon_count(struct samu *sampass, uint16_t logon_count, enum pdb_value_state flag);
789 bool pdb_set_country_code(struct samu *sampass, uint16_t country_code,
790 enum pdb_value_state flag);
791 bool pdb_set_code_page(struct samu *sampass, uint16_t code_page,
792 enum pdb_value_state flag);
793 bool pdb_set_unknown_6(struct samu *sampass, uint32_t unkn, enum pdb_value_state flag);
794 bool pdb_set_hours(struct samu *sampass, const uint8_t *hours, int hours_len,
795 enum pdb_value_state flag);
796 bool pdb_set_backend_private_data(struct samu *sampass, void *private_data,
797 void (*free_fn)(void **),
798 const struct pdb_methods *my_methods,
799 enum pdb_value_state flag);
800 bool pdb_set_pass_can_change(struct samu *sampass, bool canchange);
801 bool pdb_set_plaintext_passwd(struct samu *sampass, const char *plaintext);
802 uint32_t pdb_build_fields_present(struct samu *sampass);
803 bool pdb_element_is_changed(const struct samu *sampass,
804 enum pdb_elements element);
805 bool pdb_element_is_set_or_changed(const struct samu *sampass,
806 enum pdb_elements element);
808 /* The following definitions come from passdb/pdb_interface.c */
810 NTSTATUS smb_register_passdb(int version, const char *name, pdb_init_function init) ;
811 struct pdb_init_function_entry *pdb_find_backend_entry(const char *name);
812 const struct pdb_init_function_entry *pdb_get_backends(void);
813 struct tevent_context *pdb_get_tevent_context(void);
814 NTSTATUS make_pdb_method_name(struct pdb_methods **methods, const char *selected);
815 struct pdb_domain_info *pdb_get_domain_info(TALLOC_CTX *mem_ctx);
816 bool pdb_getsampwnam(struct samu *sam_acct, const char *username) ;
817 bool pdb_getsampwsid(struct samu *sam_acct, const struct dom_sid *sid) ;
818 NTSTATUS pdb_create_user(TALLOC_CTX *mem_ctx, const char *name, uint32_t flags,
819 uint32_t *rid);
820 NTSTATUS pdb_delete_user(TALLOC_CTX *mem_ctx, struct samu *sam_acct);
821 NTSTATUS pdb_add_sam_account(struct samu *sam_acct) ;
822 NTSTATUS pdb_update_sam_account(struct samu *sam_acct) ;
823 NTSTATUS pdb_delete_sam_account(struct samu *sam_acct) ;
824 NTSTATUS pdb_rename_sam_account(struct samu *oldname, const char *newname);
825 NTSTATUS pdb_update_login_attempts(struct samu *sam_acct, bool success);
826 bool pdb_getgrsid(GROUP_MAP *map, struct dom_sid sid);
827 bool pdb_getgrgid(GROUP_MAP *map, gid_t gid);
828 bool pdb_getgrnam(GROUP_MAP *map, const char *name);
829 NTSTATUS pdb_create_dom_group(TALLOC_CTX *mem_ctx, const char *name,
830 uint32_t *rid);
831 NTSTATUS pdb_delete_dom_group(TALLOC_CTX *mem_ctx, uint32_t rid);
832 NTSTATUS pdb_add_group_mapping_entry(GROUP_MAP *map);
833 NTSTATUS pdb_update_group_mapping_entry(GROUP_MAP *map);
834 NTSTATUS pdb_delete_group_mapping_entry(struct dom_sid sid);
835 bool pdb_enum_group_mapping(const struct dom_sid *sid,
836 enum lsa_SidType sid_name_use,
837 GROUP_MAP ***pp_rmap,
838 size_t *p_num_entries,
839 bool unix_only);
840 NTSTATUS pdb_enum_group_members(TALLOC_CTX *mem_ctx,
841 const struct dom_sid *sid,
842 uint32_t **pp_member_rids,
843 size_t *p_num_members);
844 NTSTATUS pdb_enum_group_memberships(TALLOC_CTX *mem_ctx, struct samu *user,
845 struct dom_sid **pp_sids, gid_t **pp_gids,
846 uint32_t *p_num_groups);
847 NTSTATUS pdb_set_unix_primary_group(TALLOC_CTX *mem_ctx, struct samu *user);
848 NTSTATUS pdb_add_groupmem(TALLOC_CTX *mem_ctx, uint32_t group_rid,
849 uint32_t member_rid);
850 NTSTATUS pdb_del_groupmem(TALLOC_CTX *mem_ctx, uint32_t group_rid,
851 uint32_t member_rid);
852 NTSTATUS pdb_create_alias(const char *name, uint32_t *rid);
853 NTSTATUS pdb_delete_alias(const struct dom_sid *sid);
854 NTSTATUS pdb_get_aliasinfo(const struct dom_sid *sid, struct acct_info *info);
855 NTSTATUS pdb_set_aliasinfo(const struct dom_sid *sid, struct acct_info *info);
856 NTSTATUS pdb_add_aliasmem(const struct dom_sid *alias, const struct dom_sid *member);
857 NTSTATUS pdb_del_aliasmem(const struct dom_sid *alias, const struct dom_sid *member);
858 NTSTATUS pdb_enum_aliasmem(const struct dom_sid *alias, TALLOC_CTX *mem_ctx,
859 struct dom_sid **pp_members, size_t *p_num_members);
860 NTSTATUS pdb_enum_alias_memberships(TALLOC_CTX *mem_ctx,
861 const struct dom_sid *domain_sid,
862 const struct dom_sid *members, size_t num_members,
863 uint32_t **pp_alias_rids,
864 size_t *p_num_alias_rids);
865 NTSTATUS pdb_lookup_rids(const struct dom_sid *domain_sid,
866 int num_rids,
867 uint32_t *rids,
868 const char **names,
869 enum lsa_SidType *attrs);
870 NTSTATUS pdb_lookup_names(const struct dom_sid *domain_sid,
871 int num_names,
872 const char **names,
873 uint32_t *rids,
874 enum lsa_SidType *attrs);
875 bool pdb_get_account_policy(enum pdb_policy_type type, uint32_t *value);
876 bool pdb_set_account_policy(enum pdb_policy_type type, uint32_t value);
877 bool pdb_get_seq_num(time_t *seq_num);
878 bool pdb_uid_to_sid(uid_t uid, struct dom_sid *sid);
879 bool pdb_gid_to_sid(gid_t gid, struct dom_sid *sid);
880 bool pdb_sid_to_id(const struct dom_sid *sid, struct unixid *id);
881 uint32_t pdb_capabilities(void);
882 bool pdb_new_rid(uint32_t *rid);
883 bool initialize_password_db(bool reload, struct tevent_context *tevent_ctx);
884 struct pdb_search *pdb_search_init(TALLOC_CTX *mem_ctx,
885 enum pdb_search_type type);
886 struct pdb_search *pdb_search_users(TALLOC_CTX *mem_ctx, uint32_t acct_flags);
887 struct pdb_search *pdb_search_groups(TALLOC_CTX *mem_ctx);
888 struct pdb_search *pdb_search_aliases(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
889 uint32_t pdb_search_entries(struct pdb_search *search,
890 uint32_t start_idx, uint32_t max_entries,
891 struct samr_displayentry **result);
892 bool pdb_get_trusteddom_pw(const char *domain, char** pwd, struct dom_sid *sid,
893 time_t *pass_last_set_time);
894 bool pdb_set_trusteddom_pw(const char* domain, const char* pwd,
895 const struct dom_sid *sid);
896 bool pdb_del_trusteddom_pw(const char *domain);
897 NTSTATUS pdb_enum_trusteddoms(TALLOC_CTX *mem_ctx, uint32_t *num_domains,
898 struct trustdom_info ***domains);
899 NTSTATUS pdb_get_trusted_domain(TALLOC_CTX *mem_ctx, const char *domain,
900 struct pdb_trusted_domain **td);
901 NTSTATUS pdb_get_trusted_domain_by_sid(TALLOC_CTX *mem_ctx, struct dom_sid *sid,
902 struct pdb_trusted_domain **td);
903 NTSTATUS pdb_set_trusted_domain(const char* domain,
904 const struct pdb_trusted_domain *td);
905 NTSTATUS pdb_del_trusted_domain(const char *domain);
906 NTSTATUS pdb_enum_trusted_domains(TALLOC_CTX *mem_ctx, uint32_t *num_domains,
907 struct pdb_trusted_domain ***domains);
908 NTSTATUS make_pdb_method( struct pdb_methods **methods ) ;
909 NTSTATUS pdb_get_secret(TALLOC_CTX *mem_ctx,
910 const char *secret_name,
911 DATA_BLOB *secret_current,
912 NTTIME *secret_current_lastchange,
913 DATA_BLOB *secret_old,
914 NTTIME *secret_old_lastchange,
915 struct security_descriptor **sd);
916 NTSTATUS pdb_set_secret(const char *secret_name,
917 DATA_BLOB *secret_current,
918 DATA_BLOB *secret_old,
919 struct security_descriptor *sd);
920 NTSTATUS pdb_delete_secret(const char *secret_name);
921 bool pdb_sid_to_id_unix_users_and_groups(const struct dom_sid *sid,
922 struct unixid *id);
924 NTSTATUS pdb_enum_upn_suffixes(TALLOC_CTX *mem_ctx,
925 uint32_t *num_suffixes,
926 char ***suffixes);
928 NTSTATUS pdb_set_upn_suffixes(uint32_t num_suffixes,
929 const char **suffixes);
931 /* The following definitions come from passdb/pdb_util.c */
933 NTSTATUS create_builtin_users(const struct dom_sid *sid);
934 NTSTATUS create_builtin_administrators(const struct dom_sid *sid);
936 #include "passdb/machine_sid.h"
937 #include "passdb/lookup_sid.h"
939 /* The following definitions come from passdb/pdb_unixid.c */
940 void unixid_from_uid(struct unixid *id, uint32_t some_uid);
941 void unixid_from_gid(struct unixid *id, uint32_t some_gid);
942 void unixid_from_both(struct unixid *id, uint32_t some_id);
944 /* The following definitions come from passdb/pdb_secrets.c
945 * and should be used by PDB modules if they need to store
946 * sid/guid information for the domain in secrets database
948 bool PDB_secrets_mark_domain_protected(const char *domain);
949 bool PDB_secrets_clear_domain_protection(const char *domain);
950 bool PDB_secrets_store_domain_sid(const char *domain, const struct dom_sid *sid);
951 bool PDB_secrets_fetch_domain_sid(const char *domain, struct dom_sid *sid);
952 bool PDB_secrets_store_domain_guid(const char *domain, struct GUID *guid);
953 bool PDB_secrets_fetch_domain_guid(const char *domain, struct GUID *guid);
955 #endif /* _PASSDB_H */