summaryrefslogtreecommitdiffstats
path: root/lib/libc/posix1e/cap_get_proc.3
diff options
context:
space:
mode:
authorrwatson <rwatson@FreeBSD.org>2000-06-04 21:15:16 +0000
committerrwatson <rwatson@FreeBSD.org>2000-06-04 21:15:16 +0000
commit9f516a06e7c6f525411dce748e4dafa561368c02 (patch)
tree980a9470e933ccb2a79e7e1d8a8f646fb1c4973d /lib/libc/posix1e/cap_get_proc.3
parenta88c20a2394d023b211e87002e1c7fd00d8442ef (diff)
downloadFreeBSD-src-9f516a06e7c6f525411dce748e4dafa561368c02.zip
FreeBSD-src-9f516a06e7c6f525411dce748e4dafa561368c02.tar.gz
o Introduce man pages for POSIX.1e capability API
- cap.3 describing library interface - cap_*.3 describing specific API calls APIs to follow relatively soon, code to follow later. Obtained from: TrustedBSD Project
Diffstat (limited to 'lib/libc/posix1e/cap_get_proc.3')
-rw-r--r--lib/libc/posix1e/cap_get_proc.399
1 files changed, 99 insertions, 0 deletions
diff --git a/lib/libc/posix1e/cap_get_proc.3 b/lib/libc/posix1e/cap_get_proc.3
new file mode 100644
index 0000000..d3dd896
--- /dev/null
+++ b/lib/libc/posix1e/cap_get_proc.3
@@ -0,0 +1,99 @@
+.\"-
+.\" Copyright (c) 2000 Robert N. M. Watson
+.\" 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.
+.\"
+.\" $FreeBSD$
+.\"
+.\" TrustedBSD Project - support for POSIX.1e process capabilities
+.\"
+.Dd April 1, 2000
+.Dt CAP_GET_PROC 3
+.Os FreeBSD 5.0
+.Sh NAME
+.Nm cap_get_proc
+.Nd Obtain the Current Process Capability State
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/capability.h>
+.Ft cap_t
+.Fn cap_get_proc "void"
+.Sh DESCRIPTION
+The function
+.Fn cap_get_proc
+shall allocate a capability state in working storage, set its state to that
+of the calling process, and return a pointer to the newly created
+capability state.
+.Pp
+This function may cause memory to be allocated.
+The caller should free any releasable memory, when the capability state in
+the working storage is no longer required, by calling
+.Fn cap_free
+with the cap_t as an argument.
+.Sh IMPLEMENTATION NOTES
+FreeBSD's support for POSIX.1e interfaces and features is still under
+development at this time.
+.Sh RETURN VALUES
+Upon successful completion, this function shall return a cap_t value.
+Otherwise, a value of
+.Va (cap_t)NULL
+shall be returned and
+.Va errno
+shall be set to indicate the error.
+.Sh ERRORS
+If any of the following conditions occur, the
+.Fn cap_get_proc
+function shall return
+.Va (cap_t)NULL
+and set
+.Va errno
+to the corresponding value:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+The capability state to be returned requires more memory than is allowed
+by the hardware or system-imposed memory management constrains.
+.El
+.Sh SEE ALSO
+.Xr cap 3 ,
+.Xr cap_free 3 ,
+.Xr cap_init 3 ,
+.Xr cap_get_flag 3 ,
+.Xr cap_set_proc 3 ,
+.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
+Support for POSIX.1e Capabilities was developed as part of the TrustedBSD
+Project.
+POSIX.1e Capability support was introduced in
+.Fx 5.0 ,
+and development continues.
+.Sh AUTHORS
+.An Robert N M Watson
+.Sh BUGS
+These features are not yet fully implemented.
OpenPOWER on IntegriCloud