xref: /freebsd/lib/libc/posix1e/acl_support.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1999, 2000, 2001 Robert N. M. Watson
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 /*
31  * Support functionality for the POSIX.1e ACL interface
32  * These calls are intended only to be called within the library.
33  */
34 #ifndef _ACL_SUPPORT_H
35 #define _ACL_SUPPORT_H
36 
37 #define _POSIX1E_ACL_STRING_PERM_MAXSIZE 3       /* read, write, exec */
38 #define _ACL_T_ALIGNMENT_BITS		13
39 
40 int	_acl_type_unold(acl_type_t type);
41 int	_acl_differs(const acl_t a, const acl_t b);
42 int	_acl_type_not_valid_for_acl(const acl_t acl, acl_type_t type);
43 void	_acl_brand_from_type(acl_t acl, acl_type_t type);
44 int	_acl_brand(const acl_t acl);
45 int	_entry_brand(const acl_entry_t entry);
46 int	_acl_brand_may_be(const acl_t acl, int brand);
47 int	_entry_brand_may_be(const acl_entry_t entry, int brand);
48 void	_acl_brand_as(acl_t acl, int brand);
49 void	_entry_brand_as(const acl_entry_t entry, int brand);
50 int	_nfs4_acl_entry_from_text(acl_t, char *);
51 char	*_nfs4_acl_to_text_np(const acl_t, ssize_t *, int);
52 int	_nfs4_format_flags(char *str, size_t size, acl_flag_t var, int verbose);
53 int	_nfs4_format_access_mask(char *str, size_t size, acl_perm_t var, int verbose);
54 int	_nfs4_parse_flags(const char *str, acl_flag_t *var);
55 int	_nfs4_parse_access_mask(const char *str, acl_perm_t *var);
56 int	_posix1e_acl_check(acl_t acl);
57 void	_posix1e_acl_sort(acl_t acl);
58 int	_posix1e_acl(acl_t acl, acl_type_t type);
59 int	_posix1e_acl_id_to_name(acl_tag_t tag, uid_t id, ssize_t buf_len,
60 	    char *buf, int flags);
61 int	_posix1e_acl_perm_to_string(acl_perm_t perm, ssize_t buf_len,
62 	    char *buf);
63 int	_posix1e_acl_string_to_perm(char *string, acl_perm_t *perm);
64 int	_posix1e_acl_add_entry(acl_t acl, acl_tag_t tag, uid_t id,
65 	    acl_perm_t perm);
66 char	*string_skip_whitespace(char *string);
67 void	string_trim_trailing_whitespace(char *string);
68 int	_acl_name_to_id(acl_tag_t tag, char *name, uid_t *id);
69 
70 #endif
71