Debian Codegraph @

upstream/debian-unstable/man8/pam_timestamp.8

raw
1 '\" t
2 .\" Title: pam_timestamp
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_TIMESTAMP" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_timestamp \- Authenticate using cached successful authentication attempts
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_timestamp\&.so\fR\ 'u
34 \fBpam_timestamp\&.so\fR [timestampdir=\fIdirectory\fR] [timestamp_timeout=\fInumber\fR] [verbose] [debug]
35 .SH "DESCRIPTION"
36 .PP
37 In a nutshell,
38 \fIpam_timestamp\fR
39 caches successful authentication attempts, and allows you to use a recent successful attempt as the basis for authentication\&. This is similar mechanism which is used in
40 \fBsudo\fR\&.
41 .PP
42 When an application opens a session using
43 \fIpam_timestamp\fR, a timestamp file is created in the
44 \fItimestampdir\fR
45 directory for the user\&. When an application attempts to authenticate the user, a
46 \fIpam_timestamp\fR
47 will treat a sufficiently recent timestamp file as grounds for succeeding\&.
48 .SH "OPTIONS"
49 .PP
50 timestampdir=directory
51 .RS 4
52 Specify an alternate directory where
53 \fIpam_timestamp\fR
54 creates timestamp files\&.
55 .RE
56 .PP
57 timestamp_timeout=number
58 .RS 4
59 How long should
60 \fIpam_timestamp\fR
61 treat timestamp as valid after their last modification date (in seconds)\&. Default is 300 seconds\&.
62 .RE
63 .PP
64 verbose
65 .RS 4
66 Attempt to inform the user when access is granted\&.
67 .RE
68 .PP
69 debug
70 .RS 4
71 Turns on debugging messages sent to
72 \fBsyslog\fR(3)\&.
73 .RE
74 .SH "MODULE TYPES PROVIDED"
75 .PP
76 The
77 \fBauth\fR
78 and
79 \fBsession\fR
80 module types are provided\&.
81 .SH "RETURN VALUES"
82 .PP
83 PAM_AUTH_ERR
84 .RS 4
85 The module was not able to retrieve the user name or no valid timestamp file was found\&.
86 .RE
87 .PP
88 PAM_SUCCESS
89 .RS 4
90 Everything was successful\&.
91 .RE
92 .PP
93 PAM_SESSION_ERR
94 .RS 4
95 Timestamp file could not be created or updated\&.
96 .RE
97 .SH "NOTES"
98 .PP
99 Users can get confused when they are not always asked for passwords when running a given program\&. Some users reflexively begin typing information before noticing that it is not being asked for\&.
100 .SH "EXAMPLES"
101 .sp
102 .if n \{\
103 .RS 4
104 .\}
105 .nf
106 auth sufficient pam_timestamp\&.so verbose
107 auth required pam_unix\&.so
108
109 session required pam_unix\&.so
110 session optional pam_timestamp\&.so
111
112 .fi
113 .if n \{\
114 .RE
115 .\}
116 .SH "FILES"
117 .PP
118 /var/run/pam_timestamp/\&.\&.\&.
119 .RS 4
120 timestamp files and directories
121 .RE
122 .SH "SEE ALSO"
123 .PP
124 \fBpam_timestamp_check\fR(8),
125 \fBpam.conf\fR(5),
126 \fBpam.d\fR(5),
127 \fBpam\fR(7)
128 .SH "AUTHOR"
129 .PP
130 pam_timestamp was written by Nalin Dahyabhai\&.