2 * Unix SMB/CIFS implementation.
3 * SMB parameters and setup
4 * Copyright (C) Andrew Tridgell 1992-1998
5 * Copyright (C) Simo Sorce 2000-2002
6 * Copyright (C) Gerald Carter 2000
7 * Copyright (C) Jeremy Allison 2001
8 * Copyright (C) Andrew Bartlett 2002
10 * This program is free software; you can redistribute it and/or modify it under
11 * the terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 2 of the License, or (at your option)
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
20 * You should have received a copy of the GNU General Public License along with
21 * this program; if not, write to the Free Software Foundation, Inc., 675
22 * Mass Ave, Cambridge, MA 02139, USA.
27 #if 0 /* when made a module use this */
29 static int tdbsam_debug_level
= DBGC_ALL
;
31 #define DBGC_CLASS tdbsam_debug_level
36 #define DBGC_CLASS DBGC_PASSDB
40 #define TDBSAM_VERSION 1 /* Most recent TDBSAM version */
41 #define PDB_VERSION "20010830"
42 #define PASSDB_FILE_NAME "passdb.tdb"
43 #define USERPREFIX "USER_"
44 #define RIDPREFIX "RID_"
45 #define tdbsamver_t int32
47 struct tdbsam_privates
{
48 TDB_CONTEXT
*passwd_tdb
;
51 /* retrive-once info */
52 const char *tdbsam_location
;
56 * Convert old TDBSAM to the latest version.
57 * @param pdb_tdb A pointer to the opened TDBSAM file which must be converted.
58 * This file must be opened with read/write access.
59 * @param from Current version of the TDBSAM file.
60 * @return True if the conversion has been successful, false otherwise.
63 static BOOL
tdbsam_convert(TDB_CONTEXT
*pdb_tdb
, tdbsamver_t from
)
65 const char * vstring
= "INFO/version";
66 SAM_ACCOUNT
*user
= NULL
;
67 const char *prefix
= USERPREFIX
;
68 TDB_DATA data
, key
, old_key
;
72 if (pdb_tdb
== NULL
) {
73 DEBUG(0,("tdbsam_convert: Bad TDB Context pointer.\n"));
77 /* handle a Samba upgrade */
78 tdb_lock_bystring(pdb_tdb
, vstring
, 0);
80 if (!NT_STATUS_IS_OK(pdb_init_sam(&user
))) {
81 DEBUG(0,("tdbsam_convert: cannot initialized a SAM_ACCOUNT.\n"));
85 /* Enumerate all records and convert them */
86 key
= tdb_firstkey(pdb_tdb
);
90 /* skip all non-USER entries (eg. RIDs) */
91 while ((key
.dsize
!= 0) && (strncmp(key
.dptr
, prefix
, strlen (prefix
)))) {
93 /* increment to next in line */
94 key
= tdb_nextkey(pdb_tdb
, key
);
95 SAFE_FREE(old_key
.dptr
);
100 /* read from tdbsam */
101 data
= tdb_fetch(pdb_tdb
, key
);
103 DEBUG(0,("tdbsam_convert: database entry not found: %s.\n",key
.dptr
));
107 if (!NT_STATUS_IS_OK(pdb_reset_sam(user
))) {
108 DEBUG(0,("tdbsam_convert: cannot reset SAM_ACCOUNT.\n"));
109 SAFE_FREE(data
.dptr
);
113 /* unpack the buffer from the former format */
114 DEBUG(10,("tdbsam_convert: Try unpacking a record with (key:%s) (version:%d)\n", key
.dptr
, from
));
117 ret
= init_sam_from_buffer_v0(user
, (uint8
*)data
.dptr
, data
.dsize
);
120 ret
= init_sam_from_buffer_v1(user
, (uint8
*)data
.dptr
, data
.dsize
);
123 /* unknown tdbsam version */
127 DEBUG(0,("tdbsam_convert: Bad SAM_ACCOUNT entry returned from TDB (key:%s) (version:%d)\n", key
.dptr
, from
));
128 SAFE_FREE(data
.dptr
);
132 /* pack from the buffer into the new format */
133 DEBUG(10,("tdbsam_convert: Try packing a record (key:%s) (version:%d)\n", key
.dptr
, from
));
134 if ((data
.dsize
=init_buffer_from_sam (&buf
, user
, False
)) == -1) {
135 DEBUG(0,("tdbsam_convert: cannot pack the SAM_ACCOUNT into the new format\n"));
136 SAFE_FREE(data
.dptr
);
139 data
.dptr
= (char *)buf
;
141 /* Store the buffer inside the TDBSAM */
142 if (tdb_store(pdb_tdb
, key
, data
, TDB_MODIFY
) != TDB_SUCCESS
) {
143 DEBUG(0,("tdbsam_convert: cannot store the SAM_ACCOUNT (key:%s) in new format\n",key
.dptr
));
144 SAFE_FREE(data
.dptr
);
148 SAFE_FREE(data
.dptr
);
150 /* increment to next in line */
152 key
= tdb_nextkey(pdb_tdb
, key
);
153 SAFE_FREE(old_key
.dptr
);
160 /* upgrade finished */
161 tdb_store_int32(pdb_tdb
, vstring
, TDBSAM_VERSION
);
162 tdb_unlock_bystring(pdb_tdb
, vstring
);
168 * Open the TDB passwd database, check version and convert it if needed.
169 * @param name filename of the tdbsam file.
170 * @param open_flags file access mode.
171 * @return a TDB_CONTEXT handle on the tdbsam file.
174 static TDB_CONTEXT
* tdbsam_tdbopen (const char *name
, int open_flags
)
176 TDB_CONTEXT
*pdb_tdb
;
179 /* Try to open tdb passwd */
180 if (!(pdb_tdb
= tdb_open_log(name
, 0, TDB_DEFAULT
, open_flags
, 0600)))
183 /* Check the version */
184 version
= (tdbsamver_t
) tdb_fetch_int32(pdb_tdb
, "INFO/version");
186 version
= 0; /* Version not found, assume version 0 */
188 /* Compare the version */
189 if (version
> TDBSAM_VERSION
) {
190 /* Version more recent than the latest known */
191 DEBUG(0, ("TDBSAM version unknown: %d\n", version
));
195 else if (version
< TDBSAM_VERSION
) {
196 /* Older version, must be converted */
197 DEBUG(1, ("TDBSAM version too old (%d), trying to convert it.\n", version
));
199 /* Reopen the pdb file with read-write access if needed */
200 if (!(open_flags
& O_RDWR
)) {
201 DEBUG(10, ("tdbsam_tdbopen: TDB file opened with read only access, reopen it with read-write access.\n"));
203 pdb_tdb
= tdb_open_log(name
, 0, TDB_DEFAULT
, (open_flags
& 07777770) | O_RDWR
, 0600);
207 if (!tdbsam_convert(pdb_tdb
, version
)){
208 DEBUG(0, ("tdbsam_tdbopen: Error when trying to convert tdbsam: %s\n",name
));
212 DEBUG(1, ("TDBSAM converted successfully.\n"));
215 /* Reopen the pdb file as it must be */
216 if (!(open_flags
& O_RDWR
)) {
218 pdb_tdb
= tdb_open_log(name
, 0, TDB_DEFAULT
, open_flags
, 0600);
225 /***************************************************************
226 Open the TDB passwd database for SAM account enumeration.
227 ****************************************************************/
229 static NTSTATUS
tdbsam_setsampwent(struct pdb_methods
*my_methods
, BOOL update
)
231 struct tdbsam_privates
*tdb_state
= (struct tdbsam_privates
*)my_methods
->private_data
;
233 /* Open tdb passwd */
234 if (!(tdb_state
->passwd_tdb
= tdbsam_tdbopen(tdb_state
->tdbsam_location
, update
?(O_RDWR
|O_CREAT
):O_RDONLY
)))
236 DEBUG(0, ("Unable to open/create TDB passwd\n"));
237 return NT_STATUS_UNSUCCESSFUL
;
240 tdb_state
->key
= tdb_firstkey(tdb_state
->passwd_tdb
);
245 static void close_tdb(struct tdbsam_privates
*tdb_state
)
247 if (tdb_state
->passwd_tdb
) {
248 tdb_close(tdb_state
->passwd_tdb
);
249 tdb_state
->passwd_tdb
= NULL
;
253 /***************************************************************
254 End enumeration of the TDB passwd list.
255 ****************************************************************/
257 static void tdbsam_endsampwent(struct pdb_methods
*my_methods
)
259 struct tdbsam_privates
*tdb_state
= (struct tdbsam_privates
*)my_methods
->private_data
;
260 SAFE_FREE(tdb_state
->key
.dptr
);
261 close_tdb(tdb_state
);
263 DEBUG(7, ("endtdbpwent: closed sam database.\n"));
266 /*****************************************************************
267 Get one SAM_ACCOUNT from the TDB (next in line)
268 *****************************************************************/
270 static NTSTATUS
tdbsam_getsampwent(struct pdb_methods
*my_methods
, SAM_ACCOUNT
*user
)
272 NTSTATUS nt_status
= NT_STATUS_UNSUCCESSFUL
;
273 struct tdbsam_privates
*tdb_state
= (struct tdbsam_privates
*)my_methods
->private_data
;
274 TDB_DATA data
, old_key
;
275 const char *prefix
= USERPREFIX
;
276 int prefixlen
= strlen (prefix
);
280 DEBUG(0,("pdb_get_sampwent: SAM_ACCOUNT is NULL.\n"));
284 /* skip all non-USER entries (eg. RIDs) */
285 while ((tdb_state
->key
.dsize
!= 0) && (strncmp(tdb_state
->key
.dptr
, prefix
, prefixlen
))) {
287 old_key
= tdb_state
->key
;
289 /* increment to next in line */
290 tdb_state
->key
= tdb_nextkey(tdb_state
->passwd_tdb
, tdb_state
->key
);
292 SAFE_FREE(old_key
.dptr
);
295 /* do we have an valid iteration pointer? */
296 if(tdb_state
->passwd_tdb
== NULL
) {
297 DEBUG(0,("pdb_get_sampwent: Bad TDB Context pointer.\n"));
301 data
= tdb_fetch(tdb_state
->passwd_tdb
, tdb_state
->key
);
303 DEBUG(5,("pdb_getsampwent: database entry not found.\n"));
307 /* unpack the buffer */
308 if (!init_sam_from_buffer(user
, (unsigned char *)data
.dptr
, data
.dsize
)) {
309 DEBUG(0,("pdb_getsampwent: Bad SAM_ACCOUNT entry returned from TDB!\n"));
310 SAFE_FREE(data
.dptr
);
313 SAFE_FREE(data
.dptr
);
315 old_key
= tdb_state
->key
;
317 /* increment to next in line */
318 tdb_state
->key
= tdb_nextkey(tdb_state
->passwd_tdb
, tdb_state
->key
);
320 SAFE_FREE(old_key
.dptr
);
325 /******************************************************************
326 Lookup a name in the SAM TDB
327 ******************************************************************/
329 static NTSTATUS
tdbsam_getsampwnam (struct pdb_methods
*my_methods
, SAM_ACCOUNT
*user
, const char *sname
)
331 NTSTATUS nt_status
= NT_STATUS_UNSUCCESSFUL
;
332 struct tdbsam_privates
*tdb_state
= (struct tdbsam_privates
*)my_methods
->private_data
;
333 TDB_CONTEXT
*pwd_tdb
;
339 DEBUG(0,("pdb_getsampwnam: SAM_ACCOUNT is NULL.\n"));
344 /* Data is stored in all lower-case */
345 fstrcpy(name
, sname
);
349 slprintf(keystr
, sizeof(keystr
)-1, "%s%s", USERPREFIX
, name
);
351 key
.dsize
= strlen(keystr
) + 1;
353 /* open the accounts TDB */
354 if (!(pwd_tdb
= tdbsam_tdbopen(tdb_state
->tdbsam_location
, O_RDONLY
))) {
356 if (errno
== ENOENT
) {
358 * TDB file doesn't exist, so try to create new one. This is useful to avoid
359 * confusing error msg when adding user account first time
361 if (!(pwd_tdb
= tdb_open_log(tdb_state
->tdbsam_location
, 0, TDB_DEFAULT
, O_CREAT
, 0600))) {
362 DEBUG(0, ("pdb_getsampwnam: TDB passwd (%s) did not exist. File successfully created.\n",
363 tdb_state
->tdbsam_location
));
365 DEBUG(0, ("pdb_getsampwnam: TDB passwd (%s) does not exist. Couldn't create new one. Error was: %s\n",
366 tdb_state
->tdbsam_location
, strerror(errno
)));
369 /* requested user isn't there anyway */
370 nt_status
= NT_STATUS_NO_SUCH_USER
;
373 DEBUG(0, ("pdb_getsampwnam: Unable to open TDB passwd (%s)!\n", tdb_state
->tdbsam_location
));
378 data
= tdb_fetch(pwd_tdb
, key
);
380 DEBUG(5,("pdb_getsampwnam (TDB): error fetching database.\n"));
381 DEBUGADD(5, (" Error: %s\n", tdb_errorstr(pwd_tdb
)));
382 DEBUGADD(5, (" Key: %s\n", keystr
));
387 /* unpack the buffer */
388 if (!init_sam_from_buffer(user
, (unsigned char *)data
.dptr
, data
.dsize
)) {
389 DEBUG(0,("pdb_getsampwent: Bad SAM_ACCOUNT entry returned from TDB!\n"));
390 SAFE_FREE(data
.dptr
);
394 SAFE_FREE(data
.dptr
);
396 /* no further use for database, close it now */
402 /***************************************************************************
404 **************************************************************************/
406 static NTSTATUS
tdbsam_getsampwrid (struct pdb_methods
*my_methods
, SAM_ACCOUNT
*user
, uint32 rid
)
408 NTSTATUS nt_status
= NT_STATUS_UNSUCCESSFUL
;
409 struct tdbsam_privates
*tdb_state
= (struct tdbsam_privates
*)my_methods
->private_data
;
410 TDB_CONTEXT
*pwd_tdb
;
416 DEBUG(0,("pdb_getsampwrid: SAM_ACCOUNT is NULL.\n"));
421 slprintf(keystr
, sizeof(keystr
)-1, "%s%.8x", RIDPREFIX
, rid
);
423 key
.dsize
= strlen (keystr
) + 1;
425 /* open the accounts TDB */
426 if (!(pwd_tdb
= tdbsam_tdbopen(tdb_state
->tdbsam_location
, O_RDONLY
))) {
427 DEBUG(0, ("pdb_getsampwrid: Unable to open TDB rid database!\n"));
432 data
= tdb_fetch (pwd_tdb
, key
);
434 DEBUG(5,("pdb_getsampwrid (TDB): error looking up RID %d by key %s.\n", rid
, keystr
));
435 DEBUGADD(5, (" Error: %s\n", tdb_errorstr(pwd_tdb
)));
441 fstrcpy(name
, data
.dptr
);
442 SAFE_FREE(data
.dptr
);
446 return tdbsam_getsampwnam (my_methods
, user
, name
);
449 static NTSTATUS
tdbsam_getsampwsid(struct pdb_methods
*my_methods
, SAM_ACCOUNT
* user
, const DOM_SID
*sid
)
452 if (!sid_peek_check_rid(get_global_sam_sid(), sid
, &rid
))
453 return NT_STATUS_UNSUCCESSFUL
;
454 return tdbsam_getsampwrid(my_methods
, user
, rid
);
457 /***************************************************************************
459 ****************************************************************************/
461 static NTSTATUS
tdbsam_delete_sam_account(struct pdb_methods
*my_methods
, SAM_ACCOUNT
*sam_pass
)
463 NTSTATUS nt_status
= NT_STATUS_UNSUCCESSFUL
;
464 struct tdbsam_privates
*tdb_state
= (struct tdbsam_privates
*)my_methods
->private_data
;
465 TDB_CONTEXT
*pwd_tdb
;
471 fstrcpy(name
, pdb_get_username(sam_pass
));
475 if (!(pwd_tdb
= tdbsam_tdbopen(tdb_state
->tdbsam_location
, O_RDWR
))) {
476 DEBUG(0, ("Unable to open TDB passwd!"));
480 /* set the search key */
481 slprintf(keystr
, sizeof(keystr
)-1, "%s%s", USERPREFIX
, name
);
483 key
.dsize
= strlen (keystr
) + 1;
485 rid
= pdb_get_user_rid(sam_pass
);
487 /* it's outaa here! 8^) */
488 if (tdb_delete(pwd_tdb
, key
) != TDB_SUCCESS
) {
489 DEBUG(5, ("Error deleting entry from tdb passwd database!\n"));
490 DEBUGADD(5, (" Error: %s\n", tdb_errorstr(pwd_tdb
)));
495 /* delete also the RID key */
497 /* set the search key */
498 slprintf(keystr
, sizeof(keystr
)-1, "%s%.8x", RIDPREFIX
, rid
);
500 key
.dsize
= strlen (keystr
) + 1;
502 /* it's outaa here! 8^) */
503 if (tdb_delete(pwd_tdb
, key
) != TDB_SUCCESS
) {
504 DEBUG(5, ("Error deleting entry from tdb rid database!\n"));
505 DEBUGADD(5, (" Error: %s\n", tdb_errorstr(pwd_tdb
)));
515 /***************************************************************************
517 ****************************************************************************/
519 static BOOL
tdb_update_sam(struct pdb_methods
*my_methods
, SAM_ACCOUNT
* newpwd
, int flag
)
521 struct tdbsam_privates
*tdb_state
= (struct tdbsam_privates
*)my_methods
->private_data
;
522 TDB_CONTEXT
*pwd_tdb
= NULL
;
530 /* invalidate the existing TDB iterator if it is open */
532 if (tdb_state
->passwd_tdb
) {
533 tdb_close(tdb_state
->passwd_tdb
);
534 tdb_state
->passwd_tdb
= NULL
;
537 /* open the account TDB passwd*/
539 pwd_tdb
= tdbsam_tdbopen(tdb_state
->tdbsam_location
, O_RDWR
| O_CREAT
);
542 DEBUG(0, ("tdb_update_sam: Unable to open TDB passwd (%s)!\n",
543 tdb_state
->tdbsam_location
));
547 if (!pdb_get_group_rid(newpwd
)) {
548 DEBUG (0,("tdb_update_sam: Failing to store a SAM_ACCOUNT for [%s] without a primary group RID\n",
549 pdb_get_username(newpwd
)));
554 if ( !(user_rid
= pdb_get_user_rid(newpwd
)) ) {
555 DEBUG(0,("tdb_update_sam: SAM_ACCOUNT (%s) with no RID!\n", pdb_get_username(newpwd
)));
560 /* copy the SAM_ACCOUNT struct into a BYTE buffer for storage */
561 if ((data
.dsize
=init_buffer_from_sam (&buf
, newpwd
, False
)) == -1) {
562 DEBUG(0,("tdb_update_sam: ERROR - Unable to copy SAM_ACCOUNT info BYTE buffer!\n"));
566 data
.dptr
= (char *)buf
;
568 fstrcpy(name
, pdb_get_username(newpwd
));
571 DEBUG(5, ("Storing %saccount %s with RID %d\n", flag
== TDB_INSERT
? "(new) " : "", name
, user_rid
));
573 /* setup the USER index key */
574 slprintf(keystr
, sizeof(keystr
)-1, "%s%s", USERPREFIX
, name
);
576 key
.dsize
= strlen(keystr
) + 1;
578 /* add the account */
579 if (tdb_store(pwd_tdb
, key
, data
, flag
) != TDB_SUCCESS
) {
580 DEBUG(0, ("Unable to modify passwd TDB!"));
581 DEBUGADD(0, (" Error: %s", tdb_errorstr(pwd_tdb
)));
582 DEBUGADD(0, (" occured while storing the main record (%s)\n", keystr
));
588 data
.dsize
= strlen(name
) + 1;
591 /* setup the RID index key */
592 slprintf(keystr
, sizeof(keystr
)-1, "%s%.8x", RIDPREFIX
, user_rid
);
594 key
.dsize
= strlen (keystr
) + 1;
596 /* add the reference */
597 if (tdb_store(pwd_tdb
, key
, data
, flag
) != TDB_SUCCESS
) {
598 DEBUG(0, ("Unable to modify TDB passwd !"));
599 DEBUGADD(0, (" Error: %s\n", tdb_errorstr(pwd_tdb
)));
600 DEBUGADD(0, (" occured while storing the RID index (%s)\n", keystr
));
613 /***************************************************************************
614 Modifies an existing SAM_ACCOUNT
615 ****************************************************************************/
617 static NTSTATUS
tdbsam_update_sam_account (struct pdb_methods
*my_methods
, SAM_ACCOUNT
*newpwd
)
619 if (tdb_update_sam(my_methods
, newpwd
, TDB_MODIFY
))
622 return NT_STATUS_UNSUCCESSFUL
;
625 /***************************************************************************
626 Adds an existing SAM_ACCOUNT
627 ****************************************************************************/
629 static NTSTATUS
tdbsam_add_sam_account (struct pdb_methods
*my_methods
, SAM_ACCOUNT
*newpwd
)
631 if (tdb_update_sam(my_methods
, newpwd
, TDB_INSERT
))
634 return NT_STATUS_UNSUCCESSFUL
;
637 static void free_private_data(void **vp
)
639 struct tdbsam_privates
**tdb_state
= (struct tdbsam_privates
**)vp
;
640 close_tdb(*tdb_state
);
643 /* No need to free any further, as it is talloc()ed */
647 static NTSTATUS
pdb_init_tdbsam(PDB_CONTEXT
*pdb_context
, PDB_METHODS
**pdb_method
, const char *location
)
650 struct tdbsam_privates
*tdb_state
;
652 if (!NT_STATUS_IS_OK(nt_status
= make_pdb_methods(pdb_context
->mem_ctx
, pdb_method
))) {
656 (*pdb_method
)->name
= "tdbsam";
658 (*pdb_method
)->setsampwent
= tdbsam_setsampwent
;
659 (*pdb_method
)->endsampwent
= tdbsam_endsampwent
;
660 (*pdb_method
)->getsampwent
= tdbsam_getsampwent
;
661 (*pdb_method
)->getsampwnam
= tdbsam_getsampwnam
;
662 (*pdb_method
)->getsampwsid
= tdbsam_getsampwsid
;
663 (*pdb_method
)->add_sam_account
= tdbsam_add_sam_account
;
664 (*pdb_method
)->update_sam_account
= tdbsam_update_sam_account
;
665 (*pdb_method
)->delete_sam_account
= tdbsam_delete_sam_account
;
667 tdb_state
= talloc_zero(pdb_context
->mem_ctx
, sizeof(struct tdbsam_privates
));
670 DEBUG(0, ("talloc() failed for tdbsam private_data!\n"));
671 return NT_STATUS_NO_MEMORY
;
675 tdb_state
->tdbsam_location
= talloc_strdup(pdb_context
->mem_ctx
, location
);
678 get_private_directory(tdbfile
);
679 pstrcat(tdbfile
, "/");
680 pstrcat(tdbfile
, PASSDB_FILE_NAME
);
681 tdb_state
->tdbsam_location
= talloc_strdup(pdb_context
->mem_ctx
, tdbfile
);
684 (*pdb_method
)->private_data
= tdb_state
;
686 (*pdb_method
)->free_private_data
= free_private_data
;
691 NTSTATUS
pdb_tdbsam_init(void)
693 return smb_register_passdb(PASSDB_INTERFACE_VERSION
, "tdbsam", pdb_init_tdbsam
);