summaryrefslogtreecommitdiff
path: root/modules/pam_umask/pam_umask.8.xml
blob: 09fc0e7c5b610c062c465272f11e0aaf50f8d755 (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
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">

<refentry id="pam_umask">

  <refmeta>
    <refentrytitle>pam_umask</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id="pam_umask-name">
    <refname>pam_umask</refname>
    <refpurpose>PAM module to set the file mode creation mask</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="pam_umask-cmdsynopsis">
      <command>pam_umask.so</command>
      <arg choice="opt">
	debug
      </arg>
      <arg choice="opt">
        silent
      </arg>
      <arg choice="opt">
        usergroups
      </arg>
      <arg choice="opt">
        umask=<replaceable>mask</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="pam_umask-description">

    <title>DESCRIPTION</title>

    <para>
      pam_umask is a PAM module to set the file mode creation mask
      of the current environment. The umask affects the default
      permissions assigned to newly created files.
    </para>
    <para>
      The PAM module tries to get the umask value from the
      following places in the following order:
      <itemizedlist>
        <listitem>
          <para>
            umask= argument
          </para>
        </listitem>
        <listitem>
          <para>
            umask= entry of the users GECOS field
          </para>
        </listitem>
        <listitem>
          <para>
            pri= entry of the users GECOS field
          </para>
        </listitem>
        <listitem>
          <para>
            ulimit= entry of the users GECOS field
          </para>
        </listitem>
        <listitem>
          <para>
            UMASK= entry from /etc/default/login
          </para>
        </listitem>
        <listitem>
          <para>
            UMASK entry from /etc/login.defs
          </para>
        </listitem>
      </itemizedlist>
    </para>

  </refsect1>

  <refsect1 id="pam_umask-options">

    <title>OPTIONS</title>
    <para>
      <variablelist>

        <varlistentry>
          <term>
            <option>debug</option>
          </term>
          <listitem>
            <para>
	      Print debug information.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>
            <option>silent</option>
          </term>
          <listitem>
            <para>
              Don't print informative messages.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>
            <option>usergroups</option>
          </term>
          <listitem>
            <para>
              If the user is not root, and the user ID is equal to the
              group ID, and the username is the same as primary group name,
              the umask group bits are set to be the same as
              owner bits (examples: 022 -> 002, 077 -> 007).
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>
            <option>umask=<replaceable>mask</replaceable></option>
          </term>
          <listitem>
            <para>
               Sets the calling process's file mode creation mask (umask)
               to <option>mask</option> &amp; 0777. The value is interpreted
               as Octal.
            </para>
          </listitem>
	</varlistentry>

      </variablelist>

    </para>
  </refsect1>

  <refsect1 id="pam_umask-types">
    <title>MODULE TYPES PROVIDED</title>
    <para>
      Only the <option>session</option> type is provided.
    </para>
  </refsect1>

  <refsect1 id='pam_umask-return_values'>
    <title>RETURN VALUES</title>
    <para>
      <variablelist>

        <varlistentry>
          <term>PAM_SUCCESS</term>
          <listitem>
            <para>
              The new umask was set successfully.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_SERVICE_ERR</term>
          <listitem>
            <para>
	      No username was given.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_USER_UNKNOWN</term>
          <listitem>
            <para>
	      User not known.
            </para>
          </listitem>
        </varlistentry>

      </variablelist>
    </para>
  </refsect1>

  <refsect1 id='pam_umask-examples'>
    <title>EXAMPLES</title>
    <para>
      Add the following line to <filename>/etc/pam.d/login</filename> to
      set the user specific umask at login:
      <programlisting>
        session optional pam_umask.so umask=0022
      </programlisting>
    </para>
  </refsect1>

  <refsect1 id='pam_umask-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>pam.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_umask-author'>
    <title>AUTHOR</title>
      <para>
        pam_umask was written by Thorsten Kukuk &lt;kukuk@thkukuk.de&gt;.
      </para>
  </refsect1>

</refentry>