Differential D28255 Diff 93996 lib/libc/posix1e/acl_extended_file_np.3

Changeset View

Standalone View

lib/libc/posix1e/acl_extended_file_np.3

This file was added.

				.\"-
				.\" Copyright (c) 2021 Gleb Popov
				.\" All rights reserved.
				.\"
				.\" Redistribution and use in source and binary forms, with or without
				.\" modification, are permitted provided that the following conditions
				.\" are met:
				.\" 1. Redistributions of source code must retain the above copyright
				.\" notice, this list of conditions and the following disclaimer.
				.\" 2. Redistributions in binary form must reproduce the above copyright
				.\" notice, this list of conditions and the following disclaimer in the
				.\" documentation and/or other materials provided with the distribution.
				.\"
				.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
				.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
				.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
				.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
				.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
				.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
				.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
				.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
				.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
				.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
				.\" SUCH DAMAGE.
				.\"
				.Dd February 26, 2021
				.Dt ACL_EXTENDED_FILE_NP 3
				.Os
				.Sh NAME
				.Nm acl_extended_file_np ,
				.Nm acl_extended_file_nofollow_np ,
				.Nm acl_extended_link_np
				.Nd checks if the file has extended ACLs set
				.Sh LIBRARY
				.Lb libc
				.Sh SYNOPSIS
				.In sys/types.h
				.In sys/acl.h
				.Ft int
				.Fn acl_extended_file_np "const char* path_p"
				.Ft int
				.Fn acl_extended_file_nofollow_np "const char* path_p"
				.Ft int
				.Fn acl_extended_link_np "const char* path_p"
				.Sh DESCRIPTION
				The
				.Fn acl_extended_file_np
				function is a non-portable call that checks if the file or directory referred to
				by the argument
				.Va path_p
				contains extended access ACLs. The
				.Fn acl_extended_file_nofollow_np
				function works the same way, except it does not follow symlinks. The
				.Fn acl_extended_link_np
				function is a synonim to
				.Fn acl_extended_file_nofollow_np
				named in FreeBSD style.
				An ACL is considered to be extended access one if it contains entries other
				than the three required entries of tag types ACL_USER_OBJ, ACL_GROUP_OBJ and
				ACL_OTHER.
				.Sh RETURN VALUES
				Upon successful completion, this function returns 0 if the file object does not
				contain extended access ACLs and 1 in the other case.
				Otherwise, the value -1 is returned, and
				.Va errno
				indicates the error.
				.Sh ERRORS
				If any of the following conditions occur, the
				.Fn acl_extended_file_np
				function shall return a value of
				.Va -1
				and set
				.Va errno
				to the corresponding value:
				.Bl -tag -width Er
				.It Bq Er EACCES
				Search permission is denied for a component of the path prefix.
				.Sh SEE ALSO
				.Xr extattr_get_file 2 ,
				.Xr posix1e 3
				.Sh STANDARDS
				POSIX.1e is described in IEEE POSIX.1e draft 17.
				Discussion
				of the draft continues on the cross-platform POSIX.1e implementation
				mailing list.
				To join this list, see the
				.Fx
				POSIX.1e implementation
				page for more information.
				.Sh HISTORY
				POSIX.1e support was introduced in
				.Fx 4.0 ,
				and development continues.
				.Sh AUTHORS
				.An Gleb Popov