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 * bit flags representing initialized fields in SAM_ACCOUNT
60 PDB_BAD_PASSWORD_COUNT,
65 PDB_BACKEND_PRIVATE_DATA,
67 /* this must be the last element */
71 enum pdb_group_elements {
74 PDB_GROUP_SID_NAME_USE,
77 /* this must be the last element */
82 enum pdb_value_state {
88 #define IS_SAM_SET(x, flag) (pdb_get_init_flags(x, flag) == PDB_SET)
89 #define IS_SAM_CHANGED(x, flag) (pdb_get_init_flags(x, flag) == PDB_CHANGED)
90 #define IS_SAM_DEFAULT(x, flag) (pdb_get_init_flags(x, flag) == PDB_DEFAULT)
92 typedef struct sam_passwd
96 void (*free_fn)(struct sam_passwd **);
98 struct pdb_methods *methods;
101 /* initiailization flags */
102 struct bitmap *change_flags;
103 struct bitmap *set_flags;
105 time_t logon_time; /* logon time */
106 time_t logoff_time; /* logoff time */
107 time_t kickoff_time; /* kickoff time */
108 time_t pass_last_set_time; /* password last set time */
109 time_t pass_can_change_time; /* password can change time */
110 time_t pass_must_change_time; /* password must change time */
112 const char * username; /* UNIX username string */
113 const char * domain; /* Windows Domain name */
114 const char * nt_username; /* Windows username string */
115 const char * full_name; /* user's full name string */
116 const char * unix_home_dir; /* UNIX home directory string */
117 const char * home_dir; /* home directory string */
118 const char * dir_drive; /* home directory drive string */
119 const char * logon_script; /* logon script string */
120 const char * profile_path; /* profile path string */
121 const char * acct_desc ; /* user description string */
122 const char * workstations; /* login from workstations string */
123 const char * unknown_str ; /* don't know what this is, yet. */
124 const char * munged_dial ; /* munged path name and dial-back tel number */
126 DOM_SID user_sid; /* Primary User SID */
127 DOM_SID group_sid; /* Primary Group SID */
129 DATA_BLOB lm_pw; /* .data is Null if no password */
130 DATA_BLOB nt_pw; /* .data is Null if no password */
131 char* plaintext_pw; /* is Null if not available */
133 uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
134 uint32 unknown_3; /* 0x00ff ffff */
136 uint16 logon_divs; /* 168 - number of hours in a week */
137 uint32 hours_len; /* normally 21 bytes */
138 uint8 hours[MAX_HOURS_LEN];
141 uint16 bad_password_count;
144 uint32 unknown_6; /* 0x0000 04ec */
145 /* a tag for who added the private methods */
146 const struct pdb_methods *backend_private_methods;
147 void *backend_private_data;
148 void (*backend_private_data_free_fn)(void **);
151 /* Lets see if the remaining code can get the hint that you
152 are meant to use the pdb_...() functions. */
156 typedef struct sam_group {
159 void (*free_fn)(struct sam_group **);
161 struct pdb_methods *methods;
164 /* initiailization flags */
165 struct bitmap *change_flags;
166 struct bitmap *set_flags;
168 const char *name; /* Windows group name string */
170 DOM_SID sid; /* Group SID */
171 enum SID_NAME_USE sid_name_use; /* Group type */
173 uint32 mem_num; /* Number of member SIDs */
174 DOM_SID *members; /* SID array */
180 /*****************************************************************
181 Functions to be implemented by the new (v2) passdb API
182 ****************************************************************/
185 * This next constant specifies the version number of the PASSDB interface
186 * this SAMBA will load. Increment this if *ANY* changes are made to the interface.
189 #define PASSDB_INTERFACE_VERSION 4
191 typedef struct pdb_context
193 struct pdb_methods *pdb_methods;
194 struct pdb_methods *pwent_methods;
196 /* These functions are wrappers for the functions listed above.
197 They may do extra things like re-reading a SAM_ACCOUNT on update */
199 NTSTATUS (*pdb_setsampwent)(struct pdb_context *, BOOL update);
201 void (*pdb_endsampwent)(struct pdb_context *);
203 NTSTATUS (*pdb_getsampwent)(struct pdb_context *, SAM_ACCOUNT *user);
205 NTSTATUS (*pdb_getsampwnam)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const char *username);
207 NTSTATUS (*pdb_getsampwsid)(struct pdb_context *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
209 NTSTATUS (*pdb_add_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
211 NTSTATUS (*pdb_update_sam_account)(struct pdb_context *, SAM_ACCOUNT *sampass);
213 NTSTATUS (*pdb_delete_sam_account)(struct pdb_context *, SAM_ACCOUNT *username);
215 NTSTATUS (*pdb_getgrsid)(struct pdb_context *context, GROUP_MAP *map, DOM_SID sid);
217 NTSTATUS (*pdb_getgrgid)(struct pdb_context *context, GROUP_MAP *map, gid_t gid);
219 NTSTATUS (*pdb_getgrnam)(struct pdb_context *context, GROUP_MAP *map, const char *name);
221 NTSTATUS (*pdb_add_group_mapping_entry)(struct pdb_context *context,
224 NTSTATUS (*pdb_update_group_mapping_entry)(struct pdb_context *context,
227 NTSTATUS (*pdb_delete_group_mapping_entry)(struct pdb_context *context,
230 NTSTATUS (*pdb_enum_group_mapping)(struct pdb_context *context,
231 enum SID_NAME_USE sid_name_use,
232 GROUP_MAP **rmap, int *num_entries,
235 void (*free_fn)(struct pdb_context **);
241 typedef struct pdb_methods
243 const char *name; /* What name got this module */
244 struct pdb_context *parent;
246 /* Use macros from dlinklist.h on these two */
247 struct pdb_methods *next;
248 struct pdb_methods *prev;
250 NTSTATUS (*setsampwent)(struct pdb_methods *, BOOL update);
252 void (*endsampwent)(struct pdb_methods *);
254 NTSTATUS (*getsampwent)(struct pdb_methods *, SAM_ACCOUNT *user);
256 NTSTATUS (*getsampwnam)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const char *username);
258 NTSTATUS (*getsampwsid)(struct pdb_methods *, SAM_ACCOUNT *sam_acct, const DOM_SID *sid);
260 NTSTATUS (*add_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
262 NTSTATUS (*update_sam_account)(struct pdb_methods *, SAM_ACCOUNT *sampass);
264 NTSTATUS (*delete_sam_account)(struct pdb_methods *, SAM_ACCOUNT *username);
266 NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
268 NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
270 NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
272 NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
275 NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
278 NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
281 NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
282 enum SID_NAME_USE sid_name_use,
283 GROUP_MAP **rmap, int *num_entries,
286 void *private_data; /* Private data of some kind */
288 void (*free_private_data)(void **);
292 typedef NTSTATUS (*pdb_init_function)(struct pdb_context *,
293 struct pdb_methods **,
296 struct pdb_init_function_entry {
298 /* Function to create a member of the pdb_methods list */
299 pdb_init_function init;
300 struct pdb_init_function_entry *prev, *next;
303 #endif /* _PASSDB_H */