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
,
102 PDB_BACKEND_PRIVATE_DATA
,
104 /* this must be the last element */
108 enum pdb_group_elements
{
111 PDB_GROUP_SID_NAME_USE
,
114 /* this must be the last element */
119 enum pdb_value_state
{
125 #define IS_SAM_SET(x, flag) (pdb_get_init_flags(x, flag) == PDB_SET)
126 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
127 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
129 /* cache for bad password lockout data, to be used on replicated SAMs */
130 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
142 void (*free_fn
)(struct sam_passwd
**);
144 struct pdb_methods
*methods
;
147 /* initialization flags */
148 struct bitmap
*change_flags
;
149 struct bitmap
*set_flags
;
151 time_t logon_time
; /* logon time */
152 time_t logoff_time
; /* logoff time */
153 time_t kickoff_time
; /* kickoff time */
154 time_t bad_password_time
; /* last bad password entered */
155 time_t pass_last_set_time
; /* password last set time */
156 time_t pass_can_change_time
; /* password can change time */
157 time_t pass_must_change_time
; /* password must change time */
159 const char * username
; /* UNIX username string */
160 const char * domain
; /* Windows Domain name */
161 const char * nt_username
; /* Windows username string */
162 const char * full_name
; /* user's full name string */
163 const char * unix_home_dir
; /* UNIX home directory string */
164 const char * home_dir
; /* home directory string */
165 const char * dir_drive
; /* home directory drive string */
166 const char * logon_script
; /* logon script string */
167 const char * profile_path
; /* profile path string */
168 const char * acct_desc
; /* user description string */
169 const char * workstations
; /* login from workstations string */
170 const char * unknown_str
; /* don't know what this is, yet. */
171 const char * munged_dial
; /* munged path name and dial-back tel number */
173 DOM_SID user_sid
; /* Primary User SID */
174 DOM_SID group_sid
; /* Primary Group SID */
176 DATA_BLOB lm_pw
; /* .data is Null if no password */
177 DATA_BLOB nt_pw
; /* .data is Null if no password */
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 */
228 fstring acct_name
; /* account name */
229 fstring acct_desc
; /* account name */
230 uint32 rid
; /* domain-relative RID */
233 /*****************************************************************
234 Functions to be implemented by the new (v2) passdb API
235 ****************************************************************/
238 * This next constant specifies the version number of the PASSDB interface
239 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
242 #define PASSDB_INTERFACE_VERSION 5
244 typedef struct pdb_context
246 struct pdb_methods
*pdb_methods
;
247 struct pdb_methods
*pwent_methods
;
249 /* These functions are wrappers for the functions listed above.
250 They may do extra things like re-reading a SAM_ACCOUNT on update */
252 NTSTATUS (*pdb_setsampwent
)(struct pdb_context
*, BOOL update
);
254 void (*pdb_endsampwent
)(struct pdb_context
*);
256 NTSTATUS (*pdb_getsampwent
)(struct pdb_context
*, SAM_ACCOUNT
*user
);
258 NTSTATUS (*pdb_getsampwnam
)(struct pdb_context
*, SAM_ACCOUNT
*sam_acct
, const char *username
);
260 NTSTATUS (*pdb_getsampwsid
)(struct pdb_context
*, SAM_ACCOUNT
*sam_acct
, const DOM_SID
*sid
);
262 NTSTATUS (*pdb_add_sam_account
)(struct pdb_context
*, SAM_ACCOUNT
*sampass
);
264 NTSTATUS (*pdb_update_sam_account
)(struct pdb_context
*, SAM_ACCOUNT
*sampass
);
266 NTSTATUS (*pdb_delete_sam_account
)(struct pdb_context
*, SAM_ACCOUNT
*username
);
268 NTSTATUS (*pdb_getgrsid
)(struct pdb_context
*context
, GROUP_MAP
*map
, DOM_SID sid
);
270 NTSTATUS (*pdb_getgrgid
)(struct pdb_context
*context
, GROUP_MAP
*map
, gid_t gid
);
272 NTSTATUS (*pdb_getgrnam
)(struct pdb_context
*context
, GROUP_MAP
*map
, const char *name
);
274 NTSTATUS (*pdb_add_group_mapping_entry
)(struct pdb_context
*context
,
277 NTSTATUS (*pdb_update_group_mapping_entry
)(struct pdb_context
*context
,
280 NTSTATUS (*pdb_delete_group_mapping_entry
)(struct pdb_context
*context
,
283 NTSTATUS (*pdb_enum_group_mapping
)(struct pdb_context
*context
,
284 enum SID_NAME_USE sid_name_use
,
285 GROUP_MAP
**rmap
, int *num_entries
,
288 NTSTATUS (*pdb_find_alias
)(struct pdb_context
*context
,
289 const char *name
, DOM_SID
*sid
);
291 NTSTATUS (*pdb_create_alias
)(struct pdb_context
*context
,
292 const char *name
, uint32
*rid
);
294 NTSTATUS (*pdb_delete_alias
)(struct pdb_context
*context
,
297 NTSTATUS (*pdb_enum_aliases
)(struct pdb_context
*context
,
298 const DOM_SID
*domain_sid
,
299 uint32 start_idx
, uint32 num_entries
,
301 struct acct_info
**aliases
);
303 NTSTATUS (*pdb_get_aliasinfo
)(struct pdb_context
*context
,
305 struct acct_info
*info
);
307 NTSTATUS (*pdb_set_aliasinfo
)(struct pdb_context
*context
,
309 struct acct_info
*info
);
311 NTSTATUS (*pdb_add_aliasmem
)(struct pdb_context
*context
,
312 const DOM_SID
*alias
,
313 const DOM_SID
*member
);
315 NTSTATUS (*pdb_del_aliasmem
)(struct pdb_context
*context
,
316 const DOM_SID
*alias
,
317 const DOM_SID
*member
);
319 NTSTATUS (*pdb_enum_aliasmem
)(struct pdb_context
*context
,
320 const DOM_SID
*alias
,
321 DOM_SID
**members
, int *num_members
);
323 NTSTATUS (*pdb_enum_alias_memberships
)(struct pdb_context
*context
,
324 const DOM_SID
*alias
,
328 void (*free_fn
)(struct pdb_context
**);
334 typedef struct pdb_methods
336 const char *name
; /* What name got this module */
337 struct pdb_context
*parent
;
339 /* Use macros from dlinklist.h on these two */
340 struct pdb_methods
*next
;
341 struct pdb_methods
*prev
;
343 NTSTATUS (*setsampwent
)(struct pdb_methods
*, BOOL update
);
345 void (*endsampwent
)(struct pdb_methods
*);
347 NTSTATUS (*getsampwent
)(struct pdb_methods
*, SAM_ACCOUNT
*user
);
349 NTSTATUS (*getsampwnam
)(struct pdb_methods
*, SAM_ACCOUNT
*sam_acct
, const char *username
);
351 NTSTATUS (*getsampwsid
)(struct pdb_methods
*, SAM_ACCOUNT
*sam_acct
, const DOM_SID
*sid
);
353 NTSTATUS (*add_sam_account
)(struct pdb_methods
*, SAM_ACCOUNT
*sampass
);
355 NTSTATUS (*update_sam_account
)(struct pdb_methods
*, SAM_ACCOUNT
*sampass
);
357 NTSTATUS (*delete_sam_account
)(struct pdb_methods
*, SAM_ACCOUNT
*username
);
359 NTSTATUS (*getgrsid
)(struct pdb_methods
*methods
, GROUP_MAP
*map
, DOM_SID sid
);
361 NTSTATUS (*getgrgid
)(struct pdb_methods
*methods
, GROUP_MAP
*map
, gid_t gid
);
363 NTSTATUS (*getgrnam
)(struct pdb_methods
*methods
, GROUP_MAP
*map
, const char *name
);
365 NTSTATUS (*add_group_mapping_entry
)(struct pdb_methods
*methods
,
368 NTSTATUS (*update_group_mapping_entry
)(struct pdb_methods
*methods
,
371 NTSTATUS (*delete_group_mapping_entry
)(struct pdb_methods
*methods
,
374 NTSTATUS (*enum_group_mapping
)(struct pdb_methods
*methods
,
375 enum SID_NAME_USE sid_name_use
,
376 GROUP_MAP
**rmap
, int *num_entries
,
379 NTSTATUS (*find_alias
)(struct pdb_methods
*methods
,
380 const char *name
, DOM_SID
*sid
);
382 NTSTATUS (*create_alias
)(struct pdb_methods
*methods
,
383 const char *name
, uint32
*rid
);
385 NTSTATUS (*delete_alias
)(struct pdb_methods
*methods
,
388 NTSTATUS (*enum_aliases
)(struct pdb_methods
*methods
,
389 const DOM_SID
*domain_sid
,
390 uint32 start_idx
, uint32 max_entries
,
391 uint32
*num_aliases
, struct acct_info
**info
);
393 NTSTATUS (*get_aliasinfo
)(struct pdb_methods
*methods
,
395 struct acct_info
*info
);
397 NTSTATUS (*set_aliasinfo
)(struct pdb_methods
*methods
,
399 struct acct_info
*info
);
401 NTSTATUS (*add_aliasmem
)(struct pdb_methods
*methods
,
402 const DOM_SID
*alias
, const DOM_SID
*member
);
403 NTSTATUS (*del_aliasmem
)(struct pdb_methods
*methods
,
404 const DOM_SID
*alias
, const DOM_SID
*member
);
405 NTSTATUS (*enum_aliasmem
)(struct pdb_methods
*methods
,
406 const DOM_SID
*alias
, DOM_SID
**members
,
408 NTSTATUS (*enum_alias_memberships
)(struct pdb_methods
*methods
,
410 DOM_SID
**aliases
, int *num
);
412 void *private_data
; /* Private data of some kind */
414 void (*free_private_data
)(void **);
418 typedef NTSTATUS (*pdb_init_function
)(struct pdb_context
*,
419 struct pdb_methods
**,
422 struct pdb_init_function_entry
{
424 /* Function to create a member of the pdb_methods list */
425 pdb_init_function init
;
426 struct pdb_init_function_entry
*prev
, *next
;
429 enum sql_search_field
{ SQL_SEARCH_NONE
= 0, SQL_SEARCH_USER_SID
= 1, SQL_SEARCH_USER_NAME
= 2};
431 #endif /* _PASSDB_H */