pam_env(8)

1PAM_ENV(8)                     Linux-PAM Manual                     PAM_ENV(8)
2
3
4

NAME

6       pam_env - PAM module to set/unset environment variables
7

SYNOPSIS

9       pam_env.so [debug] [conffile=conf-file] [envfile=env-file]
10                  [readenv=0|1] [user_envfile=env-file] [user_readenv=0|1]
11

DESCRIPTION

13       The pam_env PAM module allows the (un)setting of environment variables.
14       Supported is the use of previously set environment variables as well as
15       PAM_ITEMs such as PAM_RHOST.
16
17       By default rules for (un)setting of variables is taken from the config
18       file /etc/security/pam_env.conf if no other file is specified.
19
20       This module can also parse a file with simple KEY=VAL pairs on separate
21       lines (/etc/environment by default). You can change the default file to
22       parse, with the envfile flag and turn it on or off by setting the
23       readenv flag to 1 or 0 respectively.
24
25       Since setting of PAM environment variables can have side effects to
26       other modules, this module should be the last one on the stack.
27

OPTIONS

29       conffile=/path/to/pam_env.conf
30           Indicate an alternative pam_env.conf style configuration file to
31           override the default. This can be useful when different services
32           need different environments.
33
34       debug
35           A lot of debug information is printed with syslog(3).
36
37       envfile=/path/to/environment
38           Indicate an alternative environment file to override the default.
39           This can be useful when different services need different
40           environments.
41
42       readenv=0|1
43           Turns on or off the reading of the file specified by envfile (0 is
44           off, 1 is on). By default this option is on.
45
46       user_envfile=filename
47           Indicate an alternative .pam_environment file to override the
48           default. This can be useful when different services need different
49           environments. The filename is relative to the user home directory.
50
51       user_readenv=0|1
52           Turns on or off the reading of the user specific environment file.
53           0 is off, 1 is on. By default this option is off as user supplied
54           environment variables in the PAM environment could affect behavior
55           of subsequent modules in the stack without the consent of the
56           system administrator.
57

MODULE TYPES PROVIDED

59       The auth and session module types are provided.
60

RETURN VALUES

62       PAM_ABORT
63           Not all relevant data or options could be gotten.
64
65       PAM_BUF_ERR
66           Memory buffer error.
67
68       PAM_IGNORE
69           No pam_env.conf and environment file was found.
70
71       PAM_SUCCESS
72           Environment variables were set.
73

FILES

75       /etc/security/pam_env.conf
76           Default configuration file
77
78       /etc/environment
79           Default environment file
80
81       $HOME/.pam_environment
82           User specific environment file
83

AUTHOR

88       pam_env was written by Dave Kinchlea <kinch@kinch.ark.com>.
89
90
91
92Linux-PAM Manual                  04/11/2018                        PAM_ENV(8)