libatalk/vfs/ea_sys.c

   1 /*
   2   Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13 */
  14
  15 #ifdef HAVE_CONFIG_H
  16 #include "config.h"
  17 #endif /* HAVE_CONFIG_H */
  18
  19 #include <unistd.h>
  20 #include <stdint.h>
  21 #include <errno.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <fcntl.h>
  27 #include <dirent.h>
  28 #include <arpa/inet.h>
  29
  30 #include <atalk/adouble.h>
  31 #include <atalk/ea.h>
  32 #include <atalk/afp.h>
  33 #include <atalk/logger.h>
  34 #include <atalk/volume.h>
  35 #include <atalk/vfs.h>
  36 #include <atalk/util.h>
  37 #include <atalk/unix.h>
  38 #include <atalk/compat.h>
  39
  40 /**********************************************************************************
  41  * EA VFS funcs for storing EAs in nativa filesystem EAs
  42  **********************************************************************************/
  43
  44 /*
  45  * Function: sys_get_easize
  46  *
  47  * Purpose: get size of a native EA
  48  *
  49  * Arguments:
  50  *
  51  *    vol          (r) current volume
  52  *    rbuf         (w) DSI reply buffer
  53  *    rbuflen      (rw) current length of data in reply buffer
  54  *    uname        (r) filename
  55  *    oflag        (r) link and create flag
  56  *    attruname    (r) name of attribute
  57  *
  58  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
  59  *
  60  * Effects:
  61  *
  62  * Copies EA size into rbuf in network order. Increments *rbuflen +4.
  63  */
  64 int sys_get_easize(VFS_FUNC_ARGS_EA_GETSIZE)
  65 {
  66     ssize_t   ret;
  67     uint32_t  attrsize;
  68
  69     LOG(log_debug7, logtype_afpd, "sys_getextattr_size(%s): attribute: \"%s\"", uname, attruname);
  70
  71     if ((oflag & O_NOFOLLOW) ) {
  72         ret = sys_lgetxattr(uname, attruname, rbuf +4, 0);
  73     }
  74     else {
  75         ret = sys_getxattr(uname, attruname,  rbuf +4, 0);
  76     }
  77
  78     if (ret == -1) {
  79         memset(rbuf, 0, 4);
  80         *rbuflen += 4;
  81         switch(errno) {
  82         case OPEN_NOFOLLOW_ERRNO:
  83             /* its a symlink and client requested O_NOFOLLOW  */
  84             LOG(log_debug, logtype_afpd, "sys_getextattr_size(%s): encountered symlink with kXAttrNoFollow", uname);
  85             return AFP_OK;
  86
  87         case ENOATTR:
  88         case ENOENT:
  89             return AFPERR_MISC;
  90
  91         default:
  92             LOG(log_debug, logtype_afpd, "sys_getextattr_size: error: %s", strerror(errno));
  93             return AFPERR_MISC;
  94         }
  95     }
  96
  97     if (ret > MAX_EA_SIZE)
  98       ret = MAX_EA_SIZE;
  99
 100     /* Start building reply packet */
 101     LOG(log_debug7, logtype_afpd, "sys_getextattr_size(%s): attribute: \"%s\", size: %u", uname, attruname, ret);
 102
 103     /* length of attribute data */
 104     attrsize = htonl((uint32_t)ret);
 105     memcpy(rbuf, &attrsize, 4);
 106     *rbuflen += 4;
 107
 108     ret = AFP_OK;
 109     return ret;
 110 }
 111
 112 /*
 113  * Function: sys_get_eacontent
 114  *
 115  * Purpose: copy native EA into rbuf
 116  *
 117  * Arguments:
 118  *
 119  *    vol          (r) current volume
 120  *    rbuf         (w) DSI reply buffer
 121  *    rbuflen      (rw) current length of data in reply buffer
 122  *    uname        (r) filename
 123  *    oflag        (r) link and create flag
 124  *    attruname    (r) name of attribute
 125  *    maxreply     (r) maximum EA size as of current specs/real-life
 126  *
 127  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 128  *
 129  * Effects:
 130  *
 131  * Copies EA into rbuf. Increments *rbuflen accordingly.
 132  */
 133 int sys_get_eacontent(VFS_FUNC_ARGS_EA_GETCONTENT)
 134 {
 135     ssize_t   ret;
 136     uint32_t  attrsize;
 137
 138     /* Start building reply packet */
 139
 140     maxreply -= MAX_REPLY_EXTRA_BYTES;
 141
 142     if (maxreply > MAX_EA_SIZE)
 143         maxreply = MAX_EA_SIZE;
 144
 145     LOG(log_debug7, logtype_afpd, "sys_getextattr_content(%s): attribute: \"%s\", size: %u", uname, attruname, maxreply);
 146
 147     if ((oflag & O_NOFOLLOW) ) {
 148         ret = sys_lgetxattr(uname, attruname, rbuf +4, maxreply);
 149     }
 150     else {
 151         ret = sys_getxattr(uname, attruname,  rbuf +4, maxreply);
 152     }
 153
 154     if (ret == -1) {
 155         memset(rbuf, 0, 4);
 156         *rbuflen += 4;
 157         switch(errno) {
 158         case OPEN_NOFOLLOW_ERRNO:
 159             /* its a symlink and client requested O_NOFOLLOW  */
 160             LOG(log_debug, logtype_afpd, "sys_getextattr_content(%s): encountered symlink with kXAttrNoFollow", uname);
 161             return AFP_OK;
 162
 163         case ENOATTR:
 164             return AFPERR_MISC;
 165
 166         default:
 167             LOG(log_debug, logtype_afpd, "sys_getextattr_content(%s): error: %s", attruname, strerror(errno));
 168             return AFPERR_MISC;
 169         }
 170     }
 171
 172     /* remember where we must store length of attribute data in rbuf */
 173     *rbuflen += 4 +ret;
 174
 175     attrsize = htonl((uint32_t)ret);
 176     memcpy(rbuf, &attrsize, 4);
 177
 178     return AFP_OK;
 179 }
 180
 181 /*
 182  * Function: sys_list_eas
 183  *
 184  * Purpose: copy names of native EAs into attrnamebuf
 185  *
 186  * Arguments:
 187  *
 188  *    vol          (r) current volume
 189  *    attrnamebuf  (w) store names a consecutive C strings here
 190  *    buflen       (rw) length of names in attrnamebuf
 191  *    uname        (r) filename
 192  *    oflag        (r) link and create flag
 193  *
 194  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 195  *
 196  * Effects:
 197  *
 198  * Copies names of all EAs of uname as consecutive C strings into rbuf.
 199  * Increments *rbuflen accordingly.
 200  * We hide the adouble:ea extended attributes here, but we currently
 201  * allow reading, writing and deleteting them.
 202  */
 203 int sys_list_eas(VFS_FUNC_ARGS_EA_LIST)
 204 {
 205     ssize_t attrbuflen = *buflen;
 206     int     ret, len, nlen;
 207     char    *buf;
 208     char    *ptr;
 209
 210     buf = malloc(ATTRNAMEBUFSIZ);
 211     if (!buf)
 212         return AFPERR_MISC;
 213
 214     if ((oflag & O_NOFOLLOW)) {
 215         ret = sys_llistxattr(uname, buf, ATTRNAMEBUFSIZ);
 216     }
 217     else {
 218         ret = sys_listxattr(uname, buf, ATTRNAMEBUFSIZ);
 219     }
 220
 221     if (ret == -1) switch(errno) {
 222         case OPEN_NOFOLLOW_ERRNO:
 223             /* its a symlink and client requested O_NOFOLLOW */
 224             ret = AFPERR_BADTYPE;
 225             goto exit;
 226 #ifdef HAVE_ATTROPEN            /* Solaris */
 227         case ENOATTR:
 228         case ENOENT:
 229             ret = AFP_OK;
 230             goto exit;
 231 #endif
 232         default:
 233             LOG(log_debug, logtype_afpd, "sys_list_extattr(%s): error opening atttribute dir: %s", uname, strerror(errno));
 234             ret= AFPERR_MISC;
 235             goto exit;
 236     }
 237
 238     ptr = buf;
 239     while (ret > 0)  {
 240         len = strlen(ptr);
 241         if (NOT_NETATALK_EA(ptr)) {
 242             /* Convert name to CH_UTF8_MAC and directly store in in the reply buffer */
 243             if ( 0 >= ( nlen = convert_string(vol->v_volcharset, CH_UTF8_MAC, ptr, len, attrnamebuf + attrbuflen, 256)) ) {
 244                 ret = AFPERR_MISC;
 245                 goto exit;
 246             }
 247
 248             LOG(log_debug7, logtype_afpd, "sys_list_extattr(%s): attribute: %s", uname, ptr);
 249
 250             attrbuflen += nlen + 1;
 251             if (attrbuflen > (ATTRNAMEBUFSIZ - 256)) {
 252                 /* Next EA name could overflow, so bail out with error.
 253                    FIXME: evantually malloc/memcpy/realloc whatever.
 254                    Is it worth it ? */
 255                 LOG(log_warning, logtype_afpd, "sys_list_extattr(%s): running out of buffer for EA names", uname);
 256                 ret = AFPERR_MISC;
 257                 goto exit;
 258             }
 259         }
 260         ret -= len + 1;
 261         ptr += len + 1;
 262     }
 263
 264     ret = AFP_OK;
 265
 266 exit:
 267     free(buf);
 268     *buflen = attrbuflen;
 269     return ret;
 270 }
 271
 272 /*
 273  * Function: sys_set_ea
 274  *
 275  * Purpose: set a native EA
 276  *
 277  * Arguments:
 278  *
 279  *    vol          (r) current volume
 280  *    uname        (r) filename
 281  *    attruname    (r) EA name
 282  *    ibuf         (r) buffer with EA content
 283  *    attrsize     (r) length EA in ibuf
 284  *    oflag        (r) link and create flag
 285  *
 286  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 287  *
 288  * Effects:
 289  *
 290  */
 291 int sys_set_ea(VFS_FUNC_ARGS_EA_SET)
 292 {
 293     int attr_flag;
 294     int ret;
 295
 296     attr_flag = 0;
 297     if ((oflag & O_CREAT) )
 298         attr_flag |= XATTR_CREATE;
 299
 300     else if ((oflag & O_TRUNC) )
 301         attr_flag |= XATTR_REPLACE;
 302
 303     if ((oflag & O_NOFOLLOW) ) {
 304         ret = sys_lsetxattr(uname, attruname,  ibuf, attrsize,attr_flag);
 305     }
 306     else {
 307         ret = sys_setxattr(uname, attruname,  ibuf, attrsize, attr_flag);
 308     }
 309
 310     if (ret == -1) {
 311         switch(errno) {
 312         case OPEN_NOFOLLOW_ERRNO:
 313             /* its a symlink and client requested O_NOFOLLOW  */
 314             LOG(log_debug, logtype_afpd, "sys_set_ea(\"%s/%s\", ea:'%s'): encountered symlink with kXAttrNoFollow",
 315                 getcwdpath(), uname, attruname);
 316             return AFP_OK;
 317         case EEXIST:
 318             LOG(log_debug, logtype_afpd, "sys_set_ea(\"%s/%s\", ea:'%s'): EA already exists",
 319                 getcwdpath(), uname, attruname);
 320             return AFPERR_EXIST;
 321         default:
 322             LOG(log_error, logtype_afpd, "sys_set_ea(\"%s/%s\", ea:'%s', size: %u, flags: %s|%s|%s): %s",
 323                 getcwdpath(), uname, attruname, attrsize,
 324                 oflag & O_CREAT ? "XATTR_CREATE" : "-",
 325                 oflag & O_TRUNC ? "XATTR_REPLACE" : "-",
 326                 oflag & O_NOFOLLOW ? "O_NOFOLLOW" : "-",
 327                 strerror(errno));
 328             return AFPERR_MISC;
 329         }
 330     }
 331
 332     return AFP_OK;
 333 }
 334
 335 /*
 336  * Function: sys_remove_ea
 337  *
 338  * Purpose: remove a native EA
 339  *
 340  * Arguments:
 341  *
 342  *    vol          (r) current volume
 343  *    uname        (r) filename
 344  *    attruname    (r) EA name
 345  *    oflag        (r) link and create flag
 346  *
 347  * Returns: AFP code: AFP_OK on success or appropiate AFP error code
 348  *
 349  * Effects:
 350  *
 351  * Removes EA attruname from file uname.
 352  */
 353 int sys_remove_ea(VFS_FUNC_ARGS_EA_REMOVE)
 354 {
 355     int ret;
 356
 357     if ((oflag & O_NOFOLLOW) ) {
 358         ret = sys_lremovexattr(uname, attruname);
 359     }
 360     else {
 361         ret = sys_removexattr(uname, attruname);
 362     }
 363
 364     if (ret == -1) {
 365         switch(errno) {
 366         case OPEN_NOFOLLOW_ERRNO:
 367             /* its a symlink and client requested O_NOFOLLOW  */
 368             LOG(log_debug, logtype_afpd, "sys_remove_ea(%s/%s): encountered symlink with kXAttrNoFollow", uname);
 369             return AFP_OK;
 370         case EACCES:
 371             LOG(log_debug, logtype_afpd, "sys_remove_ea(%s/%s): error: %s", uname, attruname, strerror(errno));
 372             return AFPERR_ACCESS;
 373         default:
 374             LOG(log_error, logtype_afpd, "sys_remove_ea(%s/%s): error: %s", uname, attruname, strerror(errno));
 375             return AFPERR_MISC;
 376         }
 377     }
 378
 379     return AFP_OK;
 380 }
 381
 382 /*
 383  * @brief Copy EAs
 384  *
 385  * @note Supports *at semantics, therfor switches back and forth between sfd and cwd
 386  */
 387 int sys_ea_copyfile(VFS_FUNC_ARGS_COPYFILE)
 388 {
 389         int ret = 0;
 390     int cwd = -1;
 391         ssize_t size;
 392         char *names = NULL, *end_names, *name, *value = NULL;
 393         unsigned int setxattr_ENOTSUP = 0;
 394
 395     if (sfd != -1) {
 396         if ((cwd = open(".", O_RDONLY)) == -1) {
 397             LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant open cwd: %s",
 398                 strerror(errno));
 399             ret = -1;
 400             goto getout;
 401         }
 402     }
 403
 404     if (sfd != -1) {
 405         if (fchdir(sfd) == -1) {
 406             LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to sfd: %s",
 407                 strerror(errno));
 408             ret = -1;
 409             goto getout;
 410         }
 411     }
 412
 413         size = sys_listxattr(src, NULL, 0);
 414         if (size < 0) {
 415                 if (errno != ENOSYS && errno != ENOTSUP) {
 416                         ret = -1;
 417                 }
 418                 goto getout;
 419         }
 420         names = malloc(size+1);
 421         if (names == NULL) {
 422                 ret = -1;
 423                 goto getout;
 424         }
 425         size = sys_listxattr(src, names, size);
 426         if (size < 0) {
 427                 ret = -1;
 428                 goto getout;
 429         } else {
 430                 names[size] = '\0';
 431                 end_names = names + size;
 432         }
 433
 434     if (sfd != -1) {
 435         if (fchdir(cwd) == -1) {
 436             LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to cwd: %s",
 437                 strerror(errno));
 438             ret = -1;
 439             goto getout;
 440         }
 441     }
 442
 443         for (name = names; name != end_names; name = strchr(name, '\0') + 1) {
 444                 void *old_value;
 445
 446                 /* check if this attribute shall be preserved */
 447                 if (!*name)
 448                         continue;
 449
 450         if (sfd != -1) {
 451             if (fchdir(sfd) == -1) {
 452                 LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to sfd: %s",
 453                     strerror(errno));
 454                 ret = -1;
 455                 goto getout;
 456             }
 457         }
 458
 459                 size = sys_getxattr (src, name, NULL, 0);
 460                 if (size < 0) {
 461                         ret = -1;
 462                         continue;
 463                 }
 464                 value = realloc(old_value = value, size);
 465                 if (size != 0 && value == NULL) {
 466                         free(old_value);
 467                         ret = -1;
 468                 }
 469                 size = sys_getxattr(src, name, value, size);
 470                 if (size < 0) {
 471                         ret = -1;
 472                         continue;
 473                 }
 474
 475         if (sfd != -1) {
 476             if (fchdir(cwd) == -1) {
 477                 LOG(log_error, logtype_afpd, "sys_ea_copyfile: cant chdir to cwd: %s",
 478                     strerror(errno));
 479                 ret = -1;
 480                 goto getout;
 481             }
 482         }
 483
 484                 if (sys_setxattr(dst, name, value, size, 0) != 0) {
 485                         if (errno == ENOTSUP)
 486                                 setxattr_ENOTSUP++;
 487                         else {
 488                                 if (errno == ENOSYS) {
 489                                         ret = -1;
 490                                         /* no hope of getting any further */
 491                                         break;
 492                                 } else {
 493                                         ret = -1;
 494                                 }
 495                         }
 496                 }
 497         }
 498         if (setxattr_ENOTSUP) {
 499                 errno = ENOTSUP;
 500                 ret = -1;
 501         }
 502
 503 getout:
 504     if (cwd != -1)
 505         close(cwd);
 506
 507         free(value);
 508         free(names);
 509
 510     if (ret == -1) {
 511         switch(errno) {
 512         case ENOENT:
 513             /* no attribute */
 514             break;
 515         case EACCES:
 516             LOG(log_debug, logtype_afpd, "sys_ea_copyfile(%s, %s): error: %s", src, dst, strerror(errno));
 517             return AFPERR_ACCESS;
 518         default:
 519             LOG(log_error, logtype_afpd, "sys_ea_copyfile(%s, %s): error: %s", src, dst, strerror(errno));
 520             return AFPERR_MISC;
 521         }
 522     }
 523
 524     return AFP_OK;
 525 }