Debian Codegraph @

upstream/debian-unstable/man8/pam_time.8

raw
1 '\" t
2 .\" Title: pam_time
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_TIME" "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_time \- PAM module for time control access
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_time\&.so\fR\ 'u
34 \fBpam_time\&.so\fR [conffile=conf\-file] [debug] [noaudit]
35 .SH "DESCRIPTION"
36 .PP
37 The pam_time PAM module does not authenticate the user, but instead it restricts access to a system and or specific applications at various times of the day and on specific days or over various terminal lines\&. This module can be configured to deny access to (individual) users based on their name, the time of day, the day of week, the service they are applying for and their terminal from which they are making their request\&.
38 .PP
39 By default rules for time/port access are taken from config file
40 /etc/security/time\&.conf\&. An alternative file can be specified with the
41 \fIconffile\fR
42 option\&.
43 .PP
44 If Linux PAM is compiled with audit support the module will report when it denies access\&.
45 .SH "OPTIONS"
46 .PP
47 conffile=/path/to/time\&.conf
48 .RS 4
49 Indicate an alternative time\&.conf style configuration file to override the default\&.
50 .RE
51 .PP
52 debug
53 .RS 4
54 Some debug information is printed with
55 \fBsyslog\fR(3)\&.
56 .RE
57 .PP
58 noaudit
59 .RS 4
60 Do not report logins at disallowed time to the audit subsystem\&.
61 .RE
62 .SH "MODULE TYPES PROVIDED"
63 .PP
64 Only the
65 \fBaccount\fR
66 type is provided\&.
67 .SH "RETURN VALUES"
68 .PP
69 PAM_SUCCESS
70 .RS 4
71 Access was granted\&.
72 .RE
73 .PP
74 PAM_ABORT
75 .RS 4
76 Not all relevant data could be gotten\&.
77 .RE
78 .PP
79 PAM_BUF_ERR
80 .RS 4
81 Memory buffer error\&.
82 .RE
83 .PP
84 PAM_PERM_DENIED
85 .RS 4
86 Access was not granted\&.
87 .RE
88 .PP
89 PAM_USER_UNKNOWN
90 .RS 4
91 The user is not known to the system\&.
92 .RE
93 .SH "FILES"
94 .PP
95 /etc/security/time\&.conf
96 .RS 4
97 Default configuration file
98 .RE
99 .SH "EXAMPLES"
100 .sp
101 .if n \{\
102 .RS 4
103 .\}
104 .nf
105 #%PAM\-1\&.0
106 #
107 # apply pam_time accounting to login requests
108 #
109 login account required pam_time\&.so
110
111 .fi
112 .if n \{\
113 .RE
114 .\}
115 .SH "SEE ALSO"
116 .PP
117 \fBtime.conf\fR(5),
118 \fBpam.d\fR(5),
119 \fBpam\fR(7)\&.
120 .SH "AUTHOR"
121 .PP
122 pam_time was written by Andrew G\&. Morgan <morgan@kernel\&.org>\&.