usr/src/man/man1/setlabel.1

   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 SETLABEL 1 "Jul 20, 2007"
   7 .SH NAME
   8 setlabel \- move files to zone with corresponding sensitivity label
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/bin/setlabel\fR \fInewlabel\fR \fIfilename\fR...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBsetlabel\fR moves files into the zone whose label corresponds to
  19 \fInewlabel\fR. The old file pathname is adjusted so that it is relative to the
  20 root pathname of the new zone. If the old pathname for a file's parent
  21 directory does not exist as a directory in the new zone, the file is not moved.
  22 Once moved, the file might no longer be accessible in the current zone.
  23 .sp
  24 .LP
  25 Unless \fInewlabel\fR and \fIfilename\fR have been specified, no labels are
  26 set.
  27 .sp
  28 .LP
  29 Labels are defined by the security administrator at your site. The system
  30 always displays labels in uppercase. Users can enter labels in any combination
  31 of uppercase and lowercase. Incremental changes to labels are supported.
  32 .sp
  33 .LP
  34 Refer to \fBsetflabel\fR(3TSOL) for a complete description of the conditions
  35 that are required to satisfy this command, and the privileges that are needed
  36 to execute this command.
  37 .SH EXIT STATUS
  38 .sp
  39 .LP
  40 \fBsetlabel\fR exits with one of the following values:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB0\fR\fR
  45 .ad
  46 .RS 5n
  47 Successful completion.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fB1\fR\fR
  54 .ad
  55 .RS 5n
  56 Usage error.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB2\fR\fR
  63 .ad
  64 .RS 5n
  65 Error in getting, setting or translating the label.
  66 .RE
  67
  68 .SH USAGE
  69 .sp
  70 .LP
  71 On the command line, enclose the label in double quotes unless the label is
  72 only one word. Without quotes, a second word or letter separated by a space is
  73 interpreted as a second argument.
  74 .sp
  75 .in +2
  76 .nf
  77 % \fBsetlabel SECRET \fIsomefile\fR\fR
  78 % \fBsetlabel "TOP SECRET" \fIsomefile\fR\fR
  79 .fi
  80 .in -2
  81 .sp
  82
  83 .sp
  84 .LP
  85 Use any combination of upper and lowercase letters. You can separate items in a
  86 label with blanks, tabs, commas or slashes (\fB/\fR). Do not use any other
  87 punctuation.
  88 .sp
  89 .in +2
  90 .nf
  91 % \fBsetlabel "ts a b" \fIsomefile\fR\fR
  92 % \fBsetlabel "ts,a,b" \fIsomefile\fR\fR
  93 % \fBsetlabel "ts/a b" \fIsomefile\fR\fR
  94 % \fBsetlabel " TOP SECRET A B   " \fIsomefile\fR\fR
  95 .fi
  96 .in -2
  97 .sp
  98
  99 .SH EXAMPLES
 100 .LP
 101 \fBExample 1 \fRSet a Label.
 102 .sp
 103 .LP
 104 To set \fIsomefile\fR's label to \fBSECRET A\fR:
 105
 106 .sp
 107 .in +2
 108 .nf
 109 example% \fBsetlabel "Secret a" \fIsomefile\fR\fR
 110 .fi
 111 .in -2
 112 .sp
 113
 114 .LP
 115 \fBExample 2 \fRTurn On a Compartment.
 116 .sp
 117 .LP
 118 Plus and minus signs can be used to modify an existing label. A plus sign turns
 119 on the specified compartment for \fIsomefile\fR's label.
 120
 121 .sp
 122 .in +2
 123 .nf
 124 example% \fBsetlabel +b \fIsomefile\fR\fR
 125 .fi
 126 .in -2
 127 .sp
 128
 129 .LP
 130 \fBExample 3 \fRTurn Off a Compartment.
 131 .sp
 132 .LP
 133 A minus sign turns off the compartments that are associated with a
 134 classification. To turn off compartment \fBA\fR in \fIsomefile\fR's label:
 135
 136 .sp
 137 .in +2
 138 .nf
 139 example% \fBsetlabel -A \fIsomefile\fR\fR
 140 .fi
 141 .in -2
 142 .sp
 143
 144 .sp
 145 .LP
 146 If an incremental change is being made to an existing label and the first
 147 character of the label is a hyphen (\fB\(mi\fR), a preceding double-hyphen
 148 (\fB--\fR) is required.
 149
 150 .sp
 151 .LP
 152 To turn off compartment \fB-A\fR in \fIsomefile\fR's label:
 153
 154 .sp
 155 .in +2
 156 .nf
 157 example% \fBsetlabel -- -A \fIsomefile\fR\fR
 158 .fi
 159 .in -2
 160 .sp
 161
 162 .SH ATTRIBUTES
 163 .sp
 164 .LP
 165 See \fBattributes\fR(5) for descriptions of the following attributes:
 166 .sp
 167
 168 .sp
 169 .TS
 170 box;
 171 c | c
 172 l | l .
 173 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 174 _
 175 Interface Stability     Committed
 176 .TE
 177
 178 .SH SEE ALSO
 179 .sp
 180 .LP
 181 \fBsetflabel\fR(3TSOL), \fBlabel_encodings\fR(4), \fBattributes\fR(5)
 182 .SH NOTES
 183 .sp
 184 .LP
 185 The functionality described on this manual page is available only if the system
 186 is configured with Trusted Extensions.
 187 .sp
 188 .LP
 189 This implementation of setting a label is meaningful for the Defense
 190 Intelligence Agency (DIA) Mandatory Access Control (MAC) policy. For more
 191 information, see \fBlabel_encodings\fR(4).