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