diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 12:01:37 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 12:01:37 +0000 |
commit | de848d9e9146434817c65d74d1d0313e9d729462 (patch) | |
tree | dcbd0efb229b17f696f7195671f05b354b4f70fc /doc/man/pam_get_data.3 | |
parent | Initial commit. (diff) | |
download | pam-de848d9e9146434817c65d74d1d0313e9d729462.tar.xz pam-de848d9e9146434817c65d74d1d0313e9d729462.zip |
Adding upstream version 1.4.0.upstream/1.4.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | doc/man/pam_get_data.3 | 82 | ||||
-rw-r--r-- | doc/man/pam_get_data.3.xml | 108 |
2 files changed, 190 insertions, 0 deletions
diff --git a/doc/man/pam_get_data.3 b/doc/man/pam_get_data.3 new file mode 100644 index 0000000..7c6b23e --- /dev/null +++ b/doc/man/pam_get_data.3 @@ -0,0 +1,82 @@ +'\" t +.\" Title: pam_get_data +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 06/08/2020 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" Language: English +.\" +.TH "PAM_GET_DATA" "3" "06/08/2020" "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_data \- get module internal data +.SH "SYNOPSIS" +.sp +.ft B +.nf +#include <security/pam_modules\&.h> +.fi +.ft +.HP \w'int\ pam_get_data('u +.BI "int pam_get_data(const\ pam_handle_t\ *" "pamh" ", const\ char\ *" "module_data_name" ", const\ void\ **" "data" ");" +.SH "DESCRIPTION" +.PP +This function together with the +\fBpam_set_data\fR(3) +function is useful to manage module\-specific data meaningful only to the calling PAM module\&. +.PP +The +\fBpam_get_data\fR +function looks up the object associated with the (hopefully) unique string +\fImodule_data_name\fR +in the PAM context specified by the +\fIpamh\fR +argument\&. A successful call to +\fBpam_get_data\fR +will result in +\fIdata\fR +pointing to the object\&. Note, this data is +\fInot\fR +a copy and should be treated as +\fIconstant\fR +by the module\&. +.SH "RETURN VALUES" +.PP +PAM_SUCCESS +.RS 4 +Data was successful retrieved\&. +.RE +.PP +PAM_SYSTEM_ERR +.RS 4 +A NULL pointer was submitted as PAM handle or the function was called by an application\&. +.RE +.PP +PAM_NO_MODULE_DATA +.RS 4 +Module data not found or there is an entry, but it has the value NULL\&. +.RE +.SH "SEE ALSO" +.PP +\fBpam_end\fR(3), +\fBpam_set_data\fR(3), +\fBpam_strerror\fR(3) diff --git a/doc/man/pam_get_data.3.xml b/doc/man/pam_get_data.3.xml new file mode 100644 index 0000000..e84e5a4 --- /dev/null +++ b/doc/man/pam_get_data.3.xml @@ -0,0 +1,108 @@ +<?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_data'> + + <refmeta> + <refentrytitle>pam_get_data</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id='pam_get_data-name'> + <refname>pam_get_data</refname> + <refpurpose> + get module internal data + </refpurpose> + </refnamediv> + + +<!-- body begins here --> + + <refsynopsisdiv> + + <funcsynopsis id="pam_get_data-synopsis"> + <funcsynopsisinfo>#include <security/pam_modules.h></funcsynopsisinfo> + <funcprototype> + <funcdef>int <function>pam_get_data</function></funcdef> + <paramdef>const pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>const char *<parameter>module_data_name</parameter></paramdef> + <paramdef>const void **<parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + + </refsynopsisdiv> + + + <refsect1 id="pam_get_data-description"> + <title>DESCRIPTION</title> + <para> + This function together with the + <citerefentry> + <refentrytitle>pam_set_data</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function + is useful to manage module-specific data meaningful only to + the calling PAM module. + </para> + <para> + The <function>pam_get_data</function> function looks up the + object associated with the (hopefully) unique string + <emphasis>module_data_name</emphasis> in the PAM context + specified by the <emphasis>pamh</emphasis> argument. + A successful call to + <function>pam_get_data</function> will result in + <emphasis>data</emphasis> pointing to the object. Note, + this data is <emphasis>not</emphasis> a copy and should be + treated as <emphasis>constant</emphasis> by the module. + </para> + </refsect1> + + <refsect1 id="pam_get_data-return_values"> + <title>RETURN VALUES</title> + <variablelist> + <varlistentry> + <term>PAM_SUCCESS</term> + <listitem> + <para> + Data was successful retrieved. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_SYSTEM_ERR</term> + <listitem> + <para> + A NULL pointer was submitted as PAM handle or the + function was called by an application. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>PAM_NO_MODULE_DATA</term> + <listitem> + <para> + Module data not found or there is an entry, but it has + the value NULL. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id="pam_get_data-see_also"> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam_end</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_set_data</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> + </para> + </refsect1> + +</refentry> |