2 * Store posix-level xattrs in a tdb
4 * Copyright (C) Volker Lendecke, 2007
5 * Copyright (C) Andrew Bartlett, 2012
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 #include "system/filesys.h"
23 #include "smbd/smbd.h"
24 #include "dbwrap/dbwrap.h"
25 #include "dbwrap/dbwrap_open.h"
26 #include "source3/lib/xattr_tdb.h"
29 #define DBGC_CLASS DBGC_VFS
31 static bool xattr_tdb_init(int snum, TALLOC_CTX *mem_ctx, struct db_context **p_db);
33 static int xattr_tdb_get_file_id(struct vfs_handle_struct *handle,
34 const char *path, struct file_id *id)
37 TALLOC_CTX *frame = talloc_stackframe();
38 struct smb_filename *smb_fname;
40 smb_fname = synthetic_smb_fname(frame, path, NULL, NULL, 0);
41 if (smb_fname == NULL) {
47 ret = SMB_VFS_NEXT_STAT(handle, smb_fname);
54 *id = SMB_VFS_NEXT_FILE_ID_CREATE(handle, &smb_fname->st);
59 static ssize_t xattr_tdb_getxattr(struct vfs_handle_struct *handle,
60 const char *path, const char *name,
61 void *value, size_t size)
64 struct db_context *db;
68 TALLOC_CTX *frame = talloc_stackframe();
70 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
71 if (!xattr_tdb_init(-1, frame, &db))
73 TALLOC_FREE(frame); return -1;
76 ret = xattr_tdb_get_file_id(handle, path, &id);
82 xattr_size = xattr_tdb_getattr(db, frame, &id, name, &blob);
88 if (blob.length > size) {
93 memcpy(value, blob.data, xattr_size);
98 static ssize_t xattr_tdb_fgetxattr(struct vfs_handle_struct *handle,
99 struct files_struct *fsp,
100 const char *name, void *value, size_t size)
102 SMB_STRUCT_STAT sbuf;
104 struct db_context *db;
107 TALLOC_CTX *frame = talloc_stackframe();
109 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
110 if (!xattr_tdb_init(-1, frame, &db))
112 TALLOC_FREE(frame); return -1;
115 if (SMB_VFS_NEXT_FSTAT(handle, fsp, &sbuf) == -1) {
120 id = SMB_VFS_NEXT_FILE_ID_CREATE(handle, &sbuf);
122 xattr_size = xattr_tdb_getattr(db, frame, &id, name, &blob);
123 if (xattr_size < 0) {
128 if (blob.length > size) {
133 memcpy(value, blob.data, xattr_size);
138 static int xattr_tdb_setxattr(struct vfs_handle_struct *handle,
139 const char *path, const char *name,
140 const void *value, size_t size, int flags)
143 struct db_context *db;
145 TALLOC_CTX *frame = talloc_stackframe();
147 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
148 if (!xattr_tdb_init(-1, frame, &db))
150 TALLOC_FREE(frame); return -1;
153 ret = xattr_tdb_get_file_id(handle, path, &id);
159 ret = xattr_tdb_setattr(db, &id, name, value, size, flags);
164 static int xattr_tdb_fsetxattr(struct vfs_handle_struct *handle,
165 struct files_struct *fsp,
166 const char *name, const void *value,
167 size_t size, int flags)
169 SMB_STRUCT_STAT sbuf;
171 struct db_context *db;
173 TALLOC_CTX *frame = talloc_stackframe();
175 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
176 if (!xattr_tdb_init(-1, frame, &db))
178 TALLOC_FREE(frame); return -1;
181 if (SMB_VFS_NEXT_FSTAT(handle, fsp, &sbuf) == -1) {
186 id = SMB_VFS_NEXT_FILE_ID_CREATE(handle, &sbuf);
188 ret = xattr_tdb_setattr(db, &id, name, value, size, flags);
194 static ssize_t xattr_tdb_listxattr(struct vfs_handle_struct *handle,
195 const char *path, char *list, size_t size)
198 struct db_context *db;
200 TALLOC_CTX *frame = talloc_stackframe();
202 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
203 if (!xattr_tdb_init(-1, frame, &db))
205 TALLOC_FREE(frame); return -1;
208 ret = xattr_tdb_get_file_id(handle, path, &id);
214 ret = xattr_tdb_listattr(db, &id, list, size);
220 static ssize_t xattr_tdb_flistxattr(struct vfs_handle_struct *handle,
221 struct files_struct *fsp, char *list,
224 SMB_STRUCT_STAT sbuf;
226 struct db_context *db;
228 TALLOC_CTX *frame = talloc_stackframe();
230 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
231 if (!xattr_tdb_init(-1, frame, &db))
233 TALLOC_FREE(frame); return -1;
236 if (SMB_VFS_NEXT_FSTAT(handle, fsp, &sbuf) == -1) {
241 id = SMB_VFS_NEXT_FILE_ID_CREATE(handle, &sbuf);
243 ret = xattr_tdb_listattr(db, &id, list, size);
248 static int xattr_tdb_removexattr(struct vfs_handle_struct *handle,
249 const char *path, const char *name)
252 struct db_context *db;
254 TALLOC_CTX *frame = talloc_stackframe();
256 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
257 if (!xattr_tdb_init(-1, frame, &db))
259 TALLOC_FREE(frame); return -1;
262 ret = xattr_tdb_get_file_id(handle, path, &id);
269 ret = xattr_tdb_removeattr(db, &id, name);
274 static int xattr_tdb_fremovexattr(struct vfs_handle_struct *handle,
275 struct files_struct *fsp, const char *name)
277 SMB_STRUCT_STAT sbuf;
279 struct db_context *db;
281 TALLOC_CTX *frame = talloc_stackframe();
283 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
284 if (!xattr_tdb_init(-1, frame, &db))
286 TALLOC_FREE(frame); return -1;
289 if (SMB_VFS_NEXT_FSTAT(handle, fsp, &sbuf) == -1) {
294 id = SMB_VFS_NEXT_FILE_ID_CREATE(handle, &sbuf);
296 ret = xattr_tdb_removeattr(db, &id, name);
302 * Open the tdb file upon VFS_CONNECT
305 static bool xattr_tdb_init(int snum, TALLOC_CTX *mem_ctx, struct db_context **p_db)
307 struct db_context *db;
311 def_dbname = state_path("xattr.tdb");
312 if (def_dbname == NULL) {
317 dbname = lp_parm_const_string(snum, "xattr_tdb", "file", def_dbname);
319 /* now we know dbname is not NULL */
322 db = db_open(NULL, dbname, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0600,
323 DBWRAP_LOCK_ORDER_2, DBWRAP_FLAG_NONE);
332 TALLOC_FREE(def_dbname);
337 TALLOC_FREE(def_dbname);
341 static int xattr_tdb_open(vfs_handle_struct *handle,
342 struct smb_filename *smb_fname,
347 struct db_context *db = NULL;
348 TALLOC_CTX *frame = NULL;
351 fsp->fh->fd = SMB_VFS_NEXT_OPEN(handle,
356 if (fsp->fh->fd < 0) {
360 if ((flags & (O_CREAT|O_EXCL)) != (O_CREAT|O_EXCL)) {
365 * We know we used O_CREAT|O_EXCL and it worked.
366 * We must have created the file.
369 ret = SMB_VFS_FSTAT(fsp, &smb_fname->st);
371 /* Can't happen... */
372 DBG_WARNING("SMB_VFS_FSTAT failed on file %s (%s)\n",
373 smb_fname_str_dbg(smb_fname),
377 fsp->file_id = SMB_VFS_FILE_ID_CREATE(fsp->conn, &smb_fname->st);
379 frame = talloc_stackframe();
380 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
381 if (!xattr_tdb_init(-1, frame, &db))
383 TALLOC_FREE(frame); return -1;
386 xattr_tdb_remove_all_attrs(db, &fsp->file_id);
391 static int xattr_tdb_mkdir(vfs_handle_struct *handle,
392 const struct smb_filename *smb_fname,
395 struct db_context *db = NULL;
396 TALLOC_CTX *frame = NULL;
397 struct file_id fileid;
399 struct smb_filename *smb_fname_tmp = NULL;
401 ret = SMB_VFS_NEXT_MKDIR(handle, smb_fname, mode);
406 frame = talloc_stackframe();
407 smb_fname_tmp = cp_smb_filename(frame, smb_fname);
408 if (smb_fname_tmp == NULL) {
414 /* Always use LSTAT here - we just creaded the directory. */
415 ret = SMB_VFS_LSTAT(handle->conn, smb_fname_tmp);
417 /* Rename race. Let upper level take care of it. */
421 if (!S_ISDIR(smb_fname_tmp->st.st_ex_mode)) {
422 /* Rename race. Let upper level take care of it. */
427 fileid = SMB_VFS_FILE_ID_CREATE(handle->conn, &smb_fname_tmp->st);
429 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
430 if (!xattr_tdb_init(-1, frame, &db))
432 TALLOC_FREE(frame); return -1;
435 xattr_tdb_remove_all_attrs(db, &fileid);
441 * On unlink we need to delete the tdb record
443 static int xattr_tdb_unlink(vfs_handle_struct *handle,
444 const struct smb_filename *smb_fname)
446 struct smb_filename *smb_fname_tmp = NULL;
448 struct db_context *db;
450 bool remove_record = false;
451 TALLOC_CTX *frame = talloc_stackframe();
453 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
454 if (!xattr_tdb_init(-1, frame, &db))
456 TALLOC_FREE(frame); return -1;
459 smb_fname_tmp = cp_smb_filename(frame, smb_fname);
460 if (smb_fname_tmp == NULL) {
466 if (smb_fname_tmp->flags & SMB_FILENAME_POSIX_PATH) {
467 ret = SMB_VFS_NEXT_LSTAT(handle, smb_fname_tmp);
469 ret = SMB_VFS_NEXT_STAT(handle, smb_fname_tmp);
475 if (smb_fname_tmp->st.st_ex_nlink == 1) {
476 /* Only remove record on last link to file. */
477 remove_record = true;
480 ret = SMB_VFS_NEXT_UNLINK(handle, smb_fname_tmp);
486 if (!remove_record) {
490 id = SMB_VFS_NEXT_FILE_ID_CREATE(handle, &smb_fname_tmp->st);
492 xattr_tdb_remove_all_attrs(db, &id);
500 * On rmdir we need to delete the tdb record
502 static int xattr_tdb_rmdir(vfs_handle_struct *handle,
503 const struct smb_filename *smb_fname)
505 SMB_STRUCT_STAT sbuf;
507 struct db_context *db;
509 TALLOC_CTX *frame = talloc_stackframe();
511 SMB_VFS_HANDLE_GET_DATA(handle, db, struct db_context,
512 if (!xattr_tdb_init(-1, frame, &db))
514 TALLOC_FREE(frame); return -1;
517 if (vfs_stat_smb_basename(handle->conn,
524 ret = SMB_VFS_NEXT_RMDIR(handle, smb_fname);
531 id = SMB_VFS_NEXT_FILE_ID_CREATE(handle, &sbuf);
533 xattr_tdb_remove_all_attrs(db, &id);
540 * Destructor for the VFS private data
543 static void close_xattr_db(void **data)
545 struct db_context **p_db = (struct db_context **)data;
549 static int xattr_tdb_connect(vfs_handle_struct *handle, const char *service,
554 struct db_context *db;
556 res = SMB_VFS_NEXT_CONNECT(handle, service, user);
561 snum = find_service(talloc_tos(), service, &sname);
562 if (snum == -1 || sname == NULL) {
564 * Should not happen, but we should not fail just *here*.
569 if (!xattr_tdb_init(snum, NULL, &db)) {
570 DEBUG(5, ("Could not init xattr tdb\n"));
571 lp_do_parameter(snum, "ea support", "False");
575 lp_do_parameter(snum, "ea support", "True");
577 SMB_VFS_HANDLE_SET_DATA(handle, db, close_xattr_db,
578 struct db_context, return -1);
583 static struct vfs_fn_pointers vfs_xattr_tdb_fns = {
584 .getxattr_fn = xattr_tdb_getxattr,
585 .fgetxattr_fn = xattr_tdb_fgetxattr,
586 .setxattr_fn = xattr_tdb_setxattr,
587 .fsetxattr_fn = xattr_tdb_fsetxattr,
588 .listxattr_fn = xattr_tdb_listxattr,
589 .flistxattr_fn = xattr_tdb_flistxattr,
590 .removexattr_fn = xattr_tdb_removexattr,
591 .fremovexattr_fn = xattr_tdb_fremovexattr,
592 .open_fn = xattr_tdb_open,
593 .mkdir_fn = xattr_tdb_mkdir,
594 .unlink_fn = xattr_tdb_unlink,
595 .rmdir_fn = xattr_tdb_rmdir,
596 .connect_fn = xattr_tdb_connect,
599 NTSTATUS vfs_xattr_tdb_init(void);
600 NTSTATUS vfs_xattr_tdb_init(void)
602 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "xattr_tdb",