contrib/libarchive/libarchive/archive_acl_private.h

   1 /*-
   2  * Copyright (c) 2003-2010 Tim Kientzle
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 #ifndef __LIBARCHIVE_BUILD
  29 #error This header is only to be used internally to libarchive.
  30 #endif
  31
  32 #ifndef ARCHIVE_ACL_PRIVATE_H_INCLUDED
  33 #define ARCHIVE_ACL_PRIVATE_H_INCLUDED
  34
  35 #include "archive_string.h"
  36
  37 struct archive_acl_entry {
  38         struct archive_acl_entry *next;
  39         int     type;                   /* E.g., access or default */
  40         int     tag;                    /* E.g., user/group/other/mask */
  41         int     permset;                /* r/w/x bits */
  42         int     id;                     /* uid/gid for user/group */
  43         struct archive_mstring name;            /* uname/gname */
  44 };
  45
  46 struct archive_acl {
  47         mode_t          mode;
  48         struct archive_acl_entry        *acl_head;
  49         struct archive_acl_entry        *acl_p;
  50         int              acl_state;     /* See acl_next for details. */
  51         wchar_t         *acl_text_w;
  52         char            *acl_text;
  53         int              acl_types;
  54 };
  55
  56 void archive_acl_clear(struct archive_acl *);
  57 void archive_acl_copy(struct archive_acl *, struct archive_acl *);
  58 int archive_acl_count(struct archive_acl *, int);
  59 int archive_acl_reset(struct archive_acl *, int);
  60 int archive_acl_next(struct archive *, struct archive_acl *, int,
  61     int *, int *, int *, int *, const char **);
  62
  63 int archive_acl_add_entry(struct archive_acl *, int, int, int, int, const char *);
  64 int archive_acl_add_entry_w_len(struct archive_acl *,
  65     int, int, int, int, const wchar_t *, size_t);
  66 int archive_acl_add_entry_len(struct archive_acl *,
  67     int, int, int, int, const char *, size_t);
  68
  69 const wchar_t *archive_acl_text_w(struct archive *, struct archive_acl *, int);
  70 int archive_acl_text_l(struct archive_acl *, int, const char **, size_t *,
  71     struct archive_string_conv *);
  72
  73 /*
  74  * Private ACL parser.  This is private because it handles some
  75  * very weird formats that clients should not be messing with.
  76  * Clients should only deal with their platform-native formats.
  77  * Because of the need to support many formats cleanly, new arguments
  78  * are likely to get added on a regular basis.  Clients who try to use
  79  * this interface are likely to be surprised when it changes.
  80  */
  81 int archive_acl_parse_w(struct archive_acl *,
  82                     const wchar_t *, int /* type */);
  83 int archive_acl_parse_l(struct archive_acl *,
  84                     const char *, int /* type */,
  85                     struct archive_string_conv *);
  86
  87 #endif /* ARCHIVE_ENTRY_PRIVATE_H_INCLUDED */