← Back to branch summary

~ubuntu-branches/ubuntu/breezy/pam/breezy

« back to all changes in this revision

Viewing changes to Linux-PAM/doc/modules/pam_env.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Sam Hartman
  • Date: 2004-06-28 14:28:08 UTC
  • mfrom: (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20040628142808-adikk7vtfg3pzcjw
Tags: 0.76-22
http://bugs.debian.org/254904
* Add uploaders
* Document location of repository
* Fix options containing arguments in pam_unix, Closes: #254904

Show diffs side-by-side

added added

removed removed

Lines of Context:
Linux-PAM/doc/modules/pam_env.sgml
 
1
<!--
 
2
   $Id: pam_env.sgml,v 1.1 2001/04/29 04:16:54 hartmans 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
<tt/envfile/=<em/env-file-name/; <tt/readenv/=<em/0|1/
 
55
 
 
56
<tag><bf>Description:</bf></tag>
 
57
This module allows you to (un)set arbitrary environment variables
 
58
using fixed strings, the value of previously set environment variables
 
59
and/or <em/PAM_ITEM/s.
 
60
 
 
61
<p>
 
62
All is controlled via a configuration file (by default,
 
63
<tt>/etc/security/pam_env.conf</tt> but can be overriden with
 
64
<tt>conffile</tt> argument).  Each line starts with the variable name,
 
65
there are then two possible options for each variable <bf>DEFAULT</bf>
 
66
and <bf>OVERRIDE</bf>.  <bf>DEFAULT</bf> allows an administrator to
 
67
set the value of the variable to some default value, if none is
 
68
supplied then the empty string is assumed.  The <bf>OVERRIDE</bf>
 
69
option tells pam_env that it should enter in its value (overriding the
 
70
default value) if there is one to use.  <bf>OVERRIDE</bf> is not used,
 
71
<tt>""</tt> is assumed and no override will be done.
 
72
 
 
73
<p>
 
74
<tscreen>
 
75
<verb>
 
76
VARIABLE   [DEFAULT=[value]]  [OVERRIDE=[value]]
 
77
</verb>
 
78
</tscreen>
 
79
 
 
80
<p>
 
81
(Possibly non-existent) environment variables may be used in values
 
82
using the <tt>&dollar;&lcub;string&rcub;</tt> syntax and (possibly
 
83
non-existent) <em/PAM_ITEM/s may be used in values using the
 
84
<tt>&commat;&lcub;string&rcub;</tt> syntax. Both the <tt>&dollar;</tt>
 
85
and <tt>&commat;</tt> characters can be backslash-escaped to be used
 
86
as literal values (as in <tt>&bsol;&dollar;</tt>.  Double quotes may
 
87
be used in values (but not environment variable names) when white
 
88
space is needed <bf>the full value must be delimited by the quotes and
 
89
embedded or escaped quotes are not supported</bf>.
 
90
 
 
91
<p>
 
92
This module can also parse a file with simple <tt>KEY=VAL</tt> pairs
 
93
on seperate lines (<tt>/etc/environment</tt> by default). You can
 
94
change the default file to parse, with the <em/envfile/ flag and turn
 
95
it on or off by setting the <em/readenv/ flag to 1 or 0 respectively.
 
96
 
 
97
<p>
 
98
The behavior of this module can be modified with one of the following
 
99
flags:
 
100
 
 
101
<p>
 
102
<itemize>
 
103
 
 
104
<item><tt/debug/
 
105
- write more information to <tt/syslog(3)/.
 
106
 
 
107
<item><tt/conffile=/<em/filename/
 
108
- by default the file <tt>/etc/security/pam_env.conf</tt> is used as
 
109
the configuration file. This option overrides the default. You must
 
110
supply a complete path + file name.
 
111
 
 
112
<item><tt/envfile=/<em/filename/
 
113
- by default the file <tt>/etc/environment</tt> is used to load KEY=VAL
 
114
pairs directly into the env. This option overrides the default. You must
 
115
supply a complete path + file name.
 
116
 
 
117
<item><tt/readenv=/<em/0|1/
 
118
- turns on or off the reading of the file specified by envfile (0 is off,
 
119
1 is on). By default this option is on.
 
120
 
 
121
</itemize>
 
122
 
 
123
<tag><bf>Examples/suggested usage:</bf></tag>
 
124
 
 
125
See sample <tt>pam_env.conf</tt> for more information and examples.
 
126
 
 
127
</descrip>
 
128
 
 
129
<!--
 
130
End of sgml insert for this module.
 
131
-->
 
132
 
 
133
 
 
134
 
 
135
 
 
136
 
 
137
 
 
138
 
 
139
 
 
140
 
 
141