source: branches/samba-3.0/source/include/passdb.h

Last change on this file was 1, checked in by Paul Smedley, 18 years ago

Initial code import
File size: 12.6 KB
Line 
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
8
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.
13
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.
18
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.
22*/
23
24#ifndef _PASSDB_H
25#define _PASSDB_H
26
27
28/*
29 * fields_present flags meanings
30 * same names as found in samba4 idl files
31 */
32
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_DESCRIPTION 0x00000010
38#define ACCT_COMMENT 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
63
64/*
65 * bit flags representing initialized fields in struct samu
66 */
67enum pdb_elements {
68 PDB_UNINIT,
69 PDB_SMBHOME,
70 PDB_PROFILE,
71 PDB_DRIVE,
72 PDB_LOGONSCRIPT,
73 PDB_LOGONTIME,
74 PDB_LOGOFFTIME,
75 PDB_KICKOFFTIME,
76 PDB_BAD_PASSWORD_TIME,
77 PDB_CANCHANGETIME,
78 PDB_MUSTCHANGETIME,
79 PDB_PLAINTEXT_PW,
80 PDB_USERNAME,
81 PDB_FULLNAME,
82 PDB_DOMAIN,
83 PDB_NTUSERNAME,
84 PDB_HOURSLEN,
85 PDB_LOGONDIVS,
86 PDB_USERSID,
87 PDB_GROUPSID,
88 PDB_ACCTCTRL,
89 PDB_PASSLASTSET,
90 PDB_UNIXHOMEDIR,
91 PDB_ACCTDESC,
92 PDB_WORKSTATIONS,
93 PDB_COMMENT,
94 PDB_MUNGEDDIAL,
95 PDB_HOURS,
96 PDB_FIELDS_PRESENT,
97 PDB_BAD_PASSWORD_COUNT,
98 PDB_LOGON_COUNT,
99 PDB_UNKNOWN6,
100 PDB_LMPASSWD,
101 PDB_NTPASSWD,
102 PDB_PWHISTORY,
103 PDB_BACKEND_PRIVATE_DATA,
104
105 /* this must be the last element */
106 PDB_COUNT
107};
108
109enum pdb_group_elements {
110 PDB_GROUP_NAME,
111 PDB_GROUP_SID,
112 PDB_GROUP_SID_NAME_USE,
113 PDB_GROUP_MEMBERS,
114
115 /* this must be the last element */
116 PDB_GROUP_COUNT
117};
118
119
120enum pdb_value_state {
121 PDB_DEFAULT=0,
122 PDB_SET,
123 PDB_CHANGED
124};
125
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)
129
130/* cache for bad password lockout data, to be used on replicated SAMs */
131typedef struct logon_cache_struct {
132 time_t entry_timestamp;
133 uint32 acct_ctrl;
134 uint16 bad_password_count;
135 time_t bad_password_time;
136} LOGIN_CACHE;
137
138struct samu {
139 struct pdb_methods *methods;
140
141 /* initialization flags */
142 struct bitmap *change_flags;
143 struct bitmap *set_flags;
144
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 */
152
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 *comment;
164 const char *munged_dial; /* munged path name and dial-back tel number */
165
166 DOM_SID user_sid;
167 DOM_SID *group_sid;
168
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 */
173
174 uint32 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
175 uint32 fields_present; /* 0x00ff ffff */
176
177 uint16 logon_divs; /* 168 - number of hours in a week */
178 uint32 hours_len; /* normally 21 bytes */
179 uint8 hours[MAX_HOURS_LEN];
180
181 /* Was unknown_5. */
182 uint16 bad_password_count;
183 uint16 logon_count;
184
185 uint32 unknown_6; /* 0x0000 04ec */
186
187 /* a tag for who added the private methods */
188
189 const struct pdb_methods *backend_private_methods;
190 void *backend_private_data;
191 void (*backend_private_data_free_fn)(void **);
192
193 /* maintain a copy of the user's struct passwd */
194
195 struct passwd *unix_pw;
196};
197
198struct acct_info {
199 fstring acct_name; /* account name */
200 fstring acct_desc; /* account name */
201 uint32 rid; /* domain-relative RID */
202};
203
204struct samr_displayentry {
205 uint32 idx;
206 uint32 rid;
207 uint32 acct_flags;
208 const char *account_name;
209 const char *fullname;
210 const char *description;
211};
212
213enum pdb_search_type {
214 PDB_USER_SEARCH,
215 PDB_GROUP_SEARCH,
216 PDB_ALIAS_SEARCH
217};
218
219struct pdb_search {
220 TALLOC_CTX *mem_ctx;
221 enum pdb_search_type type;
222 struct samr_displayentry *cache;
223 uint32 num_entries;
224 ssize_t cache_size;
225 BOOL search_ended;
226 void *private_data;
227 BOOL (*next_entry)(struct pdb_search *search,
228 struct samr_displayentry *entry);
229 void (*search_end)(struct pdb_search *search);
230};
231
232/*****************************************************************
233 Functions to be implemented by the new (v2) passdb API
234****************************************************************/
235
236/*
237 * This next constant specifies the version number of the PASSDB interface
238 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
239 * Changed interface to fix int -> size_t problems. JRA.
240 * There's no point in allocating arrays in
241 * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
242 * the pdb module. Remove the latter, this might happen more often. VL.
243 * changed to version 14 to move lookup_rids and lookup_names to return
244 * enum lsa_SidType rather than uint32.
245 */
246
247#define PASSDB_INTERFACE_VERSION 15
248
249struct pdb_methods
250{
251 const char *name; /* What name got this module */
252
253 NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update, uint32 acb_mask);
254
255 void (*endsampwent)(struct pdb_methods *);
256
257 NTSTATUS (*getsampwent)(struct pdb_methods *, struct samu *user);
258
259 NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
260
261 NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const DOM_SID *sid);
262
263 NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
264 const char *name, uint32 acct_flags,
265 uint32 *rid);
266
267 NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
268 struct samu *sam_acct);
269
270 NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
271
272 NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
273
274 NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
275
276 NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
277
278 NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, BOOL success);
279
280 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
281
282 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
283
284 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
285
286 NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
287 TALLOC_CTX *mem_ctx, const char *name,
288 uint32 *rid);
289
290 NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
291 TALLOC_CTX *mem_ctx, uint32 rid);
292
293 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
294 GROUP_MAP *map);
295
296 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
297 GROUP_MAP *map);
298
299 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
300 DOM_SID sid);
301
302 NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
303 const DOM_SID *sid, enum lsa_SidType sid_name_use,
304 GROUP_MAP **pp_rmap, size_t *p_num_entries,
305 BOOL unix_only);
306
307 NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
308 TALLOC_CTX *mem_ctx,
309 const DOM_SID *group,
310 uint32 **pp_member_rids,
311 size_t *p_num_members);
312
313 NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
314 TALLOC_CTX *mem_ctx,
315 struct samu *user,
316 DOM_SID **pp_sids, gid_t **pp_gids,
317 size_t *p_num_groups);
318
319 NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
320 TALLOC_CTX *mem_ctx,
321 struct samu *user);
322
323 NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
324 TALLOC_CTX *mem_ctx,
325 uint32 group_rid, uint32 member_rid);
326
327 NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
328 TALLOC_CTX *mem_ctx,
329 uint32 group_rid, uint32 member_rid);
330
331 NTSTATUS (*find_alias)(struct pdb_methods *methods,
332 const char *name, DOM_SID *sid);
333
334 NTSTATUS (*create_alias)(struct pdb_methods *methods,
335 const char *name, uint32 *rid);
336
337 NTSTATUS (*delete_alias)(struct pdb_methods *methods,
338 const DOM_SID *sid);
339
340 NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
341 const DOM_SID *sid,
342 struct acct_info *info);
343
344 NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
345 const DOM_SID *sid,
346 struct acct_info *info);
347
348 NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
349 const DOM_SID *alias, const DOM_SID *member);
350 NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
351 const DOM_SID *alias, const DOM_SID *member);
352 NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
353 const DOM_SID *alias, DOM_SID **members,
354 size_t *p_num_members);
355 NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
356 TALLOC_CTX *mem_ctx,
357 const DOM_SID *domain_sid,
358 const DOM_SID *members,
359 size_t num_members,
360 uint32 **pp_alias_rids,
361 size_t *p_num_alias_rids);
362
363 NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
364 const DOM_SID *domain_sid,
365 int num_rids,
366 uint32 *rids,
367 const char **pp_names,
368 enum lsa_SidType *attrs);
369
370 NTSTATUS (*lookup_names)(struct pdb_methods *methods,
371 const DOM_SID *domain_sid,
372 int num_names,
373 const char **pp_names,
374 uint32 *rids,
375 enum lsa_SidType *attrs);
376
377 NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
378 int policy_index, uint32 *value);
379
380 NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
381 int policy_index, uint32 value);
382
383 NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
384
385 BOOL (*search_users)(struct pdb_methods *methods,
386 struct pdb_search *search,
387 uint32 acct_flags);
388 BOOL (*search_groups)(struct pdb_methods *methods,
389 struct pdb_search *search);
390 BOOL (*search_aliases)(struct pdb_methods *methods,
391 struct pdb_search *search,
392 const DOM_SID *sid);
393
394 BOOL (*uid_to_rid)(struct pdb_methods *methods, uid_t uid,
395 uint32 *rid);
396 BOOL (*uid_to_sid)(struct pdb_methods *methods, uid_t uid,
397 DOM_SID *sid);
398 BOOL (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
399 DOM_SID *sid);
400 BOOL (*sid_to_id)(struct pdb_methods *methods, const DOM_SID *sid,
401 union unid_t *id, enum lsa_SidType *type);
402
403 BOOL (*rid_algorithm)(struct pdb_methods *methods);
404 BOOL (*new_rid)(struct pdb_methods *methods, uint32 *rid);
405
406 void *private_data; /* Private data of some kind */
407
408 void (*free_private_data)(void **);
409};
410
411typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
412
413struct pdb_init_function_entry {
414 const char *name;
415
416 /* Function to create a member of the pdb_methods list */
417 pdb_init_function init;
418
419 struct pdb_init_function_entry *prev, *next;
420};
421
422#endif /* _PASSDB_H */
Note: See TracBrowser for help on using the repository browser.