diff options
Diffstat (limited to '')
| -rw-r--r-- | modules/pam_rootok/pam_rootok.8 | 106 | ||||
| -rw-r--r-- | modules/pam_rootok/pam_rootok.8.xml | 131 |
2 files changed, 237 insertions, 0 deletions
diff --git a/modules/pam_rootok/pam_rootok.8 b/modules/pam_rootok/pam_rootok.8 new file mode 100644 index 0000000..861a6a6 --- /dev/null +++ b/modules/pam_rootok/pam_rootok.8 @@ -0,0 +1,106 @@ +'\" t +.\" Title: pam_rootok +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 09/03/2021 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" Language: English +.\" +.TH "PAM_ROOTOK" "8" "09/03/2021" "Linux-PAM Manual" "Linux\-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +pam_rootok \- Gain only root access +.SH "SYNOPSIS" +.HP \w'\fBpam_rootok\&.so\fR\ 'u +\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" +.PP +\fBdebug\fR +.RS 4 +Print debug information\&. +.RE +.SH "MODULE TYPES PROVIDED" +.PP +The +\fBauth\fR, +\fBaccount\fR +and +\fBpassword\fR +module types are provided\&. +.SH "RETURN VALUES" +.PP +PAM_SUCCESS +.RS 4 +The +\fIUID\fR +is +\fI0\fR\&. +.RE +.PP +PAM_AUTH_ERR +.RS 4 +The +\fIUID\fR +is +\fBnot\fR +\fI0\fR\&. +.RE +.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 +/etc/pam\&.d/su +configuration file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# su authentication\&. Root is granted access by default\&. +auth sufficient pam_rootok\&.so +auth required pam_unix\&.so + +.fi +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.PP +\fBsu\fR(1), +\fBpam.conf\fR(5), +\fBpam.d\fR(5), +\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 index 0000000..06457bf --- /dev/null +++ b/modules/pam_rootok/pam_rootok.8.xml @@ -0,0 +1,131 @@ +<?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-types"> + <title>MODULE TYPES PROVIDED</title> + <para> + The <option>auth</option>, <option>account</option> and + <option>password</option> module types are provided. + </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>5</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, <morgan@kernel.org>. + </para> + </refsect1> + +</refentry> |