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 struct samu
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;
139 struct pdb_methods *methods;
141 /* initialization flags */
142 struct bitmap *change_flags;
143 struct bitmap *set_flags;
145 time_t logon_time; /* logon time */
146 time_t logoff_time; /* logoff time */
147 time_t kickoff_time; /* kickoff time */
148 time_t bad_password_time; /* last bad password entered */
149 time_t pass_last_set_time; /* password last set time */
150 time_t pass_can_change_time; /* password can change time */
151 time_t pass_must_change_time; /* password must change time */
153 const char *username; /* UNIX username string */
154 const char *domain; /* Windows Domain name */
155 const char *nt_username; /* Windows username string */
156 const char *full_name; /* user's full name string */
157 const char *home_dir; /* home directory string */
158 const char *dir_drive; /* home directory drive string */
159 const char *logon_script; /* logon script string */
160 const char *profile_path; /* profile path string */
161 const char *acct_desc; /* user description string */
162 const char *workstations; /* login from workstations string */
163 const char *unknown_str; /* don't know what this is, yet. */
164 const char *munged_dial; /* munged path name and dial-back tel number */
166 DOM_SID user_sid; /* Primary User SID */
167 DOM_SID group_sid; /* Primary Group SID */
169 DATA_BLOB lm_pw; /* .data is Null if no password */
170 DATA_BLOB nt_pw; /* .data is Null if no password */
171 DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
172 char* plaintext_pw; /* is Null if not available */
174 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
175 uint32 fields_present; /* 0x00ff ffff */
177 uint16 logon_divs; /* 168 - number of hours in a week */
178 uint32 hours_len; /* normally 21 bytes */
179 uint8 hours[MAX_HOURS_LEN];
182 uint16 bad_password_count;
185 uint32 unknown_6; /* 0x0000 04ec */
187 /* a tag for who added the private methods */
188 const struct pdb_methods *backend_private_methods;
189 void *backend_private_data;
190 void (*backend_private_data_free_fn)(void **);
192 /* maintain a copy of the user's struct passwd */
194 struct passwd *unix_pw;
198 fstring acct_name; /* account name */
199 fstring acct_desc; /* account name */
200 uint32 rid; /* domain-relative RID */
203 struct samr_displayentry {
207 const char *account_name;
208 const char *fullname;
209 const char *description;
212 enum pdb_search_type {
220 enum pdb_search_type type;
221 struct samr_displayentry *cache;
226 BOOL (*next_entry)(struct pdb_search *search,
227 struct samr_displayentry *entry);
228 void (*search_end)(struct pdb_search *search);
231 /*****************************************************************
232 Functions to be implemented by the new (v2) passdb API
233 ****************************************************************/
236 * This next constant specifies the version number of the PASSDB interface
237 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
238 * Changed interface to fix int -> size_t problems. JRA.
239 * There's no point in allocating arrays in
240 * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
241 * the pdb module. Remove the latter, this might happen more often. VL.
244 #define PASSDB_INTERFACE_VERSION 12
248 const char *name; /* What name got this module */
250 NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update, uint16 acb_mask);
252 void (*endsampwent)(struct pdb_methods *);
254 NTSTATUS (*getsampwent)(struct pdb_methods *, struct samu *user);
256 NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
258 NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const DOM_SID *sid);
260 NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
261 const char *name, uint32 acct_flags,
264 NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
265 struct samu *sam_acct);
267 NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
269 NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
271 NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
273 NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
275 NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, BOOL success);
277 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
279 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
281 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
283 NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
284 TALLOC_CTX *mem_ctx, const char *name,
287 NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
288 TALLOC_CTX *mem_ctx, uint32 rid);
290 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
293 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
296 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
299 NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
300 enum SID_NAME_USE sid_name_use,
301 GROUP_MAP **pp_rmap, size_t *p_num_entries,
304 NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
306 const DOM_SID *group,
307 uint32 **pp_member_rids,
308 size_t *p_num_members);
310 NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
313 DOM_SID **pp_sids, gid_t **pp_gids,
314 size_t *p_num_groups);
316 NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
320 NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
322 uint32 group_rid, uint32 member_rid);
324 NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
326 uint32 group_rid, uint32 member_rid);
328 NTSTATUS (*find_alias)(struct pdb_methods *methods,
329 const char *name, DOM_SID *sid);
331 NTSTATUS (*create_alias)(struct pdb_methods *methods,
332 const char *name, uint32 *rid);
334 NTSTATUS (*delete_alias)(struct pdb_methods *methods,
337 NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
339 struct acct_info *info);
341 NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
343 struct acct_info *info);
345 NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
346 const DOM_SID *alias, const DOM_SID *member);
347 NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
348 const DOM_SID *alias, const DOM_SID *member);
349 NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
350 const DOM_SID *alias, DOM_SID **members,
351 size_t *p_num_members);
352 NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
354 const DOM_SID *domain_sid,
355 const DOM_SID *members,
357 uint32 **pp_alias_rids,
358 size_t *p_num_alias_rids);
360 NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
361 const DOM_SID *domain_sid,
364 const char **pp_names,
367 NTSTATUS (*lookup_names)(struct pdb_methods *methods,
368 const DOM_SID *domain_sid,
370 const char **pp_names,
374 NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
375 int policy_index, uint32 *value);
377 NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
378 int policy_index, uint32 value);
380 NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
382 BOOL (*search_users)(struct pdb_methods *methods,
383 struct pdb_search *search,
385 BOOL (*search_groups)(struct pdb_methods *methods,
386 struct pdb_search *search);
387 BOOL (*search_aliases)(struct pdb_methods *methods,
388 struct pdb_search *search,
391 BOOL (*uid_to_rid)(struct pdb_methods *methods, uid_t uid,
393 BOOL (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
395 BOOL (*sid_to_id)(struct pdb_methods *methods, const DOM_SID *sid,
396 union unid_t *id, enum SID_NAME_USE *type);
398 BOOL (*rid_algorithm)(struct pdb_methods *methods);
399 BOOL (*new_rid)(struct pdb_methods *methods, uint32 *rid);
401 void *private_data; /* Private data of some kind */
403 void (*free_private_data)(void **);
406 typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
408 struct pdb_init_function_entry {
411 /* Function to create a member of the pdb_methods list */
412 pdb_init_function init;
414 struct pdb_init_function_entry *prev, *next;
417 #endif /* _PASSDB_H */