/*
Bacula® - The Network Backup Solution
- Copyright (C) 2008-2009 Free Software Foundation Europe e.V.
+ Copyright (C) 2008-2010 Free Software Foundation Europe e.V.
The main author of Bacula is Kern Sibbald, with contributions from
many others, a complete list can be found in the file AUTHORS.
This program is Free Software; you can redistribute it and/or
- modify it under the terms of version two of the GNU General Public
+ modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
* they were saved using a filed on the same platform.
*
* Currently we support the following OSes:
- * - FreeBSD (Extended Attributes)
* - Darwin (Extended Attributes)
* - Linux (Extended Attributes)
* - NetBSD (Extended Attributes)
+ * - FreeBSD (Extended Attributes)
+ * - OpenBSD (Extended Attributes)
+ * (As it seems either they never implemented xattr or they are removed
+ * the support as it stated it was in version 3.1 but the current syscall
+ * tabled shows the extattr_ functions are not implemented. So as such we
+ * might eventually support xattr on OpenBSD when they implemented them using
+ * the same interface as FreeBSD and NetBSD.
* - Solaris (Extended Attributes and Extensible Attributes)
*
* Written by Marco van Wieringen, November MMVIII
*
- * Version $Id$
*/
#include "bacula.h"
}
/*
- * This is a supported OS, See what kind of interface we should use.
- * Start with the generic interface used by most OS-es.
+ * First some generic functions for OSes that use the same xattr encoding scheme.
*/
#if defined(HAVE_DARWIN_OS) || \
- defined(HAVE_FREEBSD_OS) || \
defined(HAVE_LINUX_OS) || \
- defined(HAVE_NETBSD_OS)
-
-#ifdef HAVE_SYS_XATTR_H
-#include <sys/xattr.h>
-#endif
-
-/*
- * Define the supported XATTR streams for this OS
- */
-#if defined(HAVE_DARWIN_OS)
-static int os_default_xattr_streams[1] = { STREAM_XATTR_DARWIN };
-static const char *xattr_acl_skiplist[2] = { "com.apple.system.Security", NULL };
-static const char *xattr_skiplist[3] = { "com.apple.system.extendedsecurity", "com.apple.ResourceFork", NULL };
-#elif defined(HAVE_FREEBSD_OS)
-static int os_default_xattr_streams[1] = { STREAM_XATTR_FREEBSD };
-static const char *xattr_acl_skiplist[1] = { NULL };
-static const char *xattr_skiplist[1] = { NULL };
-#elif defined(HAVE_LINUX_OS)
-static int os_default_xattr_streams[1] = { STREAM_XATTR_LINUX };
-static const char *xattr_acl_skiplist[2] = { "system.posix_acl_access", NULL };
-static const char *xattr_skiplist[1] = { NULL };
-#elif defined(HAVE_NETBSD_OS)
-static int os_default_xattr_streams[1] = { STREAM_XATTR_NETBSD };
-static const char *xattr_acl_skiplist[1] = { NULL };
-static const char *xattr_skiplist[1] = { NULL };
-#endif
-
-/*
- * OSX doesn't have llistxattr, lgetxattr and lsetxattr but has
- * listxattr, getxattr and setxattr with an extra options argument
- * which mimics the l variants of the functions when we specify
- * XATTR_NOFOLLOW as the options value.
- */
-#if defined(HAVE_DARWIN_OS)
- #define llistxattr(path, list, size) listxattr((path), (list), (size), XATTR_NOFOLLOW)
- #define lgetxattr(path, name, value, size) getxattr((path), (name), (value), (size), 0, XATTR_NOFOLLOW)
- #define lsetxattr(path, name, value, size, flags) setxattr((path), (name), (value), (size), (flags), XATTR_NOFOLLOW)
-#else
- /*
- * Fallback to the non l-functions when those are not available.
- */
- #if defined(HAVE_GETXATTR) && !defined(HAVE_LGETXATTR)
- #define lgetxattr getxattr
- #endif
- #if defined(HAVE_SETXATTR) && !defined(HAVE_LSETXATTR)
- #define lsetxattr setxattr
- #endif
- #if defined(HAVE_LISTXATTR) && !defined(HAVE_LLISTXATTR)
- #define llistxattr listxattr
- #endif
-#endif
+ defined(HAVE_NETBSD_OS) || \
+ defined(HAVE_FREEBSD_OS) || \
+ defined(HAVE_OPENBSD_OS)
-static void xattr_drop_internal_table(xattr_t *xattr_value_list)
+static void xattr_drop_internal_table(alist *xattr_value_list)
{
xattr_t *current_xattr;
/*
* Walk the list of xattrs and free allocated memory on traversing.
*/
- for (current_xattr = xattr_value_list;
- current_xattr != (xattr_t *)NULL;
- current_xattr++) {
+ foreach_alist(current_xattr, xattr_value_list) {
/*
* See if we can shortcut.
*/
- if (current_xattr->magic != XATTR_MAGIC)
+ if (current_xattr == NULL || current_xattr->magic != XATTR_MAGIC)
break;
free(current_xattr->name);
if (current_xattr->value_length > 0)
free(current_xattr->value);
+
+ free(current_xattr);
}
- /*
- * Free the array of control structs.
- */
- free(xattr_value_list);
+ delete xattr_value_list;
}
/*
* This is repeated 1 or more times.
*
*/
-static uint32_t serialize_xattr_stream(JCR *jcr, uint32_t expected_serialize_len, xattr_t *xattr_value_list)
+static uint32_t serialize_xattr_stream(JCR *jcr, uint32_t expected_serialize_len, alist *xattr_value_list)
{
xattr_t *current_xattr;
ser_declare;
/*
* Walk the list of xattrs and serialize the data.
*/
- for (current_xattr = xattr_value_list; current_xattr != (xattr_t *)NULL; current_xattr++) {
+ foreach_alist(current_xattr, xattr_value_list) {
/*
* See if we can shortcut.
*/
- if (current_xattr->magic != XATTR_MAGIC)
+ if (current_xattr == NULL || current_xattr->magic != XATTR_MAGIC)
break;
ser_uint32(current_xattr->magic);
ser_bytes(current_xattr->name, current_xattr->name_length);
ser_uint32(current_xattr->value_length);
- ser_bytes(current_xattr->value, current_xattr->value_length);
+ if (current_xattr->value_length > 0 && current_xattr->value) {
+ ser_bytes(current_xattr->value, current_xattr->value_length);
+ }
}
ser_end(jcr->xattr_data->content, expected_serialize_len + 10);
jcr->xattr_data->content_length = ser_length(jcr->xattr_data->content);
+
return jcr->xattr_data->content_length;
}
-static bxattr_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
+static bxattr_exit_code unserialize_xattr_stream(JCR *jcr, alist *xattr_value_list)
+{
+ unser_declare;
+ xattr_t *current_xattr;
+ bxattr_exit_code retval = bxattr_exit_ok;
+
+ /*
+ * Parse the stream and call restore_xattr_on_file for each extended attribute.
+ *
+ * Start unserializing the data. We keep on looping while we have not
+ * unserialized all bytes in the stream.
+ */
+ unser_begin(jcr->xattr_data->content, jcr->xattr_data->content_length);
+ while (unser_length(jcr->xattr_data->content) < jcr->xattr_data->content_length) {
+ /*
+ * First make sure the magic is present. This way we can easily catch corruption.
+ * Any missing MAGIC is fatal we do NOT try to continue.
+ */
+
+ current_xattr = (xattr_t *)malloc(sizeof(xattr_t));
+ unser_uint32(current_xattr->magic);
+ if (current_xattr->magic != XATTR_MAGIC) {
+ Mmsg1(jcr->errmsg, _("Illegal xattr stream, no XATTR_MAGIC on file \"%s\"\n"),
+ jcr->last_fname);
+ Dmsg1(100, "Illegal xattr stream, no XATTR_MAGIC on file \"%s\"\n",
+ jcr->last_fname);
+ free(current_xattr);
+ return bxattr_exit_error;
+ }
+
+ /*
+ * Decode the valuepair. First decode the length of the name.
+ */
+ unser_uint32(current_xattr->name_length);
+ if (current_xattr->name_length == 0) {
+ Mmsg1(jcr->errmsg, _("Illegal xattr stream, xattr name length <= 0 on file \"%s\"\n"),
+ jcr->last_fname);
+ Dmsg1(100, "Illegal xattr stream, xattr name length <= 0 on file \"%s\"\n",
+ jcr->last_fname);
+ free(current_xattr);
+ return bxattr_exit_error;
+ }
+
+ /*
+ * Allocate room for the name and decode its content.
+ */
+ current_xattr->name = (char *)malloc(current_xattr->name_length + 1);
+ unser_bytes(current_xattr->name, current_xattr->name_length);
+
+ /*
+ * The xattr_name needs to be null terminated for lsetxattr.
+ */
+ current_xattr->name[current_xattr->name_length] = '\0';
+
+ /*
+ * Decode the value length.
+ */
+ unser_uint32(current_xattr->value_length);
+
+ if (current_xattr->value_length > 0) {
+ /*
+ * Allocate room for the value and decode its content.
+ */
+ current_xattr->value = (char *)malloc(current_xattr->value_length);
+ unser_bytes(current_xattr->value, current_xattr->value_length);
+ } else {
+ current_xattr->value = NULL;
+ }
+
+ xattr_value_list->append(current_xattr);
+ }
+
+ unser_end(jcr->xattr_data->content, jcr->xattr_data->content_length);
+ return retval;
+}
+#endif
+
+/*
+ * This is a supported OS, See what kind of interface we should use.
+ */
+#if defined(HAVE_DARWIN_OS) || \
+ defined(HAVE_LINUX_OS)
+
+#if (!defined(HAVE_LISTXATTR) && !defined(HAVE_LLISTXATTR)) || \
+ (!defined(HAVE_GETXATTR) && !defined(HAVE_LGETXATTR)) || \
+ (!defined(HAVE_SETXATTR) && !defined(HAVE_LSETXATTR))
+#error "Missing either full support for the LXATTR or XATTR functions."
+#endif
+
+#ifdef HAVE_SYS_XATTR_H
+#include <sys/xattr.h>
+#else
+#error "Missing sys/xattr.h header file"
+#endif
+
+/*
+ * Define the supported XATTR streams for this OS
+ */
+#if defined(HAVE_DARWIN_OS)
+static int os_default_xattr_streams[1] = { STREAM_XATTR_DARWIN };
+static const char *xattr_acl_skiplist[2] = { "com.apple.system.Security", NULL };
+static const char *xattr_skiplist[3] = { "com.apple.system.extendedsecurity", "com.apple.ResourceFork", NULL };
+#elif defined(HAVE_LINUX_OS)
+static int os_default_xattr_streams[1] = { STREAM_XATTR_LINUX };
+static const char *xattr_acl_skiplist[2] = { "system.posix_acl_access", NULL };
+static const char *xattr_skiplist[1] = { NULL };
+#endif
+
+/*
+ * OSX doesn't have llistxattr, lgetxattr and lsetxattr but has
+ * listxattr, getxattr and setxattr with an extra options argument
+ * which mimics the l variants of the functions when we specify
+ * XATTR_NOFOLLOW as the options value.
+ */
+#if defined(HAVE_DARWIN_OS)
+ #define llistxattr(path, list, size) listxattr((path), (list), (size), XATTR_NOFOLLOW)
+ #define lgetxattr(path, name, value, size) getxattr((path), (name), (value), (size), 0, XATTR_NOFOLLOW)
+ #define lsetxattr(path, name, value, size, flags) setxattr((path), (name), (value), (size), (flags), XATTR_NOFOLLOW)
+#else
+ /*
+ * Fallback to the non l-functions when those are not available.
+ */
+ #if defined(HAVE_GETXATTR) && !defined(HAVE_LGETXATTR)
+ #define lgetxattr getxattr
+ #endif
+ #if defined(HAVE_SETXATTR) && !defined(HAVE_LSETXATTR)
+ #define lsetxattr setxattr
+ #endif
+ #if defined(HAVE_LISTXATTR) && !defined(HAVE_LLISTXATTR)
+ #define llistxattr listxattr
+ #endif
+#endif
+
+static bxattr_exit_code linux_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
{
bool skip_xattr;
+ char *xattr_list, *bp;
int cnt, xattr_count = 0;
int32_t xattr_list_len,
xattr_value_len;
uint32_t expected_serialize_len = 0;
- char *xattr_list, *bp;
- xattr_t *xattr_value_list = NULL, *current_xattr;
+ xattr_t *current_xattr;
+ alist *xattr_value_list = NULL;
bxattr_exit_code retval = bxattr_exit_error;
berrno be;
* First get the length of the available list with extended attributes.
*/
xattr_list_len = llistxattr(jcr->last_fname, NULL, 0);
- if (xattr_list_len < 0) {
+ switch (xattr_list_len) {
+ case -1:
switch (errno) {
case ENOENT:
return bxattr_exit_ok;
jcr->last_fname, be.bstrerror());
return bxattr_exit_error;
}
- } else if (xattr_list_len == 0) {
+ break;
+ case 0:
return bxattr_exit_ok;
+ default:
+ break;
}
/*
* Get the actual list of extended attributes names for a file.
*/
xattr_list_len = llistxattr(jcr->last_fname, xattr_list, xattr_list_len);
- if (xattr_list_len < 0) {
+ switch (xattr_list_len) {
+ case -1:
switch (errno) {
case ENOENT:
retval = bxattr_exit_ok;
jcr->last_fname, be.bstrerror());
goto bail_out;
}
+ break;
+ default:
+ break;
}
xattr_list[xattr_list_len] = '\0';
- /*
- * Count the number of extended attributes on a file.
- */
- bp = xattr_list;
- while ((bp - xattr_list) + 1 < xattr_list_len) {
- skip_xattr = false;
-
- /*
- * On some OSes you also get the acls in the extented attribute list.
- * So we check if we are already backing up acls and if we do we
- * don't store the extended attribute with the same info.
- */
- if (ff_pkt->flags & FO_ACL) {
- for (cnt = 0; xattr_acl_skiplist[cnt] != NULL; cnt++) {
- if (!strcmp(bp, xattr_acl_skiplist[cnt])) {
- skip_xattr = true;
- break;
- }
- }
- }
-
- /*
- * On some OSes we want to skip certain xattrs which are in the xattr_skiplist array.
- */
- if (!skip_xattr) {
- for (cnt = 0; xattr_skiplist[cnt] != NULL; cnt++) {
- if (!strcmp(bp, xattr_skiplist[cnt])) {
- skip_xattr = true;
- break;
- }
- }
- }
-
- if (!skip_xattr) {
- xattr_count++;
- }
- bp = strchr(bp, '\0') + 1;
- }
-
- if (xattr_count == 0) {
- retval = bxattr_exit_ok;
- goto bail_out;
- }
-
- /*
- * Allocate enough room to hold all extended attributes.
- * After allocating the storage make sure its empty by zeroing it.
- */
- xattr_value_list = (xattr_t *)malloc(xattr_count * sizeof(xattr_t));
- memset((caddr_t)xattr_value_list, 0, xattr_count * sizeof(xattr_t));
+ xattr_value_list = New(alist(10, not_owned_by_alist));
/*
* Walk the list of extended attributes names and retrieve the data.
* We already count the bytes needed for serializing the stream later on.
*/
- current_xattr = xattr_value_list;
bp = xattr_list;
while ((bp - xattr_list) + 1 < xattr_list_len) {
+ int name_len;
skip_xattr = false;
/*
*/
if (ff_pkt->flags & FO_ACL) {
for (cnt = 0; xattr_acl_skiplist[cnt] != NULL; cnt++) {
- if (!strcmp(bp, xattr_acl_skiplist[cnt])) {
+ if (bstrcmp(bp, xattr_acl_skiplist[cnt])) {
skip_xattr = true;
break;
}
*/
if (!skip_xattr) {
for (cnt = 0; xattr_skiplist[cnt] != NULL; cnt++) {
- if (!strcmp(bp, xattr_skiplist[cnt])) {
+ if (bstrcmp(bp, xattr_skiplist[cnt])) {
skip_xattr = true;
break;
}
}
}
- if (skip_xattr) {
+ name_len = strlen(bp);
+ if (skip_xattr || name_len == 0) {
bp = strchr(bp, '\0') + 1;
continue;
}
/*
* Each xattr valuepair starts with a magic so we can parse it easier.
*/
+ current_xattr = (xattr_t *)malloc(sizeof(xattr_t));
current_xattr->magic = XATTR_MAGIC;
expected_serialize_len += sizeof(current_xattr->magic);
/*
* Allocate space for storing the name.
*/
- current_xattr->name_length = strlen(bp);
+ current_xattr->name_length = name_len;
current_xattr->name = (char *)malloc(current_xattr->name_length);
memcpy((caddr_t)current_xattr->name, (caddr_t)bp, current_xattr->name_length);
* First see how long the value is for the extended attribute.
*/
xattr_value_len = lgetxattr(jcr->last_fname, bp, NULL, 0);
- if (xattr_value_len < 0) {
+ switch (xattr_value_len) {
+ case -1:
switch (errno) {
case ENOENT:
retval = bxattr_exit_ok;
+ free(current_xattr->name);
+ free(current_xattr);
goto bail_out;
default:
Mmsg2(jcr->errmsg, _("lgetxattr error on file \"%s\": ERR=%s\n"),
jcr->last_fname, be.bstrerror());
Dmsg2(100, "lgetxattr error file=%s ERR=%s\n",
jcr->last_fname, be.bstrerror());
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ }
+ break;
+ case 0:
+ current_xattr->value = NULL;
+ current_xattr->value_length = 0;
+ expected_serialize_len += sizeof(current_xattr->value_length);
+ break;
+ default:
+ /*
+ * Allocate space for storing the value.
+ */
+ current_xattr->value = (char *)malloc(xattr_value_len);
+ memset((caddr_t)current_xattr->value, 0, xattr_value_len);
+
+ xattr_value_len = lgetxattr(jcr->last_fname, bp, current_xattr->value, xattr_value_len);
+ if (xattr_value_len < 0) {
+ switch (errno) {
+ case ENOENT:
+ retval = bxattr_exit_ok;
+ free(current_xattr->value);
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ default:
+ Mmsg2(jcr->errmsg, _("lgetxattr error on file \"%s\": ERR=%s\n"),
+ jcr->last_fname, be.bstrerror());
+ Dmsg2(100, "lgetxattr error file=%s ERR=%s\n",
+ jcr->last_fname, be.bstrerror());
+ free(current_xattr->value);
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ }
+ }
+ /*
+ * Store the actual length of the value.
+ */
+ current_xattr->value_length = xattr_value_len;
+ expected_serialize_len += sizeof(current_xattr->value_length) + current_xattr->value_length;
+
+ /*
+ * Protect ourself against things getting out of hand.
+ */
+ if (expected_serialize_len >= MAX_XATTR_STREAM) {
+ Mmsg2(jcr->errmsg, _("Xattr stream on file \"%s\" exceeds maximum size of %d bytes\n"),
+ jcr->last_fname, MAX_XATTR_STREAM);
+ free(current_xattr->value);
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ }
+ break;
+ }
+
+ xattr_value_list->append(current_xattr);
+ xattr_count++;
+ bp = strchr(bp, '\0') + 1;
+ }
+
+ free(xattr_list);
+ xattr_list = (char *)NULL;
+
+ /*
+ * If we found any xattr send them to the SD.
+ */
+ if (xattr_count > 0) {
+ /*
+ * Serialize the datastream.
+ */
+ if (serialize_xattr_stream(jcr, expected_serialize_len, xattr_value_list) < expected_serialize_len) {
+ Mmsg1(jcr->errmsg, _("Failed to serialize extended attributes on file \"%s\"\n"),
+ jcr->last_fname);
+ Dmsg1(100, "Failed to serialize extended attributes on file \"%s\"\n",
+ jcr->last_fname);
+ goto bail_out;
+ }
+
+ xattr_drop_internal_table(xattr_value_list);
+
+ /*
+ * Send the datastream to the SD.
+ */
+ return send_xattr_stream(jcr, os_default_xattr_streams[0]);
+ } else {
+ xattr_drop_internal_table(xattr_value_list);
+
+ return bxattr_exit_ok;
+ }
+
+bail_out:
+ if (xattr_list != NULL) {
+ free(xattr_list);
+ }
+ if (xattr_value_list != NULL) {
+ xattr_drop_internal_table(xattr_value_list);
+ }
+ return retval;
+}
+
+static bxattr_exit_code linux_xattr_parse_streams(JCR *jcr, int stream)
+{
+ xattr_t *current_xattr;
+ alist *xattr_value_list;
+ berrno be;
+
+ xattr_value_list = New(alist(10, not_owned_by_alist));
+
+ if (unserialize_xattr_stream(jcr, xattr_value_list) != bxattr_exit_ok) {
+ xattr_drop_internal_table(xattr_value_list);
+ return bxattr_exit_error;
+ }
+
+ foreach_alist(current_xattr, xattr_value_list) {
+ if (lsetxattr(jcr->last_fname, current_xattr->name, current_xattr->value, current_xattr->value_length, 0) != 0) {
+ switch (errno) {
+ case ENOENT:
+ goto bail_out;
+ default:
+ Mmsg2(jcr->errmsg, _("lsetxattr error on file \"%s\": ERR=%s\n"),
+ jcr->last_fname, be.bstrerror());
+ Dmsg2(100, "lsetxattr error file=%s ERR=%s\n",
+ jcr->last_fname, be.bstrerror());
goto bail_out;
}
}
+ }
+
+ xattr_drop_internal_table(xattr_value_list);
+ return bxattr_exit_ok;
+
+bail_out:
+ xattr_drop_internal_table(xattr_value_list);
+ return bxattr_exit_error;
+}
+
+/*
+ * Function pointers to the build and parse function to use for these xattrs.
+ */
+static bxattr_exit_code (*os_build_xattr_streams)(JCR *jcr, FF_PKT *ff_pkt) = linux_xattr_build_streams;
+static bxattr_exit_code (*os_parse_xattr_streams)(JCR *jcr, int stream) = linux_xattr_parse_streams;
+
+#elif defined(HAVE_FREEBSD_OS) || \
+ defined(HAVE_NETBSD_OS) || \
+ defined(HAVE_OPENBSD_OS)
+
+#if (!defined(HAVE_EXTATTR_GET_LINK) && !defined(HAVE_EXTATTR_GET_FILE)) || \
+ (!defined(HAVE_EXTATTR_SET_LINK) && !defined(HAVE_EXTATTR_SET_FILE)) || \
+ (!defined(HAVE_EXTATTR_LIST_LINK) && !defined(HAVE_EXTATTR_LIST_FILE)) || \
+ !defined(HAVE_EXTATTR_NAMESPACE_TO_STRING) || \
+ !defined(HAVE_EXTATTR_STRING_TO_NAMESPACE)
+#error "Missing full support for the extattr functions."
+#endif
+
+#ifdef HAVE_SYS_EXTATTR_H
+#include <sys/extattr.h>
+#else
+#error "Missing sys/extattr.h header file"
+#endif
+
+#ifdef HAVE_LIBUTIL_H
+#include <libutil.h>
+#endif
+
+#if !defined(HAVE_EXTATTR_GET_LINK) && defined(HAVE_EXTATTR_GET_FILE)
+#define extattr_get_link extattr_get_file
+#endif
+#if !defined(HAVE_EXTATTR_SET_LINK) && defined(HAVE_EXTATTR_SET_FILE)
+#define extattr_set_link extattr_set_file
+#endif
+#if !defined(HAVE_EXTATTR_LIST_LINK) && defined(HAVE_EXTATTR_LIST_FILE)
+#define extattr_list_link extattr_list_file
+#endif
+
+#if defined(HAVE_FREEBSD_OS)
+static int os_default_xattr_streams[1] = { STREAM_XATTR_FREEBSD };
+static int os_default_xattr_namespaces[2] = { EXTATTR_NAMESPACE_USER, EXTATTR_NAMESPACE_SYSTEM };
+static const char *xattr_acl_skiplist[2] = { "system.posix1e.acl_access", NULL };
+static const char *xattr_skiplist[1] = { NULL };
+#elif defined(HAVE_NETBSD_OS)
+static int os_default_xattr_streams[1] = { STREAM_XATTR_NETBSD };
+static int os_default_xattr_namespaces[2] = { EXTATTR_NAMESPACE_USER, EXTATTR_NAMESPACE_SYSTEM };
+static const char *xattr_acl_skiplist[1] = { NULL };
+static const char *xattr_skiplist[1] = { NULL };
+#elif defined(HAVE_OPENBSD_OS)
+static int os_default_xattr_streams[1] = { STREAM_XATTR_OPENBSD };
+static int os_default_xattr_namespaces[2] = { EXTATTR_NAMESPACE_USER, EXTATTR_NAMESPACE_SYSTEM };
+static const char *xattr_acl_skiplist[1] = { NULL };
+static const char *xattr_skiplist[1] = { NULL };
+#endif
+
+static bxattr_exit_code bsd_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
+{
+ bool skip_xattr;
+ char *xattr_list;
+ int cnt, index, xattr_count = 0;
+ int32_t xattr_list_len,
+ xattr_value_len;
+ uint32_t expected_serialize_len = 0;
+ unsigned int namespace_index;
+ int attrnamespace;
+ char *current_attrnamespace = NULL;
+ char current_attrname[XATTR_BUFSIZ], current_attrtuple[XATTR_BUFSIZ];
+ xattr_t *current_xattr;
+ alist *xattr_value_list = NULL;
+ bxattr_exit_code retval = bxattr_exit_error;
+ berrno be;
+
+ xattr_value_list = New(alist(10, not_owned_by_alist));
+
+ /*
+ * Loop over all available xattr namespaces.
+ */
+ for (namespace_index = 0; namespace_index < sizeof(os_default_xattr_namespaces) / sizeof(int); namespace_index++) {
+ attrnamespace = os_default_xattr_namespaces[namespace_index];
/*
- * Allocate space for storing the value.
+ * Convert the numeric attrnamespace into a string representation and make a private copy of that string.
+ * The extattr_namespace_to_string functions returns a strdupped string which we need to free.
*/
- current_xattr->value = (char *)malloc(xattr_value_len);
- memset((caddr_t)current_xattr->value, 0, xattr_value_len);
+ if (extattr_namespace_to_string(attrnamespace, ¤t_attrnamespace) != 0) {
+ Mmsg2(jcr->errmsg, _("Failed to convert %d into namespace on file \"%s\"\n"),
+ attrnamespace, jcr->last_fname);
+ Dmsg2(100, "Failed to convert %d into namespace on file \"%s\"\n",
+ attrnamespace, jcr->last_fname);
+ goto bail_out;
+ }
- xattr_value_len = lgetxattr(jcr->last_fname, bp, current_xattr->value, xattr_value_len);
- if (xattr_value_len < 0) {
+ /*
+ * First get the length of the available list with extended attributes.
+ * If we get EPERM on system namespace, don't return error.
+ * This is expected for normal users trying to archive the system
+ * namespace on FreeBSD 6.2 and later. On NetBSD 3.1 and later,
+ * they've decided to return EOPNOTSUPP instead.
+ */
+ xattr_list_len = extattr_list_link(jcr->last_fname, attrnamespace, NULL, 0);
+ switch (xattr_list_len) {
+ case -1:
switch (errno) {
case ENOENT:
retval = bxattr_exit_ok;
goto bail_out;
+#if defined(EOPNOTSUPP)
+ case EOPNOTSUPP:
+#endif
+ case EPERM:
+ if (attrnamespace == EXTATTR_NAMESPACE_SYSTEM) {
+ actuallyfree(current_attrnamespace);
+ current_attrnamespace = NULL;
+ continue;
+ }
+ /*
+ * FALLTHROUGH
+ */
default:
- Mmsg2(jcr->errmsg, _("lgetxattr error on file \"%s\": ERR=%s\n"),
+ Mmsg2(jcr->errmsg, _("extattr_list_link error on file \"%s\": ERR=%s\n"),
jcr->last_fname, be.bstrerror());
- Dmsg2(100, "lgetxattr error file=%s ERR=%s\n",
+ Dmsg2(100, "extattr_list_link error file=%s ERR=%s\n",
jcr->last_fname, be.bstrerror());
goto bail_out;
}
+ break;
+ case 0:
+ continue;
+ default:
+ break;
}
/*
- * Store the actual length of the value.
+ * Allocate room for the extented attribute list.
*/
- current_xattr->value_length = xattr_value_len;
- expected_serialize_len += sizeof(current_xattr->value_length) + current_xattr->value_length;
+ xattr_list = (char *)malloc(xattr_list_len + 1);
+ memset((caddr_t)xattr_list, 0, xattr_list_len + 1);
/*
- * Protect ourself against things getting out of hand.
+ * Get the actual list of extended attributes names for a file.
*/
- if (expected_serialize_len >= MAX_XATTR_STREAM) {
- Mmsg2(jcr->errmsg, _("Xattr stream on file \"%s\" exceeds maximum size of %d bytes\n"),
- jcr->last_fname, MAX_XATTR_STREAM);
- goto bail_out;
+ xattr_list_len = extattr_list_link(jcr->last_fname, attrnamespace, xattr_list, xattr_list_len);
+ switch (xattr_list_len) {
+ case -1:
+ switch (errno) {
+ case ENOENT:
+ retval = bxattr_exit_ok;
+ goto bail_out;
+ default:
+ Mmsg2(jcr->errmsg, _("extattr_list_link error on file \"%s\": ERR=%s\n"),
+ jcr->last_fname, be.bstrerror());
+ Dmsg2(100, "extattr_list_link error file=%s ERR=%s\n",
+ jcr->last_fname, be.bstrerror());
+ goto bail_out;
+ }
+ break;
+ default:
+ break;
}
-
+ xattr_list[xattr_list_len] = '\0';
+
/*
- * Next attribute.
+ * Walk the list of extended attributes names and retrieve the data.
+ * We already count the bytes needed for serializing the stream later on.
*/
- current_xattr++;
- bp = strchr(bp, '\0') + 1;
- }
+ for (index = 0; index < xattr_list_len; index += xattr_list[index] + 1) {
+ skip_xattr = false;
- /*
- * Serialize the datastream.
- */
- if (serialize_xattr_stream(jcr, expected_serialize_len, xattr_value_list) < expected_serialize_len) {
- Mmsg1(jcr->errmsg, _("Failed to serialize extended attributes on file \"%s\"\n"),
- jcr->last_fname);
- Dmsg1(100, "Failed to serialize extended attributes on file \"%s\"\n",
- jcr->last_fname);
- goto bail_out;
- }
+ /*
+ * Print the current name into the buffer as its not null terminated we need to
+ * use the length encoded in the string for copying only the needed bytes.
+ */
+ cnt = xattr_list[index];
+ if (cnt > ((int)sizeof(current_attrname) - 1)) {
+ cnt = ((int)sizeof(current_attrname) - 1);
+ }
+ strncpy(current_attrname, xattr_list + (index + 1), cnt);
+ current_attrname[cnt] = '\0';
- xattr_drop_internal_table(xattr_value_list);
- free(xattr_list);
+ /*
+ * First make a xattr tuple of the current namespace and the name of the xattr.
+ * e.g. something like user.<attrname> or system.<attrname>
+ */
+ bsnprintf(current_attrtuple, sizeof(current_attrtuple), "%s.%s", current_attrnamespace, current_attrname);
- /*
- * Send the datastream to the SD.
- */
- return send_xattr_stream(jcr, os_default_xattr_streams[0]);
+ /*
+ * On some OSes you also get the acls in the extented attribute list.
+ * So we check if we are already backing up acls and if we do we
+ * don't store the extended attribute with the same info.
+ */
+ if (ff_pkt->flags & FO_ACL) {
+ for (cnt = 0; xattr_acl_skiplist[cnt] != NULL; cnt++) {
+ if (bstrcmp(current_attrtuple, xattr_acl_skiplist[cnt])) {
+ skip_xattr = true;
+ break;
+ }
+ }
+ }
-bail_out:
- if (xattr_value_list) {
- xattr_drop_internal_table(xattr_value_list);
- }
- free(xattr_list);
- return retval;
-}
+ /*
+ * On some OSes we want to skip certain xattrs which are in the xattr_skiplist array.
+ */
+ if (!skip_xattr) {
+ for (cnt = 0; xattr_skiplist[cnt] != NULL; cnt++) {
+ if (bstrcmp(current_attrtuple, xattr_skiplist[cnt])) {
+ skip_xattr = true;
+ break;
+ }
+ }
+ }
-static bxattr_exit_code generic_xattr_parse_streams(JCR *jcr, int stream)
-{
- unser_declare;
- xattr_t current_xattr;
- bxattr_exit_code retval = bxattr_exit_ok;
- berrno be;
+ if (skip_xattr) {
+ continue;
+ }
+
+ /*
+ * Each xattr valuepair starts with a magic so we can parse it easier.
+ */
+ current_xattr = (xattr_t *)malloc(sizeof(xattr_t));
+ current_xattr->magic = XATTR_MAGIC;
+ expected_serialize_len += sizeof(current_xattr->magic);
+
+ /*
+ * Allocate space for storing the name.
+ */
+ current_xattr->name_length = strlen(current_attrtuple);
+ current_xattr->name = (char *)malloc(current_xattr->name_length);
+ memcpy((caddr_t)current_xattr->name, (caddr_t)current_attrtuple, current_xattr->name_length);
+
+ expected_serialize_len += sizeof(current_xattr->name_length) + current_xattr->name_length;
+
+ /*
+ * First see how long the value is for the extended attribute.
+ */
+ xattr_value_len = extattr_get_link(jcr->last_fname, attrnamespace, current_attrname, NULL, 0);
+ switch (xattr_value_len) {
+ case -1:
+ switch (errno) {
+ case ENOENT:
+ retval = bxattr_exit_ok;
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ default:
+ Mmsg2(jcr->errmsg, _("extattr_get_link error on file \"%s\": ERR=%s\n"),
+ jcr->last_fname, be.bstrerror());
+ Dmsg2(100, "extattr_get_link error file=%s ERR=%s\n",
+ jcr->last_fname, be.bstrerror());
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ }
+ break;
+ case 0:
+ current_xattr->value = NULL;
+ current_xattr->value_length = 0;
+ expected_serialize_len += sizeof(current_xattr->value_length);
+ break;
+ default:
+ /*
+ * Allocate space for storing the value.
+ */
+ current_xattr->value = (char *)malloc(xattr_value_len);
+ memset((caddr_t)current_xattr->value, 0, xattr_value_len);
+
+ xattr_value_len = extattr_get_link(jcr->last_fname, attrnamespace, current_attrname, current_xattr->value, xattr_value_len);
+ if (xattr_value_len < 0) {
+ switch (errno) {
+ case ENOENT:
+ retval = bxattr_exit_ok;
+ free(current_xattr->value);
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ default:
+ Mmsg2(jcr->errmsg, _("extattr_get_link error on file \"%s\": ERR=%s\n"),
+ jcr->last_fname, be.bstrerror());
+ Dmsg2(100, "extattr_get_link error file=%s ERR=%s\n",
+ jcr->last_fname, be.bstrerror());
+ free(current_xattr->value);
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ }
+ }
+
+ /*
+ * Store the actual length of the value.
+ */
+ current_xattr->value_length = xattr_value_len;
+ expected_serialize_len += sizeof(current_xattr->value_length) + current_xattr->value_length;
+
+ /*
+ * Protect ourself against things getting out of hand.
+ */
+ if (expected_serialize_len >= MAX_XATTR_STREAM) {
+ Mmsg2(jcr->errmsg, _("Xattr stream on file \"%s\" exceeds maximum size of %d bytes\n"),
+ jcr->last_fname, MAX_XATTR_STREAM);
+ free(current_xattr->value);
+ free(current_xattr->name);
+ free(current_xattr);
+ goto bail_out;
+ }
+ break;
+ }
+
+ xattr_value_list->append(current_xattr);
+ xattr_count++;
+
+ }
+
+ /*
+ * Drop the local copy of the current_attrnamespace.
+ */
+ actuallyfree(current_attrnamespace);
+ current_attrnamespace = NULL;
+
+ /*
+ * We are done with this xattr list.
+ */
+ free(xattr_list);
+ xattr_list = (char *)NULL;
+ }
/*
- * Parse the stream and perform the setxattr calls on the file.
- *
- * Start unserializing the data. We keep on looping while we have not
- * unserialized all bytes in the stream.
+ * If we found any xattr send them to the SD.
*/
- unser_begin(jcr->xattr_data->content, jcr->xattr_data->content_length);
- while (unser_length(jcr->xattr_data->content) < jcr->xattr_data->content_length) {
+ if (xattr_count > 0) {
/*
- * First make sure the magic is present. This way we can easily catch corruption.
- * Any missing MAGIC is fatal we do NOT try to continue.
+ * Serialize the datastream.
*/
- unser_uint32(current_xattr.magic);
- if (current_xattr.magic != XATTR_MAGIC) {
- Mmsg1(jcr->errmsg, _("Illegal xattr stream, no XATTR_MAGIC on file \"%s\"\n"),
+ if (serialize_xattr_stream(jcr, expected_serialize_len, xattr_value_list) < expected_serialize_len) {
+ Mmsg1(jcr->errmsg, _("Failed to serialize extended attributes on file \"%s\"\n"),
jcr->last_fname);
- Dmsg1(100, "Illegal xattr stream, no XATTR_MAGIC on file \"%s\"\n",
+ Dmsg1(100, "Failed to serialize extended attributes on file \"%s\"\n",
jcr->last_fname);
- return bxattr_exit_error;
+ goto bail_out;
}
- /*
- * Decode the valuepair. First decode the length of the name.
- */
- unser_uint32(current_xattr.name_length);
-
- /*
- * Allocate room for the name and decode its content.
- */
- current_xattr.name = (char *)malloc(current_xattr.name_length + 1);
- unser_bytes(current_xattr.name, current_xattr.name_length);
+ xattr_drop_internal_table(xattr_value_list);
/*
- * The xattr_name needs to be null terminated for lsetxattr.
+ * Send the datastream to the SD.
*/
- current_xattr.name[current_xattr.name_length] = '\0';
+ return send_xattr_stream(jcr, os_default_xattr_streams[0]);
+ } else {
+ xattr_drop_internal_table(xattr_value_list);
+
+ return bxattr_exit_ok;
+ }
+
+bail_out:
+ if (current_attrnamespace != NULL) {
+ actuallyfree(current_attrnamespace);
+ }
+ if (xattr_list != NULL) {
+ free(xattr_list);
+ }
+ if (xattr_value_list != NULL) {
+ xattr_drop_internal_table(xattr_value_list);
+ }
+ return retval;
+}
+static bxattr_exit_code bsd_parse_xattr_streams(JCR *jcr, int stream)
+{
+ xattr_t *current_xattr;
+ alist *xattr_value_list;
+ int current_attrnamespace, cnt;
+ char *attrnamespace, *attrname;
+ berrno be;
+
+ xattr_value_list = New(alist(10, not_owned_by_alist));
+
+ if (unserialize_xattr_stream(jcr, xattr_value_list) != bxattr_exit_ok) {
+ xattr_drop_internal_table(xattr_value_list);
+ return bxattr_exit_error;
+ }
+
+ foreach_alist(current_xattr, xattr_value_list) {
/*
- * Decode the value length.
+ * Try splitting the xattr_name into a namespace and name part.
+ * The splitting character is a .
*/
- unser_uint32(current_xattr.value_length);
+ attrnamespace = current_xattr->name;
+ if ((attrname = strchr(attrnamespace, '.')) == (char *)NULL) {
+ Mmsg2(jcr->errmsg, _("Failed to split %s into namespace and name part on file \"%s\"\n"),
+ current_xattr->name, jcr->last_fname);
+ Dmsg2(100, "Failed to split %s into namespace and name part on file \"%s\"\n",
+ current_xattr->name, jcr->last_fname);
+ goto bail_out;
+ }
+ *attrname++ = '\0';
/*
- * Allocate room for the value and decode its content.
+ * Make sure the attrnamespace makes sense.
*/
- current_xattr.value = (char *)malloc(current_xattr.value_length);
- unser_bytes(current_xattr.value, current_xattr.value_length);
+ if (extattr_string_to_namespace(attrnamespace, ¤t_attrnamespace) != 0) {
+ Mmsg2(jcr->errmsg, _("Failed to convert %s into namespace on file \"%s\"\n"),
+ attrnamespace, jcr->last_fname);
+ Dmsg2(100, "Failed to convert %s into namespace on file \"%s\"\n",
+ attrnamespace, jcr->last_fname);
+ goto bail_out;
+ }
/*
- * Try to set the extended attribute on the file.
- * If we fail to set this attribute we flag the error but its not fatal,
- * we try to restore the other extended attributes too.
+ * Try restoring the extended attribute.
*/
- if (lsetxattr(jcr->last_fname, current_xattr.name, current_xattr.value,
- current_xattr.value_length, 0) != 0) {
+ cnt = extattr_set_link(jcr->last_fname, current_attrnamespace,
+ attrname, current_xattr->value, current_xattr->value_length);
+ if (cnt < 0 || cnt != (int)current_xattr->value_length) {
switch (errno) {
case ENOENT:
+ goto bail_out;
break;
default:
- Mmsg2(jcr->errmsg, _("lsetxattr error on file \"%s\": ERR=%s\n"),
+ Mmsg2(jcr->errmsg, _("extattr_set_link error on file \"%s\": ERR=%s\n"),
jcr->last_fname, be.bstrerror());
- Dmsg2(100, "lsetxattr error file=%s ERR=%s\n",
+ Dmsg2(100, "extattr_set_link error file=%s ERR=%s\n",
jcr->last_fname, be.bstrerror());
- retval = bxattr_exit_error;
+ goto bail_out;
break;
}
}
-
- /*
- * Free the temporary buffers.
- */
- free(current_xattr.name);
- free(current_xattr.value);
}
- unser_end(jcr->xattr_data->content, jcr->xattr_data->content_length);
- return retval;
+ xattr_drop_internal_table(xattr_value_list);
+ return bxattr_exit_ok;
+
+bail_out:
+ xattr_drop_internal_table(xattr_value_list);
+ return bxattr_exit_error;
}
/*
- * For all these os-es setup the build and parse function pointer to the generic functions.
+ * Function pointers to the build and parse function to use for these xattrs.
*/
-static bxattr_exit_code (*os_build_xattr_streams)(JCR *jcr, FF_PKT *ff_pkt) = generic_xattr_build_streams;
-static bxattr_exit_code (*os_parse_xattr_streams)(JCR *jcr, int stream) = generic_xattr_parse_streams;
+static bxattr_exit_code (*os_build_xattr_streams)(JCR *jcr, FF_PKT *ff_pkt) = bsd_build_xattr_streams;
+static bxattr_exit_code (*os_parse_xattr_streams)(JCR *jcr, int stream) = bsd_parse_xattr_streams;
#elif defined(HAVE_SUN_OS)
/*
#include <sys/acl.h>
#endif
+#if !defined(HAVE_OPENAT) || \
+ !defined(HAVE_UNLINKAT) || \
+ !defined(HAVE_FCHOWNAT) || \
+ !defined(HAVE_FUTIMESAT)
+#error "Unable to compile code because of missing openat, unlinkat, fchownat or futimesat function"
+#endif
+
/*
* Define the supported XATTR streams for this OS
*/
char link_source[PATH_MAX];
char *acl_text = NULL;
char attribs[MAXSTRING];
- char buffer[BUFSIZ];
+ char buffer[XATTR_BUFSIZ];
bxattr_exit_code retval = bxattr_exit_error;
berrno be;
}
bail_out:
- if (acl_text) {
+ if (acl_text != NULL) {
free(acl_text);
}
if (attrfd != -1) {
/*
* Skip only the toplevel . dir.
*/
- if (!attr_parent && !strcmp(dp->d_name, "."))
+ if (!attr_parent && bstrcmp(dp->d_name, "."))
continue;
/*
* Skip all .. directories
*/
- if (!strcmp(dp->d_name, ".."))
+ if (bstrcmp(dp->d_name, ".."))
continue;
Dmsg3(400, "processing extended attribute %s%s on file \"%s\"\n",
/*
* We are not interested in read-only extensible attributes.
*/
- if (!strcmp(dp->d_name, VIEW_READONLY)) {
+ if (bstrcmp(dp->d_name, VIEW_READONLY)) {
Dmsg3(400, "Skipping readonly extensible attributes %s%s on file \"%s\"\n",
current_xattr_namespace, dp->d_name, jcr->last_fname);
* We are only interested in read-write extensible attributes
* when they contain non-transient values.
*/
- if (!strcmp(dp->d_name, VIEW_READWRITE)) {
+ if (bstrcmp(dp->d_name, VIEW_READWRITE)) {
/*
* Determine if there are non-transient system attributes at the toplevel.
* We need to provide a fd to the open file.
* If its not the hidden_dir create the entry.
* The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
*/
- if (strcmp(target_attrname, ".")) {
+ if (!bstrcmp(target_attrname, ".")) {
unlinkat(attrdirfd, target_attrname, AT_REMOVEDIR);
if (mkdir(target_attrname, st.st_mode) < 0) {
Jmsg3(jcr, M_WARNING, 0, _("Unable to mkdir xattr %s on file \"%s\": ERR=%s\n"),
#if defined(HAVE_SYS_NVPAIR_H) && defined(_PC_SATTR_ENABLED)
case STREAM_XATTR_SOLARIS_SYS:
if (pathconf(jcr->last_fname, _PC_SATTR_ENABLED) <= 0) {
- Qmsg1(jcr, M_WARNING, 0,
- _("Failed to restore extensible attributes on file \"%s\"\n"),
- jcr->last_fname);
+ Mmsg1(jcr->errmsg, _("Failed to restore extensible attributes on file \"%s\"\n"), jcr->last_fname);
Dmsg1(100, "Unable to restore extensible attributes on file \"%s\", filesystem doesn't support this\n",
jcr->last_fname);
return bxattr_exit_error;
#endif
case STREAM_XATTR_SOLARIS:
if (pathconf(jcr->last_fname, _PC_XATTR_ENABLED) <= 0) {
- Qmsg1(jcr, M_WARNING, 0,
- _("Failed to restore extended attributes on file \"%s\"\n"),
- jcr->last_fname);
+ Mmsg1(jcr->errmsg, _("Failed to restore extended attributes on file \"%s\"\n"), jcr->last_fname);
Dmsg1(100, "Unable to restore extended attributes on file \"%s\", filesystem doesn't support this\n",
jcr->last_fname);
return bxattr_exit_error;
projects / bacula / bacula / blobdiff