include/atalk/ea.h

   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 #ifndef ATALK_EA_H
  16 #define ATALK_EA_H
  17
  18 #ifdef HAVE_CONFIG_H
  19 #include <config.h>
  20 #endif
  21
  22 #ifdef HAVE_SOLARIS_ACLS
  23 #include <sys/acl.h>
  24 #endif
  25
  26 #include <atalk/vfs.h>
  27
  28 /*
  29  * This seems to be the current limit fo HFS+, we arbitrarily force that
  30  *  which also safes us from buffer overflows
  31  */
  32 #define MAX_EA_SIZE 3802
  33
  34 /*
  35  * At time of writing the 10.5.6 client adds 8 bytes to the
  36  * length of the EA that we send him
  37 */
  38 #define MAX_REPLY_EXTRA_BYTES 8
  39
  40 /*
  41  * Library user must provide a static buffer of size ATTRNAMEBUFSIZ.
  42  * It's used when listing EAs as intermediate buffer. For afpd it's
  43  * defined in extattrs.c.
  44  */
  45 #define ATTRNAMEBUFSIZ 4096
  46
  47 enum {
  48     kXAttrNoFollow = 0x1,
  49     kXAttrCreate = 0x2,
  50     kXAttrReplace = 0x4
  51 };
  52
  53 #if !defined(HAVE_SETXATTR)
  54 #define XATTR_CREATE  0x1       /* set value, fail if attr already exists */
  55 #define XATTR_REPLACE 0x2       /* set value, fail if attr does not exist */
  56 #endif
  57
  58 /* Names for our Extended Attributes adouble data */
  59 #define AD_EA_META "org.netatalk.Metadata"
  60 #define AD_EA_RESO "org.netatalk.ResourceFork"
  61
  62 /****************************************************************************************
  63  * Wrappers for native EA functions taken from Samba
  64  ****************************************************************************************/
  65 ssize_t sys_getxattr (const char *path, const char *name, void *value, size_t size);
  66 ssize_t sys_lgetxattr (const char *path, const char *name, void *value, size_t size);
  67 ssize_t sys_fgetxattr (int filedes, const char *name, void *value, size_t size);
  68 ssize_t sys_listxattr (const char *path, char *list, size_t size);
  69 ssize_t sys_llistxattr (const char *path, char *list, size_t size);
  70 ssize_t sys_flistxattr (int filedes, char *list, size_t size);
  71 int sys_removexattr (const char *path, const char *name);
  72 int sys_lremovexattr (const char *path, const char *name);
  73 int sys_fremovexattr (int filedes, const char *name);
  74 int sys_setxattr (const char *path, const char *name, const void *value, size_t size, int flags);
  75 int sys_lsetxattr (const char *path, const char *name, const void *value, size_t size, int flags);
  76 int sys_fsetxattr (int filedes, const char *name, const void *value, size_t size, int flags);
  77 int sys_copyxattr (const char *src, const char *dst);
  78
  79 /****************************************************************************************
  80  * Stuff for our implementation of storing EAs in files in .AppleDouble dirs
  81  ****************************************************************************************/
  82
  83 #define EA_INITED   0xea494e54  /* ea"INT", for interfacing ea_open w. ea_close */
  84 #define EA_MAGIC    0x61644541 /* "adEA" */
  85 #define EA_VERSION1 0x01
  86 #define EA_VERSION  EA_VERSION1
  87
  88 typedef enum {
  89     /* ea_open flags */
  90     EA_CREATE    = (1<<1),      /* create if not existing on ea_open */
  91     EA_RDONLY    = (1<<2),      /* open read only */
  92     EA_RDWR      = (1<<3),      /* open read/write */
  93     /* ea_open internal flags */
  94     EA_DIR       = (1<<4)       /* ea header file is for a dir, ea_open adds it as appropiate */
  95 } eaflags_t;
  96
  97 #define EA_MAGIC_OFF   0
  98 #define EA_MAGIC_LEN   4
  99 #define EA_VERSION_OFF (EA_MAGIC_OFF + EA_MAGIC_LEN)
 100 #define EA_VERSION_LEN 2
 101 #define EA_COUNT_OFF   (EA_VERSION_OFF + EA_VERSION_LEN)
 102 #define EA_COUNT_LEN   2
 103 #define EA_HEADER_SIZE (EA_MAGIC_LEN + EA_VERSION_LEN + EA_COUNT_LEN)
 104
 105 /*
 106  * structs describing the layout of the Extended Attributes bookkeeping file.
 107  * This isn't really an AppleDouble structure, it's just a binary blob that
 108  * lives in our .AppleDouble directory too.
 109  */
 110
 111 struct ea_entry {
 112     size_t       ea_namelen; /* len of ea_name without terminating 0 ie. strlen(ea_name)*/
 113     size_t       ea_size;    /* size of EA*/
 114     char         *ea_name;   /* name of the EA */
 115 };
 116
 117 /* We read the on-disk data into *ea_data and parse it into this*/
 118 struct ea {
 119     uint32_t             ea_inited;       /* needed for interfacing ea_open w. ea_close */
 120     const struct vol     *vol;            /* vol handle, ea_close needs it */
 121     int                  dirfd;           /* for *at (cf openat) semantics, -1 means ignore */
 122     char                 *filename;       /* name of file, needed by ea_close too */
 123     unsigned int         ea_count;        /* number of EAs in ea_entries array */
 124     struct ea_entry      (*ea_entries)[]; /* malloced and realloced as needed by ea_count*/
 125     int                  ea_fd;           /* open fd for ea_data */
 126     eaflags_t            ea_flags;        /* flags */
 127     size_t               ea_size;         /* size of header file = size of ea_data buffer */
 128     char                 *ea_data;        /* pointer to buffer into that we actually *
 129                                            * read the disc file into                 */
 130 };
 131
 132 /* On-disk format, just for reference ! */
 133 #if 0
 134 struct ea_entry_ondisk {
 135     uint32_t               ea_size;
 136     char                   ea_name[]; /* zero terminated string */
 137 };
 138
 139 struct ea_ondisk {
 140     u_int32_t              ea_magic;
 141     u_int16_t              ea_version;
 142     u_int16_t              ea_count;
 143     struct ea_entry_ondisk ea_entries[ea_count];
 144 };
 145 #endif /* 0 */
 146
 147 /* VFS inderected funcs ... : */
 148
 149 /* Default adouble EAs */
 150 extern int get_easize(VFS_FUNC_ARGS_EA_GETSIZE);
 151 extern int get_eacontent(VFS_FUNC_ARGS_EA_GETCONTENT);
 152 extern int list_eas(VFS_FUNC_ARGS_EA_LIST);
 153 extern int set_ea(VFS_FUNC_ARGS_EA_SET);
 154 extern int remove_ea(VFS_FUNC_ARGS_EA_REMOVE);
 155 /* ... EA VFS funcs that deal with file/dir cp/mv/rm */
 156 extern int ea_deletefile(VFS_FUNC_ARGS_DELETEFILE);
 157 extern int ea_renamefile(VFS_FUNC_ARGS_RENAMEFILE);
 158 extern int ea_copyfile(VFS_FUNC_ARGS_COPYFILE);
 159 extern int ea_chown(VFS_FUNC_ARGS_CHOWN);
 160 extern int ea_chmod_file(VFS_FUNC_ARGS_SETFILEMODE);
 161 extern int ea_chmod_dir(VFS_FUNC_ARGS_SETDIRUNIXMODE);
 162
 163 /* native EAs */
 164 extern int sys_get_easize(VFS_FUNC_ARGS_EA_GETSIZE);
 165 extern int sys_get_eacontent(VFS_FUNC_ARGS_EA_GETCONTENT);
 166 extern int sys_list_eas(VFS_FUNC_ARGS_EA_LIST);
 167 extern int sys_set_ea(VFS_FUNC_ARGS_EA_SET);
 168 extern int sys_remove_ea(VFS_FUNC_ARGS_EA_REMOVE);
 169 /* native EA VFSfile/dir cp/mv/rm */
 170 extern int sys_ea_copyfile(VFS_FUNC_ARGS_COPYFILE);
 171
 172 /* dbd needs access to these */
 173 extern int ea_open(const struct vol * restrict vol,
 174                    const char * restrict uname,
 175                    eaflags_t eaflags,
 176                    struct ea * restrict ea);
 177 extern int ea_openat(const struct vol * restrict vol,
 178                      int dirfd,
 179                      const char * restrict uname,
 180                      eaflags_t eaflags,
 181                      struct ea * restrict ea);
 182 extern int ea_close(struct ea * restrict ea);
 183 extern char *ea_path(const struct ea * restrict ea, const char * restrict eaname, int macname);
 184
 185 #endif /* ATALK_EA_H */