aboutsummaryrefslogtreecommitdiff
path: root/doc/man/pam_set_data.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/pam_set_data.3')
-rw-r--r--doc/man/pam_set_data.393
1 files changed, 0 insertions, 93 deletions
diff --git a/doc/man/pam_set_data.3 b/doc/man/pam_set_data.3
deleted file mode 100644
index c3a2a689..00000000
--- a/doc/man/pam_set_data.3
+++ /dev/null
@@ -1,93 +0,0 @@
-.\" Title: pam_set_data
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/27/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
-.\"
-.TH "PAM_SET_DATA" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.SH "NAME"
-pam_set_data \- set module internal data
-.SH "SYNOPSIS"
-.sp
-.ft B
-.nf
-#include <security/pam_modules.h>
-.fi
-.ft
-.HP 17
-.BI "int pam_set_data(pam_handle_t\ *" "pamh" ", const\ char\ *" "module_data_name" ", void\ *" "data" ", void\ " "(*cleanup)(pam_handle_t\ *pamh,\ void\ *data,\ int\ error_status)" ");"
-.SH "DESCRIPTION"
-.PP
-The
-\fBpam_set_data\fR
-function associates a pointer to an object with the (hopefully) unique string
-\fImodule_data_name\fR
-in the PAM context specified by the
-\fIpamh\fR
-argument.
-.PP
-PAM modules may be dynamically loadable objects. In general such files should not contain
-\fIstatic\fR
-variables. This function and its counterpart
-\fBpam_get_data\fR(3), provide a mechanism for a module to associate some data with the handle
-\fIpamh\fR. Typically a module will call the
-\fBpam_set_data\fR
-function to register some data under a (hopefully) unique
-\fImodule_data_name\fR. The data is available for use by other modules too but
-\fInot\fR
-by an application. Since this functions stores only a pointer to the
-\fIdata\fR, the module should not modify or free the content of it.
-.PP
-The function
-\fBcleanup()\fR
-is associated with the
-\fIdata\fR
-and, if non\-NULL, it is called when this data is over\-written or following a call to
-\fBpam_end\fR(3).
-.PP
-The
-\fIerror_status\fR
-argument is used to indicate to the module the sort of action it is to take in cleaning this data item. As an example, Kerberos creates a ticket file during the authentication phase, this file might be associated with a data item. When
-\fBpam_end\fR(3)
-is called by the module, the
-\fIerror_status\fR
-carries the return value of the
-\fBpam_authenticate\fR(3)
-or other
-\fIlibpam\fR
-function as appropriate. Based on this value the Kerberos module may choose to delete the ticket file (\fIauthentication failure\fR) or leave it in place.
-.PP
-The
-\fIerror_status\fR
-may have been logically OR'd with either of the following two values:
-.TP 3n
-PAM_DATA_REPLACE
-When a data item is being replaced (through a second call to
-\fBpam_set_data\fR) this mask is used. Otherwise, the call is assumed to be from
-\fBpam_end\fR(3).
-.TP 3n
-PAM_DATA_SILENT
-Which indicates that the process would prefer to perform the
-\fBcleanup()\fR
-quietly. That is, discourages logging/messages to the user.
-.SH "RETURN VALUES"
-.TP 3n
-PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
-PAM_SUCCESS
-Data was successful stored.
-.TP 3n
-PAM_SYSTEM_ERR
-A NULL pointer was submitted as PAM handle or the function was called by an application.
-.SH "SEE ALSO"
-.PP
-
-\fBpam_end\fR(3),
-\fBpam_get_data\fR(3),
-\fBpam_strerror\fR(3)