archive_acl_private.h revision 358088 
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 ARCHIVE_ACL_PRIVATE_H_INCLUDED
29#define ARCHIVE_ACL_PRIVATE_H_INCLUDED
30
31#ifndef __LIBARCHIVE_BUILD
32#error This header is only to be used internally to libarchive.
33#endif
34
35#include "archive_string.h"
36
37struct 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
46struct 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
56void archive_acl_clear(struct archive_acl *);
57void archive_acl_copy(struct archive_acl *, struct archive_acl *);
58int archive_acl_count(struct archive_acl *, int);
59int archive_acl_types(struct archive_acl *);
60int archive_acl_reset(struct archive_acl *, int);
61int archive_acl_next(struct archive *, struct archive_acl *, int,
62    int *, int *, int *, int *, const char **);
63
64int archive_acl_add_entry(struct archive_acl *, int, int, int, int, const char *);
65int archive_acl_add_entry_w_len(struct archive_acl *,
66    int, int, int, int, const wchar_t *, size_t);
67int archive_acl_add_entry_len(struct archive_acl *,
68    int, int, int, int, const char *, size_t);
69
70wchar_t *archive_acl_to_text_w(struct archive_acl *, ssize_t *, int,
71    struct archive *);
72char *archive_acl_to_text_l(struct archive_acl *, ssize_t *, int,
73    struct archive_string_conv *);
74
75/*
76 * ACL text parser.
77 */
78int archive_acl_from_text_w(struct archive_acl *, const wchar_t * /* wtext */,
79    int /* type */);
80int archive_acl_from_text_l(struct archive_acl *, const char * /* text */,
81    int /* type */, struct archive_string_conv *);
82
83#endif /* ARCHIVE_ENTRY_PRIVATE_H_INCLUDED */
84