]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/filed/xattr.c
Small change to comments
[bacula/bacula] / bacula / src / filed / xattr.c
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2008-2009 Free Software Foundation Europe e.V.
5
6    The main author of Bacula is Kern Sibbald, with contributions from
7    many others, a complete list can be found in the file AUTHORS.
8    This program is Free Software; you can redistribute it and/or
9    modify it under the terms of version two of the GNU General Public
10    License as published by the Free Software Foundation and included
11    in the file LICENSE.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23    Bacula® is a registered trademark of Kern Sibbald.
24    The licensor of Bacula is the Free Software Foundation Europe
25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26    Switzerland, email:ftf@fsfeurope.org.
27 */
28 /*
29  * Functions to handle Extended Attributes for bacula.
30  *
31  * Extended Attributes are so OS specific we only restore Extended Attributes if
32  * they were saved using a filed on the same platform.
33  *
34  * Currently we support the following OSes:
35  *   - FreeBSD (Extended Attributes)
36  *   - Darwin (Extended Attributes)
37  *   - Linux (Extended Attributes)
38  *   - NetBSD (Extended Attributes)
39  *   - Solaris (Extended Attributes and Extensible Attributes)
40  *
41  *   Written by Marco van Wieringen, November MMVIII
42  *
43  *   Version $Id$
44  */
45
46 #include "bacula.h"
47 #include "filed.h"
48 #include "xattr.h"
49
50 #if !defined(HAVE_XATTR)
51 /*
52  * Entry points when compiled without support for XATTRs or on an unsupported platform.
53  */
54 bsub_exit_code build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
55 {
56    return bsub_exit_fatal;
57 }
58
59 bsub_exit_code parse_xattr_streams(JCR *jcr, int stream)
60 {
61    return bsub_exit_fatal;
62 }
63 #else
64 /*
65  * Send a XATTR stream to the SD.
66  */
67 static bsub_exit_code send_xattr_stream(JCR *jcr, int stream)
68 {
69    BSOCK *sd = jcr->store_bsock;
70    POOLMEM *msgsave;
71 #ifdef FD_NO_SEND_TEST
72    return bsub_exit_ok;
73 #endif
74
75    /*
76     * Sanity check
77     */
78    if (jcr->xattr_data_len <= 0)
79       return bsub_exit_ok;
80
81    /*
82     * Send header
83     */
84    if (!sd->fsend("%ld %d 0", jcr->JobFiles, stream)) {
85       Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
86             sd->bstrerror());
87       return bsub_exit_fatal;
88    }
89
90    /*
91     * Send the buffer to the storage deamon
92     */
93    Dmsg1(400, "Backing up XATTR <%s>\n", jcr->xattr_data);
94    msgsave = sd->msg;
95    sd->msg = jcr->xattr_data;
96    sd->msglen = jcr->xattr_data_len;
97    if (!sd->send()) {
98       sd->msg = msgsave;
99       sd->msglen = 0;
100       Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
101             sd->bstrerror());
102       return bsub_exit_fatal;
103    }
104
105    jcr->JobBytes += sd->msglen;
106    sd->msg = msgsave;
107    if (!sd->signal(BNET_EOD)) {
108       Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
109             sd->bstrerror());
110       return bsub_exit_fatal;
111    }
112    Dmsg1(200, "XATTR of file: %s successfully backed up!\n", jcr->last_fname);
113    return bsub_exit_ok;
114 }
115
116 /*
117  * This is a supported OS, See what kind of interface we should use.
118  * Start with the generic interface used by most OS-es.
119  */
120 #if defined(HAVE_DARWIN_OS) || \
121     defined(HAVE_FREEBSD_OS) || \
122     defined(HAVE_LINUX_OS) || \
123     defined(HAVE_NETBSD_OS)
124        
125 #ifdef HAVE_SYS_XATTR_H
126 #include <sys/xattr.h>
127 #endif
128
129 /*
130  * Define the supported XATTR streams for this OS
131  */
132 #if defined(HAVE_DARWIN_OS)
133 static int os_default_xattr_streams[1] = { STREAM_XATTR_DARWIN };
134 #elif defined(HAVE_FREEBSD_OS)
135 static int os_default_xattr_streams[1] = { STREAM_XATTR_FREEBSD };
136 #elif defined(HAVE_LINUX_OS)
137 static int os_default_xattr_streams[1] = { STREAM_XATTR_LINUX };
138 #elif defined(HAVE_NETBSD_OS)
139 static int os_default_xattr_streams[1] = { STREAM_XATTR_NETBSD };
140 #endif
141
142 /*
143  * OSX doesn't have llistxattr, lgetxattr and lsetxattr but has
144  * listxattr, getxattr and setxattr with an extra options argument
145  * which mimics the l variants of the functions when we specify
146  * XATTR_NOFOLLOW as the options value.
147  */
148 #if defined(HAVE_DARWIN_OS)
149    #define llistxattr(path, list, size) listxattr((path), (list), (size), XATTR_NOFOLLOW)
150    #define lgetxattr(path, name, value, size) getxattr((path), (name), (value), (size), 0, XATTR_NOFOLLOW)
151    #define lsetxattr(path, name, value, size, flags) setxattr((path), (name), (value), (size), (flags), XATTR_NOFOLLOW)
152 #else
153    /*
154     * Fallback to the non l-functions when those are not available.
155     */
156    #if defined(HAVE_GETXATTR) && !defined(HAVE_LGETXATTR)
157    #define lgetxattr getxattr
158    #endif
159    #if defined(HAVE_SETXATTR) && !defined(HAVE_LSETXATTR)
160    #define lsetxattr setxattr
161    #endif
162    #if defined(HAVE_LISTXATTR) && !defined(HAVE_LLISTXATTR)
163    #define llistxattr listxattr
164    #endif
165 #endif
166
167 static void xattr_drop_internal_table(xattr_t *xattr_value_list)
168 {
169    xattr_t *current_xattr;
170
171    /*
172     * Walk the list of xattrs and free allocated memory on traversing.
173     */
174    for (current_xattr = xattr_value_list;
175         current_xattr != (xattr_t *)NULL;
176         current_xattr++) {
177       /*
178        * See if we can shortcut.
179        */
180       if (current_xattr->magic != XATTR_MAGIC)
181          break;
182
183       free(current_xattr->name);
184
185       if (current_xattr->value_length > 0)
186          free(current_xattr->value);
187    }
188
189    /*
190     * Free the array of control structs.
191     */
192    free(xattr_value_list);
193 }
194
195 /*
196  * The xattr stream for OSX, FreeBSD, Linux and NetBSD is a serialized stream of bytes
197  * which encodes one or more xattr_t structures.
198  *
199  * The Serialized stream consists of the following elements:
200  *    magic - A magic string which makes it easy to detect any binary incompatabilites
201  *    name_length - The length of the following xattr name
202  *    name - The name of the extended attribute
203  *    value_length - The length of the following xattr data
204  *    value - The actual content of the extended attribute
205  *
206  * This is repeated 1 or more times.
207  * 
208  */
209 static uint32_t serialize_xattr_stream(JCR *jcr, uint32_t expected_serialize_len, xattr_t *xattr_value_list)
210 {
211    xattr_t *current_xattr;
212    ser_declare;
213
214    /*
215     * Make sure the serialized stream fits in the poolmem buffer.
216     * We allocate some more to be sure the stream is gonna fit.
217     */
218    jcr->xattr_data = check_pool_memory_size(jcr->xattr_data, expected_serialize_len + 10);
219    ser_begin(jcr->xattr_data, expected_serialize_len + 10);
220
221    /*
222     * Walk the list of xattrs and serialize the data.
223     */
224    for (current_xattr = xattr_value_list; current_xattr != (xattr_t *)NULL; current_xattr++) {
225       /*
226        * See if we can shortcut.
227        */
228       if (current_xattr->magic != XATTR_MAGIC)
229          break;
230
231       ser_uint32(current_xattr->magic);
232       ser_uint32(current_xattr->name_length);
233       ser_bytes(current_xattr->name, current_xattr->name_length);
234
235       ser_uint32(current_xattr->value_length);
236       ser_bytes(current_xattr->value, current_xattr->value_length);
237    }
238
239    ser_end(jcr->xattr_data, expected_serialize_len + 10);
240    jcr->xattr_data_len = ser_length(jcr->xattr_data);
241    return jcr->xattr_data_len;
242 }
243
244 static bsub_exit_code generic_xattr_build_streams(JCR *jcr, FF_PKT *ff_pkt)
245 {
246    int count = 0;
247    int32_t xattr_list_len,
248            xattr_value_len;
249    uint32_t expected_serialize_len = 0;
250    char *xattr_list, *bp;
251    xattr_t *xattr_value_list = NULL, *current_xattr;
252    bsub_exit_code retval = bsub_exit_nok;
253    berrno be;
254
255    /*
256     * First get the length of the available list with extended attributes.
257     */
258    xattr_list_len = llistxattr(jcr->last_fname, NULL, 0);
259    if (xattr_list_len < 0) {
260       switch (errno) {
261       case ENOENT:
262          return bsub_exit_ok;
263       default:
264          Mmsg2(jcr->errmsg, _("llistxattr error on file \"%s\": ERR=%s\n"),
265                jcr->last_fname, be.bstrerror());
266          Dmsg2(100, "llistxattr error file=%s ERR=%s\n",
267                jcr->last_fname, be.bstrerror());
268          return bsub_exit_nok;
269       }
270    } else if (xattr_list_len == 0) {
271       return bsub_exit_ok;
272    }
273
274    /*
275     * Allocate room for the extented attribute list.
276     */
277    xattr_list = (char *)malloc(xattr_list_len + 1);
278    memset((caddr_t)xattr_list, 0, xattr_list_len + 1);
279
280    /*
281     * Get the actual list of extended attributes names for a file.
282     */
283    xattr_list_len = llistxattr(jcr->last_fname, xattr_list, xattr_list_len);
284    if (xattr_list_len < 0) {
285       switch (errno) {
286       case ENOENT:
287          retval = bsub_exit_ok;
288          goto bail_out;
289       default:
290          Mmsg2(jcr->errmsg, _("llistxattr error on file \"%s\": ERR=%s\n"),
291                jcr->last_fname, be.bstrerror());
292          Dmsg2(100, "llistxattr error file=%s ERR=%s\n",
293                jcr->last_fname, be.bstrerror());
294          goto bail_out;
295       }
296    }
297    xattr_list[xattr_list_len] = '\0';
298
299    /*
300     * Count the number of extended attributes on a file.
301     */
302    bp = xattr_list;
303    while ((bp - xattr_list) + 1 < xattr_list_len) {
304 #if defined(HAVE_LINUX_OS)
305       /*
306        * On Linux you also get the acls in the extented attribute list.
307        * So we check if we are already backing up acls and if we do we
308        * don't store the extended attribute with the same info.
309        */
310       if ((ff_pkt->flags & FO_ACL) == 0 || strcmp(bp, "system.posix_acl_access"))
311          count++;
312 #else
313       count++;
314 #endif
315
316       bp = strchr(bp, '\0') + 1;
317    }
318
319    if (count == 0) {
320       retval = bsub_exit_ok;
321       goto bail_out;
322    }
323
324    /*
325     * Allocate enough room to hold all extended attributes.
326     * After allocating the storage make sure its empty by zeroing it.
327     */
328    xattr_value_list = (xattr_t *)malloc(count * sizeof(xattr_t));
329    memset((caddr_t)xattr_value_list, 0, count * sizeof(xattr_t));
330
331    /*
332     * Walk the list of extended attributes names and retrieve the data.
333     * We already count the bytes needed for serializing the stream later on.
334     */
335    current_xattr = xattr_value_list;
336    bp = xattr_list;
337    while ((bp - xattr_list) + 1 < xattr_list_len) {
338 #if defined(HAVE_LINUX_OS)
339       /*
340        * On Linux you also get the acls in the extented attribute list.
341        * So we check if we are already backing up acls and if we do we
342        * don't store the extended attribute with the same info.
343        */
344       if (ff_pkt->flags & FO_ACL && !strcmp(bp, "system.posix_acl_access")) {
345          bp = strchr(bp, '\0') + 1;
346          continue;
347       }
348 #endif
349
350       /*
351        * Each xattr valuepair starts with a magic so we can parse it easier.
352        */
353       current_xattr->magic = XATTR_MAGIC;
354       expected_serialize_len += sizeof(current_xattr->magic);
355
356       /*
357        * Allocate space for storing the name.
358        */
359       current_xattr->name_length = strlen(bp);
360       current_xattr->name = (char *)malloc(current_xattr->name_length);
361       memcpy((caddr_t)current_xattr->name, (caddr_t)bp, current_xattr->name_length);
362
363       expected_serialize_len += sizeof(current_xattr->name_length) + current_xattr->name_length;
364
365       /*
366        * First see how long the value is for the extended attribute.
367        */
368       xattr_value_len = lgetxattr(jcr->last_fname, bp, NULL, 0);
369       if (xattr_value_len < 0) {
370          switch (errno) {
371          case ENOENT:
372             retval = bsub_exit_ok;
373             goto bail_out;
374          default:
375             Mmsg2(jcr->errmsg, _("lgetxattr error on file \"%s\": ERR=%s\n"),
376                   jcr->last_fname, be.bstrerror());
377             Dmsg2(100, "lgetxattr error file=%s ERR=%s\n",
378                   jcr->last_fname, be.bstrerror());
379             goto bail_out;
380          }
381       }
382
383       /*
384        * Allocate space for storing the value.
385        */
386       current_xattr->value = (char *)malloc(xattr_value_len);
387       memset((caddr_t)current_xattr->value, 0, xattr_value_len);
388
389       xattr_value_len = lgetxattr(jcr->last_fname, bp, current_xattr->value, xattr_value_len);
390       if (xattr_value_len < 0) {
391          switch (errno) {
392          case ENOENT:
393             retval = bsub_exit_ok;
394             goto bail_out;
395          default:
396             Mmsg2(jcr->errmsg, _("lgetxattr error on file \"%s\": ERR=%s\n"),
397                   jcr->last_fname, be.bstrerror());
398             Dmsg2(100, "lgetxattr error file=%s ERR=%s\n",
399                   jcr->last_fname, be.bstrerror());
400             goto bail_out;
401          }
402       }
403
404       /*
405        * Store the actual length of the value.
406        */
407       current_xattr->value_length = xattr_value_len;
408       expected_serialize_len += sizeof(current_xattr->value_length) + current_xattr->value_length;
409
410       /*
411        * Protect ourself against things getting out of hand.
412        */
413       if (expected_serialize_len >= MAX_XATTR_STREAM) {
414          Mmsg2(jcr->errmsg, _("Xattr stream on file \"%s\" exceeds maximum size of %d bytes\n"),
415                jcr->last_fname, MAX_XATTR_STREAM);
416          goto bail_out;
417       }
418       
419       /*
420        * Next attribute.
421        */
422       current_xattr++;
423       bp = strchr(bp, '\0') + 1;
424    }
425
426    /*
427     * Serialize the datastream.
428     */
429    if (serialize_xattr_stream(jcr, expected_serialize_len, xattr_value_list) < expected_serialize_len) {
430       Mmsg1(jcr->errmsg, _("Failed to serialize extended attributes on file \"%s\"\n"),
431             jcr->last_fname);
432       Dmsg1(100, "Failed to serialize extended attributes on file \"%s\"\n",
433             jcr->last_fname);
434       goto bail_out;
435    }
436
437    xattr_drop_internal_table(xattr_value_list);
438    free(xattr_list);
439
440    /*
441     * Send the datastream to the SD.
442     */
443    return send_xattr_stream(jcr, os_default_xattr_streams[0]);
444
445 bail_out:
446    if (xattr_value_list) {
447       xattr_drop_internal_table(xattr_value_list);
448    }
449    free(xattr_list);
450    return retval;
451 }
452
453 static bsub_exit_code generic_xattr_parse_streams(JCR *jcr, int stream)
454 {
455    unser_declare;
456    xattr_t current_xattr;
457    bsub_exit_code retval = bsub_exit_ok;
458    berrno be;
459
460    /*
461     * Parse the stream and perform the setxattr calls on the file.
462     *
463     * Start unserializing the data. We keep on looping while we have not
464     * unserialized all bytes in the stream.
465     */
466    unser_begin(jcr->xattr_data, jcr->xattr_data_len);
467    while (unser_length(jcr->xattr_data) < jcr->xattr_data_len) {
468       /*
469        * First make sure the magic is present. This way we can easily catch corruption.
470        * Any missing MAGIC is fatal we do NOT try to continue.
471        */
472       unser_uint32(current_xattr.magic);
473       if (current_xattr.magic != XATTR_MAGIC) {
474          Mmsg1(jcr->errmsg, _("Illegal xattr stream, no XATTR_MAGIC on file \"%s\"\n"),
475                jcr->last_fname);
476          Dmsg1(100, "Illegal xattr stream, no XATTR_MAGIC on file \"%s\"\n",
477                jcr->last_fname);
478          return bsub_exit_nok;
479       }
480
481       /*
482        * Decode the valuepair. First decode the length of the name.
483        */
484       unser_uint32(current_xattr.name_length);
485       
486       /*
487        * Allocate room for the name and decode its content.
488        */
489       current_xattr.name = (char *)malloc(current_xattr.name_length + 1);
490       unser_bytes(current_xattr.name, current_xattr.name_length);
491
492       /*
493        * The xattr_name needs to be null terminated for lsetxattr.
494        */
495       current_xattr.name[current_xattr.name_length] = '\0';
496
497       /*
498        * Decode the value length.
499        */
500       unser_uint32(current_xattr.value_length);
501
502       /*
503        * Allocate room for the value and decode its content.
504        */
505       current_xattr.value = (char *)malloc(current_xattr.value_length);
506       unser_bytes(current_xattr.value, current_xattr.value_length);
507
508       /*
509        * Try to set the extended attribute on the file.
510        * If we fail to set this attribute we flag the error but its not fatal,
511        * we try to restore the other extended attributes too.
512        */
513       if (lsetxattr(jcr->last_fname, current_xattr.name, current_xattr.value,
514                     current_xattr.value_length, 0) != 0) {
515          switch (errno) {
516          case ENOENT:
517             break;
518          default:
519             Mmsg2(jcr->errmsg, _("lsetxattr error on file \"%s\": ERR=%s\n"),
520                   jcr->last_fname, be.bstrerror());
521             Dmsg2(100, "lsetxattr error file=%s ERR=%s\n",
522                   jcr->last_fname, be.bstrerror());
523             retval = bsub_exit_nok;
524             break;
525          }
526       }
527
528       /*
529        * Free the temporary buffers.
530        */
531       free(current_xattr.name);
532       free(current_xattr.value);
533    }
534
535    unser_end(jcr->xattr_data, jcr->xattr_data_len);
536    return retval;
537 }
538
539 /*
540  * For all these os-es setup the build and parse function pointer to the generic functions.
541  */
542 static bsub_exit_code (*os_build_xattr_streams)(JCR *jcr, FF_PKT *ff_pkt) = generic_xattr_build_streams;
543 static bsub_exit_code (*os_parse_xattr_streams)(JCR *jcr, int stream) = generic_xattr_parse_streams;
544
545 #elif defined(HAVE_SUN_OS)
546 /*
547  * Solaris extended attributes were introduced in Solaris 9
548  * by PSARC 1999/209
549  *
550  * Solaris extensible attributes were introduced in OpenSolaris
551  * by PSARC 2007/315 Solaris extensible attributes are also
552  * sometimes called extended system attributes.
553  *
554  * man fsattr(5) on Solaris gives a wealth of info. The most
555  * important bits are:
556  *
557  * Attributes are logically supported as files within the  file
558  * system.   The  file  system  is  therefore augmented with an
559  * orthogonal name space of file attributes. Any file  (includ-
560  * ing  attribute files) can have an arbitrarily deep attribute
561  * tree associated with it. Attribute values  are  accessed  by
562  * file descriptors obtained through a special attribute inter-
563  * face.  This logical view of "attributes as files" allows the
564  * leveraging  of  existing file system interface functionality
565  * to support the construction, deletion, and  manipulation  of
566  * attributes.
567  *
568  * The special files  "."  and  ".."  retain  their  accustomed
569  * semantics within the attribute hierarchy.  The "." attribute
570  * file refers to the current directory and the ".."  attribute
571  * file  refers to the parent directory.  The unnamed directory
572  * at the head of each attribute tree is considered the "child"
573  * of  the  file it is associated with and the ".." file refers
574  * to the associated file.  For  any  non-directory  file  with
575  * attributes,  the  ".." entry in the unnamed directory refers
576  * to a file that is not a directory.
577  *
578  * Conceptually, the attribute model is fully general. Extended
579  * attributes  can  be  any  type of file (doors, links, direc-
580  * tories, and so forth) and can even have their own attributes
581  * (fully  recursive).   As a result, the attributes associated
582  * with a file could be an arbitrarily deep directory hierarchy
583  * where each attribute could have an equally complex attribute
584  * tree associated with it.  Not all implementations  are  able
585  * to,  or  want to, support the full model. Implementation are
586  * therefore permitted to reject operations that are  not  sup-
587  * ported.   For  example,  the implementation for the UFS file
588  * system allows only regular files as attributes (for example,
589  * no sub-directories) and rejects attempts to place attributes
590  * on attributes.
591  *
592  * The following list details the operations that are  rejected
593  * in the current implementation:
594  *
595  * link                     Any attempt to create links between
596  *                          attribute  and  non-attribute space
597  *                          is rejected  to  prevent  security-
598  *                          related   or   otherwise  sensitive
599  *                          attributes from being exposed,  and
600  *                          therefore  manipulable,  as regular
601  *                          files.
602  *
603  * rename                   Any  attempt  to   rename   between
604  *                          attribute  and  non-attribute space
605  *                          is rejected to prevent  an  already
606  *                          linked  file from being renamed and
607  *                          thereby circumventing the link res-
608  *                          triction above.
609  *
610  * mkdir, symlink, mknod    Any  attempt  to  create  a   "non-
611  *                          regular" file in attribute space is
612  *                          rejected to reduce the  functional-
613  *                          ity,  and  therefore  exposure  and
614  *                          risk, of  the  initial  implementa-
615  *                          tion.
616  *
617  * The entire available name space has been allocated to  "gen-
618  * eral use" to bring the implementation in line with the NFSv4
619  * draft standard [NFSv4]. That standard defines "named  attri-
620  * butes"  (equivalent  to Solaris Extended Attributes) with no
621  * naming restrictions.  All Sun  applications  making  use  of
622  * opaque extended attributes will use the prefix "SUNW".
623  *
624  */
625 #ifdef HAVE_SYS_ATTR_H
626 #include <sys/attr.h>
627 #endif
628
629 #ifdef HAVE_ATTR_H
630 #include <attr.h>
631 #endif
632
633 #ifdef HAVE_SYS_NVPAIR_H
634 #include <sys/nvpair.h>
635 #endif
636
637 #ifdef HAVE_SYS_ACL_H
638 #include <sys/acl.h>
639 #endif
640
641 /*
642  * Define the supported XATTR streams for this OS
643  */
644 #if defined(HAVE_SYS_NVPAIR_H) && defined(_PC_SATTR_ENABLED)
645 static int os_default_xattr_streams[2] = { STREAM_XATTR_SOLARIS, STREAM_XATTR_SOLARIS_SYS};
646 #else
647 static int os_default_xattr_streams[1] = { STREAM_XATTR_SOLARIS };
648 #endif /* defined(HAVE_SYS_NVPAIR_H) && defined(_PC_SATTR_ENABLED) */
649
650 /*
651  * This is the count of xattrs saved on a certain file, it gets reset
652  * on each new file processed and is used to see if we need to send
653  * the hidden xattr dir data. We only send that data when we encounter
654  * an other xattr on the file.
655  */
656 static int nr_xattr_saved = 0;
657 static char toplevel_hidden_dir_xattr_data[MAXSTRING];
658 static int toplevel_hidden_dir_xattr_data_len;
659
660 /*
661  * This code creates a temporary cache with entries for each xattr which has
662  * a link count > 1 (which indicates it has one or more hard linked counterpart(s))
663  */
664 static alist *xattr_link_cache = NULL;
665
666 static struct xattr_link_cache_entry *find_xattr_link_cache_entry(ino_t inum)
667 {
668    xattr_link_cache_entry_t *ptr;
669
670    foreach_alist(ptr, xattr_link_cache) {
671       if (ptr && ptr->inum == inum) {
672          return ptr;
673       }
674    }
675    return NULL;
676 }
677
678 static void add_xattr_link_cache_entry(ino_t inum, char *target)
679 {
680    xattr_link_cache_entry_t *ptr;
681
682    ptr = (xattr_link_cache_entry_t *)malloc(sizeof(struct xattr_link_cache_entry));
683    memset((caddr_t)ptr, 0, sizeof(struct xattr_link_cache_entry));
684    ptr->inum = inum;
685    bstrncpy(ptr->target, target, sizeof(ptr->target));
686    xattr_link_cache->append(ptr);
687 }
688
689 #if defined(HAVE_SYS_NVPAIR_H) && defined(_PC_SATTR_ENABLED)
690 /*
691  * This function returns true if a non default extended system attribute
692  * list is associated with fd and returns false when an error has occured
693  * or when only extended system attributes other than archive,
694  * av_modified or crtime are set.
695  *
696  * The function returns true for the following cases:
697  *
698  * - any extended system attribute other than the default attributes
699  *   ('archive', 'av_modified' and 'crtime') is set
700  * - nvlist has NULL name string
701  * - nvpair has data type of 'nvlist'
702  * - default data type.
703  */
704 static bool solaris_has_non_transient_extensible_attributes(int fd)
705 {
706    boolean_t value;
707    data_type_t type;
708    nvlist_t *response;
709    nvpair_t *pair;
710    f_attr_t fattr;
711    char *name;
712    bool retval = false;
713
714    if (fgetattr(fd, XATTR_VIEW_READWRITE, &response) != 0) {
715       return false;
716    }
717
718    pair = NULL;
719    while ((pair = nvlist_next_nvpair(response, pair)) != NULL) {
720       name = nvpair_name(pair);
721
722       if (name != NULL) {
723          fattr = name_to_attr(name);
724       } else {
725          retval = true;
726          goto bail_out;
727       }
728
729       type = nvpair_type(pair);
730       switch (type) {
731       case DATA_TYPE_BOOLEAN_VALUE:
732          if (nvpair_value_boolean_value(pair, &value) != 0) {
733             continue;
734          }
735          if (value && fattr != F_ARCHIVE &&
736                       fattr != F_AV_MODIFIED) {
737             retval = true;
738             goto bail_out;
739          }
740          break;
741       case DATA_TYPE_UINT64_ARRAY:
742          if (fattr != F_CRTIME) {
743             retval = true;
744             goto bail_out;
745          }
746          break;
747       case DATA_TYPE_NVLIST:
748       default:
749          retval = true;
750          goto bail_out;
751       }
752    }
753
754 bail_out:
755    if (response != NULL) {
756       nvlist_free(response);
757    }
758    return retval;
759 }
760 #endif /* HAVE_SYS_NVPAIR_H && _PC_SATTR_ENABLED */
761
762 #if defined(HAVE_ACL) && !defined(HAVE_EXTENDED_ACL)
763 /*
764  * See if an acl is a trivial one (e.g. just the stat bits encoded as acl.)
765  * There is no need to store those acls as we already store the stat bits too.
766  */
767 static bool acl_is_trivial(int count, aclent_t *entries)
768 {
769    int n;
770    aclent_t *ace;
771
772    for (n = 0; n < count; n++) {
773       ace = &entries[n];
774       if (!(ace->a_type == USER_OBJ ||
775             ace->a_type == GROUP_OBJ ||
776             ace->a_type == OTHER_OBJ ||
777             ace->a_type == CLASS_OBJ))
778         return false;
779    }
780    return true;
781 }
782 #endif /* HAVE_ACL && !HAVE_EXTENDED_ACL */
783
784 static bsub_exit_code solaris_save_xattr_acl(JCR *jcr, int fd, const char *attrname, char **acl_text)
785 {
786 #ifdef HAVE_ACL
787 #ifdef HAVE_EXTENDED_ACL
788    int flags;
789    acl_t *aclp = NULL;
790    berrno be;
791
792    /*
793     * See if this attribute has an ACL
794     */
795    if ((fd != -1 && fpathconf(fd, _PC_ACL_ENABLED) > 0) ||
796        pathconf(attrname, _PC_ACL_ENABLED) > 0) {
797       /*
798        * See if there is a non trivial acl on the file.
799        */
800       if ((fd != -1 && facl_get(fd, ACL_NO_TRIVIAL, &aclp) != 0) ||
801            acl_get(attrname, ACL_NO_TRIVIAL, &aclp) != 0) {
802          switch (errno) {
803          case ENOENT:
804             return bsub_exit_ok;
805          default:
806             Mmsg3(jcr->errmsg, _("Unable to get acl on xattr %s on file \"%s\": ERR=%s\n"),
807                   attrname, jcr->last_fname, be.bstrerror());
808             Dmsg3(100, "facl_get/acl_get of xattr %s on \"%s\" failed: ERR=%s\n",
809                   attrname, jcr->last_fname, be.bstrerror());
810             return bsub_exit_nok;
811          }
812       }
813
814       if (aclp != NULL) {
815 #if defined(ACL_SID_FMT)
816          /*
817           * New format flag added in newer Solaris versions.
818           */
819          flags = ACL_APPEND_ID | ACL_COMPACT_FMT | ACL_SID_FMT;
820 #else
821          flags = ACL_APPEND_ID | ACL_COMPACT_FMT;
822 #endif /* ACL_SID_FMT */
823
824          *acl_text = acl_totext(aclp, flags);
825          acl_free(aclp);
826       } else {
827          *acl_text = NULL;
828       }
829    } else {
830       *acl_text = NULL;
831    }
832    return bsub_exit_ok;
833 #else /* HAVE_EXTENDED_ACL */
834    int n;
835    aclent_t *acls = NULL;
836    berrno be;
837
838    /*
839     * See if this attribute has an ACL
840     */
841    if (fd != -1) {
842       n = facl(fd, GETACLCNT, 0, NULL);
843    } else {
844       n = acl(attrname, GETACLCNT, 0, NULL);
845    }
846
847    if (n >= MIN_ACL_ENTRIES) {
848       acls = (aclent_t *)malloc(n * sizeof(aclent_t));
849       if ((fd != -1 && facl(fd, GETACL, n, acls) != n) ||
850           acl(attrname, GETACL, n, acls) != n) {
851          switch (errno) {
852          case ENOENT:
853             free(acls);
854             return bsub_exit_ok;
855          default:
856             Mmsg3(jcr->errmsg, _("Unable to get acl on xattr %s on file \"%s\": ERR=%s\n"),
857                   attrname, jcr->last_fname, be.bstrerror());
858             Dmsg3(100, "facl/acl of xattr %s on \"%s\" failed: ERR=%s\n",
859                   attrname, jcr->last_fname, be.bstrerror());
860             free(acls);
861             return bsub_exit_nok;
862          }
863       }
864
865       /*
866        * See if there is a non trivial acl on the file.
867        */
868       if (!acl_is_trivial(n, acls)) {
869          if ((*acl_text = acltotext(acls, n)) == NULL) {
870             Mmsg3(jcr->errmsg, _("Unable to get acl text on xattr %s on file \"%s\": ERR=%s\n"),
871                   attrname, jcr->last_fname, be.bstrerror());
872             Dmsg3(100, "acltotext of xattr %s on \"%s\" failed: ERR=%s\n",
873                   attrname, jcr->last_fname, be.bstrerror());
874             free(acls);
875             return bsub_exit_nok;
876          }
877       } else {
878          *acl_text = NULL;
879       }
880
881      free(acls);
882    } else {
883       *acl_text = NULL;
884    }
885    return bsub_exit_ok;
886 #endif /* HAVE_EXTENDED_ACL */
887
888 #else /* HAVE_ACL */
889    return bsub_exit_ok;
890 #endif /* HAVE_ACL */
891 }
892
893 /*
894  * Forward declaration for recursive function call.
895  */
896 static bsub_exit_code solaris_save_xattrs(JCR *jcr, const char *xattr_namespace, const char *attr_parent);
897
898 /*
899  * Save an extended or extensible attribute.
900  * This is stored as an opaque stream of bytes with the following encoding:
901  *
902  * <xattr_name>\0<stat_buffer>\0<acl_string>\0<actual_xattr_data>
903  * 
904  * or for a hardlinked or symlinked attribute
905  *
906  * <xattr_name>\0<stat_buffer>\0<xattr_link_source>\0
907  *
908  * xattr_name can be a subpath relative to the file the xattr is on.
909  * stat_buffer is the string representation of the stat struct.
910  * acl_string is an acl text when a non trivial acl is set on the xattr.
911  * actual_xattr_data is the content of the xattr file.
912  */
913 static bsub_exit_code solaris_save_xattr(JCR *jcr, int fd, const char *xattr_namespace,
914                                          const char *attrname, bool toplevel_hidden_dir, int stream)
915 {
916    int cnt;
917    int attrfd = -1;
918    struct stat st;
919    struct xattr_link_cache_entry *xlce;
920    char target_attrname[PATH_MAX];
921    char link_source[PATH_MAX];
922    char *acl_text = NULL;
923    char attribs[MAXSTRING];
924    char buffer[BUFSIZ];
925    bsub_exit_code retval = bsub_exit_nok;
926    berrno be;
927
928    bsnprintf(target_attrname, sizeof(target_attrname), "%s%s", xattr_namespace, attrname);
929
930    /*
931     * Get the stats of the extended or extensible attribute.
932     */
933    if (fstatat(fd, attrname, &st, AT_SYMLINK_NOFOLLOW) < 0) {
934       switch (errno) {
935       case ENOENT:
936          retval = bsub_exit_ok;
937          goto bail_out;
938       default:
939          Mmsg3(jcr->errmsg, _("Unable to get status on xattr %s on file \"%s\": ERR=%s\n"),
940                target_attrname, jcr->last_fname, be.bstrerror());
941          Dmsg3(100, "fstatat of xattr %s on \"%s\" failed: ERR=%s\n",
942                target_attrname, jcr->last_fname, be.bstrerror());
943          goto bail_out;
944       }
945    }
946
947    /*
948     * Based on the filetype perform the correct action. We support most filetypes here, more
949     * then the actual implementation on Solaris supports so some code may never get executed
950     * due to limitations in the implementation.
951     */
952    switch (st.st_mode & S_IFMT) {
953    case S_IFIFO:
954    case S_IFCHR:
955    case S_IFBLK:
956       /*
957        * Get any acl on the xattr.
958        */
959       if (solaris_save_xattr_acl(jcr, attrfd, attrname, &acl_text) != bsub_exit_ok)
960          goto bail_out;
961
962       /*
963        * The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
964        * Encode the stat struct into an ASCII representation.
965        */
966       encode_stat(attribs, &st, 0, stream);
967       cnt = bsnprintf(buffer, sizeof(buffer), "%s%c%s%c%s%c",
968                      target_attrname, 0, attribs, 0, (acl_text) ? acl_text : "", 0);
969       break;
970
971    case S_IFDIR:
972       /*
973        * Get any acl on the xattr.
974        */
975       if (solaris_save_xattr_acl(jcr, attrfd, attrname, &acl_text) != bsub_exit_ok)
976          goto bail_out;
977
978       /*
979        * See if this is the toplevel_hidden_dir being saved.
980        */
981       if (toplevel_hidden_dir) {
982          /*
983           * Save the data for later storage when we encounter a real xattr.
984           * Encode the stat struct into an ASCII representation and jump out of the function.
985           */
986          encode_stat(attribs, &st, 0, stream);
987          toplevel_hidden_dir_xattr_data_len = bsnprintf(toplevel_hidden_dir_xattr_data,
988                                                         sizeof(toplevel_hidden_dir_xattr_data),
989                                                         "%s%c%s%c%s%c",
990                                                         target_attrname, 0, attribs, 0,
991                                                         (acl_text) ? acl_text : "", 0);
992          goto bail_out;
993       } else {
994          /*
995           * The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
996           * Encode the stat struct into an ASCII representation.
997           */
998          encode_stat(attribs, &st, 0, stream);
999          cnt = bsnprintf(buffer, sizeof(buffer),
1000                          "%s%c%s%c%s%c",
1001                          target_attrname, 0, attribs, 0, (acl_text) ? acl_text : "", 0);
1002       }
1003       break;
1004    case S_IFREG:
1005       /*
1006        * If this is a hardlinked file check the inode cache for a hit.
1007        */
1008       if (st.st_nlink > 1) {
1009          /*
1010           * See if the cache already knows this inode number.
1011           */
1012          if ((xlce = find_xattr_link_cache_entry(st.st_ino)) != NULL) {
1013             /*
1014              * Generate a xattr encoding with the reference to the target in there.
1015              */
1016             encode_stat(attribs, &st, st.st_ino, stream);
1017             cnt = bsnprintf(buffer, sizeof(buffer),
1018                             "%s%c%s%c%s%c",
1019                             target_attrname, 0, attribs, 0, xlce->target, 0);
1020             pm_memcpy(jcr->xattr_data, buffer, cnt);
1021             jcr->xattr_data_len = cnt;
1022             retval = send_xattr_stream(jcr, stream);
1023
1024             /*
1025              * For a hard linked file we are ready now, no need to recursively save the attributes.
1026              */
1027             goto bail_out;
1028          }
1029
1030          /*
1031           * Store this hard linked file in the cache.
1032           * Store the name relative to the top level xattr space.
1033           */
1034          add_xattr_link_cache_entry(st.st_ino, target_attrname + 1);
1035       }
1036
1037       /*
1038        * Get any acl on the xattr.
1039        */
1040       if (solaris_save_xattr_acl(jcr, attrfd, attrname, &acl_text) != bsub_exit_ok) {
1041          goto bail_out;
1042       }
1043
1044       /*
1045        * Encode the stat struct into an ASCII representation.
1046        */
1047       encode_stat(attribs, &st, 0, stream);
1048       cnt = bsnprintf(buffer, sizeof(buffer),
1049                      "%s%c%s%c%s%c",
1050                      target_attrname, 0, attribs, 0, (acl_text) ? acl_text : "", 0);
1051
1052       /*
1053        * Open the extended or extensible attribute file.
1054        */
1055       if ((attrfd = openat(fd, attrname, O_RDONLY)) < 0) {
1056          switch (errno) {
1057          case ENOENT:
1058             retval = bsub_exit_ok;
1059             goto bail_out;
1060          default:
1061             Mmsg3(jcr->errmsg, _("Unable to open xattr %s on \"%s\": ERR=%s\n"),
1062                   target_attrname, jcr->last_fname, be.bstrerror());
1063             Dmsg3(100, "openat of xattr %s on \"%s\" failed: ERR=%s\n",
1064                   target_attrname, jcr->last_fname, be.bstrerror());
1065             goto bail_out;
1066          }
1067       }
1068       break;
1069
1070    case S_IFLNK:
1071       /*
1072        * The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
1073        * Encode the stat struct into an ASCII representation.
1074        */
1075       if (readlink(attrname, link_source, sizeof(link_source)) < 0) {
1076          switch (errno) {
1077          case ENOENT:
1078             retval = bsub_exit_ok;
1079             goto bail_out;
1080          default:
1081             Mmsg3(jcr->errmsg, _("Unable to read symlin %s on \"%s\": ERR=%s\n"),
1082                   target_attrname, jcr->last_fname, be.bstrerror());
1083             Dmsg3(100, "readlink of xattr %s on \"%s\" failed: ERR=%s\n",
1084                   target_attrname, jcr->last_fname, be.bstrerror());
1085             goto bail_out;
1086          }
1087       }
1088
1089       /*
1090        * Generate a xattr encoding with the reference to the target in there.
1091        */
1092       encode_stat(attribs, &st, st.st_ino, stream);
1093       cnt = bsnprintf(buffer, sizeof(buffer),
1094                       "%s%c%s%c%s%c",
1095                       target_attrname, 0, attribs, 0, link_source, 0);
1096       pm_memcpy(jcr->xattr_data, buffer, cnt);
1097       jcr->xattr_data_len = cnt;
1098       retval = send_xattr_stream(jcr, stream);
1099
1100       /*
1101        * For a soft linked file we are ready now, no need to recursively save the attributes.
1102        */
1103       goto bail_out;
1104
1105    default:
1106       goto bail_out;
1107    }
1108
1109    /*
1110     * See if this is the first real xattr being saved. If it is save the toplevel_hidden_dir attributes first.
1111     */
1112    if (nr_xattr_saved == 0) {
1113       pm_memcpy(jcr->xattr_data, toplevel_hidden_dir_xattr_data, toplevel_hidden_dir_xattr_data_len);
1114       jcr->xattr_data_len = toplevel_hidden_dir_xattr_data_len;
1115       retval = send_xattr_stream(jcr, STREAM_XATTR_SOLARIS);
1116    }
1117
1118    pm_memcpy(jcr->xattr_data, buffer, cnt);
1119    jcr->xattr_data_len = cnt;
1120
1121    /*
1122     * Only dump the content of regular files.
1123     */
1124    switch (st.st_mode & S_IFMT) {
1125    case S_IFREG:
1126       if (st.st_size > 0) {
1127          /*
1128           * Protect ourself against things getting out of hand.
1129           */
1130          if (st.st_size >= MAX_XATTR_STREAM) {
1131             Mmsg2(jcr->errmsg, _("Xattr stream on file \"%s\" exceeds maximum size of %d bytes\n"),
1132                   jcr->last_fname, MAX_XATTR_STREAM);
1133             goto bail_out;
1134          }
1135
1136          while ((cnt = read(attrfd, buffer, sizeof(buffer))) > 0) {
1137             jcr->xattr_data = check_pool_memory_size(jcr->xattr_data, jcr->xattr_data_len + cnt);
1138             memcpy(jcr->xattr_data + jcr->xattr_data_len, buffer, cnt);
1139             jcr->xattr_data_len += cnt;
1140          }
1141
1142          if (cnt < 0) {
1143             Mmsg2(jcr->errmsg, _("Unable to read content of xattr %s on file \"%s\"\n"),
1144                   target_attrname, jcr->last_fname);
1145             Dmsg2(100, "read of data from xattr %s on \"%s\" failed\n",
1146                   target_attrname, jcr->last_fname);
1147             goto bail_out;
1148          }
1149       }
1150       break;
1151
1152    default:
1153       break;
1154    }
1155
1156    if (retval) {
1157       retval = send_xattr_stream(jcr, stream);
1158       nr_xattr_saved++;
1159    }
1160
1161    /*
1162     * Recursivly call solaris_save_extended_attributes for archiving the attributes
1163     * available on this extended attribute.
1164     */
1165    if (retval) {
1166       retval = solaris_save_xattrs(jcr, xattr_namespace, attrname);
1167       
1168       /*
1169        * The recursive call could change our working dir so change back to the wanted workdir.
1170        */
1171       if (fchdir(fd) < 0) {
1172          switch (errno) {
1173          case ENOENT:
1174             retval = bsub_exit_ok;
1175             goto bail_out;
1176          default:
1177             Mmsg2(jcr->errmsg, _("Unable to chdir to xattr space of file \"%s\": ERR=%s\n"),
1178                   jcr->last_fname, be.bstrerror());
1179             Dmsg3(100, "Unable to fchdir to xattr space of file \"%s\" using fd %d: ERR=%s\n",
1180                   jcr->last_fname, fd, be.bstrerror());
1181             goto bail_out;
1182          }
1183       }
1184    }
1185
1186 bail_out:
1187    if (acl_text) {
1188       free(acl_text);
1189    }
1190    if (attrfd != -1) {
1191       close(attrfd);
1192    }
1193    return retval;
1194 }
1195
1196 static bsub_exit_code solaris_save_xattrs(JCR *jcr, const char *xattr_namespace, const char *attr_parent)
1197 {
1198    const char *name;
1199    int fd, filefd = -1, attrdirfd = -1;
1200    DIR *dirp;
1201    struct dirent *dp;
1202    char current_xattr_namespace[PATH_MAX];
1203    bsub_exit_code retval = bsub_exit_nok;
1204    berrno be;
1205  
1206    /*
1207     * Determine what argument to use. Use attr_parent when set
1208     * (recursive call) or jcr->last_fname for first call. Also save
1209     * the current depth of the xattr_space we are in.
1210     */
1211    if (attr_parent) {
1212       name = attr_parent;
1213       if (xattr_namespace) {
1214          bsnprintf(current_xattr_namespace, sizeof(current_xattr_namespace), "%s%s/",
1215                    xattr_namespace, attr_parent);
1216       } else {
1217          bstrncpy(current_xattr_namespace, "/", sizeof(current_xattr_namespace));
1218       }
1219    } else {
1220       name = jcr->last_fname;
1221       bstrncpy(current_xattr_namespace, "/", sizeof(current_xattr_namespace));
1222    }
1223
1224    /*
1225     * Open the file on which to save the xattrs read-only.
1226     */
1227    if ((filefd = open(name, O_RDONLY | O_NONBLOCK)) < 0) {
1228       switch (errno) {
1229       case ENOENT:
1230          retval = bsub_exit_ok;
1231          goto bail_out;
1232       default:
1233          Mmsg2(jcr->errmsg, _("Unable to open file \"%s\": ERR=%s\n"),
1234                jcr->last_fname, be.bstrerror());
1235          Dmsg2(100, "Unable to open file \"%s\": ERR=%s\n",
1236                jcr->last_fname, be.bstrerror());
1237          goto bail_out;
1238       }
1239    }
1240
1241    /*
1242     * Open the xattr naming space.
1243     */
1244    if ((attrdirfd = openat(filefd, ".", O_RDONLY | O_XATTR)) < 0) {
1245       switch (errno) {
1246       case EINVAL:
1247          /*
1248           * Gentile way of the system saying this type of xattr layering is not supported.
1249           * Which is not problem we just forget about this this xattr.
1250           * But as this is not an error we return a positive return value.
1251           */
1252          retval = bsub_exit_ok;
1253          goto bail_out;
1254       case ENOENT:
1255          retval = bsub_exit_ok;
1256          goto bail_out;
1257       default:
1258          Mmsg3(jcr->errmsg, _("Unable to open xattr space %s on file \"%s\": ERR=%s\n"),
1259                name, jcr->last_fname, be.bstrerror());
1260          Dmsg3(100, "Unable to open xattr space %s on file \"%s\": ERR=%s\n",
1261                name, jcr->last_fname, be.bstrerror());
1262          goto bail_out;
1263       }
1264    }
1265
1266   /*
1267    * We need to change into the attribute directory to determine if each of the
1268    * attributes should be saved.
1269    */
1270    if (fchdir(attrdirfd) < 0) {
1271       Mmsg2(jcr->errmsg, _("Unable to chdir to xattr space on file \"%s\": ERR=%s\n"),
1272             jcr->last_fname, be.bstrerror());
1273       Dmsg3(100, "Unable to fchdir to xattr space on file \"%s\" using fd %d: ERR=%s\n",
1274             jcr->last_fname, attrdirfd, be.bstrerror());
1275       goto bail_out;
1276    }
1277
1278    /*
1279     * Save the data of the toplevel xattr hidden_dir. We save this one before anything
1280     * else because the readdir returns "." entry after the extensible attr entry.
1281     * And as we want this entry before anything else we better just save its data.
1282     */
1283    if (!attr_parent)
1284       solaris_save_xattr(jcr, attrdirfd, current_xattr_namespace, ".",
1285                             true, STREAM_XATTR_SOLARIS);
1286
1287    if ((fd = dup(attrdirfd)) == -1 ||
1288        (dirp = fdopendir(fd)) == (DIR *)NULL) {
1289       Mmsg2(jcr->errmsg, _("Unable to list the xattr space on file \"%s\": ERR=%s\n"),
1290             jcr->last_fname, be.bstrerror());
1291       Dmsg3(100, "Unable to fdopendir xattr space on file \"%s\" using fd %d: ERR=%s\n",
1292             jcr->last_fname, fd, be.bstrerror());
1293
1294       goto bail_out;
1295    }
1296
1297    /*
1298     * Walk the namespace.
1299     */
1300    while (dp = readdir(dirp)) {
1301       /*
1302        * Skip only the toplevel . dir.
1303        */
1304       if (!attr_parent && !strcmp(dp->d_name, "."))
1305          continue;
1306
1307       /*
1308        * Skip all .. directories
1309        */
1310       if (!strcmp(dp->d_name, ".."))
1311          continue;
1312
1313       Dmsg3(400, "processing extended attribute %s%s on file \"%s\"\n",
1314          current_xattr_namespace, dp->d_name, jcr->last_fname);
1315
1316 #if defined(HAVE_SYS_NVPAIR_H) && defined(_PC_SATTR_ENABLED)
1317       /*
1318        * We are not interested in read-only extensible attributes.
1319        */
1320       if (!strcmp(dp->d_name, VIEW_READONLY)) {
1321          Dmsg3(400, "Skipping readonly extensible attributes %s%s on file \"%s\"\n",
1322             current_xattr_namespace, dp->d_name, jcr->last_fname);
1323
1324          continue;
1325       }
1326
1327       /*
1328        * We are only interested in read-write extensible attributes
1329        * when they contain non-transient values.
1330        */
1331       if (!strcmp(dp->d_name, VIEW_READWRITE)) {
1332          /*
1333           * Determine if there are non-transient system attributes at the toplevel.
1334           * We need to provide a fd to the open file.
1335           */
1336          if (!solaris_has_non_transient_extensible_attributes(filefd)) {
1337             Dmsg3(400, "Skipping transient extensible attributes %s%s on file \"%s\"\n",
1338                current_xattr_namespace, dp->d_name, jcr->last_fname);
1339             continue;
1340          }
1341
1342          /*
1343           * Save the xattr.
1344           */
1345          solaris_save_xattr(jcr, attrdirfd, current_xattr_namespace, dp->d_name,
1346                                false, STREAM_XATTR_SOLARIS_SYS);
1347          continue;
1348       }
1349 #endif /* HAVE_SYS_NVPAIR_H && _PC_SATTR_ENABLED */
1350
1351       /*
1352        * Save the xattr.
1353        */
1354       solaris_save_xattr(jcr, attrdirfd, current_xattr_namespace, dp->d_name,
1355                             false, STREAM_XATTR_SOLARIS);
1356    }
1357
1358    closedir(dirp);
1359    retval = bsub_exit_ok;
1360
1361 bail_out:
1362    if (attrdirfd != -1)
1363       close(attrdirfd);
1364    if (filefd != -1)
1365       close(filefd);
1366    return retval;
1367 }
1368
1369 #ifdef HAVE_ACL
1370 static bsub_exit_code solaris_restore_xattr_acl(JCR *jcr, int fd, const char *attrname, char *acl_text)
1371 {
1372 #ifdef HAVE_EXTENDED_ACL
1373    int error;
1374    acl_t *aclp = NULL;
1375    berrno be;
1376
1377    if ((error = acl_fromtext(acl_text, &aclp)) != 0) {
1378       Mmsg1(jcr->errmsg, _("Unable to convert acl from text on file \"%s\"\n"),
1379             jcr->last_fname);
1380       return bsub_exit_nok;
1381    }
1382
1383    if ((fd != -1 && facl_set(fd, aclp) != 0) ||
1384         acl_set(attrname, aclp) != 0) {
1385       Mmsg3(jcr->errmsg, _("Unable to restore acl of xattr %s on file \"%s\": ERR=%s\n"),
1386             attrname, jcr->last_fname, be.bstrerror());
1387       Dmsg3(100, "Unable to restore acl of xattr %s on file \"%s\": ERR=%s\n",
1388             attrname, jcr->last_fname, be.bstrerror());
1389       return bsub_exit_nok;
1390    }
1391
1392    if (aclp) {
1393       acl_free(aclp);
1394    }
1395    return bsub_exit_ok;
1396
1397 #else /* HAVE_EXTENDED_ACL */
1398    int n;
1399    aclent_t *acls = NULL;
1400    berrno be;
1401
1402    acls = aclfromtext(acl_text, &n);
1403    if (!acls) {
1404       if ((fd != -1 && facl(fd, SETACL, n, acls) != 0) ||
1405            acl(attrname, SETACL, n, acls) != 0) {
1406          Mmsg3(jcr->errmsg, _("Unable to restore acl of xattr %s on file \"%s\": ERR=%s\n"),
1407                attrname, jcr->last_fname, be.bstrerror());
1408          Dmsg3(100, "Unable to restore acl of xattr %s on file \"%s\": ERR=%s\n",
1409                attrname, jcr->last_fname, be.bstrerror());
1410          return bsub_exit_nok;
1411       }
1412    }
1413
1414    if (acls) {
1415       free(acls);
1416    }
1417    return bsub_exit_ok;
1418
1419 #endif /* HAVE_EXTENDED_ACL */
1420
1421 }
1422 #endif /* HAVE_ACL */
1423
1424 static bsub_exit_code solaris_restore_xattrs(JCR *jcr, bool is_extensible)
1425 {
1426    int fd, filefd = -1, attrdirfd = -1, attrfd = -1;
1427    int used_bytes, total_bytes, cnt;
1428    char *bp, *target_attrname, *attribs;
1429    char *linked_target = NULL;
1430    char *acl_text = NULL;
1431    char *data = NULL;
1432    int32_t inum;
1433    struct stat st;
1434    struct timeval times[2];
1435    bsub_exit_code retval = bsub_exit_nok;
1436    berrno be;
1437
1438    /*
1439     * Parse the xattr stream. First the part that is the same for all xattrs.
1440     */
1441    used_bytes = 0;
1442    total_bytes = jcr->xattr_data_len;
1443
1444    /*
1445     * The name of the target xattr has a leading / we are not interested
1446     * in that so skip it when decoding the string. We always start a the /
1447     * of the xattr space anyway.
1448     */
1449    target_attrname = jcr->xattr_data + 1;
1450    if ((bp = strchr(target_attrname, '\0')) == (char *)NULL ||
1451        (used_bytes = (bp - jcr->xattr_data)) >= (total_bytes - 1)) {
1452       goto parse_error;
1453    }
1454    attribs = ++bp;
1455
1456    /*
1457     * Open the file on which to restore the xattrs read-only.
1458     */
1459    if ((filefd = open(jcr->last_fname, O_RDONLY | O_NONBLOCK)) < 0) {
1460       Mmsg2(jcr->errmsg, _("Unable to open file \"%s\": ERR=%s\n"),
1461             jcr->last_fname, be.bstrerror());
1462       Dmsg2(100, "Unable to open file \"%s\": ERR=%s\n",
1463             jcr->last_fname, be.bstrerror());
1464       goto bail_out;
1465    }
1466
1467    /*
1468     * Open the xattr naming space and make it the current working dir.
1469     */
1470    if ((attrdirfd = openat(filefd, ".", O_RDONLY | O_XATTR)) < 0) {
1471       Mmsg2(jcr->errmsg, _("Unable to open xattr space on file \"%s\": ERR=%s\n"),
1472             jcr->last_fname, be.bstrerror());
1473       Dmsg2(100, "Unable to open xattr space on file \"%s\": ERR=%s\n",
1474             jcr->last_fname, be.bstrerror());
1475       goto bail_out;
1476    }
1477
1478    if (fchdir(attrdirfd) < 0) {
1479       Mmsg2(jcr->errmsg, _("Unable to chdir to xattr space on file \"%s\": ERR=%s\n"),
1480             jcr->last_fname, be.bstrerror());
1481       Dmsg3(100, "Unable to fchdir to xattr space on file \"%s\" using fd %d: ERR=%s\n",
1482             jcr->last_fname, attrdirfd, be.bstrerror());
1483       goto bail_out;
1484    }
1485
1486    /*
1487     * Try to open the correct xattr subdir based on the target_attrname given.
1488     * e.g. check if its a subdir attrname. Each / in the string makes us go
1489     * one level deeper.
1490     */
1491    while ((bp = strchr(target_attrname, '/')) != (char *)NULL) {
1492       *bp = '\0';
1493
1494       if ((fd = open(target_attrname, O_RDONLY | O_NONBLOCK)) < 0) {
1495          Mmsg3(jcr->errmsg, _("Unable to open xattr %s on file \"%s\": ERR=%s\n"),
1496                target_attrname, jcr->last_fname, be.bstrerror());
1497          Dmsg3(100, "Unable to open xattr %s on file \"%s\": ERR=%s\n",
1498                target_attrname, jcr->last_fname, be.bstrerror());
1499          goto bail_out;
1500       }
1501
1502       close(filefd);
1503       filefd = fd;
1504
1505       /*
1506        * Open the xattr naming space.
1507        */
1508       if ((fd = openat(filefd, ".", O_RDONLY | O_XATTR)) < 0) {
1509          Mmsg3(jcr->errmsg, _("Unable to open xattr space %s on file \"%s\": ERR=%s\n"),
1510                target_attrname, jcr->last_fname, be.bstrerror());
1511          Dmsg3(100, "Unable to open xattr space %s on file \"%s\": ERR=%s\n",
1512                target_attrname, jcr->last_fname, be.bstrerror());
1513          goto bail_out;
1514       }
1515
1516       close(attrdirfd);
1517       attrdirfd = fd;
1518
1519       /*
1520        * Make the xattr space our current workingdir.
1521        */
1522       if (fchdir(attrdirfd) < 0) {
1523          Mmsg3(jcr->errmsg, _("Unable to chdir to xattr space %s on file \"%s\": ERR=%s\n"),
1524                target_attrname, jcr->last_fname, be.bstrerror());
1525          Dmsg4(100, "Unable to fchdir to xattr space %s on file \"%s\" using fd %d: ERR=%s\n",
1526                target_attrname, jcr->last_fname, attrdirfd, be.bstrerror());
1527          goto bail_out;
1528       }
1529
1530       target_attrname = ++bp;
1531    }
1532
1533    /*
1534     * Decode the attributes from the stream.
1535     */
1536    decode_stat(attribs, &st, &inum);
1537
1538    /*
1539     * Decode the next field (acl_text).
1540     */
1541    if ((bp = strchr(attribs, '\0')) == (char *)NULL ||
1542        (used_bytes = (bp - jcr->xattr_data)) >= (total_bytes - 1)) {
1543       goto parse_error;
1544    }
1545    acl_text = ++bp;
1546
1547    /*
1548     * Based on the filetype perform the correct action. We support most filetypes here, more
1549     * then the actual implementation on Solaris supports so some code may never get executed
1550     * due to limitations in the implementation.
1551     */
1552    switch (st.st_mode & S_IFMT) {
1553    case S_IFIFO:
1554       /*
1555        * The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
1556        */
1557       unlinkat(attrdirfd, target_attrname, 0);
1558       if (mkfifo(target_attrname, st.st_mode) < 0) {
1559          Mmsg3(jcr->errmsg, _("Unable to mkfifo xattr %s on file \"%s\": ERR=%s\n"),
1560                target_attrname, jcr->last_fname, be.bstrerror());
1561          Dmsg3(100, "Unable to mkfifo xattr %s on file \"%s\": ERR=%s\n",
1562                target_attrname,  jcr->last_fname, be.bstrerror());
1563          goto bail_out;
1564       }
1565       break;
1566    case S_IFCHR:
1567    case S_IFBLK:
1568       /*
1569        * The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
1570        */
1571       unlinkat(attrdirfd, target_attrname, 0);
1572       if (mknod(target_attrname, st.st_mode, st.st_rdev) < 0) {
1573          Mmsg3(jcr->errmsg, _("Unable to mknod xattr %s on file \"%s\": ERR=%s\n"),
1574                target_attrname, jcr->last_fname, be.bstrerror());
1575          Dmsg3(100, "Unable to mknod xattr %s on file \"%s\": ERR=%s\n",
1576                target_attrname,  jcr->last_fname, be.bstrerror());
1577          goto bail_out;
1578       }
1579       break;
1580    case S_IFDIR:
1581       /*
1582        * If its not the hidden_dir create the entry.
1583        * The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
1584        */
1585       if (strcmp(target_attrname, ".")) {
1586          unlinkat(attrdirfd, target_attrname, AT_REMOVEDIR);
1587          if (mkdir(target_attrname, st.st_mode) < 0) {
1588             Jmsg3(jcr, M_WARNING, 0, _("Unable to mkdir xattr %s on file \"%s\": ERR=%s\n"),
1589                target_attrname, jcr->last_fname, be.bstrerror());
1590             Dmsg3(100, "Unable to mkdir xattr %s on file \"%s\": ERR=%s\n",
1591                target_attrname,  jcr->last_fname, be.bstrerror());
1592             goto bail_out;
1593          }
1594       }
1595       break;
1596    case S_IFREG:
1597       /*
1598        * See if this is a hard linked file. e.g. inum != 0
1599        */
1600       if (inum != 0) {
1601          linked_target = bp;
1602
1603          unlinkat(attrdirfd, target_attrname, 0);
1604          if (link(linked_target, target_attrname) < 0) {
1605             Mmsg4(jcr->errmsg, _("Unable to link xattr %s to %s on file \"%s\": ERR=%s\n"),
1606                   target_attrname, linked_target, jcr->last_fname, be.bstrerror());
1607             Dmsg4(100, "Unable to link xattr %s to %s on file \"%s\": ERR=%s\n",
1608                   target_attrname, linked_target, jcr->last_fname, be.bstrerror());
1609             goto bail_out;
1610          }
1611
1612          /*
1613           * Successfully restored xattr.
1614           */
1615          retval = bsub_exit_ok;
1616          goto bail_out;
1617       } else {
1618          if ((bp = strchr(acl_text, '\0')) == (char *)NULL ||
1619              (used_bytes = (bp - jcr->xattr_data)) >= total_bytes) {
1620             goto parse_error;
1621          }
1622
1623          if (used_bytes < (total_bytes - 1))
1624             data = ++bp;
1625
1626          /*
1627           * Restore the actual xattr.
1628           */
1629          if (!is_extensible) {
1630             unlinkat(attrdirfd, target_attrname, 0);
1631          }
1632
1633          if ((attrfd = openat(attrdirfd, target_attrname, O_RDWR | O_CREAT | O_TRUNC, st.st_mode)) < 0) {
1634             Mmsg3(jcr->errmsg, _("Unable to open xattr %s on file \"%s\": ERR=%s\n"),
1635                   target_attrname, jcr->last_fname, be.bstrerror());
1636             Dmsg3(100, "Unable to open xattr %s on file \"%s\": ERR=%s\n",
1637                   target_attrname, jcr->last_fname, be.bstrerror());
1638             goto bail_out;
1639          }
1640       }
1641
1642       /*
1643        * Restore the actual data.
1644        */
1645       if (st.st_size > 0) {
1646          used_bytes = (data - jcr->xattr_data);
1647          cnt = total_bytes - used_bytes;
1648
1649          /*
1650           * Do a sanity check, the st.st_size should be the same as the number of bytes
1651           * we have available as data of the stream.
1652           */
1653          if (cnt != st.st_size) {
1654             Mmsg2(jcr->errmsg, _("Unable to restore data of xattr %s on file \"%s\": Not all data available in xattr stream\n"),
1655                   target_attrname, jcr->last_fname);
1656             Dmsg2(100, "Unable to restore data of xattr %s on file \"%s\": Not all data available in xattr stream\n",
1657                   target_attrname, jcr->last_fname);
1658             goto bail_out;
1659          }
1660
1661          while (cnt > 0) {
1662             cnt = write(attrfd, data, cnt);
1663             if (cnt < 0) {
1664                Mmsg3(jcr->errmsg, _("Unable to restore data of xattr %s on file \"%s\": ERR=%s\n"),
1665                      target_attrname, jcr->last_fname, be.bstrerror());
1666                Dmsg3(100, "Unable to restore data of xattr %s on file \"%s\": ERR=%s\n",
1667                      target_attrname, jcr->last_fname, be.bstrerror());
1668                goto bail_out;
1669             }
1670
1671             used_bytes += cnt;
1672             data += cnt;
1673             cnt = total_bytes - used_bytes;
1674          }
1675       }
1676       break;
1677    case S_IFLNK:
1678       /*
1679        * The current implementation of xattr on Solaris doesn't support this, but if it ever does we are prepared.
1680        */
1681       linked_target = bp;
1682
1683       if (symlink(linked_target, target_attrname) < 0) {
1684          Mmsg4(jcr->errmsg, _("Unable to symlink xattr %s to %s on file \"%s\": ERR=%s\n"),
1685                target_attrname, linked_target, jcr->last_fname, be.bstrerror());
1686          Dmsg4(100, "Unable to symlink xattr %s to %s on file \"%s\": ERR=%s\n",
1687                target_attrname, linked_target, jcr->last_fname, be.bstrerror());
1688          goto bail_out;
1689       }
1690
1691       /*
1692        * Successfully restored xattr.
1693        */
1694       retval = bsub_exit_ok;
1695       goto bail_out;
1696    default:
1697       goto bail_out;
1698    }
1699
1700    /*
1701     * Restore owner and acl for non extensible attributes.
1702     */
1703    if (!is_extensible) {
1704       if (fchownat(attrdirfd, target_attrname, st.st_uid, st.st_gid, AT_SYMLINK_NOFOLLOW) < 0) {
1705          switch (errno) {
1706          case EINVAL:
1707             /*
1708              * Gentile way of the system saying this type of xattr layering is not supported.
1709              * But as this is not an error we return a positive return value.
1710              */
1711             retval = bsub_exit_ok;
1712             break;
1713          case ENOENT:
1714             retval = bsub_exit_ok;
1715             break;
1716          default:
1717             Mmsg3(jcr->errmsg, _("Unable to restore owner of xattr %s on file \"%s\": ERR=%s\n"),
1718                   target_attrname, jcr->last_fname, be.bstrerror());
1719             Dmsg3(100, "Unable to restore owner of xattr %s on file \"%s\": ERR=%s\n",
1720                   target_attrname, jcr->last_fname, be.bstrerror());
1721          }
1722          goto bail_out;
1723       }
1724    }
1725
1726 #ifdef HAVE_ACL
1727    if (acl_text && *acl_text)
1728       if (solaris_restore_xattr_acl(jcr, attrfd, target_attrname, acl_text) != bsub_exit_ok)
1729          goto bail_out;
1730 #endif /* HAVE_ACL */
1731
1732    /*
1733     * For a non extensible attribute restore access and modification time on the xattr.
1734     */
1735    if (!is_extensible) {
1736       times[0].tv_sec = st.st_atime;
1737       times[0].tv_usec = 0;
1738       times[1].tv_sec = st.st_mtime;
1739       times[1].tv_usec = 0;
1740
1741       if (futimesat(attrdirfd, target_attrname, times) < 0) {
1742          Mmsg3(jcr->errmsg, _("Unable to restore filetimes of xattr %s on file \"%s\": ERR=%s\n"),
1743                target_attrname, jcr->last_fname, be.bstrerror());
1744          Dmsg3(100, "Unable to restore filetimes of xattr %s on file \"%s\": ERR=%s\n",
1745                target_attrname, jcr->last_fname, be.bstrerror());
1746          goto bail_out;
1747       }
1748    }
1749
1750    /*
1751     * Successfully restored xattr.
1752     */
1753    retval = bsub_exit_ok;
1754    goto bail_out;
1755
1756 parse_error:
1757    Mmsg1(jcr->errmsg, _("Illegal xattr stream, failed to parse xattr stream on file \"%s\"\n"),
1758          jcr->last_fname);
1759    Dmsg1(100, "Illegal xattr stream, failed to parse xattr stream on file \"%s\"\n",
1760          jcr->last_fname);
1761
1762 bail_out:
1763    if (attrfd != -1) {
1764       close(attrfd);
1765    }
1766    if (attrdirfd != -1) {
1767       close(attrdirfd);
1768    }
1769    if (filefd != -1) {
1770       close(filefd);
1771    }
1772    return retval;
1773 }
1774
1775 static bsub_exit_code solaris_build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
1776 {
1777    char cwd[PATH_MAX];
1778    bsub_exit_code retval = bsub_exit_ok;
1779
1780    /*
1781     * First see if extended attributes or extensible attributes are present.
1782     * If not just pretend things went ok.
1783     */
1784    if (pathconf(jcr->last_fname, _PC_XATTR_EXISTS) > 0) {
1785       nr_xattr_saved = 0;
1786
1787       /*
1788        * As we change the cwd in the save function save the current cwd
1789        * for restore after return from the solaris_save_xattrs function.
1790        */
1791       xattr_link_cache = New(alist(10, not_owned_by_alist));
1792       getcwd(cwd, sizeof(cwd));
1793       retval = solaris_save_xattrs(jcr, NULL, NULL);
1794       chdir(cwd);
1795       delete xattr_link_cache;
1796       xattr_link_cache = NULL;
1797    }
1798    return retval;
1799 }
1800
1801 static bsub_exit_code solaris_parse_xattr_streams(JCR *jcr, int stream)
1802 {
1803    char cwd[PATH_MAX];
1804    bool is_extensible = false;
1805    bsub_exit_code retval;
1806
1807    /*
1808     * First make sure we can restore xattr on the filesystem.
1809     */
1810    switch (stream) {
1811 #if defined(HAVE_SYS_NVPAIR_H) && defined(_PC_SATTR_ENABLED)
1812    case STREAM_XATTR_SOLARIS_SYS:
1813       if (pathconf(jcr->last_fname, _PC_SATTR_ENABLED) <= 0) {
1814          Qmsg1(jcr, M_WARNING, 0,
1815                _("Failed to restore extensible attributes on file \"%s\"\n"),
1816                jcr->last_fname);
1817          Dmsg1(100, "Unable to restore extensible attributes on file \"%s\", filesystem doesn't support this\n",
1818             jcr->last_fname);
1819          return bsub_exit_nok;
1820       }
1821
1822       is_extensible = true;
1823       break;
1824 #endif
1825    case STREAM_XATTR_SOLARIS:
1826       if (pathconf(jcr->last_fname, _PC_XATTR_ENABLED) <= 0) {
1827          Qmsg1(jcr, M_WARNING, 0,
1828                _("Failed to restore extended attributes on file \"%s\"\n"),
1829                jcr->last_fname);
1830          Dmsg1(100, "Unable to restore extended attributes on file \"%s\", filesystem doesn't support this\n",
1831             jcr->last_fname);
1832          return bsub_exit_nok;
1833       }
1834       break;
1835    default:
1836       return bsub_exit_nok;
1837    }
1838
1839    /*
1840     * As we change the cwd in the restore function save the current cwd
1841     * for restore after return from the solaris_restore_xattrs function.
1842     */
1843    getcwd(cwd, sizeof(cwd));
1844    retval = solaris_restore_xattrs(jcr, is_extensible);
1845    chdir(cwd);
1846    return retval;
1847 }
1848
1849
1850 /*
1851  * Function pointers to the build and parse function to use for these xattrs.
1852  */
1853 static bsub_exit_code (*os_build_xattr_streams)(JCR *jcr, FF_PKT *ff_pkt) = solaris_build_xattr_streams;
1854 static bsub_exit_code (*os_parse_xattr_streams)(JCR *jcr, int stream) = solaris_parse_xattr_streams;
1855
1856 #endif /* defined(HAVE_SUN_OS) */
1857
1858 /*
1859  * Entry points when compiled with support for XATTRs on a supported platform.
1860  */
1861 bsub_exit_code build_xattr_streams(JCR *jcr, FF_PKT *ff_pkt)
1862 {
1863    if (os_build_xattr_streams) {
1864       return (*os_build_xattr_streams)(jcr, ff_pkt);
1865    }
1866    return bsub_exit_nok;
1867 }
1868
1869 bsub_exit_code parse_xattr_streams(JCR *jcr, int stream)
1870 {
1871    int cnt;
1872
1873    if (os_parse_xattr_streams) {
1874       /*
1875        * See if we can parse this stream, and ifso give it a try.
1876        */
1877       for (cnt = 0; cnt < sizeof(os_default_xattr_streams) / sizeof(int); cnt++) {
1878          if (os_default_xattr_streams[cnt] == stream) {
1879             return (*os_parse_xattr_streams)(jcr, stream);
1880          }
1881       }
1882    }
1883    /*
1884     * Issue a warning and discard the message. But pretend the restore was ok.
1885     */
1886    Jmsg2(jcr, M_WARNING, 0,
1887       _("Can't restore Extended Attributes of %s - incompatible xattr stream encountered - %d\n"),
1888       jcr->last_fname, stream);
1889    return bsub_exit_nok;
1890 }
1891 #endif