diff options
Diffstat (limited to '')
-rw-r--r-- | doc/man/pam_get_user.3 | 138 | ||||
-rw-r--r-- | doc/man/pam_get_user.3.xml | 164 |
2 files changed, 302 insertions, 0 deletions
diff --git a/doc/man/pam_get_user.3 b/doc/man/pam_get_user.3 new file mode 100644 index 0000000..12cfaf4 --- /dev/null +++ b/doc/man/pam_get_user.3 @@ -0,0 +1,138 @@ +'\" t +.\" Title: pam_get_user +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" 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_GET_USER" "3" "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_get_user \- get user name +.SH "SYNOPSIS" +.sp +.ft B +.nf +#include <security/pam_modules\&.h> +.fi +.ft +.HP \w'int\ pam_get_user('u +.BI "int pam_get_user(const\ pam_handle_t\ *" "pamh" ", const\ char\ **" "user" ", const\ char\ *" "prompt" ");" +.SH "DESCRIPTION" +.PP +The +\fBpam_get_user\fR +function returns the name of the user specified by +\fBpam_start\fR(3)\&. If no user was specified it returns what +\fBpam_get_item (pamh, PAM_USER, \&.\&.\&. );\fR +would have returned\&. If this is NULL it obtains the username via the +\fBpam_conv\fR(3) +mechanism, it prompts the user with the first non\-NULL string in the following list: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The +\fIprompt\fR +argument passed to the function\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +What is returned by pam_get_item (pamh, PAM_USER_PROMPT, \&.\&.\&. ); +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The default prompt: "login: " +.RE +.PP +By whatever means the username is obtained, a pointer to it is returned as the contents of +\fI*user\fR\&. Note, this memory should +\fBnot\fR +be +\fIfree()\fR\*(Aqd or +\fImodified\fR +by the module\&. +.PP +This function sets the +\fIPAM_USER\fR +item associated with the +\fBpam_set_item\fR(3) +and +\fBpam_get_item\fR(3) +functions\&. +.SH "RETURN VALUES" +.PP +PAM_SUCCESS +.RS 4 +User name was successful retrieved\&. +.RE +.PP +PAM_SYSTEM_ERR +.RS 4 +A NULL pointer was submitted\&. +.RE +.PP +PAM_CONV_ERR +.RS 4 +The conversation method supplied by the application failed to obtain the username\&. +.RE +.PP +PAM_BUF_ERR +.RS 4 +Memory buffer error\&. +.RE +.PP +PAM_ABORT +.RS 4 +Error resuming an old conversation\&. +.RE +.PP +PAM_CONV_AGAIN +.RS 4 +The conversation method supplied by the application is waiting for an event\&. +.RE +.SH "SEE ALSO" +.PP +\fBpam_end\fR(3), +\fBpam_get_item\fR(3), +\fBpam_set_item\fR(3), +\fBpam_strerror\fR(3) diff --git a/doc/man/pam_get_user.3.xml b/doc/man/pam_get_user.3.xml new file mode 100644 index 0000000..8bb176e --- /dev/null +++ b/doc/man/pam_get_user.3.xml @@ -0,0 +1,164 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!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_get_user'> + + <refmeta> + <refentrytitle>pam_get_user</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id='pam_get_user-name'> + <refname>pam_get_user</refname> + <refpurpose> + get user name + </refpurpose> + </refnamediv> + + +<!-- body begins here --> + + <refsynopsisdiv> + + <funcsynopsis id="pam_get_user-synopsis"> + <funcsynopsisinfo>#include <security/pam_modules.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>pam_get_user</function></funcdef> + <paramdef>const pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>const char **<parameter>user</parameter></paramdef> + <paramdef>const char *<parameter>prompt</parameter></paramdef> + </funcprototype> + </funcsynopsis> + + </refsynopsisdiv> + + + <refsect1 id="pam_get_user-description"> + <title>DESCRIPTION</title> + <para> + The <function>pam_get_user</function> function returns the + name of the user specified by + <citerefentry> + <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>. If no user was specified it returns what + <function>pam_get_item (pamh, PAM_USER, ... );</function> would + have returned. If this is NULL it obtains the username via the + <citerefentry> + <refentrytitle>pam_conv</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> mechanism, it prompts the user with the first + non-NULL string in the following list: + </para> + + <itemizedlist> + <listitem> + <para> + The <emphasis>prompt</emphasis> argument passed to the function. + </para> + </listitem> + <listitem> + <para> + What is returned by pam_get_item (pamh, PAM_USER_PROMPT, ... ); + </para> + </listitem> + <listitem> + <para> + The default prompt: "login: " + </para> + </listitem> + </itemizedlist> + <para> + By whatever means the username is obtained, a pointer to it is + returned as the contents of <emphasis>*user</emphasis>. Note, + this memory should <emphasis remap="B">not</emphasis> be + <emphasis>free()</emphasis>'d or <emphasis>modified</emphasis> + by the module. + </para> + <para> + This function sets the <emphasis>PAM_USER</emphasis> item + associated with the + <citerefentry> + <refentrytitle>pam_set_item</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> and + <citerefentry> + <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> functions. + </para> + </refsect1> + + <refsect1 id="pam_get_user-return_values"> + <title>RETURN VALUES</title> + <variablelist> + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + User name was successful retrieved. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_SYSTEM_ERR</term> + <listitem> + <para> + A NULL pointer was submitted. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_CONV_ERR</term> + <listitem> + <para> + The conversation method supplied by the + application failed to obtain the username. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_BUF_ERR</term> + <listitem> + <para> + Memory buffer error. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_ABORT</term> + <listitem> + <para> + Error resuming an old conversation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_CONV_AGAIN</term> + <listitem> + <para> + The conversation method supplied by the application + is waiting for an event. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id="pam_get_user-see_also"> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam_end</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_get_item</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_set_item</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> + </para> + </refsect1> + +</refentry> |