usr/src/man/man5/device_clean.5

   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 DEVICE_CLEAN 5 "Jun 14, 2007"
   7 .SH NAME
   8 device_clean \- device clean programs
   9 .SH DESCRIPTION
  10 .sp
  11 .LP
  12 Each allocatable device has a device clean program associated with it. Device
  13 clean programs are invoked by \fBdeallocate\fR(1) to clean device states,
  14 registers, and any residual information in the device before the device is
  15 allocated to a user. Such cleaning is required by the object reuse policy.
  16 .sp
  17 .LP
  18 Use \fBlist_devices\fR(1) to obtain the names and types of allocatable devices
  19 as well as the cleaning program and the authorizations that are associated with
  20 each device.
  21 .sp
  22 .LP
  23 On a system configured with Trusted Extensions, device clean programs are also
  24 invoked by \fBallocate\fR(1), in which case the program can optionally mount
  25 appropriate media for the caller.
  26 .sp
  27 .LP
  28 The following device clean programs reside in \fB/etc/security/lib\fR.
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fBaudio_clean\fR\fR
  33 .ad
  34 .RS 15n
  35 audio devices
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBfd_clean\fR\fR
  42 .ad
  43 .RS 15n
  44 floppy devices
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBst_clean\fR\fR
  51 .ad
  52 .RS 15n
  53 tape devices
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBsr_clean\fR\fR
  60 .ad
  61 .RS 15n
  62 CD-ROM devices
  63 .RE
  64
  65 .sp
  66 .LP
  67 On a system configured with Trusted Extensions, the following additional
  68 cleaning programs and wrappers are available.
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBdisk_clean\fR\fR
  73 .ad
  74 .RS 23n
  75 floppy, CD-ROM, and other removable media devices. This program mounts the
  76 device during the execution of \fBallocate\fR, if required.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBaudio_clean_wrapper\fR\fR
  83 .ad
  84 .RS 23n
  85 wrapper to make audio_clean work with CDE
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBwdwwrapper\fR\fR
  92 .ad
  93 .RS 23n
  94 wrapper to make other cleaning programs work with CDE
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBwdwmsg\fR\fR
 101 .ad
 102 .RS 23n
 103 CDE dialog boxes for cleaning programs
 104 .RE
 105
 106 .sp
 107 .LP
 108 Administrators can create device clean programs for their sites. These programs
 109 must adhere to the syntax described below.
 110 .sp
 111 .in +2
 112 .nf
 113 /etc/security/lib/\fIdevice-clean-program\fR [\(mii | \(mif | \(mis | \(miI] \e
 114 \(mim \fImode\fR \(miu \fIuser-name\fR \(miz \fIzone-name\fR \(mip \fIzone-path\fR \fIdevice-name\fR
 115 .fi
 116 .in -2
 117 .sp
 118
 119 .sp
 120 .LP
 121 where:
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fIdevice-name\fR\fR
 126 .ad
 127 .RS 15n
 128 The name of the device that is to be cleaned. Use \fBlist_devices\fR to obtain
 129 the list of allocatable devices.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fB-i\fR\fR
 136 .ad
 137 .RS 15n
 138 Invoke boot-time initialization.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB-f\fR\fR
 145 .ad
 146 .RS 15n
 147 Force cleanup by the administrator.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fB-s\fR\fR
 154 .ad
 155 .RS 15n
 156 Invoke standard cleanup by the user.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fB-I\fR\fR
 163 .ad
 164 .RS 15n
 165 Same as \fB-i\fR, with no error or warning.
 166 .RE
 167
 168 .sp
 169 .LP
 170 The following options are supported only when the system is configured with
 171 Trusted Extensions.
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fB-m\fR \fImode\fR\fR
 176 .ad
 177 .RS 16n
 178 Specify the mode in which the clean program is invoked. Valid values are allo-
 179 cate and deallocate. The default mode is allocate.
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fB-u\fR \fIuser-name\fR\fR
 186 .ad
 187 .RS 16n
 188 Specify the name of user who executes the device clean program. The default
 189 user is the caller.
 190 .RE
 191
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fB-z\fR \fIzone-name\fR\fR
 196 .ad
 197 .RS 16n
 198 Specify the name of the zone in which the device is to be allocated or
 199 deallocated. The default zone is the global zone.
 200 .RE
 201
 202 .sp
 203 .ne 2
 204 .na
 205 \fB\fB-p\fR \fIzone-path\fR\fR
 206 .ad
 207 .RS 16n
 208 Establish the root path of the zone that is specified by \fIzone-name\fR.
 209 Default is "/".
 210 .RE
 211
 212 .SH EXIT STATUS
 213 .sp
 214 .LP
 215 The following exit values are returned:
 216 .sp
 217 .ne 2
 218 .na
 219 \fB\fB0\fR\fR
 220 .ad
 221 .sp .6
 222 .RS 4n
 223 Successful completion.
 224 .RE
 225
 226 .sp
 227 .ne 2
 228 .na
 229 \fB\fB1\fR\fR
 230 .ad
 231 .sp .6
 232 .RS 4n
 233 An error. Caller can place device in error state.
 234 .RE
 235
 236 .sp
 237 .ne 2
 238 .na
 239 \fB\fB2\fR\fR
 240 .ad
 241 .sp .6
 242 .RS 4n
 243 A system error. Caller can place device in error state.
 244 .RE
 245
 246 .sp
 247 .LP
 248 On a system configured with Trusted Extensions, the following additional exit
 249 values are returned:
 250 .sp
 251 .ne 2
 252 .na
 253 \fB\fB3\fR\fR
 254 .ad
 255 .sp .6
 256 .RS 4n
 257 Mounting of device failed. Caller shall not place device in error state.
 258 .RE
 259
 260 .sp
 261 .ne 2
 262 .na
 263 \fB\fB4\fR\fR
 264 .ad
 265 .sp .6
 266 .RS 4n
 267 Mounting of device succeeded.
 268 .RE
 269
 270 .SH FILES
 271 .sp
 272 .ne 2
 273 .na
 274 \fB\fB/etc/security/lib/*\fR\fR
 275 .ad
 276 .RS 23n
 277 device clean programs
 278 .RE
 279
 280 .SH ATTRIBUTES
 281 .sp
 282 .LP
 283 See \fBattributes\fR(5)  for descriptions of the following attributes:
 284 .sp
 285
 286 .sp
 287 .TS
 288 box;
 289 c | c
 290 l | l .
 291 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 292 _
 293 Interface Stability     See below.
 294 .TE
 295
 296 .sp
 297 .LP
 298 The Invocation is Uncommitted. The Output is Not-an-interface.
 299 .SH SEE ALSO
 300 .sp
 301 .LP
 302 \fBallocate\fR(1), \fBdeallocate\fR(1), \fBlist_devices\fR(1),
 303 \fBattributes\fR(5)
 304 .sp
 305 .LP
 306 \fISystem Administration Guide: Security Services\fR