contrib/libpam/doc/modules/pam_env.sgml

   1 <!--
   2    $Id: pam_env.sgml,v 1.1 1997/04/05 06:50:42 morgan Exp $
   3
   4    This file was written by Dave Kinchlea <kinch@kinch.ark.com>
   5    Ed. AGM
   6 -->
   7
   8 <sect1>Set/unset environment variables
   9
  10 <sect2>Synopsis
  11
  12 <p>
  13 <descrip>
  14
  15 <tag><bf>Module Name:</bf></tag>
  16 <tt/pam_env/
  17
  18 <tag><bf>Author:</bf></tag>
  19 Dave Kinchlea &lt;kinch@kinch.ark.com&gt;
  20
  21 <tag><bf>Maintainer:</bf></tag>
  22 Author
  23
  24 <tag><bf>Management groups provided:</bf></tag>
  25 Authentication (setcred)
  26
  27 <tag><bf>Cryptographically sensitive:</bf></tag>
  28
  29 <tag><bf>Security rating:</bf></tag>
  30
  31 <tag><bf>Clean code base:</bf></tag>
  32
  33 <tag><bf>System dependencies:</bf></tag>
  34 <tt>/etc/security/pam_env.conf</tt>
  35
  36 <tag><bf>Network aware:</bf></tag>
  37
  38 </descrip>
  39
  40 <sect2>Overview of module
  41
  42 <p>
  43 This module allows the (un)setting of environment variables. Supported
  44 is the use of previously set environment variables as well as
  45 <em>PAM_ITEM</em>s such as <tt>PAM_RHOST</tt>.
  46
  47 <sect2>Authentication component
  48
  49 <p>
  50 <descrip>
  51
  52 <tag><bf>Recognized arguments:</bf></tag>
  53 <tt/debug/; <tt/conffile=/<em/configuration-file-name/
  54
  55 <tag><bf>Description:</bf></tag>
  56 This module allows you to (un)set arbitrary environment variables
  57 using fixed strings, the value of previously set environment variables
  58 and/or <em/PAM_ITEM/s.
  59
  60 <p>
  61 All is controlled via a configuration file (by default,
  62 <tt>/etc/security/pam_env.conf</tt> but can be overriden with
  63 <tt>connfile</tt> argument).  Each line starts with the variable name,
  64 there are then two possible options for each variable <bf>DEFAULT</bf>
  65 and <bf>OVERRIDE</bf>.  <bf>DEFAULT</bf> allows and administrator to
  66 set the value of the variable to some default value, if none is
  67 supplied then the empty string is assumed.  The <bf>OVERRIDE</bf>
  68 option tells pam_env that it should enter in its value (overriding the
  69 default value) if there is one to use.  <bf>OVERRIDE</bf> is not used,
  70 <tt>""</tt> is assumed and no override will be done.
  71
  72 <p>
  73 <tscreen>
  74 <verb>
  75 VARIABLE   [DEFAULT=[value]]  [OVERRIDE=[value]]
  76 </verb>
  77 </tscreen>
  78
  79 <p>
  80 (Possibly non-existent) environment variables may be used in values
  81 using the <tt>&dollar;&lcub;string&rcub;</tt> syntax and (possibly
  82 non-existent) <em/PAM_ITEM/s may be used in values using the
  83 <tt>&commat;&lcub;string&rcub;</tt> syntax. Both the <tt>&dollar;</tt>
  84 and <tt>&commat;</tt> characters can be backslash-escaped to be used
  85 as literal values (as in <tt>&bsol;&dollar;</tt>.  Double quotes may
  86 be used in values (but not environment variable names) when white
  87 space is needed <bf>the full value must be delimited by the quotes and
  88 embedded or escaped quotes are not supported</bf>.
  89
  90 <p>
  91 The behavior of this module can be modified with one of the following
  92 flags:
  93
  94 <p>
  95 <itemize>
  96
  97 <item><tt/debug/
  98 - write more information to <tt/syslog(3)/.
  99
 100 <item><tt/conffile=/<em/filename/
 101 - by default the file <tt>/etc/security/pam_env.conf</tt> is used as
 102 the configuration file. This option overrides the default. You must
 103 supply a complete path + file name.
 104
 105 </itemize>
 106
 107 <tag><bf>Examples/suggested usage:</bf></tag>
 108
 109 See sample <tt>pam_env.conf</tt> for more information and examples.
 110
 111 </descrip>
 112
 113 <!--
 114 End of sgml insert for this module.
 115 -->
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125