usr/src/man/man3tsol/setflabel.3tsol

   1 '\" te
   2 .\" Copyright (c) 2007, 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 SETFLABEL 3TSOL "Jul 20, 2007"
   7 .SH NAME
   8 setflabel \- move file to zone with corresponding sensitivity label
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [\fIflag\fR...] \fIfile\fR... \fB-ltsol\fR [\fIlibrary\fR...]
  13 .fi
  14
  15 .LP
  16 .nf
  17 #include <tsol/label.h>
  18
  19 \fBint\fR \fBsetflabel\fR(\fBconst char *\fR\fIpath\fR, \fBconst m_label_t *\fR\fIlabel_p\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The file that is named by \fIpath\fR is relabeled by moving it to a new
  26 pathname relative to the root directory of the zone corresponding to
  27 \fIlabel_p\fR. If the source and destination file systems are loopback mounted
  28 from the same underlying file system, the file is renamed. Otherwise, the file
  29 is copied and removed from the source directory.
  30 .sp
  31 .LP
  32 The \fBsetflabel()\fR function enforces the following policy checks:
  33 .RS +4
  34 .TP
  35 .ie t \(bu
  36 .el o
  37 If the sensitivity label of \fIlabel_p\fR equals the existing sensitivity
  38 label, then the file is not moved.
  39 .RE
  40 .RS +4
  41 .TP
  42 .ie t \(bu
  43 .el o
  44 If the corresponding directory does not exist in the destination zone, or if
  45 the directory exists, but has a different label than \fIlabel_p\fR, the file is
  46 not moved. Also, if the file already exists in the destination directory, the
  47 file is not moved.
  48 .RE
  49 .RS +4
  50 .TP
  51 .ie t \(bu
  52 .el o
  53 If the sensitivity label of the existing file is not equal to the calling
  54 process label and the caller is not in the global zone, then the file is not
  55 moved. If the caller is in the global zone, the existing file label must be in
  56 a labeled zone (not \fBADMIN_LOW\fR or \fBADMIN_HIGH\fR).
  57 .RE
  58 .RS +4
  59 .TP
  60 .ie t \(bu
  61 .el o
  62 If the calling process does not have write access to both the source and
  63 destination directories, then the calling process must have
  64 \fBPRIV_FILE_DAC_WRITE\fR in its set of effective privileges.
  65 .RE
  66 .RS +4
  67 .TP
  68 .ie t \(bu
  69 .el o
  70 If the sensitivity label of \fIlabel_p\fR provides read only access to the
  71 existing sensitivity label (an upgrade), then the user must have the
  72 \fBsolaris.label.file.upgrade\fR authorization. In addition, if the current
  73 zone is a labeled zone, then it must have been assigned the privilege
  74 \fBPRIV_FILE_UPGRADE_SL\fR when the zone was configured.
  75 .RE
  76 .RS +4
  77 .TP
  78 .ie t \(bu
  79 .el o
  80 If the sensitivity label of \fIlabel_p\fR does not provide access to the
  81 existing sensitivity label (a downgrade), then the calling user must have the
  82 \fBsolaris.label.file.downgrade\fR authorization. In addition, if the current
  83 zone is a labeled zone, then it must have been assigned the privilege
  84 \fBPRIV_FILE_DOWNGRADE_SL\fR when the zone was configured.
  85 .RE
  86 .RS +4
  87 .TP
  88 .ie t \(bu
  89 .el o
  90 If the calling process is not in the global zone, and the user does not have
  91 the \fBsolaris.label.range\fR authorization, then \fIlabel_p\fR must be within
  92 the user's label range and within the system accreditation range.
  93 .RE
  94 .RS +4
  95 .TP
  96 .ie t \(bu
  97 .el o
  98 If the existing file is in use (not tranquil) it is not moved. This tranquility
  99 check does not cover race conditions nor remote file access.
 100 .RE
 101 .sp
 102 .LP
 103 Additional policy constraints can be implemented by customizing the shell
 104 script \fB/etc/security/tsol/relabel\fR. See the comments in this file.
 105 .SH RETURN VALUES
 106 .sp
 107 .LP
 108 Upon successful completion, \fBsetflabel()\fR returns 0. Otherwise it returns
 109 -1 and sets \fIerrno\fR to indicate the error.
 110 .SH ERRORS
 111 .sp
 112 .LP
 113 The \fBsetflabel()\fR function fails and the file is unchanged if:
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEACCES\fR\fR
 118 .ad
 119 .RS 16n
 120 Search permission is denied for a component of the path prefix of \fIpath\fR.
 121 .sp
 122 The calling process does not have mandatory write access to the final component
 123 of path because the sensitivity label of the final component of path does not
 124 dominate the sensitivity label of the calling  process and the calling process
 125 does not have \fBPRIV_FILE_MAC_WRITE\fR in its set of effective privileges.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBEBUSY\fR\fR
 132 .ad
 133 .RS 16n
 134 There is an open file descriptor reference to the final component of
 135 \fIpath\fR.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBECONNREFUSED\fR\fR
 142 .ad
 143 .RS 16n
 144 A connection to the label daemon could not be established.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBEEXIST\fR\fR
 151 .ad
 152 .RS 16n
 153 A file with the same name exists in the destination directory.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBEINVAL\fR\fR
 160 .ad
 161 .RS 16n
 162 Improper parameters were received by the label daemon.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBEISDIR\fR\fR
 169 .ad
 170 .RS 16n
 171 The existing file is a directory.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fBELOOP\fR\fR
 178 .ad
 179 .RS 16n
 180 Too many symbolic links were encountered in translating \fIpath\fR.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fBEMLINK\fR\fR
 187 .ad
 188 .RS 16n
 189 The existing file is hardlinked to another file.
 190 .RE
 191
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fBENAMETOOLONG\fR\fR
 196 .ad
 197 .RS 16n
 198 The length of the path argument exceeds \fIPATH_MAX\fR.
 199 .RE
 200
 201 .sp
 202 .ne 2
 203 .na
 204 \fB\fBENOENT\fR\fR
 205 .ad
 206 .RS 16n
 207 The file referred to by \fIpath\fR does not exist.
 208 .RE
 209
 210 .sp
 211 .ne 2
 212 .na
 213 \fB\fBEROFS\fR\fR
 214 .ad
 215 .RS 16n
 216 The file system is read-only or its label is \fBADMIN_LOW\fR or
 217 \fBADMIN_HIGH\fR.
 218 .RE
 219
 220 .SH ATTRIBUTES
 221 .sp
 222 .LP
 223 See \fBattributes\fR(5) for descriptions of the following attributes:
 224 .sp
 225
 226 .sp
 227 .TS
 228 box;
 229 c | c
 230 l | l .
 231 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 232 _
 233 Interface Stability     Committed
 234 _
 235 MT-Level        MT-Safe
 236 .TE
 237
 238 .SH SEE ALSO
 239 .sp
 240 .LP
 241 \fBlibtsol\fR(3LIB), \fBattributes\fR(5)
 242 .sp
 243 .LP
 244 \fISetting a File Sensitivity Label\fR in \fISolaris Trusted Extensions
 245 Developer\&'s Guide\fR
 246 .SH NOTES
 247 .sp
 248 .LP
 249 The functionality described on this manual page is available only if the system
 250 is configured with Trusted Extensions.