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