path: root/doc/man/pam_get_item.3
diff options
authorThorsten Kukuk <>2006-06-02 15:37:38 +0000
committerThorsten Kukuk <>2006-06-02 15:37:38 +0000
commitbad0ed8d159cb77466ed81a624355b1e80ead0dc (patch)
treec1115143eded6faa7e8fe0abc42fc50d4e28fe17 /doc/man/pam_get_item.3
parent29a98911d9cb5e9187c1afe4e161c6861fac4f2b (diff)
Relevant BUGIDs: 1427738
Purpose of commit: new feature/bugfix Commit summary: --------------- 2006-06-02 Thorsten Kukuk <> * doc/man/PAM.8: Regenerate with DocBook XSL Stylesheets v1.70.1. * doc/man/pam.3: Likewise. * doc/man/pam.conf.5: Likewise. * doc/man/pam_acct_mgmt.3: Likewise. * doc/man/pam_authenticate.3: Likewise. * doc/man/pam_chauthtok.3: Likewise. * doc/man/pam_close_session.3: Likewise. * doc/man/pam_conv.3: Likewise. * doc/man/pam_end.3: Likewise. * doc/man/pam_error.3: Likewise. * doc/man/pam_fail_delay.3: Likewise. * doc/man/pam_get_data.3: Likewise. * doc/man/pam_get_item.3: Likewise. * doc/man/pam_get_user.3: Likewise. * doc/man/pam_getenv.3: Likewise. * doc/man/pam_getenvlist.3: Likewise. * doc/man/pam_info.3: Likewise. * doc/man/pam_open_session.3: Likewise. * doc/man/pam_prompt.3: Likewise. * doc/man/pam_putenv.3: Likewise. * doc/man/pam_set_data.3: Likewise. * doc/man/pam_set_item.3: Likewise. * doc/man/pam_setcred.3: Likewise. * doc/man/pam_sm_acct_mgmt.3: Likewise. * doc/man/pam_start.3: Likewise. * doc/man/pam_strerror.3: Likewise. * doc/man/pam_syslog.3: Likewise. * modules/pam_access/access.conf.5: Likewise. * modules/pam_access/pam_access.8: Likewise. * modules/pam_cracklib/pam_cracklib.8: Likewise. * modules/pam_deny/pam_deny.8: Likewise. * modules/pam_echo/pam_echo.8: Likewise. * modules/pam_env/pam_env.8: Likewise. * modules/pam_env/pam_env.conf.5: Likewise. * modules/pam_exec/pam_exec.8: Likewise. * modules/pam_filter/pam_filter.8: Likewise. * modules/pam_ftp/pam_ftp.8: Likewise. * modules/pam_group/group.conf.5: Likewise. * modules/pam_group/pam_group.8: Likewise. * modules/pam_issue/pam_issue.8: Likewise. * modules/pam_lastlog/pam_lastlog.8: Likewise. * modules/pam_mkhomedir/pam_mkhomedir.8: Likewise. * modules/pam_succeed_if/pam_succeed_if.8: Likewise. * modules/pam_umask/pam_umask.8: Likewise. * modules/pam_unix/pam_unix_acct.c (pam_sm_acct_mgmt): Use dngettext if available [#1427738]. * Check for dngettext [#1427738]. * po/*.po: Update to dngettext usage. * modules/pam_listfile/ Include Make.xml.rules. * modules/pam_listfile/pam_listfile.8.xml: New. * modules/pam_listfile/pam_listfile.8: New, generated from xml file. * modules/pam_listfile/README.xml: New. * modules/pam_listfile/README: Regenerated from xml file.
Diffstat (limited to 'doc/man/pam_get_item.3')
1 files changed, 33 insertions, 24 deletions
diff --git a/doc/man/pam_get_item.3 b/doc/man/pam_get_item.3
index 421ef4b5..0c4235a8 100644
--- a/doc/man/pam_get_item.3
+++ b/doc/man/pam_get_item.3
@@ -1,8 +1,11 @@
-.\" ** You probably do not want to edit this file directly **
-.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
-.\" Instead of manually editing it, you probably should edit the DocBook XML
-.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "PAM_GET_ITEM" "3" "05/04/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" Title: pam_get_item
+.\" Author:
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <>
+.\" Date: 06/02/2006
+.\" Manual: Linux\-PAM Manual
+.\" Source: Linux\-PAM Manual
+.TH "PAM_GET_ITEM" "3" "06/02/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
.\" disable hyphenation
.\" disable justification (adjust text to left margin only)
@@ -10,10 +13,14 @@
pam_get_item \- getting PAM informations
-\fB#include <security/pam_modules.h>\fR
+.ft B
+#include <security/pam_modules.h>
.HP 17
-\fBint\ \fBpam_get_item\fR\fR\fB(\fR\fBconst\ pam_handle_t\ *\fR\fB\fIpamh\fR\fR\fB, \fR\fBint\ \fR\fB\fIitem_type\fR\fR\fB, \fR\fBconst\ void\ **\fR\fB\fIitem\fR\fR\fB);\fR
+.BI "int pam_get_item(const\ pam_handle_t\ *" "pamh" ", int\ " "item_type" ", const\ void\ **" "item" ");"
@@ -24,41 +31,42 @@ function allows applications and PAM service modules to access and retrieve PAM
contains a pointer to the value of the corresponding item. Note, this is a pointer to the
data and should
\fIfree()\fR'ed or over\-written! The following values are supported for
+.TP 3n
The service name (which identifies that PAM stack that the PAM functions will use to authenticate the program).
+.TP 3n
The username of the entity under whose identity service will be given. That is, following authentication,
identifies the local entity that gets to use the service. Note, this value can be mapped from something (eg., "anonymous") to something else (eg. "guest119") by any module in the PAM stack. As such an application should consult the value of
after each call to a PAM function.
+.TP 3n
The string used when prompting for a user's name. The default value for this string is a localized version of "login: ".
+.TP 3n
The terminal name: prefixed by
if it is a device file; for graphical, X\-based, applications the value for this item should be the
+.TP 3n
The requesting user name: local name for a locally requesting user or a remote user name for a remote requesting user.
Generally an application or module will attempt to supply the value that is most strongly authenticated (a local account before a remote one. The level of trust in this value is embodied in the actual authentication stack associated with the application, so it is ultimately at the discretion of the system administrator.
should always identify the requesting user. In some cases,
may be NULL. In such situations, it is unclear who the requesting entity is.
+.TP 3n
The requesting hostname (the hostname of the machine from which the
@@ -67,21 +75,21 @@ entity is requesting service). That is
does identify the requesting user. In some applications,
may be NULL. In such situations, it is unclear where the authentication request is originating from.
+.TP 3n
The authentication token (often a password). This token should be ignored by all module functions besides
\fBpam_sm_chauthtok\fR(3). In the former function it is used to pass the most recent authentication token from one stacked module to another. In the latter function the token is used for another purpose. It contains the currently active authentication token.
+.TP 3n
The old authentication token. This token should be ignored by all module functions except
+.TP 3n
The pam_conv structure. See
+.TP 3n
A function pointer to redirect centrally managed failure delays. See
@@ -91,26 +99,27 @@ If a service module wishes to obtain the name of the user, it should not use thi
Only a service module is privileged to read the authentication tokens, PAM_AUTHTOK and PAM_OLDAUTHTOK.
+.TP 3n
The application attempted to set an undefined or inaccessible item.
+.TP 3n
Memory buffer error.
+.TP 3n
The value of
was NULL.
+.TP 3n
Data was successful updated.
+.TP 3n
passed as first argument was invalid.