summaryrefslogtreecommitdiff
path: root/modules/pam_env/pam_env.8.xml
blob: b85fbaae882169ed5d24b46f1d4d05cf6e5e4c4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id='pam_env'>

  <refmeta>
    <refentrytitle>pam_env</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id='pam_env-name'>
    <refname>pam_env</refname>
    <refpurpose>
      PAM module to set/unset environment variables
    </refpurpose>
  </refnamediv>

<!-- body begins here -->

  <refsynopsisdiv>
    <cmdsynopsis id="pam_env-cmdsynopsis">
      <command>pam_env.so</command>
      <arg choice="opt">
        debug
      </arg>
      <arg choice="opt">
        conffile=<replaceable>conf-file</replaceable>
      </arg>
      <arg choice="opt">
        envfile=<replaceable>env-file</replaceable>
      </arg>
      <arg choice="opt">
        readenv=<replaceable>0|1</replaceable>
      </arg>
      <arg choice="opt">
        user_envfile=<replaceable>env-file</replaceable>
      </arg>
      <arg choice="opt">
        user_readenv=<replaceable>0|1</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>


  <refsect1 id="pam_env-description">
    <title>DESCRIPTION</title>
    <para>
      The pam_env PAM module allows the (un)setting of environment
      variables. Supported is the use of previously set environment
      variables as well as <emphasis>PAM_ITEM</emphasis>s such as
      <emphasis>PAM_RHOST</emphasis>.
    </para>
    <para>
      By default rules for (un)setting of variables is taken from the
      config file <filename>/etc/security/pam_env.conf</filename> if
      no other file is specified.
    </para>
    <para>
      This module can also parse a file with simple
      <emphasis>KEY=VAL</emphasis> pairs on separate lines
      (<filename>/etc/environment</filename> by default). You can
      change the default file to parse, with the <emphasis>envfile</emphasis>
      flag and turn it on or off by setting the <emphasis>readenv</emphasis>
      flag to 1 or 0 respectively.
    </para>
  </refsect1>

  <refsect1 id="pam_env-options">
    <title>OPTIONS</title>
    <variablelist>

      <varlistentry>
        <term>
          <option>conffile=<replaceable>/path/to/pam_env.conf</replaceable></option>
        </term>
        <listitem>
          <para>
            Indicate an alternative <filename>pam_env.conf</filename>
            style configuration file to override the default. This can
            be useful when different services need different environments.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>debug</option>
        </term>
        <listitem>
          <para>
            A lot of debug information is printed with
            <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>envfile=<replaceable>/path/to/environment</replaceable></option>
        </term>
        <listitem>
          <para>
            Indicate an alternative <filename>environment</filename>
            file to override the default. This can be useful when different
            services need different environments.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>readenv=<replaceable>0|1</replaceable></option>
        </term>
        <listitem>
          <para>
            Turns on or off the reading of the file specified by envfile
            (0 is off, 1 is on). By default this option is on.
          </para>
        </listitem>
      </varlistentry>


      <varlistentry>
        <term>
          <option>user_envfile=<replaceable>filename</replaceable></option>
        </term>
        <listitem>
          <para>
            Indicate an alternative <filename>.pam_environment</filename>
            file to override the default. This can be useful when different
            services need different environments. The filename is relative to
            the user home directory.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>user_readenv=<replaceable>0|1</replaceable></option>
        </term>
        <listitem>
          <para>
            Turns on or off the reading of the user specific environment
            file. 0 is off, 1 is on. By default this option is off as user
            supplied environment variables in the PAM environment could affect
            behavior of subsequent modules in the stack without the consent
            of the system administrator.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1 id="pam_env-types">
    <title>MODULE TYPES PROVIDED</title>
    <para>
      The <option>auth</option> and <option>session</option> module
      types are provided.
    </para>
  </refsect1>

  <refsect1 id="pam_env-return_values">
    <title>RETURN VALUES</title>
    <variablelist>
      <varlistentry>
        <term>PAM_ABORT</term>
        <listitem>
           <para>
             Not all relevant data or options could be gotten.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_BUF_ERR</term>
        <listitem>
           <para>
              Memory buffer error.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_IGNORE</term>
        <listitem>
           <para>
             No pam_env.conf and environment file was found.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_SUCCESS</term>
        <listitem>
           <para>
             Environment variables were set.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="pam_env-files">
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><filename>/etc/security/pam_env.conf</filename></term>
        <listitem>
          <para>Default configuration file</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><filename>/etc/environment</filename></term>
        <listitem>
          <para>Default environment file</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><filename>$HOME/.pam_environment</filename></term>
        <listitem>
          <para>User specific environment file</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="pam_env-see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>pam_env.conf</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>

  <refsect1 id="pam_env-authors">
    <title>AUTHOR</title>
    <para>
      pam_env was written by Dave Kinchlea &lt;kinch@kinch.ark.com&gt;.
    </para>
  </refsect1>
</refentry>