diff options
Diffstat (limited to 'modules/pam_time')
| -rw-r--r-- | modules/pam_time/Makefile.am | 11 | ||||
| -rw-r--r-- | modules/pam_time/README | 45 | ||||
| -rw-r--r-- | modules/pam_time/README.xml | 34 | ||||
| -rw-r--r-- | modules/pam_time/pam_time.8 | 72 | ||||
| -rw-r--r-- | modules/pam_time/pam_time.8.xml | 148 | ||||
| -rw-r--r-- | modules/pam_time/time.conf.5 | 92 | ||||
| -rw-r--r-- | modules/pam_time/time.conf.5.xml | 143 |
7 files changed, 523 insertions, 22 deletions
diff --git a/modules/pam_time/Makefile.am b/modules/pam_time/Makefile.am index 2c77b54a..6c5ae3a2 100644 --- a/modules/pam_time/Makefile.am +++ b/modules/pam_time/Makefile.am @@ -4,7 +4,10 @@ CLEANFILES = *~ -EXTRA_DIST = README time.conf tst-pam_time +EXTRA_DIST = README $(MANS) $(XMLS) time.conf tst-pam_time + +man_MANS = time.conf.5 pam_time.8 +XMLS = README.xml time.conf.5.xml pam_time.8.xml TESTS = tst-pam_time @@ -21,3 +24,9 @@ endif securelib_LTLIBRARIES = pam_time.la secureconf_DATA = time.conf + +if ENABLE_REGENERATE_MAN +noinst_DATA = README +README: pam_time.8.xml time.conf.5.xml +-include $(top_srcdir)/Make.xml.rules +endif diff --git a/modules/pam_time/README b/modules/pam_time/README index 38b2b3e6..abafd936 100644 --- a/modules/pam_time/README +++ b/modules/pam_time/README @@ -1,30 +1,33 @@ -$Id$ +pam_time — PAM module for time control access -This is a help file for the pam_time module. It explains the need for -pam_time and also the syntax of the /etc/security/time.conf file. -[a lot of the syntax is freely adapted from the porttime file of the -shadow suite.] +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -1. Introduction -=============== +DESCRIPTION -It is desirable to restrict access to a system and or specific -applications at various times of the day and on specific days or over -various terminal lines. +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. -The pam_time module is intended to offer a configurable module that -satisfies this purpose, within the context of Linux-PAM. +By default rules for time/port access are taken from config file /etc/security/ +time.conf. -2. the /etc/security/time.conf file -=================================== +EXAMPLES -This file is the configuration script for defining time/port access -control to the system/applications. +These are some example lines which might be specified in /etc/security/ +time.conf. -Its syntax is described in the sample ./time.conf provided in this -directory. +All users except for root are denied access to console-login at all times: + +login ; tty* & !ttyp* ; !root ; !Al0000-2400 + + +Games (configured to use PAM) are only to be accessed out of working hours. +This rule does not apply to the user waster: + + +games ; * ; !waster ; Wd0000-2400 | Wk1800-0800 -unrecognised rules are ignored (but an error is logged to syslog(3)) --------------------- -Bugs to Andrew <morgan@parc.power.net> or the list <pam-list@redhat.com> diff --git a/modules/pam_time/README.xml b/modules/pam_time/README.xml new file mode 100644 index 00000000..6c11eec1 --- /dev/null +++ b/modules/pam_time/README.xml @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding='UTF-8'?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" +[ +<!-- +<!ENTITY pamtime SYSTEM "pam_time.8.xml"> +--> +<!-- +<!ENTITY timeconf SYSTEM "time.conf.5.xml"> +--> +]> + +<article> + + <articleinfo> + + <title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="pam_time.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_time-name"]/*)'/> + </title> + + </articleinfo> + + <section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="pam_time.8.xml" xpointer='xpointer(//refsect1[@id = "pam_time-description"]/*)'/> + </section> + + <section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="time.conf.5.xml" xpointer='xpointer(//refsect1[@id = "time.conf-examples"]/*)'/> + </section> + +</article> diff --git a/modules/pam_time/pam_time.8 b/modules/pam_time/pam_time.8 new file mode 100644 index 00000000..58b94ec6 --- /dev/null +++ b/modules/pam_time/pam_time.8 @@ -0,0 +1,72 @@ +.\" Title: pam_time +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 06/09/2006 +.\" Manual: Linux\-PAM Manual +.\" Source: Linux\-PAM Manual +.\" +.TH "PAM_TIME" "8" "06/09/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +pam_time \- PAM module for time control access +.SH "SYNOPSIS" +.HP 12 +\fBpam_time.so\fR +.SH "DESCRIPTION" +.PP +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. +.PP +By default rules for time/port access are taken from config file +\fI/etc/security/time.conf\fR. +.SH "OPTIONS" +.PP +This module does not recognice any options. +.SH "MODULE SERVICES PROVIDED" +.PP +Only the +\fBaccount\fR +service is supported. +.SH "RETURN VALUES" +.TP 3n +PAM_SUCCESS +Access was granted. +.TP 3n +PAM_ABORT +Not all relevant data could be gotten. +.TP 3n +PAM_BUF_ERR +Memory buffer error. +.TP 3n +PAM_PERM_DENIED +Access was not granted. +.TP 3n +PAM_USER_UNKNOWN +The user is not known to the system. +.SH "FILES" +.TP 3n +\fI/etc/security/time.conf\fR +Default configuration file +.SH "EXAMPLES" +.sp +.RS 3n +.nf +#%PAM\-1.0 +# +# apply pam_time accounting to login requests +# +login account required pam_time.so + +.fi +.RE +.SH "SEE ALSO" +.PP + +\fBtime.conf\fR(5), +\fBpam.d\fR(8), +\fBpam\fR(8). +.SH "AUTHORS" +.PP +pam_time was written by Andrew G. Morgan <morgan@kernel.org>. diff --git a/modules/pam_time/pam_time.8.xml b/modules/pam_time/pam_time.8.xml new file mode 100644 index 00000000..da245ed0 --- /dev/null +++ b/modules/pam_time/pam_time.8.xml @@ -0,0 +1,148 @@ +<?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_time'> + + <refmeta> + <refentrytitle>pam_time</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id='pam_time-name'> + <refname>pam_time</refname> + <refpurpose> + PAM module for time control access + </refpurpose> + </refnamediv> + +<!-- body begins here --> + + <refsynopsisdiv> + <cmdsynopsis id="pam_time-cmdsynopsis"> + <command>pam_time.so</command> + </cmdsynopsis> + </refsynopsisdiv> + + + <refsect1 id="pam_time-description"> + <title>DESCRIPTION</title> + <para> + 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. + </para> + <para> + By default rules for time/port access are taken from config file + <filename>/etc/security/time.conf</filename>. + </para> + </refsect1> + + <refsect1 id="pam_time-options"> + <title>OPTIONS</title> + <para>This module does not recognice any options.</para> + </refsect1> + + <refsect1 id="pam_time-services"> + <title>MODULE SERVICES PROVIDED</title> + <para> + Only the <option>account</option> service is supported. + </para> + </refsect1> + + <refsect1 id="pam_time-return_values"> + <title>RETURN VALUES</title> + <variablelist> + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + Access was granted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_ABORT</term> + <listitem> + <para> + Not all relevant data could be gotten. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_BUF_ERR</term> + <listitem> + <para> + Memory buffer error. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_PERM_DENIED</term> + <listitem> + <para> + Access was not granted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_USER_UNKNOWN</term> + <listitem> + <para> + The user is not known to the system. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id="pam_time-files"> + <title>FILES</title> + <variablelist> + <varlistentry> + <term><filename>/etc/security/time.conf</filename></term> + <listitem> + <para>Default configuration file</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='pam_time-examples'> + <title>EXAMPLES</title> + <programlisting> +#%PAM-1.0 +# +# apply pam_time accounting to login requests +# +login account required pam_time.so + </programlisting> + </refsect1> + + <refsect1 id="pam_time-see_also"> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>time.conf</refentrytitle><manvolnum>5</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam.d</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>. + </para> + </refsect1> + + <refsect1 id="pam_time-authors"> + <title>AUTHORS</title> + <para> + pam_time was written by Andrew G. Morgan <morgan@kernel.org>. + </para> + </refsect1> +</refentry> diff --git a/modules/pam_time/time.conf.5 b/modules/pam_time/time.conf.5 new file mode 100644 index 00000000..e610821d --- /dev/null +++ b/modules/pam_time/time.conf.5 @@ -0,0 +1,92 @@ +.\" Title: time.conf +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> +.\" Date: 06/09/2006 +.\" Manual: Linux\-PAM Manual +.\" Source: Linux\-PAM Manual +.\" +.TH "TIME.CONF" "5" "06/09/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +time.conf \- configuration file for the pam_time module +.SH "DESCRIPTION" +.PP +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. +.PP +For this module to function correctly there must be a correctly formatted +\fI/etc/security/time.conf\fR +file present. White spaces are ignored and lines maybe extended with '\\' (escaped newlines). Text following a '#' is ignored to the end of the line. +.PP +The syntax of the lines is as follows: +.PP + +\fIservices\fR;\fIttys\fR;\fIusers\fR;\fItimes\fR +.PP +In words, each rule occupies a line, terminated with a newline or the beginning of a comment; a '\fB#\fR'. It contains four fields separated with semicolons, '\fB;\fR'. +.PP +The first field, the +\fIservices\fR +field, is a logic list of PAM service names that the rule applies to. +.PP +The second field, the +\fItty\fR +field, is a logic list of terminal names that this rule applies to. +.PP +The third field, the +\fIusers\fR +field, is a logic list of users or a netgroup of users to whom this rule applies. +.PP +For these items the simple wildcard '*' may be used only once. With netgroups no wildcards or logic operators are allowed. +.PP +The +\fItimes\fR +field is used to indicate the times at which this rule applies. The format here is a logic list of day/time\-range entries. The days are specified by a sequence of two character entries, MoTuSa for example is Monday Tuesday and Saturday. Note that repeated days are unset MoMo = no day, and MoWk = all weekdays bar Monday. The two character combinations accepted are Mo Tu We Th Fr Sa Su Wk Wd Al, the last two being week\-end days and all 7 days of the week respectively. As a final example, AlFr means all days except Friday. +.PP +Each day/time\-range can be prefixed with a '!' to indicate "anything but". The time\-range part is two 24\-hour times HHMM, separated by a hyphen, indicating the start and finish time (if the finish time is smaller than the start time it is deemed to apply on the following day). +.PP +For a rule to be active, ALL of service+ttys+users must be satisfied by the applying process. +.PP +Note, currently there is no daemon enforcing the end of a session. This needs to be remedied. +.PP +Poorly formatted rules are logged as errors using +\fBsyslog\fR(3). +.SH "EXAMPLES" +.PP +These are some example lines which might be specified in +\fI/etc/security/time.conf\fR. +.PP +All users except for +\fIroot\fR +are denied access to console\-login at all times: +.sp +.RS 3n +.nf +login ; tty* & !ttyp* ; !root ; !Al0000\-2400 + +.fi +.RE +.sp +.PP +Games (configured to use PAM) are only to be accessed out of working hours. This rule does not apply to the user +\fIwaster\fR: +.sp +.RS 3n +.nf + +games ; * ; !waster ; Wd0000\-2400 | Wk1800\-0800 + +.fi +.RE +.sp +.SH "SEE ALSO" +.PP + +\fBpam_time\fR(8), +\fBpam.d\fR(5), +\fBpam\fR(8) +.SH "AUTHORS" +.PP +pam_time was written by Andrew G. Morgan <morgan@kernel.org>. diff --git a/modules/pam_time/time.conf.5.xml b/modules/pam_time/time.conf.5.xml new file mode 100644 index 00000000..08abb53b --- /dev/null +++ b/modules/pam_time/time.conf.5.xml @@ -0,0 +1,143 @@ +<?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="time.conf"> + + <refmeta> + <refentrytitle>time.conf</refentrytitle> + <manvolnum>5</manvolnum> + <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>time.conf</refname> + <refpurpose>configuration file for the pam_time module</refpurpose> + </refnamediv> + + <refsect1 id='time.conf-description'> + <title>DESCRIPTION</title> + + <para> + 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. + </para> + <para> + For this module to function correctly there must be a correctly + formatted <filename>/etc/security/time.conf</filename> file present. + White spaces are ignored and lines maybe extended with '\' (escaped + newlines). Text following a '#' is ignored to the end of the line. + </para> + + <para> + The syntax of the lines is as follows: + </para> + + <para> + <replaceable>services</replaceable>;<replaceable>ttys</replaceable>;<replaceable>users</replaceable>;<replaceable>times</replaceable> + </para> + <para> + In words, each rule occupies a line, terminated with a newline + or the beginning of a comment; a '<emphasis remap='B'>#</emphasis>'. + It contains four fields separated with semicolons, + '<emphasis remap='B'>;</emphasis>'. + </para> + + <para> + The first field, the <replaceable>services</replaceable> field, + is a logic list of PAM service names that the rule applies to. + </para> + + <para> + The second field, the <replaceable>tty</replaceable> + field, is a logic list of terminal names that this rule applies to. + </para> + + <para> + The third field, the <replaceable>users</replaceable> + field, is a logic list of users or a netgroup of users to whom this + rule applies. + </para> + + <para> + For these items the simple wildcard '*' may be used only once. + With netgroups no wildcards or logic operators are allowed. + </para> + + <para> + The <replaceable>times</replaceable> field is used to indicate the times + at which this rule applies. The format here is a logic + list of day/time-range entries. The days are specified by a sequence of + two character entries, MoTuSa for example is Monday Tuesday and Saturday. + Note that repeated days are unset MoMo = no day, and MoWk = all weekdays + bar Monday. The two character combinations accepted are Mo Tu We Th Fr Sa + Su Wk Wd Al, the last two being week-end days and all 7 days of the week + respectively. As a final example, AlFr means all days except Friday. + </para> + <para> + Each day/time-range can be prefixed with a '!' to indicate + "anything but". + The time-range part is two 24-hour times HHMM, separated by a hyphen, + indicating the start and finish time (if the finish time is smaller + than the start time it is deemed to apply on the following day). + </para> + + <para> + For a rule to be active, ALL of service+ttys+users must be satisfied + by the applying process. + </para> + <para> + Note, currently there is no daemon enforcing the end of a session. + This needs to be remedied. + </para> + <para> + Poorly formatted rules are logged as errors using + <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + </para> + </refsect1> + + <refsect1 id="time.conf-examples"> + <title>EXAMPLES</title> + <para> + These are some example lines which might be specified in + <filename>/etc/security/time.conf</filename>. + </para> + <para> + All users except for <emphasis>root</emphasis> are denied access + to console-login at all times: + <programlisting> +login ; tty* & !ttyp* ; !root ; !Al0000-2400 + </programlisting> + </para> + + <para> + Games (configured to use PAM) are only to be accessed out of + working hours. This rule does not apply to the user + <emphasis>waster</emphasis>: + <programlisting> +games ; * ; !waster ; Wd0000-2400 | Wk1800-0800 + </programlisting> + </para> + </refsect1> + + <refsect1 id="time.conf-see_also"> + <title>SEE ALSO</title> + <para> + <citerefentry><refentrytitle>pam_time</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> + </para> + </refsect1> + + <refsect1 id="time.conf-author"> + <title>AUTHORS</title> + <para> + pam_time was written by Andrew G. Morgan <morgan@kernel.org>. + </para> + </refsect1> +</refentry> |