d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6c412638de
freebsd-dev/lib/libc/posix1e/cap_copy_int.3

97 lines
2.9 KiB
Groff
Raw Normal View History

Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.\"-
.\" Copyright (c) 2000 Robert N. M. Watson
.\" Copyright (c) 2001 Thomas Moestl
.\" 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
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.\" SUCH DAMAGE.
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.\"
.\" $FreeBSD$
.\"
.Dd March 21, 2001
.Dt CAP_COPY_INT 3
.Os
.Sh NAME
.Nm cap_copy_int
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Nd convert an external capability representation to a capability state in
working storage
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.In sys/types.h
.In sys/capability.h
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Ft cap_t
Fixed missing `const' in synopsis.
2001-10-03 16:29:21 +00:00
.Fn cap_copy_int "const void *ext_p"
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Sh DESCRIPTION
The
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Fn cap_copy_int
function converts an external capability representation (as returned by
.Xr cap_copy_ext 3 )
in the buffer pointed to by
.Fa ext_p
to a handle to a capability state in working storage.
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Pp
This function may cause memory to be allocated.
The caller should free any releasable memory, when the capability state
in working memory is no longer required, by calling
.Xr cap_free 3
with the
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Vt cap_t
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
as an argument.
.Sh RETURN VALUES
Upon successful completion, the
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Fn cap_copy_int
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
function returns a handle to a capability state in working storage.
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
Otherwise,
.Dv NULL
is returned and the global variable
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Va errno
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
is set to indicate the error.
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Sh ERRORS
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Fn cap_copy_int
fails if:
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Bl -tag -width Er
.It Bq Er EINVAL
The
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Fa ext_p
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
does not refer to an external representation as returned by
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Xr cap_copy_ext 3 .
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.It Bq Er ENOMEM
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
The allocation of memory to hold the capability state
has failed.
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.El
.Sh SEE ALSO
.Xr cap_copy_int 3 ,
.Xr cap_free 3 ,
.Xr cap_from_text 3 ,
.Xr cap_get_flag 3 ,
.Xr cap_to_text 3 ,
.Xr posix1e 3
.Sh STANDARDS
This function is expected to conform to the withdrawn
IEEE draft 1003.1e
mdoc(7) police: markup and minor content fixes. o Removed whitespace at EOL o Removed hard sentence breaks o Added cap_size() to the NAME section o Normalized .Nd descriptions o Fixed the abuses of .Nm and .Va o Fixed some DESCRIPTION texts o Fixed the RETURN VALUES and ERRORS texts to look more traditional Reviewed by: tmm
2001-09-05 14:09:08 +00:00
.Pq Dq POSIX.1e .
Introduce implementations of POSIX.1e non-portable form capability support functions: cap_subset_np() - Is cap1 a subset of cap2 cap_equal_np() - Is cap1 equal to cap2 o Introduce implementations of POSIX.1e capability support functions: cap_copy_ext() - Externalize capability cap_copy_int() - Internalize capability cap_size() - Determine size required for cap_copy_ext() Submitted by: tmm Obtained from: TrustedBSD Project
2001-08-31 02:07:48 +00:00
.Sh HISTORY
This function first appeared in
.Fx 5.0 .
.Sh AUTHORS
.An Thomas Moestl Aq tmm@FreeBSD.org
Reference in New Issue Copy Permalink