source: branches/samba-3.3.x/source/include/passdb.h

Last change on this file was 206, checked in by Herwig Bauernfeind, 16 years ago

Import Samba 3.3 branch at 3.0.0 level (psmedley's port)
File size: 12.0 KB
RevLine 
[206]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 3 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, see <http://www.gnu.org/licenses/>.
21*/
22
23#ifndef _PASSDB_H
24#define _PASSDB_H
25
26/*
27 * bit flags representing initialized fields in struct samu
28 */
29enum pdb_elements {
30 PDB_UNINIT,
31 PDB_SMBHOME,
32 PDB_PROFILE,
33 PDB_DRIVE,
34 PDB_LOGONSCRIPT,
35 PDB_LOGONTIME,
36 PDB_LOGOFFTIME,
37 PDB_KICKOFFTIME,
38 PDB_BAD_PASSWORD_TIME,
39 PDB_CANCHANGETIME,
40 PDB_MUSTCHANGETIME,
41 PDB_PLAINTEXT_PW,
42 PDB_USERNAME,
43 PDB_FULLNAME,
44 PDB_DOMAIN,
45 PDB_NTUSERNAME,
46 PDB_HOURSLEN,
47 PDB_LOGONDIVS,
48 PDB_USERSID,
49 PDB_GROUPSID,
50 PDB_ACCTCTRL,
51 PDB_PASSLASTSET,
52 PDB_ACCTDESC,
53 PDB_WORKSTATIONS,
54 PDB_COMMENT,
55 PDB_MUNGEDDIAL,
56 PDB_HOURS,
57 PDB_FIELDS_PRESENT,
58 PDB_BAD_PASSWORD_COUNT,
59 PDB_LOGON_COUNT,
60 PDB_UNKNOWN6,
61 PDB_LMPASSWD,
62 PDB_NTPASSWD,
63 PDB_PWHISTORY,
64 PDB_BACKEND_PRIVATE_DATA,
65
66 /* this must be the last element */
67 PDB_COUNT
68};
69
70enum pdb_group_elements {
71 PDB_GROUP_NAME,
72 PDB_GROUP_SID,
73 PDB_GROUP_SID_NAME_USE,
74 PDB_GROUP_MEMBERS,
75
76 /* this must be the last element */
77 PDB_GROUP_COUNT
78};
79
80
81enum pdb_value_state {
82 PDB_DEFAULT=0,
83 PDB_SET,
84 PDB_CHANGED
85};
86
87#define IS_SAM_SET(x, flag) (pdb_get_init_flags(x, flag) == PDB_SET)
88#define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
89#define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
90
91/* cache for bad password lockout data, to be used on replicated SAMs */
92typedef struct logon_cache_struct {
93 time_t entry_timestamp;
94 uint32 acct_ctrl;
95 uint16 bad_password_count;
96 time_t bad_password_time;
97} LOGIN_CACHE;
98
99#define SAMU_BUFFER_V0 0
100#define SAMU_BUFFER_V1 1
101#define SAMU_BUFFER_V2 2
102#define SAMU_BUFFER_V3 3
103/* nothing changed from V3 to V4 */
104#define SAMU_BUFFER_V4 4
105#define SAMU_BUFFER_LATEST SAMU_BUFFER_V4
106
107struct samu {
108 struct pdb_methods *methods;
109
110 /* initialization flags */
111 struct bitmap *change_flags;
112 struct bitmap *set_flags;
113
114 time_t logon_time; /* logon time */
115 time_t logoff_time; /* logoff time */
116 time_t kickoff_time; /* kickoff time */
117 time_t bad_password_time; /* last bad password entered */
118 time_t pass_last_set_time; /* password last set time */
119 time_t pass_can_change_time; /* password can change time */
120 time_t pass_must_change_time; /* password must change time */
121
122 const char *username; /* UNIX username string */
123 const char *domain; /* Windows Domain name */
124 const char *nt_username; /* Windows username string */
125 const char *full_name; /* user's full name string */
126 const char *home_dir; /* home directory string */
127 const char *dir_drive; /* home directory drive string */
128 const char *logon_script; /* logon script string */
129 const char *profile_path; /* profile path string */
130 const char *acct_desc; /* user description string */
131 const char *workstations; /* login from workstations string */
132 const char *comment;
133 const char *munged_dial; /* munged path name and dial-back tel number */
134
135 DOM_SID user_sid;
136 DOM_SID *group_sid;
137
138 DATA_BLOB lm_pw; /* .data is Null if no password */
139 DATA_BLOB nt_pw; /* .data is Null if no password */
140 DATA_BLOB nt_pw_his; /* nt hashed password history .data is Null if not available */
141 char* plaintext_pw; /* is Null if not available */
142
143 uint32 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
144 uint32 fields_present; /* 0x00ff ffff */
145
146 uint16 logon_divs; /* 168 - number of hours in a week */
147 uint32 hours_len; /* normally 21 bytes */
148 uint8 hours[MAX_HOURS_LEN];
149
150 /* Was unknown_5. */
151 uint16 bad_password_count;
152 uint16 logon_count;
153
154 uint32 unknown_6; /* 0x0000 04ec */
155
156 /* a tag for who added the private methods */
157
158 const struct pdb_methods *backend_private_methods;
159 void *backend_private_data;
160 void (*backend_private_data_free_fn)(void **);
161
162 /* maintain a copy of the user's struct passwd */
163
164 struct passwd *unix_pw;
165};
166
167struct acct_info {
168 fstring acct_name; /* account name */
169 fstring acct_desc; /* account name */
170 uint32 rid; /* domain-relative RID */
171};
172
173struct samr_displayentry {
174 uint32 idx;
175 uint32 rid;
176 uint32 acct_flags;
177 const char *account_name;
178 const char *fullname;
179 const char *description;
180};
181
182enum pdb_search_type {
183 PDB_USER_SEARCH,
184 PDB_GROUP_SEARCH,
185 PDB_ALIAS_SEARCH
186};
187
188struct pdb_search {
189 TALLOC_CTX *mem_ctx;
190 enum pdb_search_type type;
191 struct samr_displayentry *cache;
192 uint32 num_entries;
193 ssize_t cache_size;
194 bool search_ended;
195 void *private_data;
196 bool (*next_entry)(struct pdb_search *search,
197 struct samr_displayentry *entry);
198 void (*search_end)(struct pdb_search *search);
199};
200
201/*****************************************************************
202 Functions to be implemented by the new (v2) passdb API
203****************************************************************/
204
205/*
206 * This next constant specifies the version number of the PASSDB interface
207 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
208 * Changed interface to fix int -> size_t problems. JRA.
209 * There's no point in allocating arrays in
210 * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
211 * the pdb module. Remove the latter, this might happen more often. VL.
212 * changed to version 14 to move lookup_rids and lookup_names to return
213 * enum lsa_SidType rather than uint32.
214 * Changed to 16 for access to the trusted domain passwords (obnox).
215 * Changed to 17, the sampwent interface is gone.
216 */
217
218#define PASSDB_INTERFACE_VERSION 17
219
220struct pdb_methods
221{
222 const char *name; /* What name got this module */
223
224 NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
225
226 NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const DOM_SID *sid);
227
228 NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
229 const char *name, uint32 acct_flags,
230 uint32 *rid);
231
232 NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
233 struct samu *sam_acct);
234
235 NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
236
237 NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
238
239 NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
240
241 NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
242
243 NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
244
245 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
246
247 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
248
249 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
250
251 NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
252 TALLOC_CTX *mem_ctx, const char *name,
253 uint32 *rid);
254
255 NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
256 TALLOC_CTX *mem_ctx, uint32 rid);
257
258 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
259 GROUP_MAP *map);
260
261 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
262 GROUP_MAP *map);
263
264 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
265 DOM_SID sid);
266
267 NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
268 const DOM_SID *sid, enum lsa_SidType sid_name_use,
269 GROUP_MAP **pp_rmap, size_t *p_num_entries,
270 bool unix_only);
271
272 NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
273 TALLOC_CTX *mem_ctx,
274 const DOM_SID *group,
275 uint32 **pp_member_rids,
276 size_t *p_num_members);
277
278 NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
279 TALLOC_CTX *mem_ctx,
280 struct samu *user,
281 DOM_SID **pp_sids, gid_t **pp_gids,
282 size_t *p_num_groups);
283
284 NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
285 TALLOC_CTX *mem_ctx,
286 struct samu *user);
287
288 NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
289 TALLOC_CTX *mem_ctx,
290 uint32 group_rid, uint32 member_rid);
291
292 NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
293 TALLOC_CTX *mem_ctx,
294 uint32 group_rid, uint32 member_rid);
295
296 NTSTATUS (*create_alias)(struct pdb_methods *methods,
297 const char *name, uint32 *rid);
298
299 NTSTATUS (*delete_alias)(struct pdb_methods *methods,
300 const DOM_SID *sid);
301
302 NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
303 const DOM_SID *sid,
304 struct acct_info *info);
305
306 NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
307 const DOM_SID *sid,
308 struct acct_info *info);
309
310 NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
311 const DOM_SID *alias, const DOM_SID *member);
312 NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
313 const DOM_SID *alias, const DOM_SID *member);
314 NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
315 const DOM_SID *alias, DOM_SID **members,
316 size_t *p_num_members);
317 NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
318 TALLOC_CTX *mem_ctx,
319 const DOM_SID *domain_sid,
320 const DOM_SID *members,
321 size_t num_members,
322 uint32 **pp_alias_rids,
323 size_t *p_num_alias_rids);
324
325 NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
326 const DOM_SID *domain_sid,
327 int num_rids,
328 uint32 *rids,
329 const char **pp_names,
330 enum lsa_SidType *attrs);
331
332 NTSTATUS (*lookup_names)(struct pdb_methods *methods,
333 const DOM_SID *domain_sid,
334 int num_names,
335 const char **pp_names,
336 uint32 *rids,
337 enum lsa_SidType *attrs);
338
339 NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
340 int policy_index, uint32 *value);
341
342 NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
343 int policy_index, uint32 value);
344
345 NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
346
347 bool (*search_users)(struct pdb_methods *methods,
348 struct pdb_search *search,
349 uint32 acct_flags);
350 bool (*search_groups)(struct pdb_methods *methods,
351 struct pdb_search *search);
352 bool (*search_aliases)(struct pdb_methods *methods,
353 struct pdb_search *search,
354 const DOM_SID *sid);
355
356 bool (*uid_to_rid)(struct pdb_methods *methods, uid_t uid,
357 uint32 *rid);
358 bool (*uid_to_sid)(struct pdb_methods *methods, uid_t uid,
359 DOM_SID *sid);
360 bool (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
361 DOM_SID *sid);
362 bool (*sid_to_id)(struct pdb_methods *methods, const DOM_SID *sid,
363 union unid_t *id, enum lsa_SidType *type);
364
365 bool (*rid_algorithm)(struct pdb_methods *methods);
366 bool (*new_rid)(struct pdb_methods *methods, uint32 *rid);
367
368
369 bool (*get_trusteddom_pw)(struct pdb_methods *methods,
370 const char *domain, char** pwd,
371 DOM_SID *sid, time_t *pass_last_set_time);
372 bool (*set_trusteddom_pw)(struct pdb_methods *methods,
373 const char* domain, const char* pwd,
374 const DOM_SID *sid);
375 bool (*del_trusteddom_pw)(struct pdb_methods *methods,
376 const char *domain);
377 NTSTATUS (*enum_trusteddoms)(struct pdb_methods *methods,
378 TALLOC_CTX *mem_ctx, uint32 *num_domains,
379 struct trustdom_info ***domains);
380
381 void *private_data; /* Private data of some kind */
382
383 void (*free_private_data)(void **);
384};
385
386typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
387
388struct pdb_init_function_entry {
389 const char *name;
390
391 /* Function to create a member of the pdb_methods list */
392 pdb_init_function init;
393
394 struct pdb_init_function_entry *prev, *next;
395};
396
397#endif /* _PASSDB_H */
Note: See TracBrowser for help on using the repository browser.