include/linux/xattr.h

   1 /*
   2   File: linux/xattr.h
   3
   4   Extended attributes handling.
   5
   6   Copyright (C) 2001 by Andreas Gruenbacher <a.gruenbacher@computer.org>
   7   Copyright (c) 2001-2002 Silicon Graphics, Inc.  All Rights Reserved.
   8   Copyright (c) 2004 Red Hat, Inc., James Morris <jmorris@redhat.com>
   9 */
  10 #ifndef _LINUX_XATTR_H
  11 #define _LINUX_XATTR_H
  12
  13 #define XATTR_CREATE    0x1     /* set value, fail if attr already exists */
  14 #define XATTR_REPLACE   0x2     /* set value, fail if attr does not exist */
  15
  16 /* Namespaces */
  17 #define XATTR_OS2_PREFIX "os2."
  18 #define XATTR_OS2_PREFIX_LEN (sizeof (XATTR_OS2_PREFIX) - 1)
  19
  20 #define XATTR_SECURITY_PREFIX   "security."
  21 #define XATTR_SECURITY_PREFIX_LEN (sizeof (XATTR_SECURITY_PREFIX) - 1)
  22
  23 #define XATTR_SYSTEM_PREFIX "system."
  24 #define XATTR_SYSTEM_PREFIX_LEN (sizeof (XATTR_SYSTEM_PREFIX) - 1)
  25
  26 #define XATTR_TRUSTED_PREFIX "trusted."
  27 #define XATTR_TRUSTED_PREFIX_LEN (sizeof (XATTR_TRUSTED_PREFIX) - 1)
  28
  29 #define XATTR_USER_PREFIX "user."
  30 #define XATTR_USER_PREFIX_LEN (sizeof (XATTR_USER_PREFIX) - 1)
  31
  32 /* Security namespace */
  33 #define XATTR_EVM_SUFFIX "evm"
  34 #define XATTR_NAME_EVM XATTR_SECURITY_PREFIX XATTR_EVM_SUFFIX
  35
  36 #define XATTR_SELINUX_SUFFIX "selinux"
  37 #define XATTR_NAME_SELINUX XATTR_SECURITY_PREFIX XATTR_SELINUX_SUFFIX
  38
  39 #define XATTR_SMACK_SUFFIX "SMACK64"
  40 #define XATTR_SMACK_IPIN "SMACK64IPIN"
  41 #define XATTR_SMACK_IPOUT "SMACK64IPOUT"
  42 #define XATTR_SMACK_EXEC "SMACK64EXEC"
  43 #define XATTR_SMACK_TRANSMUTE "SMACK64TRANSMUTE"
  44 #define XATTR_SMACK_MMAP "SMACK64MMAP"
  45 #define XATTR_NAME_SMACK XATTR_SECURITY_PREFIX XATTR_SMACK_SUFFIX
  46 #define XATTR_NAME_SMACKIPIN    XATTR_SECURITY_PREFIX XATTR_SMACK_IPIN
  47 #define XATTR_NAME_SMACKIPOUT   XATTR_SECURITY_PREFIX XATTR_SMACK_IPOUT
  48 #define XATTR_NAME_SMACKEXEC    XATTR_SECURITY_PREFIX XATTR_SMACK_EXEC
  49 #define XATTR_NAME_SMACKTRANSMUTE XATTR_SECURITY_PREFIX XATTR_SMACK_TRANSMUTE
  50 #define XATTR_NAME_SMACKMMAP XATTR_SECURITY_PREFIX XATTR_SMACK_MMAP
  51
  52 #define XATTR_CAPS_SUFFIX "capability"
  53 #define XATTR_NAME_CAPS XATTR_SECURITY_PREFIX XATTR_CAPS_SUFFIX
  54
  55 #define XATTR_POSIX_ACL_ACCESS  "posix_acl_access"
  56 #define XATTR_NAME_POSIX_ACL_ACCESS XATTR_SYSTEM_PREFIX XATTR_POSIX_ACL_ACCESS
  57 #define XATTR_POSIX_ACL_DEFAULT  "posix_acl_default"
  58 #define XATTR_NAME_POSIX_ACL_DEFAULT XATTR_SYSTEM_PREFIX XATTR_POSIX_ACL_DEFAULT
  59
  60 #ifdef  __KERNEL__
  61
  62 #include <linux/slab.h>
  63 #include <linux/types.h>
  64 #include <linux/spinlock.h>
  65
  66 struct inode;
  67 struct dentry;
  68
  69 struct xattr_handler {
  70         const char *prefix;
  71         int flags;      /* fs private flags passed back to the handlers */
  72         size_t (*list)(struct dentry *dentry, char *list, size_t list_size,
  73                        const char *name, size_t name_len, int handler_flags);
  74         int (*get)(struct dentry *dentry, const char *name, void *buffer,
  75                    size_t size, int handler_flags);
  76         int (*set)(struct dentry *dentry, const char *name, const void *buffer,
  77                    size_t size, int flags, int handler_flags);
  78 };
  79
  80 struct xattr {
  81         char *name;
  82         void *value;
  83         size_t value_len;
  84 };
  85
  86 ssize_t xattr_getsecurity(struct inode *, const char *, void *, size_t);
  87 ssize_t vfs_getxattr(struct dentry *, const char *, void *, size_t);
  88 ssize_t vfs_listxattr(struct dentry *d, char *list, size_t size);
  89 int __vfs_setxattr_noperm(struct dentry *, const char *, const void *, size_t, int);
  90 int vfs_setxattr(struct dentry *, const char *, const void *, size_t, int);
  91 int vfs_removexattr(struct dentry *, const char *);
  92
  93 ssize_t generic_getxattr(struct dentry *dentry, const char *name, void *buffer, size_t size);
  94 ssize_t generic_listxattr(struct dentry *dentry, char *buffer, size_t buffer_size);
  95 int generic_setxattr(struct dentry *dentry, const char *name, const void *value, size_t size, int flags);
  96 int generic_removexattr(struct dentry *dentry, const char *name);
  97 ssize_t vfs_getxattr_alloc(struct dentry *dentry, const char *name,
  98                            char **xattr_value, size_t size, gfp_t flags);
  99 int vfs_xattr_cmp(struct dentry *dentry, const char *xattr_name,
 100                   const char *value, size_t size, gfp_t flags);
 101
 102 struct simple_xattrs {
 103         struct list_head head;
 104         spinlock_t lock;
 105 };
 106
 107 struct simple_xattr {
 108         struct list_head list;
 109         char *name;
 110         size_t size;
 111         char value[0];
 112 };
 113
 114 /*
 115  * initialize the simple_xattrs structure
 116  */
 117 static inline void simple_xattrs_init(struct simple_xattrs *xattrs)
 118 {
 119         INIT_LIST_HEAD(&xattrs->head);
 120         spin_lock_init(&xattrs->lock);
 121 }
 122
 123 /*
 124  * free all the xattrs
 125  */
 126 static inline void simple_xattrs_free(struct simple_xattrs *xattrs)
 127 {
 128         struct simple_xattr *xattr, *node;
 129
 130         list_for_each_entry_safe(xattr, node, &xattrs->head, list) {
 131                 kfree(xattr->name);
 132                 kfree(xattr);
 133         }
 134 }
 135
 136 struct simple_xattr *simple_xattr_alloc(const void *value, size_t size);
 137 int simple_xattr_get(struct simple_xattrs *xattrs, const char *name,
 138                      void *buffer, size_t size);
 139 int simple_xattr_set(struct simple_xattrs *xattrs, const char *name,
 140                      const void *value, size_t size, int flags);
 141 int simple_xattr_remove(struct simple_xattrs *xattrs, const char *name);
 142 ssize_t simple_xattr_list(struct simple_xattrs *xattrs, char *buffer,
 143                           size_t size);
 144 void simple_xattr_list_add(struct simple_xattrs *xattrs,
 145                            struct simple_xattr *new_xattr);
 146
 147 #endif  /*  __KERNEL__  */
 148
 149 #endif  /* _LINUX_XATTR_H */