]> granicus.if.org Git - linux-pam/commitdiff
Relevant BUGIDs:
authorThorsten Kukuk <kukuk@thkukuk.de>
Sun, 4 Jun 2006 12:11:15 +0000 (12:11 +0000)
committerThorsten Kukuk <kukuk@thkukuk.de>
Sun, 4 Jun 2006 12:11:15 +0000 (12:11 +0000)
Purpose of commit: new feature

Commit summary:
---------------

2006-06-04  Thorsten Kukuk  <kukuk@thkukuk.de>

        * modules/pam_rootok/Makefile.am: Include Make.xml.rules.
        * modules/pam_rootok/pam_rootok.8.xml: New.
        * modules/pam_rootok/pam_rootok.8: New, generated from xml file.
        * modules/pam_rootok/README.xml: New.
        * modules/pam_rootok/README: Regenerated from xml file.

ChangeLog
NEWS
modules/pam_rootok/Makefile.am
modules/pam_rootok/README
modules/pam_rootok/README.xml [new file with mode: 0644]
modules/pam_rootok/pam_rootok.8 [new file with mode: 0644]
modules/pam_rootok/pam_rootok.8.xml [new file with mode: 0644]

index 0ee0d4fb4bcf1473b72503ef7f57a30942181e16..1371a5f5308e18f2a1b51d609de14606a70bdf7b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2006-06-04  Thorsten Kukuk  <kukuk@thkukuk.de>
 
+       * modules/pam_rootok/Makefile.am: Include Make.xml.rules.
+       * modules/pam_rootok/pam_rootok.8.xml: New.
+       * modules/pam_rootok/pam_rootok.8: New, generated from xml file.
+       * modules/pam_rootok/README.xml: New.
+       * modules/pam_rootok/README: Regenerated from xml file.
+
        * modules/pam_permit/Makefile.am: Include Make.xml.rules.
        * modules/pam_permit/pam_permit.8.xml: New.
        * modules/pam_permit/pam_permit.8: New, generated from xml file.
diff --git a/NEWS b/NEWS
index 4d228a23d247bbb0295fe5a2153dc0fe3864641f..47cd3b9e2ad606160828ad3a12e928afdc8c7496 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -5,7 +5,8 @@ Linux-PAM NEWS -- history of user-visible changes.
 * Fixed all problems found by Coverity
 * Add manual page for pam_mkhomedir, pam_umask, pam_filter,
   pam_issue, pam_ftp, pam_group, pam_lastlog, pam_listfile,
-  pam_localuser, pam_mail, pam_motd, pam_nologin, pam_permit
+  pam_localuser, pam_mail, pam_motd, pam_nologin, pam_permit,
+  pam_rootok
 
 Release 0.99.4.0
 
index f8e2d9c70f6e3d029ca3fbea466e7978e50b8641..7a97f20f60a84024fdb72481b6261446e00980af 100644 (file)
@@ -4,7 +4,10 @@
 
 CLEANFILES = *~
 
-EXTRA_DIST = README tst-pam_rootok
+EXTRA_DIST = README $(MANS) $(XMLS) tst-pam_rootok
+
+man_MANS = pam_rootok.8
+XMLS = README.xml pam_rootok.8.xml
 
 TESTS = tst-pam_rootok
 
@@ -22,3 +25,9 @@ if HAVE_VERSIONING
 endif
 
 securelib_LTLIBRARIES = pam_rootok.la
+
+if ENABLE_REGENERATE_MAN
+noinst_DATA = README
+README: pam_rootok.8.xml
+-include $(top_srcdir)/Make.xml.rules
+endif
index cccb5ce11b5027d8e0e431b4ad6cdad3a18e8dcf..55a447565262884984375e52d05434b21aacd845 100644 (file)
@@ -1,18 +1,33 @@
-# $Id$
-#
+pam_rootok — Gain only root access
 
