lib/libc/posix1e/cap_set_proc.3

   1 .\"-
   2 .\" Copyright (c) 2000 Robert N. M. Watson
   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 AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .\" TrustedBSD Project - support for POSIX.1e process capabilities
  29 .\"
  30 .Dd April 1, 2000
  31 .Dt CAP_SET_PROC 3
  32 .Os FreeBSD
  33 .Sh NAME
  34 .Nm cap_set_proc
  35 .Nd Set the Process Capability State
  36 .Sh SYNOPSIS
  37 .Fd #include <sys/types.h>
  38 .Fd #include <sys/capability.h>
  39 .Ft int
  40 .Fn cap_set_proc "cap_t cap_p"
  41 .Sh DESCRIPTION
  42 The function
  43 .Fn cap_set_proc
  44 shall set the values for all capability flags for all capabilities defined
  45 in the implementation with the capability state identified by
  46 .Ar cap_p .
  47 The new capability state of the process shall be completely determined by
  48 the contents of
  49 .Ar cap_p
  50 upon successful return from this function.
  51 If any flag in
  52 .Ar cap_p
  53 is set for any capability not currently permitted for the calling process,
  54 the function shall fail, and the capability state of the process shall
  55 remain unchanged.
  56 .Sh IMPLEMENTATION NOTES
  57 FreeBSD's support for POSIX.1e interfaces and features is still under
  58 development at this time.
  59 .Sh RETURN VALUES
  60 Upon successful completion, this function shall return a value of zero.
  61 Otherwise, a value of -1 shall be returned and
  62 .Ar errno
  63 shall be set to indicate the error.
  64 Neither the state represented in the object identified by
  65 .Ar cap_p
  66 nor the capability state of the calling process shall be affected if the
  67 return value is -1.
  68 .Sh ERRORS
  69 If any of the following conditions occur, the
  70 .Fn cap_set_proc
  71 function shall return -1 and set
  72 .Ar errno
  73 to the corresponding value:
  74 .Bl -tag -width Er
  75 .It Bq Er EINVAL
  76 The value of the
  77 .Ar cap_p
  78 argument does not refer to a capability state in working storage.
  79 .It Bq Er EPERM
  80 The caller attempted to set a capability flag of a capability that was not
  81 permitted to the invoking process.
  82 .It Bq Er ENOMEM
  83 This function requires more memory than is allowed by the hardware or
  84 system-imposed memory management constraints.
  85 .El
  86 .Sh SEE ALSO
  87 .Xr cap 3 ,
  88 .Xr cap_get_proc 3 ,
  89 .Xr posix1e 3
  90 .Sh STANDARDS
  91 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  92 of the draft continues on the cross-platform POSIX.1e implementation
  93 mailing list.  To join this list, see the
  94 .Fx
  95 POSIX.1e implementation
  96 page for more information.
  97 .Sh HISTORY
  98 Support for POSIX.1e Capabilities was developed as part of the TrustedBSD
  99 Project.
 100 POSIX.1e Capability support was introduced in
 101 .Fx 5.0 ,
 102 and development continues.
 103 .Sh AUTHORS
 104 .An Robert N M Watson
 105 .Sh BUGS
 106 While libposix1e is fully implemented, supporting kernel code is not
 107 yet available in the base distribution.
 108 It is slated for inclusion prior to 5.0-RELEASE.