usr/src/man/man4/device_allocate.4

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.
   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_ALLOCATE 4 "Mar 6, 2017"
   7 .SH NAME
   8 device_allocate \- device_allocate file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/etc/security/device_allocate\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .LP
  17 The \fBdevice_allocate\fR file is an \fBASCII\fR file that resides in the
  18 \fB/etc/security\fR directory. It contains mandatory access control information
  19 about each physical device. Each device is represented by a one- line entry of
  20 the form:
  21 .sp
  22 .LP
  23 \fIdevice-name\fR;\fIdevice-type\fR;reserved1;reserved2;\fIauths\fR;\fIdevice-e
  24 xec\fR
  25 .sp
  26 .LP
  27 where:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIdevice-name\fR\fR
  32 .ad
  33 .sp .6
  34 .RS 4n
  35 Represents an arbitrary \fBASCII\fR string naming the physical device. This
  36 field contains no embedded white space or non-printable characters.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIdevice-type\fR\fR
  43 .ad
  44 .sp .6
  45 .RS 4n
  46 Represents an arbitrary \fBASCII\fR string naming the generic device type. This
  47 field identifies and groups together devices of like type. This field contains
  48 no embedded white space or non-printable characters. The following types of
  49 devices are currently managed by the system: audio, \fBsr\fR (represents CDROM
  50 drives), \fBfd\fR (represents floppy drives), \fBst\fR (represents tape
  51 drives), \fBrmdisk\fR (removable media devices).
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBreserved1\fR\fR
  58 .ad
  59 .sp .6
  60 .RS 4n
  61 On systems configured with Trusted Extensions, this field stores a
  62 colon-separated (\fB:\fR) list of key-value pairs that describe device
  63 allocation attributes used in Trusted Extensions. Zero or more keys can be
  64 specified. The following keys are currently interpreted by Trusted Extensions
  65 systems:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBminlabel\fR\fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 Specifies the minimum label at which device can be allocated. Default value is
  74 \fBadmin_low\fR.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBmaxlabel\fR\fR
  81 .ad
  82 .sp .6
  83 .RS 4n
  84 Specifies the maximum label at which device can be allocated. Default value is
  85 \fBadmin_high\fR.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBzone\fR\fR
  92 .ad
  93 .sp .6
  94 .RS 4n
  95 Specifies the name of the zone in which device is currently allocated.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBclass\fR\fR
 102 .ad
 103 .sp .6
 104 .RS 4n
 105 Specifies  a  logical grouping of devices. For example, all Sun Ray devices of
 106 all device types. There is no default  class.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBxdpy\fR\fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 Specifies the X display name. This is used to identify devices associated with
 117 that X session. There is no default \fBxdpy\fR value.
 118 .RE
 119
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBreserved2\fR\fR
 126 .ad
 127 .sp .6
 128 .RS 4n
 129 Represents a field reserved for future use.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fIauths\fR\fR
 136 .ad
 137 .sp .6
 138 .RS 4n
 139 Represents a field that contains a comma-separated list of authorizations
 140 required to allocate the device, an asterisk (\fB*\fR) to indicate that the
 141 device is \fInot\fR allocatable, or an '\fB@\fR' symbol to indicate that no
 142 explicit authorization is needed to allocate the device. The default
 143 authorization is \fBsolaris.device.allocate\fR. See \fBauths\fR(1).
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fIdevice-exec\fR\fR
 150 .ad
 151 .sp .6
 152 .RS 4n
 153 The physical device's data clean program to be run any time the device is acted
 154 on by \fBallocate\fR(1). This ensures that unmanaged data does not remain in
 155 the physical device between uses. This field contains the filename of a program
 156 in \fB/etc/security/lib\fR or the full pathname of a cleanup script provided by
 157 the system administrator.
 158 .RE
 159
 160 .SS "Notes on \fBdevice_allocate\fR"
 161 .LP
 162 The \fBdevice_allocate\fR file is an ASCII file that resides in the
 163 \fB/etc/security\fR directory.
 164 .sp
 165 .LP
 166 Lines in \fBdevice_allocate\fR can end with a `\fB\e\fR\&' to continue an entry
 167 on the next line.
 168 .sp
 169 .LP
 170 Comments can also be included. A `\fB#\fR' makes a comment of all further text
 171 until the next NEWLINE not immediately preceded by a `\fB\e\fR\&'.
 172 .sp
 173 .LP
 174 White space is allowed in any field.
 175 .sp
 176 .LP
 177 The \fBdevice_allocate\fR file must be created by the system administrator
 178 before device allocation is enabled.
 179 .sp
 180 .LP
 181 The \fBdevice_allocate\fR file is owned by root, with a group of \fBsys\fR, and
 182 a mode of 0644.
 183 .SH EXAMPLES
 184 .LP
 185 \fBExample 1 \fRDeclaring an Allocatable Device
 186 .sp
 187 .LP
 188 Declare that physical device \fBst0\fR is a type \fBst\fR. \fBst\fR is
 189 allocatable, and the script used to clean the device after running
 190 \fBdeallocate\fR(1) is named \fB/etc/security/lib/st_clean\fR.
 191
 192 .sp
 193 .in +2
 194 .nf
 195 # scsi tape
 196 st0;\e
 197      st;\e
 198      reserved;\e
 199      reserved;\e
 200      solaris.device.allocate;\e
 201      /etc/security/lib/st_clean
 202 .fi
 203 .in -2
 204 .sp
 205
 206 .LP
 207 \fBExample 2 \fRDeclaring an Allocatable Device with Authorizations
 208 .sp
 209 .LP
 210 Declare that physical device \fBfd0\fR is of type \fBfd\fR. \fBfd\fR is
 211 allocatable by users with the \fBsolaris.device.allocate\fR authorization, and
 212 the script used to clean the device after running \fBdeallocate\fR(1) is named
 213 \fB/etc/security/lib/fd_clean\fR.
 214
 215 .sp
 216 .in +2
 217 .nf
 218 # floppy drive
 219 fd0;\e
 220      fd;\e
 221      reserved;\e
 222      reserved;\e
 223      solaris.device.allocate;\e
 224      /etc/security/lib/fd_clean
 225 .fi
 226 .in -2
 227 .sp
 228
 229 .sp
 230 .LP
 231 Making a device allocatable means that you need to allocate and deallocate it
 232 to use it (with \fBallocate\fR(1) and \fBdeallocate\fR(1)). If a device is not
 233 allocatable, there is an asterisk (\fB*\fR) in the \fIauths\fR field, and no
 234 one can use the device.
 235 .SH FILES
 236 .ne 2
 237 .na
 238 \fB\fB/etc/security/device_allocate\fR\fR
 239 .ad
 240 .sp .6
 241 .RS 4n
 242 Contains list of allocatable devices
 243 .RE
 244
 245 .SH ATTRIBUTES
 246 .LP
 247 See \fBattributes\fR(5) for descriptions of the following attributes:
 248 .sp
 249
 250 .sp
 251 .TS
 252 box;
 253 c | c
 254 l | l .
 255 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 256 _
 257 Interface Stability     Uncommitted
 258 .TE
 259
 260 .SH SEE ALSO
 261 .LP
 262 \fBauths\fR(1), \fBallocate\fR(1), \fBdeallocate\fR(1),
 263 \fBlist_devices\fR(1), \fBauth_attr\fR(4), \fBattributes\fR(5)
 264 .SH NOTES
 265 .LP
 266 On systems configured with Trusted Extensions, the functionality is enabled by
 267 default. On such systems, the \fBdevice_allocate\fR file is updated
 268 automatically by the system.