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 LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .Fd #include <sys/types.h>
  40 .Fd #include <sys/capability.h>
  41 .Ft int
  42 .Fn cap_set_proc "cap_t cap_p"
  43 .Sh DESCRIPTION
  44 The function
  45 .Fn cap_set_proc
  46 shall set the values for all capability flags for all capabilities defined
  47 in the implementation with the capability state identified by
  48 .Ar cap_p .
  49 The new capability state of the process shall be completely determined by
  50 the contents of
  51 .Ar cap_p
  52 upon successful return from this function.
  53 If any flag in
  54 .Ar cap_p
  55 is set for any capability not currently permitted for the calling process,
  56 the function shall fail, and the capability state of the process shall
  57 remain unchanged.
  58 .Sh IMPLEMENTATION NOTES
  59 .Fx Ns 's
  60 support for POSIX.1e interfaces and features is still under
  61 development at this time.
  62 .Sh RETURN VALUES
  63 Upon successful completion, this function shall return a value of zero.
  64 Otherwise, a value of -1 shall be returned and
  65 .Ar errno
  66 shall be set to indicate the error.
  67 Neither the state represented in the object identified by
  68 .Ar cap_p
  69 nor the capability state of the calling process shall be affected if the
  70 return value is -1.
  71 .Sh ERRORS
  72 If any of the following conditions occur, the
  73 .Fn cap_set_proc
  74 function shall return -1 and set
  75 .Ar errno
  76 to the corresponding value:
  77 .Bl -tag -width Er
  78 .It Bq Er EINVAL
  79 The value of the
  80 .Ar cap_p
  81 argument does not refer to a capability state in working storage.
  82 .It Bq Er EPERM
  83 The caller attempted to set a capability flag of a capability that was not
  84 permitted to the invoking process.
  85 .It Bq Er ENOMEM
  86 This function requires more memory than is allowed by the hardware or
  87 system-imposed memory management constraints.
  88 .El
  89 .Sh SEE ALSO
  90 .Xr cap 3 ,
  91 .Xr cap_get_proc 3 ,
  92 .Xr posix1e 3
  93 .Sh STANDARDS
  94 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  95 of the draft continues on the cross-platform POSIX.1e implementation
  96 mailing list.  To join this list, see the
  97 .Fx
  98 POSIX.1e implementation
  99 page for more information.
 100 .Sh HISTORY
 101 Support for POSIX.1e Capabilities was developed as part of the TrustedBSD
 102 Project.
 103 POSIX.1e Capability support was introduced in
 104 .Fx 5.0 ,
 105 and development continues.
 106 .Sh AUTHORS
 107 .An Robert N M Watson
 108 .Sh BUGS
 109 While libposix1e is fully implemented, supporting kernel code is not
 110 yet available in the base distribution.
 111 It is slated for inclusion prior to 5.0-RELEASE.