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 2 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, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 * fields_present flags meanings
30 * same names as found in samba4 idl files
33 #define ACCT_USERNAME 0x00000001
34 #define ACCT_FULL_NAME 0x00000002
35 #define ACCT_RID 0x00000004
36 #define ACCT_PRIMARY_GID 0x00000008
37 #define ACCT_ADMIN_DESC 0x00000010
38 #define ACCT_DESCRIPTION 0x00000020
39 #define ACCT_HOME_DIR 0x00000040
40 #define ACCT_HOME_DRIVE 0x00000080
41 #define ACCT_LOGON_SCRIPT 0x00000100
42 #define ACCT_PROFILE 0x00000200
43 #define ACCT_WORKSTATIONS 0x00000400
44 #define ACCT_LAST_LOGON 0x00000800
45 #define ACCT_LAST_LOGOFF 0x00001000
46 #define ACCT_LOGON_HOURS 0x00002000
47 #define ACCT_BAD_PWD_COUNT 0x00004000
48 #define ACCT_NUM_LOGONS 0x00008000
49 #define ACCT_ALLOW_PWD_CHANGE 0x00010000
50 #define ACCT_FORCE_PWD_CHANGE 0x00020000
51 #define ACCT_LAST_PWD_CHANGE 0x00040000
52 #define ACCT_EXPIRY 0x00080000
53 #define ACCT_FLAGS 0x00100000
54 #define ACCT_CALLBACK 0x00200000
55 #define ACCT_COUNTRY_CODE 0x00400000
56 #define ACCT_CODE_PAGE 0x00800000
57 #define ACCT_NT_PWD_SET 0x01000000
58 #define ACCT_LM_PWD_SET 0x02000000
59 #define ACCT_PRIVATEDATA 0x04000000
60 #define ACCT_EXPIRED_FLAG 0x08000000
61 #define ACCT_SEC_DESC 0x10000000
62 #define ACCT_OWF_PWD 0x20000000
65 * bit flags representing initialized fields in SAM_ACCOUNT
76 PDB_BAD_PASSWORD_TIME,
97 PDB_BAD_PASSWORD_COUNT,
103 PDB_BACKEND_PRIVATE_DATA,
105 /* this must be the last element */
109 enum pdb_group_elements {
112 PDB_GROUP_SID_NAME_USE,
115 /* this must be the last element */
120 enum pdb_value_state {
126 #define IS_SAM_SET(x, flag) (pdb_get_init_flags(x, flag) == PDB_SET)
127 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
128 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
130 /* cache for bad password lockout data, to be used on replicated SAMs */
131 typedef struct logon_cache_struct {
132 time_t entry_timestamp;
134 uint16 bad_password_count;
135 time_t bad_password_time;
138 typedef struct sam_passwd {
141 void (*free_fn)(struct sam_passwd **);
143 struct pdb_methods *methods;
146 /* initialization flags */
147 struct bitmap *change_flags;
148 struct bitmap *set_flags;
150 time_t logon_time; /* logon time */
151 time_t logoff_time; /* logoff time */
152 time_t kickoff_time; /* kickoff time */
153 time_t bad_password_time; /* last bad password entered */
154 time_t pass_last_set_time; /* password last set time */
155 time_t pass_can_change_time; /* password can change time */
156 time_t pass_must_change_time; /* password must change time */
158 const char * username; /* UNIX username string */
159 const char * domain; /* Windows Domain name */
160 const char * nt_username; /* Windows username string */
161 const char * full_name; /* user's full name string */
162 const char * unix_home_dir; /* UNIX home directory string */
163 const char * home_dir; /* home directory string */
164 const char * dir_drive; /* home directory drive string */
165 const char * logon_script; /* logon script string */
166 const char * profile_path; /* profile path string */
167 const char * acct_desc; /* user description string */
168 const char * workstations; /* login from workstations string */
169 const char * unknown_str; /* don't know what this is, yet. */
170 const char * munged_dial; /* munged path name and dial-back tel number */
172 DOM_SID user_sid; /* Primary User SID */
173 DOM_SID group_sid; /* Primary Group SID */
175 DATA_BLOB lm_pw; /* .data is Null if no password */
176 DATA_BLOB nt_pw; /* .data is Null if no password */
177 DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
178 char* plaintext_pw; /* is Null if not available */
180 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
181 uint32 fields_present; /* 0x00ff ffff */
183 uint16 logon_divs; /* 168 - number of hours in a week */
184 uint32 hours_len; /* normally 21 bytes */
185 uint8 hours[MAX_HOURS_LEN];
188 uint16 bad_password_count;
191 uint32 unknown_6; /* 0x0000 04ec */
192 /* a tag for who added the private methods */
193 const struct pdb_methods *backend_private_methods;
194 void *backend_private_data;
195 void (*backend_private_data_free_fn)(void **);
198 /* Lets see if the remaining code can get the hint that you
199 are meant to use the pdb_...() functions. */
203 typedef struct sam_group {
206 void (*free_fn)(struct sam_group **);
208 struct pdb_methods *methods;
211 /* initialization flags */
212 struct bitmap *change_flags;
213 struct bitmap *set_flags;
215 const char *name; /* Windows group name string */
217 DOM_SID sid; /* Group SID */
218 enum SID_NAME_USE sid_name_use; /* Group type */
220 uint32 mem_num; /* Number of member SIDs */
221 DOM_SID *members; /* SID array */
227 fstring acct_name; /* account name */
228 fstring acct_desc; /* account name */
229 uint32 rid; /* domain-relative RID */
232 struct samr_displayentry {
236 const char *account_name;
237 const char *fullname;
238 const char *description;
241 enum pdb_search_type {
249 enum pdb_search_type type;
250 struct samr_displayentry *cache;
255 BOOL (*next_entry)(struct pdb_search *search,
256 struct samr_displayentry *entry);
257 void (*search_end)(struct pdb_search *search);
260 /*****************************************************************
261 Functions to be implemented by the new (v2) passdb API
262 ****************************************************************/
265 * This next constant specifies the version number of the PASSDB interface
266 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
267 * Changed interface to fix int -> size_t problems. JRA.
268 * There's no point in allocating arrays in
269 * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
270 * the pdb module. Remove the latter, this might happen more often. VL.
273 #define PASSDB_INTERFACE_VERSION 12
275 typedef struct pdb_context
277 struct pdb_methods *pdb_methods;
278 struct pdb_methods *pwent_methods;
280 /* These functions are wrappers for the functions listed above.
281 They may do extra things like re-reading a SAM_ACCOUNT on update */
283 NTSTATUS (*pdb_setsampwent)(struct pdb_context *, BOOL update, uint16 acb_mask);
285 void (*pdb_endsampwent)(struct pdb_context *);
287 NTSTATUS (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
289 NTSTATUS (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
291 NTSTATUS (*pdb_getsampwsid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
293 NTSTATUS (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
295 NTSTATUS (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
297 NTSTATUS (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
299 NTSTATUS (*pdb_rename_sam_account)(struct pdb_context *, SAM_ACCOUNT *oldname, const char *newname);
301 NTSTATUS (*pdb_update_login_attempts)(struct pdb_context *context, SAM_ACCOUNT *sam_acct, BOOL success);
303 NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map, DOM_SID sid);
305 NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map, gid_t gid);
307 NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map, const char *name);
309 NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
312 NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
315 NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
318 NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
319 enum SID_NAME_USE sid_name_use,
320 GROUP_MAP **pp_rmap, size_t *p_num_entries,
323 NTSTATUS (*pdb_enum_group_members)(struct pdb_context *context,
325 const DOM_SID *group,
326 uint32 **pp_member_rids,
327 size_t *p_num_members);
329 NTSTATUS (*pdb_enum_group_memberships)(struct pdb_context *context,
330 const char *username,
332 DOM_SID **pp_sids, gid_t **pp_gids,
333 size_t *p_num_groups);
335 NTSTATUS (*pdb_find_alias)(struct pdb_context *context,
336 const char *name, DOM_SID *sid);
338 NTSTATUS (*pdb_create_alias)(struct pdb_context *context,
339 const char *name, uint32 *rid);
341 NTSTATUS (*pdb_delete_alias)(struct pdb_context *context,
344 NTSTATUS (*pdb_get_aliasinfo)(struct pdb_context *context,
346 struct acct_info *info);
348 NTSTATUS (*pdb_set_aliasinfo)(struct pdb_context *context,
350 struct acct_info *info);
352 NTSTATUS (*pdb_add_aliasmem)(struct pdb_context *context,
353 const DOM_SID *alias,
354 const DOM_SID *member);
356 NTSTATUS (*pdb_del_aliasmem)(struct pdb_context *context,
357 const DOM_SID *alias,
358 const DOM_SID *member);
360 NTSTATUS (*pdb_enum_aliasmem)(struct pdb_context *context,
361 const DOM_SID *alias,
362 DOM_SID **pp_members, size_t *p_num_members);
364 NTSTATUS (*pdb_enum_alias_memberships)(struct pdb_context *context,
366 const DOM_SID *domain_sid,
367 const DOM_SID *members,
369 uint32 **pp_alias_rids,
370 size_t *p_num_alias_rids);
372 NTSTATUS (*pdb_lookup_rids)(struct pdb_context *context,
373 const DOM_SID *domain_sid,
376 const char **pp_names,
379 NTSTATUS (*pdb_lookup_names)(struct pdb_context *context,
380 const DOM_SID *domain_sid,
386 NTSTATUS (*pdb_get_account_policy)(struct pdb_context *context,
387 int policy_index, uint32 *value);
389 NTSTATUS (*pdb_set_account_policy)(struct pdb_context *context,
390 int policy_index, uint32 value);
392 NTSTATUS (*pdb_get_seq_num)(struct pdb_context *context, time_t *seq_num);
394 BOOL (*pdb_search_users)(struct pdb_context *context,
395 struct pdb_search *search,
397 BOOL (*pdb_search_groups)(struct pdb_context *context,
398 struct pdb_search *search);
399 BOOL (*pdb_search_aliases)(struct pdb_context *context,
400 struct pdb_search *search,
403 void (*free_fn)(struct pdb_context **);
409 typedef struct pdb_methods
411 const char *name; /* What name got this module */
412 struct pdb_context *parent;
414 /* Use macros from dlinklist.h on these two */
415 struct pdb_methods *next;
416 struct pdb_methods *prev;
418 NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update, uint16 acb_mask);
420 void (*endsampwent)(struct pdb_methods *);
422 NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
424 NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
426 NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
428 NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
430 NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
432 NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
434 NTSTATUS (*rename_sam_account)(struct pdb_methods *, SAM_ACCOUNT *oldname, const char *newname);
436 NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, SAM_ACCOUNT *sam_acct, BOOL success);
438 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
440 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
442 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
444 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
447 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
450 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
453 NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
454 enum SID_NAME_USE sid_name_use,
455 GROUP_MAP **pp_rmap, size_t *p_num_entries,
458 NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
460 const DOM_SID *group,
461 uint32 **pp_member_rids,
462 size_t *p_num_members);
464 NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
465 const char *username,
467 DOM_SID **pp_sids, gid_t **pp_gids,
468 size_t *p_num_groups);
470 NTSTATUS (*find_alias)(struct pdb_methods *methods,
471 const char *name, DOM_SID *sid);
473 NTSTATUS (*create_alias)(struct pdb_methods *methods,
474 const char *name, uint32 *rid);
476 NTSTATUS (*delete_alias)(struct pdb_methods *methods,
479 NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
481 struct acct_info *info);
483 NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
485 struct acct_info *info);
487 NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
488 const DOM_SID *alias, const DOM_SID *member);
489 NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
490 const DOM_SID *alias, const DOM_SID *member);
491 NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
492 const DOM_SID *alias, DOM_SID **members,
493 size_t *p_num_members);
494 NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
496 const DOM_SID *domain_sid,
497 const DOM_SID *members,
499 uint32 **pp_alias_rids,
500 size_t *p_num_alias_rids);
502 NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
503 const DOM_SID *domain_sid,
506 const char **pp_names,
509 NTSTATUS (*lookup_names)(struct pdb_methods *methods,
510 const DOM_SID *domain_sid,
512 const char **pp_names,
516 NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
517 int policy_index, uint32 *value);
519 NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
520 int policy_index, uint32 value);
522 NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
524 BOOL (*search_users)(struct pdb_methods *methods,
525 struct pdb_search *search,
527 BOOL (*search_groups)(struct pdb_methods *methods,
528 struct pdb_search *search);
529 BOOL (*search_aliases)(struct pdb_methods *methods,
530 struct pdb_search *search,
533 void *private_data; /* Private data of some kind */
535 void (*free_private_data)(void **);
539 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
540 struct pdb_methods **,
543 struct pdb_init_function_entry {
545 /* Function to create a member of the pdb_methods list */
546 pdb_init_function init;
547 struct pdb_init_function_entry *prev, *next;
550 enum sql_search_field { SQL_SEARCH_NONE = 0, SQL_SEARCH_USER_SID = 1, SQL_SEARCH_USER_NAME = 2};
552 #endif /* _PASSDB_H */