Make sure we don't clobber the stack when response consists of the empty
[Samba/gebeck_regimport.git] / source3 / include / passdb.h
blob21feb7208f00c66400e3699a36a95e467dfca4fb
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
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.
24 #ifndef _PASSDB_H
25 #define _PASSDB_H
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
67 enum 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_UNKNOWNSTR,
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_BACKEND_PRIVATE_DATA,
104 /* this must be the last element */
105 PDB_COUNT
108 enum pdb_group_elements {
109 PDB_GROUP_NAME,
110 PDB_GROUP_SID,
111 PDB_GROUP_SID_NAME_USE,
112 PDB_GROUP_MEMBERS,
114 /* this must be the last element */
115 PDB_GROUP_COUNT
118 enum pdb_trust_passwd_elements {
119 PDB_TRUST_PASS,
120 PDB_TRUST_SID,
121 PDB_TRUST_NAME,
122 PDB_TRUST_MODTIME,
123 PDB_TRUST_FLAGS,
125 PDB_TRUST_COUNT
128 enum pdb_value_state {
129 PDB_DEFAULT=0,
130 PDB_SET,
131 PDB_CHANGED
134 #define IS_SAM_SET(x, flag) (pdb_get_init_flags(x, flag) == PDB_SET)
135 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
136 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
138 typedef struct sam_passwd
140 TALLOC_CTX *mem_ctx;
142 void (*free_fn)(struct sam_passwd **);
144 struct pdb_methods *methods;
146 struct user_data {
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];
187 /* Was unknown_5. */
188 uint16 bad_password_count;
189 uint16 logon_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 **);
196 } private;
198 /* Lets see if the remaining code can get the hint that you
199 are meant to use the pdb_...() functions. */
201 } SAM_ACCOUNT;
203 typedef struct sam_group {
204 TALLOC_CTX *mem_ctx;
206 void (*free_fn)(struct sam_group **);
208 struct pdb_methods *methods;
210 struct group_data {
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 */
222 } private;
224 } SAM_GROUP;
227 typedef struct _GROUP_INFO {
228 struct pdb_methods *methods;
229 DOM_SID sid;
230 enum SID_NAME_USE sid_name_use;
231 fstring nt_name;
232 fstring comment;
233 } GROUP_INFO;
235 struct acct_info
237 fstring acct_name; /* account name */
238 fstring acct_desc; /* account name */
239 uint32 rid; /* domain-relative RID */
242 typedef struct sam_trust_passwd {
243 TALLOC_CTX *mem_ctx;
245 void (*free_fn)(struct sam_trust_passwd **);
247 struct pdb_methods *methods;
249 struct trust_passwd_data {
250 uint16 flags; /* flags */
251 size_t uni_name_len; /* unicode name length */
252 smb_ucs2_t uni_name[32]; /* unicode domain name */
253 fstring pass; /* trust password */
254 time_t mod_time; /* last change time */
255 DOM_SID domain_sid; /* trusted domain sid */
256 } private;
258 } SAM_TRUST_PASSWD;
262 /*****************************************************************
263 Functions to be implemented by the new (v2) passdb API
264 ****************************************************************/
267 * This next constant specifies the version number of the PASSDB interface
268 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
271 #define PASSDB_INTERFACE_VERSION 7
273 typedef struct pdb_context
275 struct pdb_methods *pdb_methods;
276 struct pdb_methods *pwent_methods;
278 /* These functions are wrappers for the functions listed above.
279 They may do extra things like re-reading a SAM_ACCOUNT on update */
281 NTSTATUS (*pdb_setsampwent)(struct pdb_context *, BOOL update);
283 void (*pdb_endsampwent)(struct pdb_context *);
285 NTSTATUS (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
287 NTSTATUS (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
289 NTSTATUS (*pdb_getsampwsid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
291 NTSTATUS (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
293 NTSTATUS (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
295 NTSTATUS (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
297 /* group mapping functions: to be removed */
299 NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map, DOM_SID sid);
301 NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map, gid_t gid);
303 NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map, const char *name);
305 NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
306 GROUP_MAP *map);
308 NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
309 GROUP_MAP *map);
311 NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
312 DOM_SID sid);
314 NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
315 enum SID_NAME_USE sid_name_use,
316 GROUP_MAP **rmap, int *num_entries,
317 BOOL unix_only);
319 NTSTATUS (*pdb_find_alias)(struct pdb_context *context,
320 const char *name, DOM_SID *sid);
322 NTSTATUS (*pdb_create_alias)(struct pdb_context *context,
323 const char *name, uint32 *rid);
325 NTSTATUS (*pdb_delete_alias)(struct pdb_context *context,
326 const DOM_SID *sid);
328 NTSTATUS (*pdb_enum_aliases)(struct pdb_context *context,
329 const DOM_SID *domain_sid,
330 uint32 start_idx, uint32 num_entries,
331 uint32 *num_aliases,
332 struct acct_info **aliases);
334 NTSTATUS (*pdb_get_aliasinfo)(struct pdb_context *context,
335 const DOM_SID *sid,
336 struct acct_info *info);
338 NTSTATUS (*pdb_set_aliasinfo)(struct pdb_context *context,
339 const DOM_SID *sid,
340 struct acct_info *info);
342 NTSTATUS (*pdb_add_aliasmem)(struct pdb_context *context,
343 const DOM_SID *alias,
344 const DOM_SID *member);
346 NTSTATUS (*pdb_del_aliasmem)(struct pdb_context *context,
347 const DOM_SID *alias,
348 const DOM_SID *member);
350 NTSTATUS (*pdb_enum_aliasmem)(struct pdb_context *context,
351 const DOM_SID *alias,
352 DOM_SID **members, int *num_members);
354 NTSTATUS (*pdb_enum_alias_memberships)(struct pdb_context *context,
355 const DOM_SID *alias,
356 DOM_SID **aliases,
357 int *num);
359 /* group functions */
361 NTSTATUS (*pdb_get_group_info_by_sid)(struct pdb_context *context, GROUP_INFO *info, const DOM_SID *group);
363 NTSTATUS (*pdb_get_group_list)(struct pdb_context *context, GROUP_INFO **info, const enum SID_NAME_USE sid_name_use, int *num_groups);
365 NTSTATUS (*pdb_get_group_sids)(struct pdb_context *context, const DOM_SID *group, DOM_SID **members, int *num_members);
367 NTSTATUS (*pdb_add_group)(struct pdb_context *context, const SAM_GROUP *group);
369 NTSTATUS (*pdb_update_group)(struct pdb_context *context, const SAM_GROUP *group);
371 NTSTATUS (*pdb_delete_group)(struct pdb_context *context, const DOM_SID *group);
373 NTSTATUS (*pdb_add_sid_to_group)(struct pdb_context *context, const DOM_SID *group, const DOM_SID *member);
375 NTSTATUS (*pdb_remove_sid_from_group)(struct pdb_context *context, const DOM_SID *group, const DOM_SID *member);
377 NTSTATUS (*pdb_get_group_info_by_name)(struct pdb_context *context, GROUP_INFO *info, const char *name);
379 NTSTATUS (*pdb_get_group_info_by_nt_name)(struct pdb_context *context, GROUP_INFO *info, const char *nt_name);
381 NTSTATUS (*pdb_get_group_uids)(struct pdb_context *context, const DOM_SID *group, uid_t **members, int *num_members);
383 /* trust password functions */
385 NTSTATUS (*pdb_settrustpwent)(struct pdb_context *context);
387 NTSTATUS (*pdb_gettrustpwent)(struct pdb_context *context, SAM_TRUST_PASSWD *trust);
389 NTSTATUS (*pdb_gettrustpwnam)(struct pdb_context *context, SAM_TRUST_PASSWD *trust, const char *dom_name);
391 NTSTATUS (*pdb_gettrustpwsid)(struct pdb_context *context, SAM_TRUST_PASSWD *trust, const DOM_SID *sid);
393 NTSTATUS (*pdb_add_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
395 NTSTATUS (*pdb_update_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
397 NTSTATUS (*pdb_delete_trust_passwd)(struct pdb_context *context, SAM_TRUST_PASSWD* trust);
399 /* privileges functions */
401 NTSTATUS (*pdb_add_sid_to_privilege)(struct pdb_context *context, const char *priv_name, const DOM_SID *sid);
403 NTSTATUS (*pdb_remove_sid_from_privilege)(struct pdb_context *context, const char *priv_name, const DOM_SID *sid);
405 NTSTATUS (*pdb_get_privilege_set)(struct pdb_context *context, NT_USER_TOKEN *token, PRIVILEGE_SET *privs);
407 NTSTATUS (*pdb_get_privilege_entry)(struct pdb_context *context, const char *privname, char **sid_list);
409 void (*free_fn)(struct pdb_context **);
411 TALLOC_CTX *mem_ctx;
413 } PDB_CONTEXT;
415 typedef struct pdb_methods
417 const char *name; /* What name got this module */
418 struct pdb_context *parent;
420 /* Use macros from dlinklist.h on these two */
421 struct pdb_methods *next;
422 struct pdb_methods *prev;
424 NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update);
426 void (*endsampwent)(struct pdb_methods *);
428 NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
430 NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
432 NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
434 NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
436 NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
438 NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
440 /* group mapping functions: to be removed */
442 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
444 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
446 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
448 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
449 GROUP_MAP *map);
451 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
452 GROUP_MAP *map);
454 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
455 DOM_SID sid);
457 NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
458 enum SID_NAME_USE sid_name_use,
459 GROUP_MAP **rmap, int *num_entries,
460 BOOL unix_only);
462 NTSTATUS (*find_alias)(struct pdb_methods *methods,
463 const char *name, DOM_SID *sid);
465 NTSTATUS (*create_alias)(struct pdb_methods *methods,
466 const char *name, uint32 *rid);
468 NTSTATUS (*delete_alias)(struct pdb_methods *methods,
469 const DOM_SID *sid);
471 NTSTATUS (*enum_aliases)(struct pdb_methods *methods,
472 const DOM_SID *domain_sid,
473 uint32 start_idx, uint32 max_entries,
474 uint32 *num_aliases, struct acct_info **info);
476 NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
477 const DOM_SID *sid,
478 struct acct_info *info);
480 NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
481 const DOM_SID *sid,
482 struct acct_info *info);
484 NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
485 const DOM_SID *alias, const DOM_SID *member);
486 NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
487 const DOM_SID *alias, const DOM_SID *member);
488 NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
489 const DOM_SID *alias, DOM_SID **members,
490 int *num_members);
491 NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
492 const DOM_SID *sid,
493 DOM_SID **aliases, int *num);
495 /* group functions */
497 NTSTATUS (*get_group_info_by_sid)(struct pdb_methods *methods, GROUP_INFO *info, const DOM_SID *group);
499 NTSTATUS (*get_group_list)(struct pdb_methods *methods, GROUP_INFO **info, const enum SID_NAME_USE sid_name_use, int *num_groups);
501 NTSTATUS (*get_group_sids)(struct pdb_methods *methods, const DOM_SID *group, DOM_SID **members, int *num_members);
503 NTSTATUS (*add_group)(struct pdb_methods *methods, const SAM_GROUP *group);
505 NTSTATUS (*update_group)(struct pdb_methods *methods, const SAM_GROUP *group);
507 NTSTATUS (*delete_group)(struct pdb_methods *methods, const DOM_SID *group);
509 NTSTATUS (*add_sid_to_group)(struct pdb_methods *methods, const DOM_SID *group, const DOM_SID *member);
511 NTSTATUS (*remove_sid_from_group)(struct pdb_methods *methods, const DOM_SID *group, const DOM_SID *member);
513 NTSTATUS (*get_group_info_by_name)(struct pdb_methods *methods, GROUP_INFO *info, const char *name);
515 NTSTATUS (*get_group_info_by_nt_name)(struct pdb_methods *methods, GROUP_INFO *info, const char *nt_name);
517 NTSTATUS (*get_group_uids)(struct pdb_methods *methods, const DOM_SID *group, uid_t **members, int *num_members);
519 void *private_data; /* Private data of some kind */
521 void (*free_private_data)(void **);
523 /* trust password functions */
525 NTSTATUS (*settrustpwent)(struct pdb_methods *methods);
527 NTSTATUS (*gettrustpwent)(struct pdb_methods *methods, SAM_TRUST_PASSWD *trust);
529 NTSTATUS (*gettrustpwnam)(struct pdb_methods *methods, SAM_TRUST_PASSWD *trust, const char *name);
531 NTSTATUS (*gettrustpwsid)(struct pdb_methods *methods, SAM_TRUST_PASSWD *trust, const DOM_SID *sid);
533 NTSTATUS (*add_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
535 NTSTATUS (*update_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
537 NTSTATUS (*delete_trust_passwd)(struct pdb_methods *methods, const SAM_TRUST_PASSWD* trust);
539 /* privileges functions */
541 NTSTATUS (*add_sid_to_privilege)(struct pdb_methods *methods, const char *priv_name, const DOM_SID *sid);
543 NTSTATUS (*remove_sid_from_privilege)(struct pdb_methods *methods, const char *priv_name, const DOM_SID *sid);
545 NTSTATUS (*get_privilege_set)(struct pdb_methods *methods, NT_USER_TOKEN *token, PRIVILEGE_SET *privs);
547 NTSTATUS (*get_privilege_entry)(struct pdb_methods *methods, const char *privname, char **sid_list);
549 } PDB_METHODS;
551 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
552 struct pdb_methods **,
553 const char *);
555 struct pdb_init_function_entry {
556 const char *name;
557 /* Function to create a member of the pdb_methods list */
558 pdb_init_function init;
559 struct pdb_init_function_entry *prev, *next;
562 enum sql_search_field { SQL_SEARCH_NONE = 0, SQL_SEARCH_USER_SID = 1, SQL_SEARCH_USER_NAME = 2};
564 #endif /* _PASSDB_H */