summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThorsten Kukuk <kukuk@thkukuk.de>2007-11-06 14:58:53 +0000
committerThorsten Kukuk <kukuk@thkukuk.de>2007-11-06 14:58:53 +0000
commitd6e1da52bb5b01a93a60d3aff1223eb6a19082cd (patch)
tree8648c921af83b011e167b0c5cfdf5fc22f205f41 /doc
parenta38a8eae25ee1d7adb5a5eafcf1c41e94974ed90 (diff)
Relevant BUGIDs: 1822762
Purpose of commit: bugfix Commit summary: --------------- 2007-11-01 Peter Breitenlohner <peb@mppmu.mpg.de> * doc/man/pam_conv.3.xml: Correct typo. 2007-10-30 Peter Breitenlohner <peb@mppmu.mpg.de> * modules/pam_cracklib/pam_cracklib.8.xml: Correct typo. * modules/pam_limits/limits.conf.5.xml: Likewise. * modules/pam_listfile/pam_listfile.8.xml: Likewise. * modules/pam_xauth/pam_xauth.8.xml: Likewise. * modules/pam_deny/pam_deny.8.xml: Correct spelling. * modules/pam_group/pam_group.8.xml: Likewise. * modules/pam_permit/pam_permit.8.xml: Likewise. * modules/pam_shells/pam_shells.8.xml: Likewise. * modules/pam_time/pam_time.8.xml: Likewise. * modules/pam_warn/pam_warn.8.xml: Likewise.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/pam_conv.3104
-rw-r--r--doc/man/pam_conv.3.xml4
2 files changed, 62 insertions, 46 deletions
diff --git a/doc/man/pam_conv.3 b/doc/man/pam_conv.3
index 34b61fb3..4465adfc 100644
--- a/doc/man/pam_conv.3
+++ b/doc/man/pam_conv.3
@@ -1,26 +1,26 @@
.\" Title: pam_conv
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/27/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\" Date: 11/06/2007
+.\" Manual: Linux-PAM Manual
+.\" Source: Linux-PAM Manual
.\"
-.TH "PAM_CONV" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.TH "PAM_CONV" "3" "11/06/2007" "Linux-PAM Manual" "Linux-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-pam_conv \- PAM conversation function
+pam_conv - PAM conversation function
.SH "SYNOPSIS"
.sp
.ft B
.nf
-#include <security/pam_appl.h>
+#include <security/pam_appl\.h>
.fi
.ft
.sp
-.RS 3n
+.RS 4
.nf
struct pam_message {
int msg_style;
@@ -42,83 +42,99 @@ struct pam_conv {
.RE
.SH "DESCRIPTION"
.PP
-The PAM library uses an application\-defined callback to allow a direct communication between a loaded module and the application. This callback is specified by the
+The PAM library uses an application\-defined callback to allow a direct communication between a loaded module and the application\. This callback is specified by the
\fIstruct pam_conv\fR
passed to
\fBpam_start\fR(3)
-at the start of the transaction.
+at the start of the transaction\.
.PP
When a module calls the referenced conv() function, the argument
\fIappdata_ptr\fR
-is set to the second element of this structure.
+is set to the second element of this structure\.
.PP
-The other arguments of a call to conv() concern the information exchanged by module and application. That is to say,
+The other arguments of a call to conv() concern the information exchanged by module and application\. That is to say,
\fInum_msg\fR
holds the length of the array of pointers,
-\fImsg\fR. After a successful return, the pointer
+\fImsg\fR\. After a successful return, the pointer
\fIresp\fR
-points to an array of pam_response structures, holding the application supplied text. The
+points to an array of pam_response structures, holding the application supplied text\. The
\fIresp_retcode\fR
-member of this struct is unused and should be set to zero. It is the caller's responsibility to release both, this array and the responses themselves, using
-\fBfree\fR(3). Note,
+member of this struct is unused and should be set to zero\. It is the caller\'s responsibility to release both, this array and the responses themselves, using
+\fBfree\fR(3)\. Note,
\fI*resp\fR
is a
\fIstruct pam_response\fR
-array and not an array of pointers.
+array and not an array of pointers\.
.PP
The number of responses is always equal to the
\fInum_msg\fR
-conversation function argument. This does require that the response array is
-\fBfree\fR(3)'d after every call to the conversation function. The index of the responses corresponds directly to the prompt index in the pam_message array.
+conversation function argument\. This does require that the response array is
+\fBfree\fR(3)\'d after every call to the conversation function\. The index of the responses corresponds directly to the prompt index in the pam_message array\.
.PP
-On failure, the conversation function should release any resources it has allocated, and return one of the predefined PAM error codes.
+On failure, the conversation function should release any resources it has allocated, and return one of the predefined PAM error codes\.
.PP
Each message can have one of four types, specified by the
\fImsg_style\fR
member of
\fIstruct pam_message\fR:
-.TP 3n
+.PP
PAM_PROMPT_ECHO_OFF
-Obtain a string without echoing any text.
-.TP 3n
+.RS 4
+Obtain a string without echoing any text\.
+.RE
+.PP
PAM_PROMPT_ECHO_ON
-Obtain a string whilst echoing text.
-.TP 3n
+.RS 4
+Obtain a string whilst echoing text\.
+.RE
+.PP
PAM_ERROR_MSG
-Display an error message.
-.TP 3n
+.RS 4
+Display an error message\.
+.RE
+.PP
PAM_TEXT_INFO
-Display some text.
+.RS 4
+Display some text\.
+.RE
.PP
-The point of having an array of messages is that it becomes possible to pass a number of things to the application in a single call from the module. It can also be convenient for the application that related things come at once: a windows based application can then present a single form with many messages/prompts on at once.
+The point of having an array of messages is that it becomes possible to pass a number of things to the application in a single call from the module\. It can also be convenient for the application that related things come at once: a windows based application can then present a single form with many messages/prompts on at once\.
.PP
-In passing, it is worth noting that there is a descrepency between the way Linux\-PAM handles the const struct pam_message **msg conversation function argument from the way that Solaris' PAM (and derivitives, known to include HP/UX, are there others?) does. Linux\-PAM interprets the msg argument as entirely equivalent to the following prototype const struct pam_message *msg[] (which, in spirit, is consistent with the commonly used prototypes for argv argument to the familiar main() function: char **argv; and char *argv[]). Said another way Linux\-PAM interprets the msg argument as a pointer to an array of num_meg read only 'struct pam_message' pointers. Solaris' PAM implementation interprets this argument as a pointer to a pointer to an array of num_meg pam_message structures. Fortunately, perhaps, for most module/application developers when num_msg has a value of one these two definitions are entirely equivalent. Unfortunately, casually raising this number to two has led to unanticipated compatibility problems.
+In passing, it is worth noting that there is a descrepency between the way Linux\-PAM handles the const struct pam_message **msg conversation function argument from the way that Solaris\' PAM (and derivitives, known to include HP/UX, are there others?) does\. Linux\-PAM interprets the msg argument as entirely equivalent to the following prototype const struct pam_message *msg[] (which, in spirit, is consistent with the commonly used prototypes for argv argument to the familiar main() function: char **argv; and char *argv[])\. Said another way Linux\-PAM interprets the msg argument as a pointer to an array of num_msg read only \'struct pam_message\' pointers\. Solaris\' PAM implementation interprets this argument as a pointer to a pointer to an array of num_msg pam_message structures\. Fortunately, perhaps, for most module/application developers when num_msg has a value of one these two definitions are entirely equivalent\. Unfortunately, casually raising this number to two has led to unanticipated compatibility problems\.
.PP
For what its worth the two known module writer work\-arounds for trying to maintain source level compatibility with both PAM implementations are:
-.TP 3n
-\(bu
-never call the conversation function with num_msg greater than one.
-.TP 3n
-\(bu
-set up msg as doubly referenced so both types of conversation function can find the messages. That is, make
.sp
-.RS 3n
+.RS 4
+\h'-04'\(bu\h'+03'never call the conversation function with num_msg greater than one\.
+.RE
+.sp
+.RS 4
+\h'-04'\(bu\h'+03'set up msg as doubly referenced so both types of conversation function can find the messages\. That is, make
+.sp
+.RS 4
.nf
msg[n] = & (( *msg )[n])
.fi
.RE
+.RE
.SH "RETURN VALUES"
-.TP 3n
+.PP
PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
+.RS 4
+Memory buffer error\.
+.RE
+.PP
PAM_CONV_ERR
-Conversation failure. The application should not set
-\fI*resp\fR.
-.TP 3n
+.RS 4
+Conversation failure\. The application should not set
+\fI*resp\fR\.
+.RE
+.PP
PAM_SUCCESS
-Success.
+.RS 4
+Success\.
+.RE
.SH "SEE ALSO"
.PP
diff --git a/doc/man/pam_conv.3.xml b/doc/man/pam_conv.3.xml
index 73bb37cc..0098ff94 100644
--- a/doc/man/pam_conv.3.xml
+++ b/doc/man/pam_conv.3.xml
@@ -142,10 +142,10 @@ struct pam_conv {
const struct pam_message *msg[] (which, in spirit, is consistent with
the commonly used prototypes for argv argument to the familiar main()
function: char **argv; and char *argv[]). Said another way Linux-PAM
- interprets the msg argument as a pointer to an array of num_meg read
+ interprets the msg argument as a pointer to an array of num_msg read
only 'struct pam_message' pointers. Solaris' PAM implementation
interprets this argument as a pointer to a pointer to an array of
- num_meg pam_message structures. Fortunately, perhaps, for most
+ num_msg pam_message structures. Fortunately, perhaps, for most
module/application developers when num_msg has a value of one these
two definitions are entirely equivalent. Unfortunately, casually
raising this number to two has led to unanticipated compatibility