usr/src/man/man2/getppriv.2

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GETPPRIV 2 "Sep 10, 2004"
   7 .SH NAME
   8 getppriv, setppriv \- get or set a privilege set
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <priv.h>
  13
  14 \fBint\fR \fBgetppriv\fR(\fBpriv_ptype_t\fR \fIwhich\fR, \fBpriv_set_t *\fR\fIset\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fBsetppriv\fR(\fBpriv_op_t\fR \fIop\fR, \fBpriv_ptype_t\fR \fIwhich\fR, \fBpriv_set_t *\fR\fIset\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBgetppriv()\fR function returns the process privilege set specified by
  26 \fIwhich\fR in the set pointed to by \fIset\fR. The memory for \fIset\fR is
  27 allocated with \fBpriv_allocset()\fR and freed with \fBpriv_freeset()\fR. Both
  28 functions are documented on the \fBpriv_addset\fR(3C) manual page.
  29 .sp
  30 .LP
  31 The \fBsetppriv()\fR function sets or changes the process privilege set. The
  32 \fIop\fR argument specifies the operation and can be one of \fBPRIV_OFF\fR,
  33 \fBPRIV_ON\fR or \fBPRIV_SET\fR. The \fIwhich\fR argument specifies the name of
  34 the privilege set. The \fIset\fR argument specifies the set.
  35 .sp
  36 .LP
  37 If \fIop\fR is \fBPRIV_OFF\fR, the privileges in \fIset\fR are removed from the
  38 process privilege set specified by \fIwhich\fR. There are no restrictions on
  39 removing privileges from process privileges sets, but the following apply:
  40 .RS +4
  41 .TP
  42 .ie t \(bu
  43 .el o
  44 Privileges removed from \fBPRIV_PERMITTED\fR are silently removed from
  45 \fBPRIV_EFFECTIVE\fR.
  46 .RE
  47 .RS +4
  48 .TP
  49 .ie t \(bu
  50 .el o
  51 If privileges are removed from \fBPRIV_LIMIT\fR, they are not removed from the
  52 other sets until one of \fBexec\fR(2) functions has successfully completed.
  53 .RE
  54 .sp
  55 .LP
  56 If \fIop\fR is \fBPRIV_ON\fR, the privileges in \fIset\fR are added to the
  57 process privilege set specified by \fIwhich\fR.  The following operations are
  58 permitted:
  59 .RS +4
  60 .TP
  61 .ie t \(bu
  62 .el o
  63 Privileges in \fBPRIV_PERMITTED\fR can be added to \fBPRIV_EFFECTIVE\fR without
  64 restriction.
  65 .RE
  66 .RS +4
  67 .TP
  68 .ie t \(bu
  69 .el o
  70 Privileges in \fBPRIV_PERMITTED\fR can be added to \fBPRIV_INHERITABLE\fR
  71 without restriction.
  72 .RE
  73 .RS +4
  74 .TP
  75 .ie t \(bu
  76 .el o
  77 All operations that attempt to add privileges that are already present are
  78 permitted.
  79 .RE
  80 .sp
  81 .LP
  82 If \fIop\fR is \fBPRIV_SET\fR, the privileges in \fIset\fR replace completely
  83 the process privilege set specified by \fIwhich\fR. \fBPRIV_SET\fR is
  84 implemented in terms of \fBPRIV_OFF\fR and \fBPRIV_ON\fR. The same restrictions
  85 apply.
  86 .SH RETURN VALUES
  87 .sp
  88 .LP
  89 Upon successful completion, 0 is returned. Otherwise, -1  is returned and
  90 \fBerrno\fR is set to indicate the error.
  91 .SH ERRORS
  92 .sp
  93 .LP
  94 The \fBgetppriv()\fR and \fBsetppriv()\fR functions will fail if:
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBEINVAL\fR\fR
  99 .ad
 100 .RS 10n
 101 The value of \fIop\fR or \fIwhich\fR is out of range.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBEFAULT\fR\fR
 108 .ad
 109 .RS 10n
 110 The \fIset\fR argument points to an illegal address.
 111 .RE
 112
 113 .sp
 114 .LP
 115 The \fBsetppriv()\fR function will fail if:
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBEPERM\fR\fR
 120 .ad
 121 .RS 9n
 122 The application attempted to add privileges to \fBPRIV_LIMIT\fR or
 123 \fBPRIV_PERMITTED\fR, or the application attempted to add privileges to
 124 \fBPRIV_INHERITABLE\fR or \fBPRIV_EFFECTIVE\fR which were not in
 125 \fBPRIV_PERMITTED\fR.
 126 .RE
 127
 128 .SH ATTRIBUTES
 129 .sp
 130 .LP
 131 See \fBattributes\fR(5) for descriptions of the following attributes:
 132 .sp
 133
 134 .sp
 135 .TS
 136 box;
 137 c | c
 138 l | l .
 139 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 140 _
 141 Interface Stability     Evolving
 142 _
 143 MT-Level        MT-Safe
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBpriv_addset\fR(3C), \fBattributes\fR(5), \fBprivileges\fR(5)