-this module is an authentication module that performs one task: if the
-id of the user is '0' then it returns 'PAM_SUCCESS' with the
-'sufficient' /etc/pam.conf control flag it can be used to allow
-password free access to some service for 'root'
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
-Recognized arguments:
+DESCRIPTION
 
-       debug           write a message to syslog indicating success or
-                       failure.
+pam_rootok is a PAM module that authenticates the user if their UID is 0.
+Applications that are created setuid-root generally retain the UID of the user
+but run with the authority of an enhanced effective-UID. It is the real UID
+that is checked.
 
-module services provided:
+OPTIONS
 
-       auth            _authentication and _setcred (blank)
+debug
+
+    Print debug information.
+
+EXAMPLES
+
+In the case of the su(1) application the historical usage is to permit the
+superuser to adopt the identity of a lesser user without the use of a password.
+To obtain this behavior with PAM the following pair of lines are needed for the
+corresponding entry in the /etc/pam.d/su configuration file:
+
+# su authentication. Root is granted access by default.
+auth  sufficient   pam_rootok.so
+auth  required     pam_unix.so
+
+
+AUTHOR
+
+pam_rootok was written by Andrew G. Morgan, <morgan@kernel.org>.
 
-Andrew Morgan
diff --git a/modules/pam_rootok/README.xml b/modules/pam_rootok/README.xml
new file mode 100644 (file)
index 0000000..6fb58cd
--- /dev/null
@@ -0,0 +1,41 @@
+<?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 pamaccess SYSTEM "pam_rootok.8.xml">
+-->
+]>
+
+<article>
+
+  <articleinfo>
+
+    <title>
+      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_rootok.8.xml" xpointer='xpointer(//refnamediv[@id = "pam_rootok-name"]/*)'/>
+    </title>
+
+  </articleinfo>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_rootok.8.xml" xpointer='xpointer(//refsect1[@id = "pam_rootok-description"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_rootok.8.xml" xpointer='xpointer(//refsect1[@id = "pam_rootok-options"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_rootok.8.xml" xpointer='xpointer(//refsect1[@id = "pam_rootok-examples"]/*)'/>
+  </section>
+
+  <section>
+    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+      href="pam_rootok.8.xml" xpointer='xpointer(//refsect1[@id = "pam_rootok-author"]/*)'/>
+  </section>
+
+</article>
diff --git a/modules/pam_rootok/pam_rootok.8 b/modules/pam_rootok/pam_rootok.8
new file mode 100644 (file)
index 0000000..b1436f7
--- /dev/null
@@ -0,0 +1,77 @@
+.\"     Title: pam_rootok
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\"      Date: 06/04/2006
+.\"    Manual: Linux\-PAM Manual
+.\"    Source: Linux\-PAM Manual
+.\"
+.TH "PAM_ROOTOK" "8" "06/04/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+pam_rootok \- Gain only root access
+.SH "SYNOPSIS"
+.HP 14
+\fBpam_rootok.so\fR [debug]
+.SH "DESCRIPTION"
+.PP
+pam_rootok is a PAM module that authenticates the user if their
+\fIUID\fR
+is
+\fI0\fR. Applications that are created setuid\-root generally retain the
+\fIUID\fR
+of the user but run with the authority of an enhanced effective\-UID. It is the real
+\fIUID\fR
+that is checked.
+.SH "OPTIONS"
+.TP 3n
+\fBdebug\fR
+Print debug information.
+.SH "MODULE SERVICES PROVIDED"
+.PP
+Only the
+\fBauth\fR
+service is supported.
+.SH "RETURN VALUES"
+.TP 3n
+PAM_SUCCESS
+The
+\fIUID\fR
+is
+\fI0\fR.
+.TP 3n
+PAM_AUTH_ERR
+The
+\fIUID\fR
+is
+\fBnot\fR
+\fI0\fR.
+.SH "EXAMPLES"
+.PP
+In the case of the
+\fBsu\fR(1)
+application the historical usage is to permit the superuser to adopt the identity of a lesser user without the use of a password. To obtain this behavior with PAM the following pair of lines are needed for the corresponding entry in the
+\fI/etc/pam.d/su\fR
+configuration file:
+.sp
+.RS 3n
+.nf
+# su authentication. Root is granted access by default.
+auth  sufficient   pam_rootok.so
+auth  required     pam_unix.so
+      
+.fi
+.RE
+.sp
+.SH "SEE ALSO"
+.PP
+
+\fBsu\fR(1),
+\fBpam.conf\fR(5),
+\fBpam.d\fR(8),
+\fBpam\fR(8)
+.SH "AUTHOR"
+.PP
+pam_rootok was written by Andrew G. Morgan, <morgan@kernel.org>.
diff --git a/modules/pam_rootok/pam_rootok.8.xml b/modules/pam_rootok/pam_rootok.8.xml
new file mode 100644 (file)
index 0000000..ec8dee4
--- /dev/null
@@ -0,0 +1,130 @@
+<?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_rootok">
+
+  <refmeta>
+    <refentrytitle>pam_rootok</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
+  </refmeta>
+
+  <refnamediv id="pam_rootok-name">
+    <refname>pam_rootok</refname>
+    <refpurpose>Gain only root access</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis id="pam_rootok-cmdsynopsis">
+      <command>pam_rootok.so</command>
+      <arg choice="opt">
+        debug
+      </arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1 id="pam_rootok-description">
+
+    <title>DESCRIPTION</title>
+
+    <para>
+      pam_rootok is a PAM module that authenticates the user if their
+      <emphasis>UID</emphasis> is <emphasis>0</emphasis>.
+      Applications that are created setuid-root generally retain the
+      <emphasis>UID</emphasis> of the user but run with the authority
+      of an enhanced effective-UID. It is the real <emphasis>UID</emphasis>
+      that is checked.
+    </para>
+  </refsect1>
+
+  <refsect1 id="pam_rootok-options">
+    <title>OPTIONS</title>
+        <variablelist>
+      <varlistentry>
+        <term>
+          <option>debug</option>
+        </term>
+        <listitem>
+          <para>
+            Print debug information.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id="pam_rootok-services">
+    <title>MODULE SERVICES PROVIDED</title>
+    <para>
+      Only the <option>auth</option> service is supported.
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_rootok-return_values'>
+    <title>RETURN VALUES</title>
+    <variablelist>
+      <varlistentry>
+        <term>PAM_SUCCESS</term>
+        <listitem>
+          <para>
+            The <emphasis>UID</emphasis> is <emphasis>0</emphasis>.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>PAM_AUTH_ERR</term>
+        <listitem>
+          <para>
+            The <emphasis>UID</emphasis> is <emphasis remap='B'>not</emphasis>
+            <emphasis>0</emphasis>.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1 id='pam_rootok-examples'>
+    <title>EXAMPLES</title>
+    <para>
+      In the case of the <citerefentry>
+        <refentrytitle>su</refentrytitle><manvolnum>1</manvolnum>
+      </citerefentry> application the historical usage is to
+      permit the superuser to adopt the identity of a lesser user
+      without the use of a password. To obtain this behavior with PAM
+      the following pair of lines are needed for the corresponding entry
+      in the <filename>/etc/pam.d/su</filename> configuration file:
+      <programlisting>
+# su authentication. Root is granted access by default.
+auth  sufficient   pam_rootok.so
+auth  required     pam_unix.so
+      </programlisting>
+    </para>
+  </refsect1>
+
+  <refsect1 id='pam_rootok-see_also'>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>su</refentrytitle><manvolnum>1</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+       <refentrytitle>pam.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_rootok-author'>
+    <title>AUTHOR</title>
+      <para>
+        pam_rootok was written by Andrew G. Morgan, &lt;morgan@kernel.org&gt;.
+      </para>
+  </refsect1>
+
+</refentry>