idmap: unify passdb *id_to_sid methods
[Samba.git] / source3 / include / passdb.h
blob16e3bef27ccbaf0917f3ee87279c27cc13c4b235
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, gid_t gid);
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.
416 * Changed to 22, idmap control functions
417 * Changed to 23, new idmap control functions
418 * Changed to 24, removed uid_to_sid and gid_to_sid, replaced with id_to_sid
421 #define PASSDB_INTERFACE_VERSION 24
423 struct pdb_methods
425 const char *name; /* What name got this module */
427 struct pdb_domain_info *(*get_domain_info)(struct pdb_methods *,
428 TALLOC_CTX *mem_ctx);
430 NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
432 NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const struct dom_sid *sid);
434 NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
435 const char *name, uint32_t acct_flags,
436 uint32_t *rid);
438 NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
439 struct samu *sam_acct);
441 NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
443 NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
445 NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
447 NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
449 NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
451 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, struct dom_sid sid);
453 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
455 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
457 NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
458 TALLOC_CTX *mem_ctx, const char *name,
459 uint32_t *rid);
461 NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
462 TALLOC_CTX *mem_ctx, uint32_t rid);
464 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
465 GROUP_MAP *map);
467 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
468 GROUP_MAP *map);
470 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
471 struct dom_sid sid);
473 NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
474 const struct dom_sid *sid, enum lsa_SidType sid_name_use,
475 GROUP_MAP ***pp_rmap, size_t *p_num_entries,
476 bool unix_only);
478 NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
479 TALLOC_CTX *mem_ctx,
480 const struct dom_sid *group,
481 uint32_t **pp_member_rids,
482 size_t *p_num_members);
484 NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
485 TALLOC_CTX *mem_ctx,
486 struct samu *user,
487 struct dom_sid **pp_sids, gid_t **pp_gids,
488 uint32_t *p_num_groups);
490 NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
491 TALLOC_CTX *mem_ctx,
492 struct samu *user);
494 NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
495 TALLOC_CTX *mem_ctx,
496 uint32_t group_rid, uint32_t member_rid);
498 NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
499 TALLOC_CTX *mem_ctx,
500 uint32_t group_rid, uint32_t member_rid);
502 NTSTATUS (*create_alias)(struct pdb_methods *methods,
503 const char *name, uint32_t *rid);
505 NTSTATUS (*delete_alias)(struct pdb_methods *methods,
506 const struct dom_sid *sid);
508 NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
509 const struct dom_sid *sid,
510 struct acct_info *info);
512 NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
513 const struct dom_sid *sid,
514 struct acct_info *info);
516 NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
517 const struct dom_sid *alias, const struct dom_sid *member);
518 NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
519 const struct dom_sid *alias, const struct dom_sid *member);
520 NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
521 const struct dom_sid *alias, TALLOC_CTX *mem_ctx,
522 struct dom_sid **members, size_t *p_num_members);
523 NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
524 TALLOC_CTX *mem_ctx,
525 const struct dom_sid *domain_sid,
526 const struct dom_sid *members,
527 size_t num_members,
528 uint32_t **pp_alias_rids,
529 size_t *p_num_alias_rids);
531 NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
532 const struct dom_sid *domain_sid,
533 int num_rids,
534 uint32_t *rids,
535 const char **pp_names,
536 enum lsa_SidType *attrs);
538 NTSTATUS (*lookup_names)(struct pdb_methods *methods,
539 const struct dom_sid *domain_sid,
540 int num_names,
541 const char **pp_names,
542 uint32_t *rids,
543 enum lsa_SidType *attrs);
545 NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
546 enum pdb_policy_type type,
547 uint32_t *value);
549 NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
550 enum pdb_policy_type type,
551 uint32_t value);
553 NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
555 bool (*search_users)(struct pdb_methods *methods,
556 struct pdb_search *search,
557 uint32_t acct_flags);
558 bool (*search_groups)(struct pdb_methods *methods,
559 struct pdb_search *search);
560 bool (*search_aliases)(struct pdb_methods *methods,
561 struct pdb_search *search,
562 const struct dom_sid *sid);
565 * Instead of passing down a gid or uid, this function sends down a pointer
566 * to a unixid.
568 * This acts as an in-out variable so that the idmap functions can correctly
569 * receive ID_TYPE_BOTH, filling in cache details correctly rather than forcing
570 * the cache to store ID_TYPE_UID or ID_TYPE_GID.
572 bool (*id_to_sid)(struct pdb_methods *methods, struct unixid *id,
573 struct dom_sid *sid);
574 bool (*sid_to_id)(struct pdb_methods *methods, const struct dom_sid *sid,
575 struct unixid *id);
577 uint32_t (*capabilities)(struct pdb_methods *methods);
578 bool (*new_rid)(struct pdb_methods *methods, uint32_t *rid);
581 bool (*get_trusteddom_pw)(struct pdb_methods *methods,
582 const char *domain, char** pwd,
583 struct dom_sid *sid, time_t *pass_last_set_time);
584 bool (*set_trusteddom_pw)(struct pdb_methods *methods,
585 const char* domain, const char* pwd,
586 const struct dom_sid *sid);
587 bool (*del_trusteddom_pw)(struct pdb_methods *methods,
588 const char *domain);
589 NTSTATUS (*enum_trusteddoms)(struct pdb_methods *methods,
590 TALLOC_CTX *mem_ctx, uint32_t *num_domains,
591 struct trustdom_info ***domains);
593 NTSTATUS (*get_trusted_domain)(struct pdb_methods *methods,
594 TALLOC_CTX *mem_ctx,
595 const char *domain,
596 struct pdb_trusted_domain **td);
597 NTSTATUS (*get_trusted_domain_by_sid)(struct pdb_methods *methods,
598 TALLOC_CTX *mem_ctx,
599 struct dom_sid *sid,
600 struct pdb_trusted_domain **td);
601 NTSTATUS (*set_trusted_domain)(struct pdb_methods *methods,
602 const char* domain,
603 const struct pdb_trusted_domain *td);
604 NTSTATUS (*del_trusted_domain)(struct pdb_methods *methods,
605 const char *domain);
606 NTSTATUS (*enum_trusted_domains)(struct pdb_methods *methods,
607 TALLOC_CTX *mem_ctx,
608 uint32_t *num_domains,
609 struct pdb_trusted_domain ***domains);
611 NTSTATUS (*get_secret)(struct pdb_methods *methods,
612 TALLOC_CTX *mem_ctx,
613 const char *secret_name,
614 DATA_BLOB *secret_current,
615 NTTIME *secret_current_lastchange,
616 DATA_BLOB *secret_old,
617 NTTIME *secret_old_lastchange,
618 struct security_descriptor **sd);
619 NTSTATUS (*set_secret)(struct pdb_methods *methods,
620 const char *secret_name,
621 DATA_BLOB *secret_current,
622 DATA_BLOB *secret_old,
623 struct security_descriptor *sd);
624 NTSTATUS (*delete_secret)(struct pdb_methods *methods,
625 const char *secret_name);
627 NTSTATUS (*enum_upn_suffixes)(struct pdb_methods *methods,
628 TALLOC_CTX *mem_ctx,
629 uint32_t *num_suffixes,
630 char ***suffixes);
632 NTSTATUS (*set_upn_suffixes)(struct pdb_methods *methods,
633 uint32_t num_suffixes,
634 const char **suffixes);
636 bool (*is_responsible_for_our_sam)(struct pdb_methods *methods);
637 bool (*is_responsible_for_builtin)(struct pdb_methods *methods);
638 bool (*is_responsible_for_wellknown)(struct pdb_methods *methods);
639 bool (*is_responsible_for_unix_users)(struct pdb_methods *methods);
640 bool (*is_responsible_for_unix_groups)(struct pdb_methods *methods);
641 bool (*is_responsible_for_everything_else)(struct pdb_methods *methods);
643 void *private_data; /* Private data of some kind */
645 void (*free_private_data)(void **);
648 typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
650 struct pdb_init_function_entry {
651 const char *name;
653 /* Function to create a member of the pdb_methods list */
654 pdb_init_function init;
656 struct pdb_init_function_entry *prev, *next;
659 /* The following definitions come from passdb/account_pol.c */
661 void account_policy_names_list(TALLOC_CTX *mem_ctx, const char ***names, int *num_names);
662 const char *decode_account_policy_name(enum pdb_policy_type type);
663 const char *get_account_policy_attr(enum pdb_policy_type type);
664 const char *account_policy_get_desc(enum pdb_policy_type type);
665 enum pdb_policy_type account_policy_name_to_typenum(const char *name);
666 bool account_policy_get_default(enum pdb_policy_type type, uint32_t *val);
667 bool init_account_policy(void);
668 bool account_policy_get(enum pdb_policy_type type, uint32_t *value);
669 bool account_policy_set(enum pdb_policy_type type, uint32_t value);
670 bool cache_account_policy_set(enum pdb_policy_type type, uint32_t value);
671 bool cache_account_policy_get(enum pdb_policy_type type, uint32_t *value);
672 struct db_context *get_account_pol_db( void );
674 /* The following definitions come from passdb/login_cache.c */
676 bool login_cache_init(void);
677 bool login_cache_shutdown(void);
678 bool login_cache_read(struct samu *sampass, struct login_cache *entry);
679 bool login_cache_write(const struct samu *sampass,
680 const struct login_cache *entry);
681 bool login_cache_delentry(const struct samu *sampass);
683 /* The following definitions come from passdb/passdb.c */
685 const char *my_sam_name(void);
686 struct samu *samu_new( TALLOC_CTX *ctx );
687 NTSTATUS samu_set_unix(struct samu *user, const struct passwd *pwd);
688 NTSTATUS samu_alloc_rid_unix(struct pdb_methods *methods,
689 struct samu *user, const struct passwd *pwd);
690 char *pdb_encode_acct_ctrl(uint32_t acct_ctrl, size_t length);
691 uint32_t pdb_decode_acct_ctrl(const char *p);
692 void pdb_sethexpwd(char p[33], const unsigned char *pwd, uint32_t acct_ctrl);
693 bool pdb_gethexpwd(const char *p, unsigned char *pwd);
694 void pdb_sethexhours(char *p, const unsigned char *hours);
695 bool pdb_gethexhours(const char *p, unsigned char *hours);
696 int algorithmic_rid_base(void);
697 uid_t algorithmic_pdb_user_rid_to_uid(uint32_t user_rid);
698 uid_t max_algorithmic_uid(void);
699 uint32_t algorithmic_pdb_uid_to_user_rid(uid_t uid);
700 gid_t pdb_group_rid_to_gid(uint32_t group_rid);
701 gid_t max_algorithmic_gid(void);
702 uint32_t algorithmic_pdb_gid_to_group_rid(gid_t gid);
703 bool algorithmic_pdb_rid_is_user(uint32_t rid);
704 bool lookup_global_sam_name(const char *name, int flags, uint32_t *rid,
705 enum lsa_SidType *type);
706 NTSTATUS local_password_change(const char *user_name,
707 int local_flags,
708 const char *new_passwd,
709 char **pp_err_str,
710 char **pp_msg_str);
711 bool init_samu_from_buffer(struct samu *sampass, uint32_t level,
712 uint8_t *buf, uint32_t buflen);
713 uint32_t init_buffer_from_samu (uint8_t **buf, struct samu *sampass, bool size_only);
714 bool pdb_copy_sam_account(struct samu *dst, struct samu *src );
715 bool pdb_update_bad_password_count(struct samu *sampass, bool *updated);
716 bool pdb_update_autolock_flag(struct samu *sampass, bool *updated);
717 bool pdb_increment_bad_password_count(struct samu *sampass);
718 bool is_dc_trusted_domain_situation(const char *domain_name);
719 bool get_trust_pw_clear(const char *domain, char **ret_pwd,
720 const char **account_name,
721 enum netr_SchannelType *channel);
722 bool get_trust_pw_hash(const char *domain, uint8_t ret_pwd[16],
723 const char **account_name,
724 enum netr_SchannelType *channel);
725 struct cli_credentials;
726 NTSTATUS pdb_get_trust_credentials(const char *netbios_domain,
727 const char *dns_domain, /* optional */
728 TALLOC_CTX *mem_ctx,
729 struct cli_credentials **_creds);
731 /* The following definitions come from passdb/pdb_compat.c */
733 uint32_t pdb_get_user_rid (const struct samu *sampass);
734 uint32_t pdb_get_group_rid (struct samu *sampass);
735 bool pdb_set_user_sid_from_rid (struct samu *sampass, uint32_t rid, enum pdb_value_state flag);
736 bool pdb_set_group_sid_from_rid (struct samu *sampass, uint32_t grid, enum pdb_value_state flag);
738 /* The following definitions come from passdb/pdb_get_set.c */
740 bool pdb_is_password_change_time_max(time_t test_time);
741 uint32_t pdb_get_acct_ctrl(const struct samu *sampass);
742 time_t pdb_get_logon_time(const struct samu *sampass);
743 time_t pdb_get_logoff_time(const struct samu *sampass);
744 time_t pdb_get_kickoff_time(const struct samu *sampass);
745 time_t pdb_get_bad_password_time(const struct samu *sampass);
746 time_t pdb_get_pass_last_set_time(const struct samu *sampass);
747 time_t pdb_get_pass_can_change_time(const struct samu *sampass);
748 time_t pdb_get_pass_can_change_time_noncalc(const struct samu *sampass);
749 time_t pdb_get_pass_must_change_time(const struct samu *sampass);
750 bool pdb_get_pass_can_change(const struct samu *sampass);
751 uint16_t pdb_get_logon_divs(const struct samu *sampass);
752 uint32_t pdb_get_hours_len(const struct samu *sampass);
753 const uint8_t *pdb_get_hours(const struct samu *sampass);
754 const uint8_t *pdb_get_nt_passwd(const struct samu *sampass);
755 const uint8_t *pdb_get_lanman_passwd(const struct samu *sampass);
756 const uint8_t *pdb_get_pw_history(const struct samu *sampass, uint32_t *current_hist_len);
757 const char *pdb_get_plaintext_passwd(const struct samu *sampass);
758 const struct dom_sid *pdb_get_user_sid(const struct samu *sampass);
759 const struct dom_sid *pdb_get_group_sid(struct samu *sampass);
760 enum pdb_value_state pdb_get_init_flags(const struct samu *sampass, enum pdb_elements element);
761 const char *pdb_get_username(const struct samu *sampass);
762 const char *pdb_get_domain(const struct samu *sampass);
763 const char *pdb_get_nt_username(const struct samu *sampass);
764 const char *pdb_get_fullname(const struct samu *sampass);
765 const char *pdb_get_homedir(const struct samu *sampass);
766 const char *pdb_get_dir_drive(const struct samu *sampass);
767 const char *pdb_get_logon_script(const struct samu *sampass);
768 const char *pdb_get_profile_path(const struct samu *sampass);
769 const char *pdb_get_acct_desc(const struct samu *sampass);
770 const char *pdb_get_workstations(const struct samu *sampass);
771 const char *pdb_get_comment(const struct samu *sampass);
772 const char *pdb_get_munged_dial(const struct samu *sampass);
773 uint16_t pdb_get_bad_password_count(const struct samu *sampass);
774 uint16_t pdb_get_logon_count(const struct samu *sampass);
775 uint16_t pdb_get_country_code(const struct samu *sampass);
776 uint16_t pdb_get_code_page(const struct samu *sampass);
777 uint32_t pdb_get_unknown_6(const struct samu *sampass);
778 void *pdb_get_backend_private_data(const struct samu *sampass, const struct pdb_methods *my_methods);
779 bool pdb_set_acct_ctrl(struct samu *sampass, uint32_t acct_ctrl, enum pdb_value_state flag);
780 bool pdb_set_logon_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
781 bool pdb_set_logoff_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
782 bool pdb_set_kickoff_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
783 bool pdb_set_bad_password_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
784 bool pdb_set_pass_can_change_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
785 bool pdb_set_pass_last_set_time(struct samu *sampass, time_t mytime, enum pdb_value_state flag);
786 bool pdb_set_hours_len(struct samu *sampass, uint32_t len, enum pdb_value_state flag);
787 bool pdb_set_logon_divs(struct samu *sampass, uint16_t hours, enum pdb_value_state flag);
788 bool pdb_set_init_flags(struct samu *sampass, enum pdb_elements element, enum pdb_value_state value_flag);
789 bool pdb_set_user_sid(struct samu *sampass, const struct dom_sid *u_sid, enum pdb_value_state flag);
790 bool pdb_set_user_sid_from_string(struct samu *sampass, const char *u_sid, enum pdb_value_state flag);
791 bool pdb_set_group_sid(struct samu *sampass, const struct dom_sid *g_sid, enum pdb_value_state flag);
792 bool pdb_set_username(struct samu *sampass, const char *username, enum pdb_value_state flag);
793 bool pdb_set_domain(struct samu *sampass, const char *domain, enum pdb_value_state flag);
794 bool pdb_set_nt_username(struct samu *sampass, const char *nt_username, enum pdb_value_state flag);
795 bool pdb_set_fullname(struct samu *sampass, const char *full_name, enum pdb_value_state flag);
796 bool pdb_set_logon_script(struct samu *sampass, const char *logon_script, enum pdb_value_state flag);
797 bool pdb_set_profile_path(struct samu *sampass, const char *profile_path, enum pdb_value_state flag);
798 bool pdb_set_dir_drive(struct samu *sampass, const char *dir_drive, enum pdb_value_state flag);
799 bool pdb_set_homedir(struct samu *sampass, const char *home_dir, enum pdb_value_state flag);
800 bool pdb_set_acct_desc(struct samu *sampass, const char *acct_desc, enum pdb_value_state flag);
801 bool pdb_set_workstations(struct samu *sampass, const char *workstations, enum pdb_value_state flag);
802 bool pdb_set_comment(struct samu *sampass, const char *comment, enum pdb_value_state flag);
803 bool pdb_set_munged_dial(struct samu *sampass, const char *munged_dial, enum pdb_value_state flag);
804 bool pdb_set_nt_passwd(struct samu *sampass, const uint8_t pwd[NT_HASH_LEN], enum pdb_value_state flag);
805 bool pdb_set_lanman_passwd(struct samu *sampass, const uint8_t pwd[LM_HASH_LEN], enum pdb_value_state flag);
806 bool pdb_set_pw_history(struct samu *sampass, const uint8_t *pwd, uint32_t historyLen, enum pdb_value_state flag);
807 bool pdb_set_plaintext_pw_only(struct samu *sampass, const char *password, enum pdb_value_state flag);
808 bool pdb_set_bad_password_count(struct samu *sampass, uint16_t bad_password_count, enum pdb_value_state flag);
809 bool pdb_set_logon_count(struct samu *sampass, uint16_t logon_count, enum pdb_value_state flag);
810 bool pdb_set_country_code(struct samu *sampass, uint16_t country_code,
811 enum pdb_value_state flag);
812 bool pdb_set_code_page(struct samu *sampass, uint16_t code_page,
813 enum pdb_value_state flag);
814 bool pdb_set_unknown_6(struct samu *sampass, uint32_t unkn, enum pdb_value_state flag);
815 bool pdb_set_hours(struct samu *sampass, const uint8_t *hours, int hours_len,
816 enum pdb_value_state flag);
817 bool pdb_set_backend_private_data(struct samu *sampass, void *private_data,
818 void (*free_fn)(void **),
819 const struct pdb_methods *my_methods,
820 enum pdb_value_state flag);
821 bool pdb_set_pass_can_change(struct samu *sampass, bool canchange);
822 bool pdb_set_plaintext_passwd(struct samu *sampass, const char *plaintext);
823 uint32_t pdb_build_fields_present(struct samu *sampass);
824 bool pdb_element_is_changed(const struct samu *sampass,
825 enum pdb_elements element);
826 bool pdb_element_is_set_or_changed(const struct samu *sampass,
827 enum pdb_elements element);
829 /* The following definitions come from passdb/pdb_interface.c */
831 NTSTATUS smb_register_passdb(int version, const char *name, pdb_init_function init) ;
832 struct pdb_init_function_entry *pdb_find_backend_entry(const char *name);
833 const struct pdb_init_function_entry *pdb_get_backends(void);
834 struct tevent_context *pdb_get_tevent_context(void);
835 NTSTATUS make_pdb_method_name(struct pdb_methods **methods, const char *selected);
836 struct pdb_domain_info *pdb_get_domain_info(TALLOC_CTX *mem_ctx);
837 bool pdb_getsampwnam(struct samu *sam_acct, const char *username) ;
838 bool pdb_getsampwsid(struct samu *sam_acct, const struct dom_sid *sid) ;
839 NTSTATUS pdb_create_user(TALLOC_CTX *mem_ctx, const char *name, uint32_t flags,
840 uint32_t *rid);
841 NTSTATUS pdb_delete_user(TALLOC_CTX *mem_ctx, struct samu *sam_acct);
842 NTSTATUS pdb_add_sam_account(struct samu *sam_acct) ;
843 NTSTATUS pdb_update_sam_account(struct samu *sam_acct) ;
844 NTSTATUS pdb_delete_sam_account(struct samu *sam_acct) ;
845 NTSTATUS pdb_rename_sam_account(struct samu *oldname, const char *newname);
846 NTSTATUS pdb_update_login_attempts(struct samu *sam_acct, bool success);
847 bool pdb_getgrsid(GROUP_MAP *map, struct dom_sid sid);
848 bool pdb_getgrgid(GROUP_MAP *map, gid_t gid);
849 bool pdb_getgrnam(GROUP_MAP *map, const char *name);
850 NTSTATUS pdb_create_dom_group(TALLOC_CTX *mem_ctx, const char *name,
851 uint32_t *rid);
852 NTSTATUS pdb_delete_dom_group(TALLOC_CTX *mem_ctx, uint32_t rid);
853 NTSTATUS pdb_add_group_mapping_entry(GROUP_MAP *map);
854 NTSTATUS pdb_update_group_mapping_entry(GROUP_MAP *map);
855 NTSTATUS pdb_delete_group_mapping_entry(struct dom_sid sid);
856 bool pdb_enum_group_mapping(const struct dom_sid *sid,
857 enum lsa_SidType sid_name_use,
858 GROUP_MAP ***pp_rmap,
859 size_t *p_num_entries,
860 bool unix_only);
861 NTSTATUS pdb_enum_group_members(TALLOC_CTX *mem_ctx,
862 const struct dom_sid *sid,
863 uint32_t **pp_member_rids,
864 size_t *p_num_members);
865 NTSTATUS pdb_enum_group_memberships(TALLOC_CTX *mem_ctx, struct samu *user,
866 struct dom_sid **pp_sids, gid_t **pp_gids,
867 uint32_t *p_num_groups);
868 NTSTATUS pdb_set_unix_primary_group(TALLOC_CTX *mem_ctx, struct samu *user);
869 NTSTATUS pdb_add_groupmem(TALLOC_CTX *mem_ctx, uint32_t group_rid,
870 uint32_t member_rid);
871 NTSTATUS pdb_del_groupmem(TALLOC_CTX *mem_ctx, uint32_t group_rid,
872 uint32_t member_rid);
873 NTSTATUS pdb_create_alias(const char *name, uint32_t *rid);
874 NTSTATUS pdb_delete_alias(const struct dom_sid *sid);
875 NTSTATUS pdb_get_aliasinfo(const struct dom_sid *sid, struct acct_info *info);
876 NTSTATUS pdb_set_aliasinfo(const struct dom_sid *sid, struct acct_info *info);
877 NTSTATUS pdb_add_aliasmem(const struct dom_sid *alias, const struct dom_sid *member);
878 NTSTATUS pdb_del_aliasmem(const struct dom_sid *alias, const struct dom_sid *member);
879 NTSTATUS pdb_enum_aliasmem(const struct dom_sid *alias, TALLOC_CTX *mem_ctx,
880 struct dom_sid **pp_members, size_t *p_num_members);
881 NTSTATUS pdb_enum_alias_memberships(TALLOC_CTX *mem_ctx,
882 const struct dom_sid *domain_sid,
883 const struct dom_sid *members, size_t num_members,
884 uint32_t **pp_alias_rids,
885 size_t *p_num_alias_rids);
886 NTSTATUS pdb_lookup_rids(const struct dom_sid *domain_sid,
887 int num_rids,
888 uint32_t *rids,
889 const char **names,
890 enum lsa_SidType *attrs);
891 NTSTATUS pdb_lookup_names(const struct dom_sid *domain_sid,
892 int num_names,
893 const char **names,
894 uint32_t *rids,
895 enum lsa_SidType *attrs);
896 bool pdb_get_account_policy(enum pdb_policy_type type, uint32_t *value);
897 bool pdb_set_account_policy(enum pdb_policy_type type, uint32_t value);
898 bool pdb_get_seq_num(time_t *seq_num);
900 * Instead of passing down a gid or uid, this function sends down a pointer
901 * to a unixid.
903 * This acts as an in-out variable so that the idmap functions can correctly
904 * receive ID_TYPE_BOTH, filling in cache details correctly rather than forcing
905 * the cache to store ID_TYPE_UID or ID_TYPE_GID.
907 bool pdb_id_to_sid(struct unixid *id, struct dom_sid *sid);
908 bool pdb_sid_to_id(const struct dom_sid *sid, struct unixid *id);
909 uint32_t pdb_capabilities(void);
910 bool pdb_new_rid(uint32_t *rid);
911 bool initialize_password_db(bool reload, struct tevent_context *tevent_ctx);
912 struct pdb_search *pdb_search_init(TALLOC_CTX *mem_ctx,
913 enum pdb_search_type type);
914 struct pdb_search *pdb_search_users(TALLOC_CTX *mem_ctx, uint32_t acct_flags);
915 struct pdb_search *pdb_search_groups(TALLOC_CTX *mem_ctx);
916 struct pdb_search *pdb_search_aliases(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
917 uint32_t pdb_search_entries(struct pdb_search *search,
918 uint32_t start_idx, uint32_t max_entries,
919 struct samr_displayentry **result);
920 bool pdb_get_trusteddom_pw(const char *domain, char** pwd, struct dom_sid *sid,
921 time_t *pass_last_set_time);
922 bool pdb_set_trusteddom_pw(const char* domain, const char* pwd,
923 const struct dom_sid *sid);
924 bool pdb_del_trusteddom_pw(const char *domain);
925 NTSTATUS pdb_enum_trusteddoms(TALLOC_CTX *mem_ctx, uint32_t *num_domains,
926 struct trustdom_info ***domains);
927 NTSTATUS pdb_get_trusted_domain(TALLOC_CTX *mem_ctx, const char *domain,
928 struct pdb_trusted_domain **td);
929 NTSTATUS pdb_get_trusted_domain_by_sid(TALLOC_CTX *mem_ctx, struct dom_sid *sid,
930 struct pdb_trusted_domain **td);
931 NTSTATUS pdb_set_trusted_domain(const char* domain,
932 const struct pdb_trusted_domain *td);
933 NTSTATUS pdb_del_trusted_domain(const char *domain);
934 NTSTATUS pdb_enum_trusted_domains(TALLOC_CTX *mem_ctx, uint32_t *num_domains,
935 struct pdb_trusted_domain ***domains);
936 NTSTATUS make_pdb_method( struct pdb_methods **methods ) ;
937 NTSTATUS pdb_get_secret(TALLOC_CTX *mem_ctx,
938 const char *secret_name,
939 DATA_BLOB *secret_current,
940 NTTIME *secret_current_lastchange,
941 DATA_BLOB *secret_old,
942 NTTIME *secret_old_lastchange,
943 struct security_descriptor **sd);
944 NTSTATUS pdb_set_secret(const char *secret_name,
945 DATA_BLOB *secret_current,
946 DATA_BLOB *secret_old,
947 struct security_descriptor *sd);
948 NTSTATUS pdb_delete_secret(const char *secret_name);
949 bool pdb_sid_to_id_unix_users_and_groups(const struct dom_sid *sid,
950 struct unixid *id);
952 NTSTATUS pdb_enum_upn_suffixes(TALLOC_CTX *mem_ctx,
953 uint32_t *num_suffixes,
954 char ***suffixes);
956 NTSTATUS pdb_set_upn_suffixes(uint32_t num_suffixes,
957 const char **suffixes);
958 bool pdb_is_responsible_for_our_sam(void);
959 bool pdb_is_responsible_for_builtin(void);
960 bool pdb_is_responsible_for_wellknown(void);
961 bool pdb_is_responsible_for_unix_users(void);
962 bool pdb_is_responsible_for_unix_groups(void);
963 bool pdb_is_responsible_for_everything_else(void);
965 /* The following definitions come from passdb/pdb_util.c */
967 NTSTATUS pdb_create_builtin(uint32_t rid);
968 NTSTATUS create_builtin_users(const struct dom_sid *sid);
969 NTSTATUS create_builtin_administrators(const struct dom_sid *sid);
971 #include "passdb/machine_sid.h"
972 #include "passdb/lookup_sid.h"
974 /* The following definitions come from passdb/pdb_unixid.c */
975 void unixid_from_uid(struct unixid *id, uint32_t some_uid);
976 void unixid_from_gid(struct unixid *id, uint32_t some_gid);
977 void unixid_from_both(struct unixid *id, uint32_t some_id);
979 /* The following definitions come from passdb/pdb_secrets.c
980 * and should be used by PDB modules if they need to store
981 * sid/guid information for the domain in secrets database
983 bool PDB_secrets_mark_domain_protected(const char *domain);
984 bool PDB_secrets_clear_domain_protection(const char *domain);
985 bool PDB_secrets_store_domain_sid(const char *domain, const struct dom_sid *sid);
986 bool PDB_secrets_fetch_domain_sid(const char *domain, struct dom_sid *sid);
987 bool PDB_secrets_store_domain_guid(const char *domain, struct GUID *guid);
988 bool PDB_secrets_fetch_domain_guid(const char *domain, struct GUID *guid);
990 #endif /* _PASSDB_H */