2 * Store streams in xattrs
4 * Copyright (C) Volker Lendecke, 2008
6 * Partly based on James Peach's Darwin module, which is
8 * Copyright (C) James Peach 2006-2007
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, see <http://www.gnu.org/licenses/>.
25 #include "smbd/smbd.h"
26 #include "system/filesys.h"
27 #include "lib/util/tevent_unix.h"
28 #include "librpc/gen_ndr/ioctl.h"
29 #include "hash_inode.h"
32 #define DBGC_CLASS DBGC_VFS
34 struct streams_xattr_config {
37 bool store_stream_type;
45 vfs_handle_struct *handle;
48 static ssize_t get_xattr_size(connection_struct *conn,
49 const struct smb_filename *smb_fname,
50 const char *xattr_name)
56 status = get_ea_value(talloc_tos(), conn, NULL, smb_fname,
59 if (!NT_STATUS_IS_OK(status)) {
63 result = ea.value.length-1;
64 TALLOC_FREE(ea.value.data);
69 * Given a stream name, populate xattr_name with the xattr name to use for
70 * accessing the stream.
72 static NTSTATUS streams_xattr_get_name(vfs_handle_struct *handle,
74 const char *stream_name,
79 struct streams_xattr_config *config;
81 SMB_VFS_HANDLE_GET_DATA(handle, config, struct streams_xattr_config,
82 return NT_STATUS_UNSUCCESSFUL);
84 sname = talloc_strdup(ctx, stream_name + 1);
86 return NT_STATUS_NO_MEMORY;
90 * With vfs_fruit option "fruit:encoding = native" we're
91 * already converting stream names that contain illegal NTFS
92 * characters from their on-the-wire Unicode Private Range
93 * encoding to their native ASCII representation.
95 * As as result the name of xattrs storing the streams (via
96 * vfs_streams_xattr) may contain a colon, so we have to use
97 * strrchr_m() instead of strchr_m() for matching the stream
100 * In check_path_syntax() we've already ensured the streamname
101 * we got from the client is valid.
103 stype = strrchr_m(sname, ':');
107 * We only support one stream type: "$DATA"
109 if (strcasecmp_m(stype, ":$DATA") != 0) {
111 return NT_STATUS_INVALID_PARAMETER;
114 /* Split name and type */
118 *xattr_name = talloc_asprintf(ctx, "%s%s%s",
121 config->store_stream_type ? ":$DATA" : "");
122 if (*xattr_name == NULL) {
124 return NT_STATUS_NO_MEMORY;
127 DEBUG(10, ("xattr_name: %s, stream_name: %s\n", *xattr_name,
134 static bool streams_xattr_recheck(struct stream_io *sio)
137 char *xattr_name = NULL;
139 if (sio->fsp->fsp_name == sio->fsp_name_ptr) {
143 if (sio->fsp->fsp_name->stream_name == NULL) {
144 /* how can this happen */
149 status = streams_xattr_get_name(sio->handle, talloc_tos(),
150 sio->fsp->fsp_name->stream_name,
152 if (!NT_STATUS_IS_OK(status)) {
156 TALLOC_FREE(sio->xattr_name);
157 TALLOC_FREE(sio->base);
158 sio->xattr_name = talloc_strdup(VFS_MEMCTX_FSP_EXTENSION(sio->handle, sio->fsp),
160 if (sio->xattr_name == NULL) {
161 DBG_DEBUG("sio->xattr_name==NULL\n");
164 TALLOC_FREE(xattr_name);
166 sio->base = talloc_strdup(VFS_MEMCTX_FSP_EXTENSION(sio->handle, sio->fsp),
167 sio->fsp->fsp_name->base_name);
168 if (sio->base == NULL) {
169 DBG_DEBUG("sio->base==NULL\n");
173 sio->fsp_name_ptr = sio->fsp->fsp_name;
179 * Helper to stat/lstat the base file of an smb_fname.
181 static int streams_xattr_stat_base(vfs_handle_struct *handle,
182 struct smb_filename *smb_fname,
185 char *tmp_stream_name;
188 tmp_stream_name = smb_fname->stream_name;
189 smb_fname->stream_name = NULL;
191 result = SMB_VFS_NEXT_STAT(handle, smb_fname);
193 result = SMB_VFS_NEXT_LSTAT(handle, smb_fname);
195 smb_fname->stream_name = tmp_stream_name;
199 static int streams_xattr_fstat(vfs_handle_struct *handle, files_struct *fsp,
200 SMB_STRUCT_STAT *sbuf)
202 struct smb_filename *smb_fname_base = NULL;
204 struct stream_io *io = (struct stream_io *)
205 VFS_FETCH_FSP_EXTENSION(handle, fsp);
207 if (io == NULL || fsp->base_fsp == NULL) {
208 return SMB_VFS_NEXT_FSTAT(handle, fsp, sbuf);
211 DBG_DEBUG("streams_xattr_fstat called for %s\n", fsp_str_dbg(io->fsp));
213 if (!streams_xattr_recheck(io)) {
217 /* Create an smb_filename with stream_name == NULL. */
218 smb_fname_base = synthetic_smb_fname(talloc_tos(),
223 fsp->fsp_name->flags);
224 if (smb_fname_base == NULL) {
229 ret = vfs_stat(handle->conn, smb_fname_base);
230 *sbuf = smb_fname_base->st;
233 TALLOC_FREE(smb_fname_base);
237 sbuf->st_ex_size = get_xattr_size(handle->conn,
238 smb_fname_base, io->xattr_name);
239 if (sbuf->st_ex_size == -1) {
240 TALLOC_FREE(smb_fname_base);
241 SET_STAT_INVALID(*sbuf);
245 DEBUG(10, ("sbuf->st_ex_size = %d\n", (int)sbuf->st_ex_size));
247 sbuf->st_ex_ino = hash_inode(sbuf, io->xattr_name);
248 sbuf->st_ex_mode &= ~S_IFMT;
249 sbuf->st_ex_mode &= ~S_IFDIR;
250 sbuf->st_ex_mode |= S_IFREG;
251 sbuf->st_ex_blocks = sbuf->st_ex_size / STAT_ST_BLOCKSIZE + 1;
253 TALLOC_FREE(smb_fname_base);
257 static int streams_xattr_stat(vfs_handle_struct *handle,
258 struct smb_filename *smb_fname)
262 char *xattr_name = NULL;
264 if (!is_named_stream(smb_fname)) {
265 return SMB_VFS_NEXT_STAT(handle, smb_fname);
268 /* Note if lp_posix_paths() is true, we can never
269 * get here as is_named_stream() is
270 * always false. So we never need worry about
271 * not following links here. */
273 /* Populate the stat struct with info from the base file. */
274 if (streams_xattr_stat_base(handle, smb_fname, true) == -1) {
278 /* Derive the xattr name to lookup. */
279 status = streams_xattr_get_name(handle, talloc_tos(),
280 smb_fname->stream_name, &xattr_name);
281 if (!NT_STATUS_IS_OK(status)) {
282 errno = map_errno_from_nt_status(status);
286 /* Augment the base file's stat information before returning. */
287 smb_fname->st.st_ex_size = get_xattr_size(handle->conn,
290 if (smb_fname->st.st_ex_size == -1) {
291 SET_STAT_INVALID(smb_fname->st);
297 smb_fname->st.st_ex_ino = hash_inode(&smb_fname->st, xattr_name);
298 smb_fname->st.st_ex_mode &= ~S_IFMT;
299 smb_fname->st.st_ex_mode &= ~S_IFDIR;
300 smb_fname->st.st_ex_mode |= S_IFREG;
301 smb_fname->st.st_ex_blocks =
302 smb_fname->st.st_ex_size / STAT_ST_BLOCKSIZE + 1;
306 TALLOC_FREE(xattr_name);
310 static int streams_xattr_lstat(vfs_handle_struct *handle,
311 struct smb_filename *smb_fname)
315 char *xattr_name = NULL;
317 if (!is_named_stream(smb_fname)) {
318 return SMB_VFS_NEXT_LSTAT(handle, smb_fname);
321 /* Populate the stat struct with info from the base file. */
322 if (streams_xattr_stat_base(handle, smb_fname, false) == -1) {
326 /* Derive the xattr name to lookup. */
327 status = streams_xattr_get_name(handle, talloc_tos(),
328 smb_fname->stream_name, &xattr_name);
329 if (!NT_STATUS_IS_OK(status)) {
330 errno = map_errno_from_nt_status(status);
334 /* Augment the base file's stat information before returning. */
335 smb_fname->st.st_ex_size = get_xattr_size(handle->conn,
338 if (smb_fname->st.st_ex_size == -1) {
339 SET_STAT_INVALID(smb_fname->st);
345 smb_fname->st.st_ex_ino = hash_inode(&smb_fname->st, xattr_name);
346 smb_fname->st.st_ex_mode &= ~S_IFMT;
347 smb_fname->st.st_ex_mode |= S_IFREG;
348 smb_fname->st.st_ex_blocks =
349 smb_fname->st.st_ex_size / STAT_ST_BLOCKSIZE + 1;
354 TALLOC_FREE(xattr_name);
358 static int streams_xattr_openat(struct vfs_handle_struct *handle,
359 const struct files_struct *dirfsp,
360 const struct smb_filename *smb_fname,
366 struct streams_xattr_config *config = NULL;
367 struct stream_io *sio = NULL;
369 char *xattr_name = NULL;
371 bool set_empty_xattr = false;
374 SMB_VFS_HANDLE_GET_DATA(handle, config, struct streams_xattr_config,
377 DEBUG(10, ("streams_xattr_open called for %s with flags 0x%x\n",
378 smb_fname_str_dbg(smb_fname), flags));
380 if (!is_named_stream(smb_fname)) {
381 return SMB_VFS_NEXT_OPENAT(handle,
390 * For now assert this, so the below SMB_VFS_SETXATTR() works.
392 SMB_ASSERT(fsp_get_pathref_fd(dirfsp) == AT_FDCWD);
394 status = streams_xattr_get_name(handle, talloc_tos(),
395 smb_fname->stream_name, &xattr_name);
396 if (!NT_STATUS_IS_OK(status)) {
397 errno = map_errno_from_nt_status(status);
401 status = get_ea_value(talloc_tos(), handle->conn, NULL,
402 smb_fname, xattr_name, &ea);
404 DEBUG(10, ("get_ea_value returned %s\n", nt_errstr(status)));
406 if (!NT_STATUS_IS_OK(status)) {
407 if (!NT_STATUS_EQUAL(status, NT_STATUS_NOT_FOUND)) {
409 * The base file is not there. This is an error even if
410 * we got O_CREAT, the higher levels should have created
411 * the base file for us.
413 DBG_DEBUG("streams_xattr_open: base file %s not around, "
414 "returning ENOENT\n", smb_fname->base_name);
419 if (!(flags & O_CREAT)) {
424 set_empty_xattr = true;
427 if (flags & O_TRUNC) {
428 set_empty_xattr = true;
431 if (set_empty_xattr) {
433 * The attribute does not exist or needs to be truncated
437 * Darn, xattrs need at least 1 byte
441 DEBUG(10, ("creating or truncating attribute %s on file %s\n",
442 xattr_name, smb_fname->base_name));
444 ret = SMB_VFS_FSETXATTR(fsp->base_fsp ? fsp->base_fsp : fsp,
447 flags & O_EXCL ? XATTR_CREATE : 0);
453 fakefd = vfs_fake_fd();
455 sio = VFS_ADD_FSP_EXTENSION(handle, fsp, struct stream_io, NULL);
461 sio->xattr_name = talloc_strdup(VFS_MEMCTX_FSP_EXTENSION(handle, fsp),
463 if (sio->xattr_name == NULL) {
469 * so->base needs to be a copy of fsp->fsp_name->base_name,
470 * making it identical to streams_xattr_recheck(). If the
471 * open is changing directories, fsp->fsp_name->base_name
472 * will be the full path from the share root, whilst
473 * smb_fname will be relative to the $cwd.
475 sio->base = talloc_strdup(VFS_MEMCTX_FSP_EXTENSION(handle, fsp),
476 fsp->fsp_name->base_name);
477 if (sio->base == NULL) {
482 sio->fsp_name_ptr = fsp->fsp_name;
483 sio->handle = handle;
490 vfs_fake_fd_close(fakefd);
497 static int streams_xattr_close(vfs_handle_struct *handle,
503 fd = fsp_get_pathref_fd(fsp);
505 DBG_DEBUG("streams_xattr_close called [%s] fd [%d]\n",
506 smb_fname_str_dbg(fsp->fsp_name), fd);
508 if (!is_named_stream(fsp->fsp_name)) {
509 return SMB_VFS_NEXT_CLOSE(handle, fsp);
512 ret = vfs_fake_fd_close(fd);
518 static int streams_xattr_unlink_internal(vfs_handle_struct *handle,
519 struct files_struct *dirfsp,
520 const struct smb_filename *smb_fname,
525 char *xattr_name = NULL;
527 if (!is_named_stream(smb_fname)) {
528 return SMB_VFS_NEXT_UNLINKAT(handle,
534 status = streams_xattr_get_name(handle, talloc_tos(),
535 smb_fname->stream_name, &xattr_name);
536 if (!NT_STATUS_IS_OK(status)) {
537 errno = map_errno_from_nt_status(status);
541 SMB_ASSERT(smb_fname->fsp != NULL);
542 SMB_ASSERT(smb_fname->fsp->base_fsp != NULL);
544 ret = SMB_VFS_FREMOVEXATTR(smb_fname->fsp->base_fsp, xattr_name);
546 if ((ret == -1) && (errno == ENOATTR)) {
554 TALLOC_FREE(xattr_name);
558 static int streams_xattr_unlinkat(vfs_handle_struct *handle,
559 struct files_struct *dirfsp,
560 const struct smb_filename *smb_fname,
564 if (flags & AT_REMOVEDIR) {
565 ret = SMB_VFS_NEXT_UNLINKAT(handle,
570 ret = streams_xattr_unlink_internal(handle,
578 static int streams_xattr_renameat(vfs_handle_struct *handle,
579 files_struct *srcfsp,
580 const struct smb_filename *smb_fname_src,
581 files_struct *dstfsp,
582 const struct smb_filename *smb_fname_dst)
586 char *src_xattr_name = NULL;
587 char *dst_xattr_name = NULL;
588 bool src_is_stream, dst_is_stream;
592 struct smb_filename *pathref = NULL;
594 src_is_stream = is_ntfs_stream_smb_fname(smb_fname_src);
595 dst_is_stream = is_ntfs_stream_smb_fname(smb_fname_dst);
597 if (!src_is_stream && !dst_is_stream) {
598 return SMB_VFS_NEXT_RENAMEAT(handle,
605 /* For now don't allow renames from or to the default stream. */
606 if (is_ntfs_default_stream_smb_fname(smb_fname_src) ||
607 is_ntfs_default_stream_smb_fname(smb_fname_dst)) {
612 /* Don't rename if the streams are identical. */
613 if (strcasecmp_m(smb_fname_src->stream_name,
614 smb_fname_dst->stream_name) == 0) {
618 /* Get the xattr names. */
619 status = streams_xattr_get_name(handle, talloc_tos(),
620 smb_fname_src->stream_name,
622 if (!NT_STATUS_IS_OK(status)) {
623 errno = map_errno_from_nt_status(status);
626 status = streams_xattr_get_name(handle, talloc_tos(),
627 smb_fname_dst->stream_name,
629 if (!NT_STATUS_IS_OK(status)) {
630 errno = map_errno_from_nt_status(status);
634 /* read the old stream */
635 status = get_ea_value(talloc_tos(), handle->conn, NULL,
636 smb_fname_src, src_xattr_name, &ea);
637 if (!NT_STATUS_IS_OK(status)) {
638 errno = map_errno_from_nt_status(status);
642 if (smb_fname_dst->fsp == NULL) {
643 status = synthetic_pathref(talloc_tos(),
644 handle->conn->cwd_fsp,
645 smb_fname_dst->base_name,
649 smb_fname_dst->flags,
651 if (!NT_STATUS_IS_OK(status)) {
655 smb_fname_dst = pathref;
657 /* (over)write the new stream */
658 nret = SMB_VFS_FSETXATTR(
660 dst_xattr_name, ea.value.data, ea.value.length,
663 if (errno == ENOATTR) {
670 * remove the old stream.
671 * Note that now we're doing this by handle
672 * not by pathname we must do it on the base_fsp,
673 * as we have to remove the actual xattr on the base file.
675 SMB_ASSERT(smb_fname_src->fsp->base_fsp != NULL);
677 oret = SMB_VFS_FREMOVEXATTR(smb_fname_src->fsp->base_fsp,
680 if (errno == ENOATTR) {
690 TALLOC_FREE(pathref);
691 TALLOC_FREE(src_xattr_name);
692 TALLOC_FREE(dst_xattr_name);
696 static NTSTATUS walk_xattr_streams(vfs_handle_struct *handle,
698 const struct smb_filename *smb_fname,
699 bool (*fn)(struct ea_struct *ea,
706 struct streams_xattr_config *config;
708 SMB_VFS_HANDLE_GET_DATA(handle, config, struct streams_xattr_config,
709 return NT_STATUS_UNSUCCESSFUL);
711 status = get_ea_names_from_file(talloc_tos(),
715 if (!NT_STATUS_IS_OK(status)) {
719 for (i=0; i<num_names; i++) {
723 * We want to check with samba_private_attr_name()
724 * whether the xattr name is a private one,
725 * unfortunately it flags xattrs that begin with the
726 * default streams prefix as private.
728 * By only calling samba_private_attr_name() in case
729 * the xattr does NOT begin with the default prefix,
730 * we know that if it returns 'true' it definitely one
731 * of our internal xattr like "user.DOSATTRIB".
733 if (strncasecmp_m(names[i], SAMBA_XATTR_DOSSTREAM_PREFIX,
734 strlen(SAMBA_XATTR_DOSSTREAM_PREFIX)) != 0) {
735 if (samba_private_attr_name(names[i])) {
740 if (strncmp(names[i], config->prefix,
741 config->prefix_len) != 0) {
745 status = get_ea_value(names,
751 if (!NT_STATUS_IS_OK(status)) {
752 DEBUG(10, ("Could not get ea %s for file %s: %s\n",
754 smb_fname->base_name,
759 ea.name = talloc_asprintf(
760 ea.value.data, ":%s%s",
761 names[i] + config->prefix_len,
762 config->store_stream_type ? "" : ":$DATA");
763 if (ea.name == NULL) {
764 DEBUG(0, ("talloc failed\n"));
768 if (!fn(&ea, private_data)) {
769 TALLOC_FREE(ea.value.data);
773 TALLOC_FREE(ea.value.data);
780 static bool add_one_stream(TALLOC_CTX *mem_ctx, unsigned int *num_streams,
781 struct stream_struct **streams,
782 const char *name, off_t size,
785 struct stream_struct *tmp;
787 tmp = talloc_realloc(mem_ctx, *streams, struct stream_struct,
793 tmp[*num_streams].name = talloc_strdup(tmp, name);
794 if (tmp[*num_streams].name == NULL) {
798 tmp[*num_streams].size = size;
799 tmp[*num_streams].alloc_size = alloc_size;
806 struct streaminfo_state {
808 vfs_handle_struct *handle;
809 unsigned int num_streams;
810 struct stream_struct *streams;
814 static bool collect_one_stream(struct ea_struct *ea, void *private_data)
816 struct streaminfo_state *state =
817 (struct streaminfo_state *)private_data;
819 if (!add_one_stream(state->mem_ctx,
820 &state->num_streams, &state->streams,
821 ea->name, ea->value.length-1,
822 smb_roundup(state->handle->conn,
823 ea->value.length-1))) {
824 state->status = NT_STATUS_NO_MEMORY;
831 static NTSTATUS streams_xattr_streaminfo(vfs_handle_struct *handle,
832 struct files_struct *fsp,
833 const struct smb_filename *smb_fname,
835 unsigned int *pnum_streams,
836 struct stream_struct **pstreams)
838 SMB_STRUCT_STAT sbuf;
841 struct streaminfo_state state;
843 ret = vfs_stat_smb_basename(handle->conn, smb_fname, &sbuf);
845 return map_nt_error_from_unix(errno);
848 state.streams = *pstreams;
849 state.num_streams = *pnum_streams;
850 state.mem_ctx = mem_ctx;
851 state.handle = handle;
852 state.status = NT_STATUS_OK;
854 if (S_ISLNK(sbuf.st_ex_mode)) {
856 * Currently we do't have SMB_VFS_LLISTXATTR
857 * inside the VFS which means there's no way
858 * to cope with a symlink when lp_posix_pathnames().
859 * returns true. For now ignore links.
860 * FIXME - by adding SMB_VFS_LLISTXATTR. JRA.
862 status = NT_STATUS_OK;
864 status = walk_xattr_streams(handle, fsp, smb_fname,
865 collect_one_stream, &state);
868 if (!NT_STATUS_IS_OK(status)) {
869 TALLOC_FREE(state.streams);
873 if (!NT_STATUS_IS_OK(state.status)) {
874 TALLOC_FREE(state.streams);
878 *pnum_streams = state.num_streams;
879 *pstreams = state.streams;
881 return SMB_VFS_NEXT_STREAMINFO(handle,
889 static NTSTATUS streams_xattr_fstreaminfo(vfs_handle_struct *handle,
890 struct files_struct *fsp,
892 unsigned int *pnum_streams,
893 struct stream_struct **pstreams)
896 struct streaminfo_state state;
898 state.streams = *pstreams;
899 state.num_streams = *pnum_streams;
900 state.mem_ctx = mem_ctx;
901 state.handle = handle;
902 state.status = NT_STATUS_OK;
904 status = walk_xattr_streams(handle,
910 if (!NT_STATUS_IS_OK(status)) {
911 TALLOC_FREE(state.streams);
915 if (!NT_STATUS_IS_OK(state.status)) {
916 TALLOC_FREE(state.streams);
920 *pnum_streams = state.num_streams;
921 *pstreams = state.streams;
923 return SMB_VFS_NEXT_FSTREAMINFO(handle,
930 static uint32_t streams_xattr_fs_capabilities(struct vfs_handle_struct *handle,
931 enum timestamp_set_resolution *p_ts_res)
933 return SMB_VFS_NEXT_FS_CAPABILITIES(handle, p_ts_res) | FILE_NAMED_STREAMS;
936 static int streams_xattr_connect(vfs_handle_struct *handle,
937 const char *service, const char *user)
939 struct streams_xattr_config *config;
940 const char *default_prefix = SAMBA_XATTR_DOSSTREAM_PREFIX;
944 rc = SMB_VFS_NEXT_CONNECT(handle, service, user);
949 config = talloc_zero(handle->conn, struct streams_xattr_config);
950 if (config == NULL) {
951 DEBUG(1, ("talloc_zero() failed\n"));
956 prefix = lp_parm_const_string(SNUM(handle->conn),
957 "streams_xattr", "prefix",
959 config->prefix = talloc_strdup(config, prefix);
960 if (config->prefix == NULL) {
961 DEBUG(1, ("talloc_strdup() failed\n"));
965 config->prefix_len = strlen(config->prefix);
966 DEBUG(10, ("streams_xattr using stream prefix: %s\n", config->prefix));
968 config->store_stream_type = lp_parm_bool(SNUM(handle->conn),
973 SMB_VFS_HANDLE_SET_DATA(handle, config,
974 NULL, struct stream_xattr_config,
980 static ssize_t streams_xattr_pwrite(vfs_handle_struct *handle,
981 files_struct *fsp, const void *data,
982 size_t n, off_t offset)
984 struct stream_io *sio =
985 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
988 struct smb_filename *smb_fname_base = NULL;
991 DEBUG(10, ("streams_xattr_pwrite called for %d bytes\n", (int)n));
994 return SMB_VFS_NEXT_PWRITE(handle, fsp, data, n, offset);
997 if (!streams_xattr_recheck(sio)) {
1001 if ((offset + n) >= lp_smbd_max_xattr_size(SNUM(handle->conn))) {
1003 * Requested write is beyond what can be read based on
1004 * samba configuration.
1005 * ReFS returns STATUS_FILESYSTEM_LIMITATION, which causes
1006 * entire file to be skipped by File Explorer. VFAT returns
1007 * NT_STATUS_OBJECT_NAME_COLLISION causes user to be prompted
1008 * to skip writing metadata, but copy data.
1010 DBG_ERR("Write to xattr [%s] on file [%s] exceeds maximum "
1011 "supported extended attribute size. "
1012 "Depending on filesystem type and operating system "
1013 "(OS) specifics, this value may be increased using "
1014 "the value of the parameter: "
1015 "smbd max xattr size = <bytes>. Consult OS and "
1016 "filesystem manpages prior to increasing this limit.\n",
1017 sio->xattr_name, sio->base);
1022 /* Create an smb_filename with stream_name == NULL. */
1023 smb_fname_base = synthetic_smb_fname(talloc_tos(),
1027 fsp->fsp_name->twrp,
1028 fsp->fsp_name->flags);
1029 if (smb_fname_base == NULL) {
1034 status = get_ea_value(talloc_tos(), handle->conn, NULL,
1035 smb_fname_base, sio->xattr_name, &ea);
1036 if (!NT_STATUS_IS_OK(status)) {
1040 if ((offset + n) > ea.value.length-1) {
1043 tmp = talloc_realloc(talloc_tos(), ea.value.data, uint8_t,
1047 TALLOC_FREE(ea.value.data);
1051 ea.value.data = tmp;
1052 ea.value.length = offset + n + 1;
1053 ea.value.data[offset+n] = 0;
1056 memcpy(ea.value.data + offset, data, n);
1058 ret = SMB_VFS_FSETXATTR(fsp->base_fsp ? fsp->base_fsp : fsp,
1060 ea.value.data, ea.value.length, 0);
1061 TALLOC_FREE(ea.value.data);
1070 static ssize_t streams_xattr_pread(vfs_handle_struct *handle,
1071 files_struct *fsp, void *data,
1072 size_t n, off_t offset)
1074 struct stream_io *sio =
1075 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1076 struct ea_struct ea;
1078 size_t length, overlap;
1079 struct smb_filename *smb_fname_base = NULL;
1081 DEBUG(10, ("streams_xattr_pread: offset=%d, size=%d\n",
1082 (int)offset, (int)n));
1085 return SMB_VFS_NEXT_PREAD(handle, fsp, data, n, offset);
1088 if (!streams_xattr_recheck(sio)) {
1092 /* Create an smb_filename with stream_name == NULL. */
1093 smb_fname_base = synthetic_smb_fname(talloc_tos(),
1097 fsp->fsp_name->twrp,
1098 fsp->fsp_name->flags);
1099 if (smb_fname_base == NULL) {
1104 status = get_ea_value(talloc_tos(), handle->conn, NULL,
1105 smb_fname_base, sio->xattr_name, &ea);
1106 if (!NT_STATUS_IS_OK(status)) {
1110 length = ea.value.length-1;
1112 DEBUG(10, ("streams_xattr_pread: get_ea_value returned %d bytes\n",
1115 /* Attempt to read past EOF. */
1116 if (length <= offset) {
1120 overlap = (offset + n) > length ? (length - offset) : n;
1121 memcpy(data, ea.value.data + offset, overlap);
1123 TALLOC_FREE(ea.value.data);
1127 struct streams_xattr_pread_state {
1129 struct vfs_aio_state vfs_aio_state;
1132 static void streams_xattr_pread_done(struct tevent_req *subreq);
1134 static struct tevent_req *streams_xattr_pread_send(
1135 struct vfs_handle_struct *handle,
1136 TALLOC_CTX *mem_ctx,
1137 struct tevent_context *ev,
1138 struct files_struct *fsp,
1140 size_t n, off_t offset)
1142 struct tevent_req *req = NULL;
1143 struct tevent_req *subreq = NULL;
1144 struct streams_xattr_pread_state *state = NULL;
1145 struct stream_io *sio =
1146 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1148 req = tevent_req_create(mem_ctx, &state,
1149 struct streams_xattr_pread_state);
1155 subreq = SMB_VFS_NEXT_PREAD_SEND(state, ev, handle, fsp,
1157 if (tevent_req_nomem(req, subreq)) {
1158 return tevent_req_post(req, ev);
1160 tevent_req_set_callback(subreq, streams_xattr_pread_done, req);
1164 state->nread = SMB_VFS_PREAD(fsp, data, n, offset);
1165 if (state->nread != n) {
1166 if (state->nread != -1) {
1169 tevent_req_error(req, errno);
1170 return tevent_req_post(req, ev);
1173 tevent_req_done(req);
1174 return tevent_req_post(req, ev);
1177 static void streams_xattr_pread_done(struct tevent_req *subreq)
1179 struct tevent_req *req = tevent_req_callback_data(
1180 subreq, struct tevent_req);
1181 struct streams_xattr_pread_state *state = tevent_req_data(
1182 req, struct streams_xattr_pread_state);
1184 state->nread = SMB_VFS_PREAD_RECV(subreq, &state->vfs_aio_state);
1185 TALLOC_FREE(subreq);
1187 if (tevent_req_error(req, state->vfs_aio_state.error)) {
1190 tevent_req_done(req);
1193 static ssize_t streams_xattr_pread_recv(struct tevent_req *req,
1194 struct vfs_aio_state *vfs_aio_state)
1196 struct streams_xattr_pread_state *state = tevent_req_data(
1197 req, struct streams_xattr_pread_state);
1199 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
1203 *vfs_aio_state = state->vfs_aio_state;
1204 return state->nread;
1207 struct streams_xattr_pwrite_state {
1209 struct vfs_aio_state vfs_aio_state;
1212 static void streams_xattr_pwrite_done(struct tevent_req *subreq);
1214 static struct tevent_req *streams_xattr_pwrite_send(
1215 struct vfs_handle_struct *handle,
1216 TALLOC_CTX *mem_ctx,
1217 struct tevent_context *ev,
1218 struct files_struct *fsp,
1220 size_t n, off_t offset)
1222 struct tevent_req *req = NULL;
1223 struct tevent_req *subreq = NULL;
1224 struct streams_xattr_pwrite_state *state = NULL;
1225 struct stream_io *sio =
1226 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1228 req = tevent_req_create(mem_ctx, &state,
1229 struct streams_xattr_pwrite_state);
1235 subreq = SMB_VFS_NEXT_PWRITE_SEND(state, ev, handle, fsp,
1237 if (tevent_req_nomem(req, subreq)) {
1238 return tevent_req_post(req, ev);
1240 tevent_req_set_callback(subreq, streams_xattr_pwrite_done, req);
1244 state->nwritten = SMB_VFS_PWRITE(fsp, data, n, offset);
1245 if (state->nwritten != n) {
1246 if (state->nwritten != -1) {
1249 tevent_req_error(req, errno);
1250 return tevent_req_post(req, ev);
1253 tevent_req_done(req);
1254 return tevent_req_post(req, ev);
1257 static void streams_xattr_pwrite_done(struct tevent_req *subreq)
1259 struct tevent_req *req = tevent_req_callback_data(
1260 subreq, struct tevent_req);
1261 struct streams_xattr_pwrite_state *state = tevent_req_data(
1262 req, struct streams_xattr_pwrite_state);
1264 state->nwritten = SMB_VFS_PWRITE_RECV(subreq, &state->vfs_aio_state);
1265 TALLOC_FREE(subreq);
1267 if (tevent_req_error(req, state->vfs_aio_state.error)) {
1270 tevent_req_done(req);
1273 static ssize_t streams_xattr_pwrite_recv(struct tevent_req *req,
1274 struct vfs_aio_state *vfs_aio_state)
1276 struct streams_xattr_pwrite_state *state = tevent_req_data(
1277 req, struct streams_xattr_pwrite_state);
1279 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
1283 *vfs_aio_state = state->vfs_aio_state;
1284 return state->nwritten;
1287 static int streams_xattr_ftruncate(struct vfs_handle_struct *handle,
1288 struct files_struct *fsp,
1293 struct ea_struct ea;
1295 struct stream_io *sio =
1296 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1297 struct smb_filename *smb_fname_base = NULL;
1299 DEBUG(10, ("streams_xattr_ftruncate called for file %s offset %.0f\n",
1300 fsp_str_dbg(fsp), (double)offset));
1303 return SMB_VFS_NEXT_FTRUNCATE(handle, fsp, offset);
1306 if (!streams_xattr_recheck(sio)) {
1310 /* Create an smb_filename with stream_name == NULL. */
1311 smb_fname_base = synthetic_smb_fname(talloc_tos(),
1315 fsp->fsp_name->twrp,
1316 fsp->fsp_name->flags);
1317 if (smb_fname_base == NULL) {
1322 status = get_ea_value(talloc_tos(), handle->conn, NULL,
1323 smb_fname_base, sio->xattr_name, &ea);
1324 if (!NT_STATUS_IS_OK(status)) {
1328 tmp = talloc_realloc(talloc_tos(), ea.value.data, uint8_t,
1332 TALLOC_FREE(ea.value.data);
1337 /* Did we expand ? */
1338 if (ea.value.length < offset + 1) {
1339 memset(&tmp[ea.value.length], '\0',
1340 offset + 1 - ea.value.length);
1343 ea.value.data = tmp;
1344 ea.value.length = offset + 1;
1345 ea.value.data[offset] = 0;
1347 ret = SMB_VFS_FSETXATTR(fsp->base_fsp ? fsp->base_fsp : fsp,
1349 ea.value.data, ea.value.length, 0);
1351 TALLOC_FREE(ea.value.data);
1360 static int streams_xattr_fallocate(struct vfs_handle_struct *handle,
1361 struct files_struct *fsp,
1366 struct stream_io *sio =
1367 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1369 DEBUG(10, ("streams_xattr_fallocate called for file %s offset %.0f"
1371 fsp_str_dbg(fsp), (double)offset, (double)len));
1374 return SMB_VFS_NEXT_FALLOCATE(handle, fsp, mode, offset, len);
1377 if (!streams_xattr_recheck(sio)) {
1381 /* Let the pwrite code path handle it. */
1386 static int streams_xattr_fchown(vfs_handle_struct *handle, files_struct *fsp,
1387 uid_t uid, gid_t gid)
1389 struct stream_io *sio =
1390 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1393 return SMB_VFS_NEXT_FCHOWN(handle, fsp, uid, gid);
1399 static int streams_xattr_fchmod(vfs_handle_struct *handle,
1403 struct stream_io *sio =
1404 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1407 return SMB_VFS_NEXT_FCHMOD(handle, fsp, mode);
1413 static ssize_t streams_xattr_fgetxattr(struct vfs_handle_struct *handle,
1414 struct files_struct *fsp,
1419 struct stream_io *sio =
1420 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1423 return SMB_VFS_NEXT_FGETXATTR(handle, fsp, name, value, size);
1430 static ssize_t streams_xattr_flistxattr(struct vfs_handle_struct *handle,
1431 struct files_struct *fsp,
1435 struct stream_io *sio =
1436 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1439 return SMB_VFS_NEXT_FLISTXATTR(handle, fsp, list, size);
1446 static int streams_xattr_fremovexattr(struct vfs_handle_struct *handle,
1447 struct files_struct *fsp,
1450 struct stream_io *sio =
1451 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1454 return SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
1461 static int streams_xattr_fsetxattr(struct vfs_handle_struct *handle,
1462 struct files_struct *fsp,
1468 struct stream_io *sio =
1469 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1472 return SMB_VFS_NEXT_FSETXATTR(handle, fsp, name, value,
1480 struct streams_xattr_fsync_state {
1482 struct vfs_aio_state vfs_aio_state;
1485 static void streams_xattr_fsync_done(struct tevent_req *subreq);
1487 static struct tevent_req *streams_xattr_fsync_send(
1488 struct vfs_handle_struct *handle,
1489 TALLOC_CTX *mem_ctx,
1490 struct tevent_context *ev,
1491 struct files_struct *fsp)
1493 struct tevent_req *req = NULL;
1494 struct tevent_req *subreq = NULL;
1495 struct streams_xattr_fsync_state *state = NULL;
1496 struct stream_io *sio =
1497 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1499 req = tevent_req_create(mem_ctx, &state,
1500 struct streams_xattr_fsync_state);
1506 subreq = SMB_VFS_NEXT_FSYNC_SEND(state, ev, handle, fsp);
1507 if (tevent_req_nomem(req, subreq)) {
1508 return tevent_req_post(req, ev);
1510 tevent_req_set_callback(subreq, streams_xattr_fsync_done, req);
1515 * There's no pathname based sync variant and we don't have access to
1516 * the basefile handle, so we can't do anything here.
1519 tevent_req_done(req);
1520 return tevent_req_post(req, ev);
1523 static void streams_xattr_fsync_done(struct tevent_req *subreq)
1525 struct tevent_req *req = tevent_req_callback_data(
1526 subreq, struct tevent_req);
1527 struct streams_xattr_fsync_state *state = tevent_req_data(
1528 req, struct streams_xattr_fsync_state);
1530 state->ret = SMB_VFS_FSYNC_RECV(subreq, &state->vfs_aio_state);
1531 TALLOC_FREE(subreq);
1532 if (state->ret != 0) {
1533 tevent_req_error(req, errno);
1537 tevent_req_done(req);
1540 static int streams_xattr_fsync_recv(struct tevent_req *req,
1541 struct vfs_aio_state *vfs_aio_state)
1543 struct streams_xattr_fsync_state *state = tevent_req_data(
1544 req, struct streams_xattr_fsync_state);
1546 if (tevent_req_is_unix_error(req, &vfs_aio_state->error)) {
1550 *vfs_aio_state = state->vfs_aio_state;
1554 static bool streams_xattr_lock(vfs_handle_struct *handle,
1561 struct stream_io *sio =
1562 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1565 return SMB_VFS_NEXT_LOCK(handle, fsp, op, offset, count, type);
1571 static bool streams_xattr_getlock(vfs_handle_struct *handle,
1578 struct stream_io *sio =
1579 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1582 return SMB_VFS_NEXT_GETLOCK(handle, fsp, poffset,
1583 pcount, ptype, ppid);
1590 static int streams_xattr_kernel_flock(vfs_handle_struct *handle,
1592 uint32_t share_access,
1593 uint32_t access_mask)
1595 struct stream_io *sio =
1596 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1599 return SMB_VFS_NEXT_KERNEL_FLOCK(handle, fsp,
1600 share_access, access_mask);
1606 static int streams_xattr_linux_setlease(vfs_handle_struct *handle,
1610 struct stream_io *sio =
1611 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1614 return SMB_VFS_NEXT_LINUX_SETLEASE(handle, fsp, leasetype);
1620 static bool streams_xattr_strict_lock_check(struct vfs_handle_struct *handle,
1622 struct lock_struct *plock)
1624 struct stream_io *sio =
1625 (struct stream_io *)VFS_FETCH_FSP_EXTENSION(handle, fsp);
1628 return SMB_VFS_NEXT_STRICT_LOCK_CHECK(handle, fsp, plock);
1634 static struct vfs_fn_pointers vfs_streams_xattr_fns = {
1635 .fs_capabilities_fn = streams_xattr_fs_capabilities,
1636 .connect_fn = streams_xattr_connect,
1637 .openat_fn = streams_xattr_openat,
1638 .close_fn = streams_xattr_close,
1639 .stat_fn = streams_xattr_stat,
1640 .fstat_fn = streams_xattr_fstat,
1641 .lstat_fn = streams_xattr_lstat,
1642 .pread_fn = streams_xattr_pread,
1643 .pwrite_fn = streams_xattr_pwrite,
1644 .pread_send_fn = streams_xattr_pread_send,
1645 .pread_recv_fn = streams_xattr_pread_recv,
1646 .pwrite_send_fn = streams_xattr_pwrite_send,
1647 .pwrite_recv_fn = streams_xattr_pwrite_recv,
1648 .unlinkat_fn = streams_xattr_unlinkat,
1649 .renameat_fn = streams_xattr_renameat,
1650 .ftruncate_fn = streams_xattr_ftruncate,
1651 .fallocate_fn = streams_xattr_fallocate,
1652 .streaminfo_fn = streams_xattr_streaminfo,
1653 .fstreaminfo_fn = streams_xattr_fstreaminfo,
1655 .fsync_send_fn = streams_xattr_fsync_send,
1656 .fsync_recv_fn = streams_xattr_fsync_recv,
1658 .lock_fn = streams_xattr_lock,
1659 .getlock_fn = streams_xattr_getlock,
1660 .kernel_flock_fn = streams_xattr_kernel_flock,
1661 .linux_setlease_fn = streams_xattr_linux_setlease,
1662 .strict_lock_check_fn = streams_xattr_strict_lock_check,
1664 .fchown_fn = streams_xattr_fchown,
1665 .fchmod_fn = streams_xattr_fchmod,
1667 .fgetxattr_fn = streams_xattr_fgetxattr,
1668 .flistxattr_fn = streams_xattr_flistxattr,
1669 .fremovexattr_fn = streams_xattr_fremovexattr,
1670 .fsetxattr_fn = streams_xattr_fsetxattr,
1674 NTSTATUS vfs_streams_xattr_init(TALLOC_CTX *ctx)
1676 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "streams_xattr",
1677 &vfs_streams_xattr_fns);