diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/man/pam_getenvlist.3 | 66 | ||||
| -rw-r--r-- | doc/man/pam_getenvlist.3.xml | 85 |
2 files changed, 151 insertions, 0 deletions
diff --git a/doc/man/pam_getenvlist.3 b/doc/man/pam_getenvlist.3 new file mode 100644 index 0000000..9ce441d --- /dev/null +++ b/doc/man/pam_getenvlist.3 @@ -0,0 +1,66 @@ +'\" t +.\" Title: pam_getenvlist +.\" 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_GETENVLIST" "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_getenvlist \- getting the PAM environment +.SH "SYNOPSIS" +.sp +.ft B +.nf +#include <security/pam_appl\&.h> +.fi +.ft +.HP \w'char\ **pam_getenvlist('u +.BI "char **pam_getenvlist(pam_handle_t\ *" "pamh" ");" +.SH "DESCRIPTION" +.PP +The +\fBpam_getenvlist\fR +function returns a complete copy of the PAM environment as associated with the handle +\fIpamh\fR\&. The PAM environment variables represent the contents of the regular environment variables of the authenticated user when service is granted\&. +.PP +The format of the memory is a malloc()\*(Aqd array of char pointers, the last element of which is set to NULL\&. Each of the non\-NULL entries in this array point to a NUL terminated and malloc()\*(Aqd char string of the form: "\fIname=value\fR"\&. +.PP +It should be noted that this memory will never be free()\*(Aqd by libpam\&. Once obtained by a call to +\fBpam_getenvlist\fR, it is the responsibility of the calling application to free() this memory\&. +.PP +It is by design, and not a coincidence, that the format and contents of the returned array matches that required for the third argument of the +\fBexecle\fR(3) +function call\&. +.SH "RETURN VALUES" +.PP +The +\fBpam_getenvlist\fR +function returns NULL on failure\&. +.SH "SEE ALSO" +.PP +\fBpam_start\fR(3), +\fBpam_getenv\fR(3), +\fBpam_putenv\fR(3), +\fBpam\fR(8) diff --git a/doc/man/pam_getenvlist.3.xml b/doc/man/pam_getenvlist.3.xml new file mode 100644 index 0000000..1c29b73 --- /dev/null +++ b/doc/man/pam_getenvlist.3.xml @@ -0,0 +1,85 @@ +<?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_getenvlist'> + <refmeta> + <refentrytitle>pam_getenvlist</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_getenvlist-name"> + <refname>pam_getenvlist</refname> + <refpurpose>getting the PAM environment</refpurpose> + </refnamediv> + +<!-- body begins here --> + + <refsynopsisdiv> + <funcsynopsis id='pam_getenvlist-synopsis'> + <funcsynopsisinfo>#include <security/pam_appl.h></funcsynopsisinfo> + <funcprototype> + <funcdef>char **<function>pam_getenvlist</function></funcdef> + <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + + <refsect1 id='pam_getenvlist-description'> + <title>DESCRIPTION</title> + <para> + The <function>pam_getenvlist</function> function returns a complete + copy of the PAM environment as associated with the handle + <emphasis>pamh</emphasis>. The PAM environment variables + represent the contents of the regular environment variables of the + authenticated user when service is granted. + </para> + <para> + The format of the memory is a malloc()'d array of char pointers, + the last element of which is set to NULL. Each of the non-NULL + entries in this array point to a NUL terminated and malloc()'d + char string of the form: "<emphasis>name=value</emphasis>". + </para> + <para> + It should be noted that this memory will never be free()'d by + libpam. Once obtained by a call to + <function>pam_getenvlist</function>, it is the responsibility of + the calling application to free() this memory. + </para> + <para> + It is by design, and not a coincidence, that the format and contents + of the returned array matches that required for the third argument of + the + <citerefentry> + <refentrytitle>execle</refentrytitle><manvolnum>3</manvolnum> + </citerefentry> function call. + </para> + </refsect1> + + <refsect1 id="pam_getenvlist-return_values"> + <title>RETURN VALUES</title> + <para> + The <function>pam_getenvlist</function> function returns NULL + on failure. + </para> + </refsect1> + + <refsect1 id='pam_getenvlist-see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_getenv</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry> |