c8e4bc21e41c4975335c85821b5d49550ee6a635
[ira/wip.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 #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
107 struct 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
167 struct acct_info {
168         fstring acct_name; /* account name */
169         fstring acct_desc; /* account name */
170         uint32 rid; /* domain-relative RID */
171 };
172
173 struct 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
182 enum pdb_search_type {
183         PDB_USER_SEARCH,
184         PDB_GROUP_SEARCH,
185         PDB_ALIAS_SEARCH
186 };
187
188 struct pdb_search {
189         enum pdb_search_type type;
190         struct samr_displayentry *cache;
191         uint32 num_entries;
192         ssize_t cache_size;
193         bool search_ended;
194         void *private_data;
195         bool (*next_entry)(struct pdb_search *search,
196                            struct samr_displayentry *entry);
197         void (*search_end)(struct pdb_search *search);
198 };
199
200 struct pdb_domain_info {
201         char *name;
202         char *dns_domain;
203         char *dns_forest;
204         struct dom_sid sid;
205         struct GUID guid;
206 };
207
208 /*
209  * Types of account policy.
210  */
211 enum pdb_policy_type {
212         PDB_POLICY_MIN_PASSWORD_LEN = 1,
213         PDB_POLICY_PASSWORD_HISTORY = 2,
214         PDB_POLICY_USER_MUST_LOGON_TO_CHG_PASS  = 3,
215         PDB_POLICY_MAX_PASSWORD_AGE = 4,
216         PDB_POLICY_MIN_PASSWORD_AGE = 5,
217         PDB_POLICY_LOCK_ACCOUNT_DURATION = 6,
218         PDB_POLICY_RESET_COUNT_TIME = 7,
219         PDB_POLICY_BAD_ATTEMPT_LOCKOUT = 8,
220         PDB_POLICY_TIME_TO_LOGOUT = 9,
221         PDB_POLICY_REFUSE_MACHINE_PW_CHANGE = 10
222 };
223
224 #define PDB_CAP_STORE_RIDS      0x0001
225 #define PDB_CAP_ADS             0x0002
226
227 /*****************************************************************
228  Functions to be implemented by the new (v2) passdb API 
229 ****************************************************************/
230
231 /*
232  * This next constant specifies the version number of the PASSDB interface
233  * this SAMBA will load. Increment this if *ANY* changes are made to the interface. 
234  * Changed interface to fix int -> size_t problems. JRA.
235  * There's no point in allocating arrays in
236  * samr_lookup_rids twice. It was done in the srv_samr_nt.c code as well as in
237  * the pdb module. Remove the latter, this might happen more often. VL.
238  * changed to version 14 to move lookup_rids and lookup_names to return
239  * enum lsa_SidType rather than uint32.
240  * Changed to 16 for access to the trusted domain passwords (obnox).
241  * Changed to 17, the sampwent interface is gone.
242  * Changed to 18, pdb_rid_algorithm -> pdb_capabilities
243  * Changed to 19, removed uid_to_rid
244  */
245
246 #define PASSDB_INTERFACE_VERSION 19
247
248 struct pdb_methods 
249 {
250         const char *name; /* What name got this module */
251
252         struct pdb_domain_info *(*get_domain_info)(struct pdb_methods *,
253                                                    TALLOC_CTX *mem_ctx);
254
255         NTSTATUS (*getsampwnam)(struct pdb_methods *, struct samu *sam_acct, const char *username);
256
257         NTSTATUS (*getsampwsid)(struct pdb_methods *, struct samu *sam_acct, const DOM_SID *sid);
258
259         NTSTATUS (*create_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
260                                 const char *name, uint32 acct_flags,
261                                 uint32 *rid);
262
263         NTSTATUS (*delete_user)(struct pdb_methods *, TALLOC_CTX *tmp_ctx,
264                                 struct samu *sam_acct);
265
266         NTSTATUS (*add_sam_account)(struct pdb_methods *, struct samu *sampass);
267
268         NTSTATUS (*update_sam_account)(struct pdb_methods *, struct samu *sampass);
269
270         NTSTATUS (*delete_sam_account)(struct pdb_methods *, struct samu *username);
271
272         NTSTATUS (*rename_sam_account)(struct pdb_methods *, struct samu *oldname, const char *newname);
273
274         NTSTATUS (*update_login_attempts)(struct pdb_methods *methods, struct samu *sam_acct, bool success);
275
276         NTSTATUS (*getgrsid)(struct pdb_methods *methods, GROUP_MAP *map, DOM_SID sid);
277
278         NTSTATUS (*getgrgid)(struct pdb_methods *methods, GROUP_MAP *map, gid_t gid);
279
280         NTSTATUS (*getgrnam)(struct pdb_methods *methods, GROUP_MAP *map, const char *name);
281
282         NTSTATUS (*create_dom_group)(struct pdb_methods *methods,
283                                      TALLOC_CTX *mem_ctx, const char *name,
284                                      uint32 *rid);
285
286         NTSTATUS (*delete_dom_group)(struct pdb_methods *methods,
287                                      TALLOC_CTX *mem_ctx, uint32 rid);
288
289         NTSTATUS (*add_group_mapping_entry)(struct pdb_methods *methods,
290                                             GROUP_MAP *map);
291
292         NTSTATUS (*update_group_mapping_entry)(struct pdb_methods *methods,
293                                                GROUP_MAP *map);
294
295         NTSTATUS (*delete_group_mapping_entry)(struct pdb_methods *methods,
296                                                DOM_SID sid);
297
298         NTSTATUS (*enum_group_mapping)(struct pdb_methods *methods,
299                                        const DOM_SID *sid, enum lsa_SidType sid_name_use,
300                                        GROUP_MAP **pp_rmap, size_t *p_num_entries,
301                                        bool unix_only);
302
303         NTSTATUS (*enum_group_members)(struct pdb_methods *methods,
304                                        TALLOC_CTX *mem_ctx,
305                                        const DOM_SID *group,
306                                        uint32 **pp_member_rids,
307                                        size_t *p_num_members);
308
309         NTSTATUS (*enum_group_memberships)(struct pdb_methods *methods,
310                                            TALLOC_CTX *mem_ctx,
311                                            struct samu *user,
312                                            DOM_SID **pp_sids, gid_t **pp_gids,
313                                            size_t *p_num_groups);
314
315         NTSTATUS (*set_unix_primary_group)(struct pdb_methods *methods,
316                                            TALLOC_CTX *mem_ctx,
317                                            struct samu *user);
318
319         NTSTATUS (*add_groupmem)(struct pdb_methods *methods,
320                                  TALLOC_CTX *mem_ctx,
321                                  uint32 group_rid, uint32 member_rid);
322
323         NTSTATUS (*del_groupmem)(struct pdb_methods *methods,
324                                  TALLOC_CTX *mem_ctx,
325                                  uint32 group_rid, uint32 member_rid);
326
327         NTSTATUS (*create_alias)(struct pdb_methods *methods,
328                                  const char *name, uint32 *rid);
329
330         NTSTATUS (*delete_alias)(struct pdb_methods *methods,
331                                  const DOM_SID *sid);
332
333         NTSTATUS (*get_aliasinfo)(struct pdb_methods *methods,
334                                   const DOM_SID *sid,
335                                   struct acct_info *info);
336
337         NTSTATUS (*set_aliasinfo)(struct pdb_methods *methods,
338                                   const DOM_SID *sid,
339                                   struct acct_info *info);
340
341         NTSTATUS (*add_aliasmem)(struct pdb_methods *methods,
342                                  const DOM_SID *alias, const DOM_SID *member);
343         NTSTATUS (*del_aliasmem)(struct pdb_methods *methods,
344                                  const DOM_SID *alias, const DOM_SID *member);
345         NTSTATUS (*enum_aliasmem)(struct pdb_methods *methods,
346                                   const DOM_SID *alias, TALLOC_CTX *mem_ctx,
347                                   DOM_SID **members, size_t *p_num_members);
348         NTSTATUS (*enum_alias_memberships)(struct pdb_methods *methods,
349                                            TALLOC_CTX *mem_ctx,
350                                            const DOM_SID *domain_sid,
351                                            const DOM_SID *members,
352                                            size_t num_members,
353                                            uint32 **pp_alias_rids,
354                                            size_t *p_num_alias_rids);
355
356         NTSTATUS (*lookup_rids)(struct pdb_methods *methods,
357                                 const DOM_SID *domain_sid,
358                                 int num_rids,
359                                 uint32 *rids,
360                                 const char **pp_names,
361                                 enum lsa_SidType *attrs);
362
363         NTSTATUS (*lookup_names)(struct pdb_methods *methods,
364                                  const DOM_SID *domain_sid,
365                                  int num_names,
366                                  const char **pp_names,
367                                  uint32 *rids,
368                                  enum lsa_SidType *attrs);
369
370         NTSTATUS (*get_account_policy)(struct pdb_methods *methods,
371                                        enum pdb_policy_type type,
372                                        uint32_t *value);
373
374         NTSTATUS (*set_account_policy)(struct pdb_methods *methods,
375                                        enum pdb_policy_type type,
376                                        uint32_t value);
377
378         NTSTATUS (*get_seq_num)(struct pdb_methods *methods, time_t *seq_num);
379
380         bool (*search_users)(struct pdb_methods *methods,
381                              struct pdb_search *search,
382                              uint32 acct_flags);
383         bool (*search_groups)(struct pdb_methods *methods,
384                               struct pdb_search *search);
385         bool (*search_aliases)(struct pdb_methods *methods,
386                                struct pdb_search *search,
387                                const DOM_SID *sid);
388
389         bool (*uid_to_sid)(struct pdb_methods *methods, uid_t uid,
390                            DOM_SID *sid);
391         bool (*gid_to_sid)(struct pdb_methods *methods, gid_t gid,
392                            DOM_SID *sid);
393         bool (*sid_to_id)(struct pdb_methods *methods, const DOM_SID *sid,
394                           union unid_t *id, enum lsa_SidType *type);
395
396         uint32_t (*capabilities)(struct pdb_methods *methods);
397         bool (*new_rid)(struct pdb_methods *methods, uint32 *rid);
398
399
400         bool (*get_trusteddom_pw)(struct pdb_methods *methods,
401                                   const char *domain, char** pwd, 
402                                   DOM_SID *sid, time_t *pass_last_set_time);
403         bool (*set_trusteddom_pw)(struct pdb_methods *methods, 
404                                   const char* domain, const char* pwd,
405                                   const DOM_SID *sid);
406         bool (*del_trusteddom_pw)(struct pdb_methods *methods, 
407                                   const char *domain);
408         NTSTATUS (*enum_trusteddoms)(struct pdb_methods *methods,
409                                      TALLOC_CTX *mem_ctx, uint32 *num_domains,
410                                      struct trustdom_info ***domains);
411
412         void *private_data;  /* Private data of some kind */
413
414         void (*free_private_data)(void **);
415 };
416
417 typedef NTSTATUS (*pdb_init_function)(struct pdb_methods **, const char *);
418
419 struct pdb_init_function_entry {
420         const char *name;
421
422         /* Function to create a member of the pdb_methods list */
423         pdb_init_function init;
424
425         struct pdb_init_function_entry *prev, *next;
426 };
427
428 #endif /* _PASSDB_H */