path: root/doc/man/pam_set_item.3
diff options
Diffstat (limited to 'doc/man/pam_set_item.3')
1 files changed, 112 insertions, 52 deletions
diff --git a/doc/man/pam_set_item.3 b/doc/man/pam_set_item.3
index b0582778..0fe861c6 100644
--- a/doc/man/pam_set_item.3
+++ b/doc/man/pam_set_item.3
@@ -1,55 +1,115 @@
-.\" Hey Emacs! This file is -*- nroff -*- source.
-.\" $Id$
-.\" Copyright (c) Andrew G. Morgan 1996,1997 <>
-.TH PAM_SET_ITEM 3 "2001 Jan 21" "Linux-PAM" "App. Programmers' Manual"
-pam_set_item, pam_get_item \- item manipulation under PAM
-.B #include <security/pam_appl.h>
-.B #include <secruity/pam_modules.h>
+.\" ** 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_SET_ITEM" "3" "02/12/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.\" disable justification (adjust text to left margin only) l
+pam_set_item \- set and update PAM informations
+\fB#include <security/pam_modules.h>\fR
+.HP 17
+\fBint\ \fBpam_set_item\fR\fR\fB(\fR\fBpam_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
+function allows applications and PAM service modules to access and to update PAM informations of
+\fIitem_type\fR. For this a copy of the object pointed to by the
+argument is created. The following
+\fIitem_type\fRs are supported:
+The service name (which identifies that PAM stack that the PAM functions will use to authenticate the program).
+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.
+The string used when prompting for a user's name. The default value for this string is a localized version of "login: ".
+The terminal name: prefixed by
+if it is a device file; for graphical, X\-based, applications the value for this item should be the
+The requesting user name: local name for a locally requesting user or a remote user name for a remote requesting user.
-.BI "int pam_set_item(pam_handle_t " *pamh ", int " item_type ", void " *item ");"
+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.
-.BI "int pam_get_item(const pam_handle_t " *pamh ", int " item_type ", const void " **item_p ");"
-.sp 2
-.B pam_set_item
-.B pam_set_item
-These functions are currently undocumented in a man page, but see the
-end of this man page for more information (the PAM guides).
-On success
-is returned, all other return values should be treated as errors.
-May be translated to text with
-.BR pam_strerror "(3). "
-DCE-RFC 86.0, October 1995.
-.sp 2
-none known.
-.BR pam (8)
+should always identify the requesting user. In some cases,
+may be NULL. In such situations, it is unclear who the requesting entity is.
+The requesting hostname (the hostname of the machine from which the
+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.
+The authentication token (often a password). This token should be ignored by all module functions besides
-.BR pam_strerror "(3)."
-Also, see the three
-.BR Linux-PAM
-Guides, for
-.BR "System administrators" ", "
-.BR "module developers" ", "
-.BR "application developers" ". "
+\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.
+The old authentication token. This token should be ignored by all module functions except
+The pam_conv structure. See
+A function pointer to redirect centrally managed failure delays. See
+For all
+\fIitem_type\fRs, other than PAM_CONV and PAM_FAIL_DELAY,
+is a pointer to a <NUL> terminated character string. In the case of PAM_CONV,
+points to an initialized
+structure. In the case of PAM_FAIL_DELAY,
+is a function pointer:
+\fBvoid (*delay_fn)(int retval, unsigned usec_delay, void *appdata_ptr)\fR
+Both, PAM_AUTHTOK and PAM_OLDAUTHTOK, will be reseted before returning to the application. Which means an application is not able to access the authentication tokens.
+The application attempted to set an undefined or inaccessible item.
+Memory buffer error.
+Data was successful updated.
+passed as first argument was invalid.