modules/pam_namespace/pam_namespace.8

   1 .\"     Title: pam_namespace
   2 .\"    Author: [see the "AUTHORS" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 08/17/2012
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_NAMESPACE" "8" "08/17/2012" "Linux-PAM Manual" "Linux-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_namespace \- PAM module for configuring namespace for a session
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_namespace\&.so\fR\ 'u
 174 \fBpam_namespace\&.so\fR [debug] [unmnt_remnt] [unmnt_only] [require_selinux] [gen_hash] [ignore_config_error] [ignore_instance_parent_mode] [unmount_on_close] [use_current_context] [use_default_context] [mount_private]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 The pam_namespace PAM module sets up a private namespace for a session with polyinstantiated directories\&. A polyinstantiated directory provides a different instance of itself based on user name, or when using SELinux, user name, security context or both\&. If an executable script
 179 \FC/etc/security/namespace\&.init\F[]
 180 exists, it is used to initialize the instance directory after it is set up and mounted on the polyinstantiated directory\&. The script receives the polyinstantiated directory path, the instance directory path, flag whether the instance directory was newly created (0 for no, 1 for yes), and the user name as its arguments\&.
 181 .PP
 182 The pam_namespace module disassociates the session namespace from the parent namespace\&. Any mounts/unmounts performed in the parent namespace, such as mounting of devices, are not reflected in the session namespace\&. To propagate selected mount/unmount events from the parent namespace into the disassociated session namespace, an administrator may use the special shared\-subtree feature\&. For additional information on shared\-subtree feature, please refer to the mount(8) man page and the shared\-subtree description at http://lwn\&.net/Articles/159077 and http://lwn\&.net/Articles/159092\&.
 183 .SH "OPTIONS"
 184 .PP
 185 \fBdebug\fR
 186 .RS 4
 187 A lot of debug information is logged using syslog
 188 .RE
 189 .PP
 190 \fBunmnt_remnt\fR
 191 .RS 4
 192 For programs such as su and newrole, the login session has already setup a polyinstantiated namespace\&. For these programs, polyinstantiation is performed based on new user id or security context, however the command first needs to undo the polyinstantiation performed by login\&. This argument instructs the command to first undo previous polyinstantiation before proceeding with new polyinstantiation based on new id/context
 193 .RE
 194 .PP
 195 \fBunmnt_only\fR
 196 .RS 4
 197 For trusted programs that want to undo any existing bind mounts and process instance directories on their own, this argument allows them to unmount currently mounted instance directories
 198 .RE
 199 .PP
 200 \fBrequire_selinux\fR
 201 .RS 4
 202 If selinux is not enabled, return failure
 203 .RE
 204 .PP
 205 \fBgen_hash\fR
 206 .RS 4
 207 Instead of using the security context string for the instance name, generate and use its md5 hash\&.
 208 .RE
 209 .PP
 210 \fBignore_config_error\fR
 211 .RS 4
 212 If a line in the configuration file corresponding to a polyinstantiated directory contains format error, skip that line process the next line\&. Without this option, pam will return an error to the calling program resulting in termination of the session\&.
 213 .RE
 214 .PP
 215 \fBignore_instance_parent_mode\fR
 216 .RS 4
 217 Instance parent directories by default are expected to have the restrictive mode of 000\&. Using this option, an administrator can choose to ignore the mode of the instance parent\&. This option should be used with caution as it will reduce security and isolation goals of the polyinstantiation mechanism\&.
 218 .RE
 219 .PP
 220 \fBunmount_on_close\fR
 221 .RS 4
 222 Explicitly unmount the polyinstantiated directories instead of relying on automatic namespace destruction after the last process in a namespace exits\&. This option should be used only in case it is ensured by other means that there cannot be any processes running in the private namespace left after the session close\&. It is also useful only in case there are multiple pam session calls in sequence from the same process\&.
 223 .RE
 224 .PP
 225 \fBuse_current_context\fR
 226 .RS 4
 227 Useful for services which do not change the SELinux context with setexeccon call\&. The module will use the current SELinux context of the calling process for the level and context polyinstantiation\&.
 228 .RE
 229 .PP
 230 \fBuse_default_context\fR
 231 .RS 4
 232 Useful for services which do not use pam_selinux for changing the SELinux context with setexeccon call\&. The module will use the default SELinux context of the user for the level and context polyinstantiation\&.
 233 .RE
 234 .PP
 235 \fBmount_private\fR
 236 .RS 4
 237 This option can be used on systems where the / mount point or its submounts are made shared (for example with a
 238 \fBmount \-\-make\-rshared /\fR
 239 command)\&. The module will mark the whole directory tree so any mount and unmount operations in the polyinstantiation namespace are private\&. Normally the pam_namespace will try to detect the shared / mount point and make the polyinstantiated directories private automatically\&. This option has to be used just when only a subtree is shared and / is not\&.
 240 .sp
 241 Note that mounts and unmounts done in the private namespace will not affect the parent namespace if this option is used or when the shared / mount point is autodetected\&.
 242 .RE
 243 .SH "MODULE TYPES PROVIDED"
 244 .PP
 245 Only the
 246 \fBsession\fR
 247 module type is provided\&. The module must not be called from multithreaded processes\&.
 248 .SH "RETURN VALUES"
 249 .PP
 250 PAM_SUCCESS
 251 .RS 4
 252 Namespace setup was successful\&.
 253 .RE
 254 .PP
 255 PAM_SERVICE_ERR
 256 .RS 4
 257 Unexpected system error occurred while setting up namespace\&.
 258 .RE
 259 .PP
 260 PAM_SESSION_ERR
 261 .RS 4
 262 Unexpected namespace configuration error occurred\&.
 263 .RE
 264 .SH "FILES"
 265 .PP
 266 \FC/etc/security/namespace\&.conf\F[]
 267 .RS 4
 268 Main configuration file
 269 .RE
 270 .PP
 271 \FC/etc/security/namespace\&.d\F[]
 272 .RS 4
 273 Directory for additional configuration files
 274 .RE
 275 .PP
 276 \FC/etc/security/namespace\&.init\F[]
 277 .RS 4
 278 Init script for instance directories
 279 .RE
 280 .SH "EXAMPLES"
 281 .PP
 282 For the <service>s you need polyinstantiation (login for example) put the following line in /etc/pam\&.d/<service> as the last line for session group:
 283 .PP
 284 session required pam_namespace\&.so [arguments]
 285 .PP
 286 To use polyinstantiation with graphical display manager gdm, insert the following line, before exit 0, in /etc/gdm/PostSession/Default:
 287 .PP
 288 /usr/sbin/gdm\-safe\-restart
 289 .PP
 290 This allows gdm to restart after each session and appropriately adjust namespaces of display manager and the X server\&. If polyinstantiation of /tmp is desired along with the graphical environment, then additional configuration changes are needed to address the interaction of X server and font server namespaces with their use of /tmp to create communication sockets\&. Please use the initialization script
 291 \FC/etc/security/namespace\&.init\F[]
 292 to ensure that the X server and its clients can appropriately access the communication socket X0\&. Please refer to the sample instructions provided in the comment section of the instance initialization script
 293 \FC/etc/security/namespace\&.init\F[]\&. In addition, perform the following changes to use graphical environment with polyinstantiation of /tmp:
 294 .PP
 295
 296 .sp
 297 .if n \{\
 298 .RS 4
 299 .\}
 300 .fam C
 301 .ps -1
 302 .nf
 303 .if t \{\
 304 .sp -1
 305 .\}
 306 .BB lightgray adjust-for-leading-newline
 307 .sp -1
 308
 309       1\&. Disable the use of font server by commenting out "FontPath"
 310          line in /etc/X11/xorg\&.conf\&. If you do want to use the font server
 311          then you will have to augment the instance initialization
 312          script to appropriately provide /tmp/\&.font\-unix from the
 313          polyinstantiated /tmp\&.
 314       2\&. Ensure that the gdm service is setup to use pam_namespace,
 315          as described above, by modifying /etc/pam\&.d/gdm\&.
 316       3\&. Ensure that the display manager is configured to restart X server
 317          with each new session\&. This default setup can be verified by
 318          making sure that /usr/share/gdm/defaults\&.conf contains
 319          "AlwaysRestartServer=true", and it is not overridden by
 320          /etc/gdm/custom\&.conf\&.
 321
 322 .EB lightgray adjust-for-leading-newline
 323 .if t \{\
 324 .sp 1
 325 .\}
 326 .fi
 327 .fam
 328 .ps +1
 329 .if n \{\
 330 .RE
 331 .\}
 332 .sp
 333 .SH "SEE ALSO"
 334 .PP
 335
 336 \fBnamespace.conf\fR(5),
 337 \fBpam.d\fR(5),
 338 \fBmount\fR(8),
 339 \fBpam\fR(8)\&.
 340 .SH "AUTHORS"
 341 .PP
 342 The namespace setup scheme was designed by Stephen Smalley, Janak Desai and Chad Sellers\&. The pam_namespace PAM module was developed by Janak Desai <janak@us\&.ibm\&.com>, Chad Sellers <csellers@tresys\&.com> and Steve Grubb <sgrubb@redhat\&.com>\&. Additional improvements by Xavier Toth <txtoth@gmail\&.com> and Tomas Mraz <tmraz@redhat\&.com>\&.