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/>.
26 /**********************************************************************
27 * Masks for mappings between unix uid and gid types and
29 **********************************************************************/
31 /* Take the bottom bit. */
32 #define RID_TYPE_MASK 1
33 #define RID_MULTIPLIER 2
35 /* The two common types. */
36 #define USER_RID_TYPE 0
37 #define GROUP_RID_TYPE 1
40 * bit flags representing initialized fields in struct samu
51 PDB_BAD_PASSWORD_TIME
,
71 PDB_BAD_PASSWORD_COUNT
,
77 PDB_BACKEND_PRIVATE_DATA
,
79 /* this must be the last element */
83 enum pdb_group_elements
{
86 PDB_GROUP_SID_NAME_USE
,
89 /* this must be the last element */
94 enum pdb_value_state
{
100 #define IS_SAM_SET(x, flag) (pdb_get_init_flags(x, flag) == PDB_SET)
101 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
102 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
104 /* cache for bad password lockout data, to be used on replicated SAMs */
106 time_t entry_timestamp
;
108 uint16_t bad_password_count
;
109 time_t bad_password_time
;
112 #define SAMU_BUFFER_V0 0
113 #define SAMU_BUFFER_V1 1
114 #define SAMU_BUFFER_V2 2
115 #define SAMU_BUFFER_V3 3
116 /* nothing changed from V3 to V4 */
117 #define SAMU_BUFFER_V4 4
118 #define SAMU_BUFFER_LATEST SAMU_BUFFER_V4
121 struct pdb_methods
*methods
;
123 /* initialization flags */
124 struct bitmap
*change_flags
;
125 struct bitmap
*set_flags
;
127 time_t logon_time
; /* logon time */
128 time_t logoff_time
; /* logoff time */
129 time_t kickoff_time
; /* kickoff time */
130 time_t bad_password_time
; /* last bad password entered */
131 time_t pass_last_set_time
; /* password last set time */
132 time_t pass_can_change_time
; /* password can change time */
133 time_t pass_must_change_time
; /* password must change time */
135 const char *username
; /* UNIX username string */
136 const char *domain
; /* Windows Domain name */
137 const char *nt_username
; /* Windows username string */
138 const char *full_name
; /* user's full name string */
139 const char *home_dir
; /* home directory string */
140 const char *dir_drive
; /* home directory drive string */
141 const char *logon_script
; /* logon script string */
142 const char *profile_path
; /* profile path string */
143 const char *acct_desc
; /* user description string */
144 const char *workstations
; /* login from workstations string */
146 const char *munged_dial
; /* munged path name and dial-back tel number */
148 struct dom_sid user_sid
;
149 struct dom_sid
*group_sid
;
151 DATA_BLOB lm_pw
; /* .data is Null if no password */
152 DATA_BLOB nt_pw
; /* .data is Null if no password */
153 DATA_BLOB nt_pw_his
; /* nt hashed password history .data is Null if not available */
154 char* plaintext_pw
; /* is Null if not available */
156 uint32_t acct_ctrl
; /* account info (ACB_xxxx bit-mask) */
157 uint32_t fields_present
; /* 0x00ff ffff */
159 uint16_t logon_divs
; /* 168 - number of hours in a week */
160 uint32_t hours_len
; /* normally 21 bytes */
161 uint8_t hours
[MAX_HOURS_LEN
];
164 uint16_t bad_password_count
;
165 uint16_t logon_count
;
167 uint32_t unknown_6
; /* 0x0000 04ec */
169 /* a tag for who added the private methods */
171 const struct pdb_methods
*backend_private_methods
;
172 void *backend_private_data
;
173 void (*backend_private_data_free_fn
)(void **);
175 /* maintain a copy of the user's struct passwd */
177 struct passwd
*unix_pw
;
181 fstring acct_name
; /* account name */
182 fstring acct_desc
; /* account name */
183 uint32_t rid
; /* domain-relative RID */
186 struct samr_displayentry
{
190 const char *account_name
;
191 const char *fullname
;
192 const char *description
;
195 enum pdb_search_type
{
202 enum pdb_search_type type
;
203 struct samr_displayentry
*cache
;
204 uint32_t num_entries
;
208 bool (*next_entry
)(struct pdb_search
*search
,
209 struct samr_displayentry
*entry
);
210 void (*search_end
)(struct pdb_search
*search
);
213 struct pdb_domain_info
{
222 * trusted domain entry/entries returned by secrets_get_trusted_domains
223 * (used in _lsa_enum_trust_dom call)
225 struct trustdom_info
{
231 * Types of account policy.
233 enum pdb_policy_type
{
234 PDB_POLICY_MIN_PASSWORD_LEN
= 1,
235 PDB_POLICY_PASSWORD_HISTORY
= 2,
236 PDB_POLICY_USER_MUST_LOGON_TO_CHG_PASS
= 3,
237 PDB_POLICY_MAX_PASSWORD_AGE
= 4,
238 PDB_POLICY_MIN_PASSWORD_AGE
= 5,
239 PDB_POLICY_LOCK_ACCOUNT_DURATION
= 6,
240 PDB_POLICY_RESET_COUNT_TIME
= 7,
241 PDB_POLICY_BAD_ATTEMPT_LOCKOUT
= 8,
242 PDB_POLICY_TIME_TO_LOGOUT
= 9,
243 PDB_POLICY_REFUSE_MACHINE_PW_CHANGE
= 10
246 #define PDB_CAP_STORE_RIDS 0x0001
247 #define PDB_CAP_ADS 0x0002
249 /*****************************************************************
250 Functions to be implemented by the new (v2) passdb API
251 ****************************************************************/
254 * This next constant specifies the version number of the PASSDB interface
255 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
256 * Changed interface to fix int -> size_t problems. JRA.
257 * There's no point in allocating arrays in
258 * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
259 * the pdb module. Remove the latter, this might happen more often. VL.
260 * changed to version 14 to move lookup_rids and lookup_names to return
261 * enum lsa_SidType rather than uint32_t.
262 * Changed to 16 for access to the trusted domain passwords (obnox).
263 * Changed to 17, the sampwent interface is gone.
264 * Changed to 18, pdb_rid_algorithm -> pdb_capabilities
265 * Changed to 19, removed uid_to_rid
268 #define PASSDB_INTERFACE_VERSION 19
272 const char *name
; /* What name got this module */
274 struct pdb_domain_info
*(*get_domain_info
)(struct pdb_methods
*,
275 TALLOC_CTX
*mem_ctx
);
277 NTSTATUS (*getsampwnam
)(struct pdb_methods
*, struct samu
*sam_acct
, const char *username
);
279 NTSTATUS (*getsampwsid
)(struct pdb_methods
*, struct samu
*sam_acct
, const struct dom_sid
*sid
);
281 NTSTATUS (*create_user
)(struct pdb_methods
*, TALLOC_CTX
*tmp_ctx
,
282 const char *name
, uint32_t acct_flags
,
285 NTSTATUS (*delete_user
)(struct pdb_methods
*, TALLOC_CTX
*tmp_ctx
,
286 struct samu
*sam_acct
);
288 NTSTATUS (*add_sam_account
)(struct pdb_methods
*, struct samu
*sampass
);
290 NTSTATUS (*update_sam_account
)(struct pdb_methods
*, struct samu
*sampass
);
292 NTSTATUS (*delete_sam_account
)(struct pdb_methods
*, struct samu
*username
);
294 NTSTATUS (*rename_sam_account
)(struct pdb_methods
*, struct samu
*oldname
, const char *newname
);
296 NTSTATUS (*update_login_attempts
)(struct pdb_methods
*methods
, struct samu
*sam_acct
, bool success
);
298 NTSTATUS (*getgrsid
)(struct pdb_methods
*methods
, GROUP_MAP
*map
, struct dom_sid sid
);
300 NTSTATUS (*getgrgid
)(struct pdb_methods
*methods
, GROUP_MAP
*map
, gid_t gid
);
302 NTSTATUS (*getgrnam
)(struct pdb_methods
*methods
, GROUP_MAP
*map
, const char *name
);
304 NTSTATUS (*create_dom_group
)(struct pdb_methods
*methods
,
305 TALLOC_CTX
*mem_ctx
, const char *name
,
308 NTSTATUS (*delete_dom_group
)(struct pdb_methods
*methods
,
309 TALLOC_CTX
*mem_ctx
, uint32_t rid
);
311 NTSTATUS (*add_group_mapping_entry
)(struct pdb_methods
*methods
,
314 NTSTATUS (*update_group_mapping_entry
)(struct pdb_methods
*methods
,
317 NTSTATUS (*delete_group_mapping_entry
)(struct pdb_methods
*methods
,
320 NTSTATUS (*enum_group_mapping
)(struct pdb_methods
*methods
,
321 const struct dom_sid
*sid
, enum lsa_SidType sid_name_use
,
322 GROUP_MAP
**pp_rmap
, size_t *p_num_entries
,
325 NTSTATUS (*enum_group_members
)(struct pdb_methods
*methods
,
327 const struct dom_sid
*group
,
328 uint32_t **pp_member_rids
,
329 size_t *p_num_members
);
331 NTSTATUS (*enum_group_memberships
)(struct pdb_methods
*methods
,
334 struct dom_sid
**pp_sids
, gid_t
**pp_gids
,
335 size_t *p_num_groups
);
337 NTSTATUS (*set_unix_primary_group
)(struct pdb_methods
*methods
,
341 NTSTATUS (*add_groupmem
)(struct pdb_methods
*methods
,
343 uint32_t group_rid
, uint32_t member_rid
);
345 NTSTATUS (*del_groupmem
)(struct pdb_methods
*methods
,
347 uint32_t group_rid
, uint32_t member_rid
);
349 NTSTATUS (*create_alias
)(struct pdb_methods
*methods
,
350 const char *name
, uint32_t *rid
);
352 NTSTATUS (*delete_alias
)(struct pdb_methods
*methods
,
353 const struct dom_sid
*sid
);
355 NTSTATUS (*get_aliasinfo
)(struct pdb_methods
*methods
,
356 const struct dom_sid
*sid
,
357 struct acct_info
*info
);
359 NTSTATUS (*set_aliasinfo
)(struct pdb_methods
*methods
,
360 const struct dom_sid
*sid
,
361 struct acct_info
*info
);
363 NTSTATUS (*add_aliasmem
)(struct pdb_methods
*methods
,
364 const struct dom_sid
*alias
, const struct dom_sid
*member
);
365 NTSTATUS (*del_aliasmem
)(struct pdb_methods
*methods
,
366 const struct dom_sid
*alias
, const struct dom_sid
*member
);
367 NTSTATUS (*enum_aliasmem
)(struct pdb_methods
*methods
,
368 const struct dom_sid
*alias
, TALLOC_CTX
*mem_ctx
,
369 struct dom_sid
**members
, size_t *p_num_members
);
370 NTSTATUS (*enum_alias_memberships
)(struct pdb_methods
*methods
,
372 const struct dom_sid
*domain_sid
,
373 const struct dom_sid
*members
,
375 uint32_t **pp_alias_rids
,
376 size_t *p_num_alias_rids
);
378 NTSTATUS (*lookup_rids
)(struct pdb_methods
*methods
,
379 const struct dom_sid
*domain_sid
,
382 const char **pp_names
,
383 enum lsa_SidType
*attrs
);
385 NTSTATUS (*lookup_names
)(struct pdb_methods
*methods
,
386 const struct dom_sid
*domain_sid
,
388 const char **pp_names
,
390 enum lsa_SidType
*attrs
);
392 NTSTATUS (*get_account_policy
)(struct pdb_methods
*methods
,
393 enum pdb_policy_type type
,
396 NTSTATUS (*set_account_policy
)(struct pdb_methods
*methods
,
397 enum pdb_policy_type type
,
400 NTSTATUS (*get_seq_num
)(struct pdb_methods
*methods
, time_t *seq_num
);
402 bool (*search_users
)(struct pdb_methods
*methods
,
403 struct pdb_search
*search
,
404 uint32_t acct_flags
);
405 bool (*search_groups
)(struct pdb_methods
*methods
,
406 struct pdb_search
*search
);
407 bool (*search_aliases
)(struct pdb_methods
*methods
,
408 struct pdb_search
*search
,
409 const struct dom_sid
*sid
);
411 bool (*uid_to_sid
)(struct pdb_methods
*methods
, uid_t uid
,
412 struct dom_sid
*sid
);
413 bool (*gid_to_sid
)(struct pdb_methods
*methods
, gid_t gid
,
414 struct dom_sid
*sid
);
415 bool (*sid_to_id
)(struct pdb_methods
*methods
, const struct dom_sid
*sid
,
416 union unid_t
*id
, enum lsa_SidType
*type
);
418 uint32_t (*capabilities
)(struct pdb_methods
*methods
);
419 bool (*new_rid
)(struct pdb_methods
*methods
, uint32_t *rid
);
422 bool (*get_trusteddom_pw
)(struct pdb_methods
*methods
,
423 const char *domain
, char** pwd
,
424 struct dom_sid
*sid
, time_t *pass_last_set_time
);
425 bool (*set_trusteddom_pw
)(struct pdb_methods
*methods
,
426 const char* domain
, const char* pwd
,
427 const struct dom_sid
*sid
);
428 bool (*del_trusteddom_pw
)(struct pdb_methods
*methods
,
430 NTSTATUS (*enum_trusteddoms
)(struct pdb_methods
*methods
,
431 TALLOC_CTX
*mem_ctx
, uint32_t *num_domains
,
432 struct trustdom_info
***domains
);
434 void *private_data
; /* Private data of some kind */
436 void (*free_private_data
)(void **);
439 typedef NTSTATUS (*pdb_init_function
)(struct pdb_methods
**, const char *);
441 struct pdb_init_function_entry
{
444 /* Function to create a member of the pdb_methods list */
445 pdb_init_function init
;
447 struct pdb_init_function_entry
*prev
, *next
;
450 #endif /* _PASSDB_H */