diff options
author | Thorsten Kukuk <kukuk@thkukuk.de> | 2008-01-08 12:44:15 +0000 |
---|---|---|
committer | Thorsten Kukuk <kukuk@thkukuk.de> | 2008-01-08 12:44:15 +0000 |
commit | d48c90b14254794fcad9ccc37873a8c663cce02d (patch) | |
tree | 62e42b3fd242091e7fab171d1b816586c09e743c /doc/man/pam_sm_setcred.3 | |
parent | 1f802e15b36f0ca69dc4127a9332983acfd70117 (diff) | |
download | pam-d48c90b14254794fcad9ccc37873a8c663cce02d.tar.gz pam-d48c90b14254794fcad9ccc37873a8c663cce02d.tar.bz2 pam-d48c90b14254794fcad9ccc37873a8c663cce02d.zip |
Relevant BUGIDs:
Purpose of commit: cleanup
Commit summary:
---------------
Remove autogenerated documentation from CVS
Diffstat (limited to 'doc/man/pam_sm_setcred.3')
-rw-r--r-- | doc/man/pam_sm_setcred.3 | 95 |
1 files changed, 0 insertions, 95 deletions
diff --git a/doc/man/pam_sm_setcred.3 b/doc/man/pam_sm_setcred.3 deleted file mode 100644 index b4cb70e8..00000000 --- a/doc/man/pam_sm_setcred.3 +++ /dev/null @@ -1,95 +0,0 @@ -.\" Title: pam_sm_setcred -.\" 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_SM_SETCRED" "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_sm_setcred \- PAM service function to alter credentials -.SH "SYNOPSIS" -.sp -.ft B -.nf -#define PAM_SM_AUTH -.fi -.ft -.sp -.ft B -.nf -#include <security/pam_modules.h> -.fi -.ft -.HP 30 -.BI "PAM_EXTERN int pam_sm_setcred(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");" -.SH "DESCRIPTION" -.PP -The -\fBpam_sm_setcred\fR -function is the service module's implementation of the -\fBpam_setcred\fR(3) -interface. -.PP -This function performs the task of altering the credentials of the user with respect to the corresponding authorization scheme. Generally, an authentication module may have access to more information about a user than their authentication token. This function is used to make such information available to the application. It should only be called -\fIafter\fR -the user has been authenticated but before a session has been established. -.PP -Valid flags, which may be logically OR'd with -\fIPAM_SILENT\fR, are: -.TP 3n -PAM_SILENT -Do not emit any messages. -.TP 3n -PAM_DELETE_CRED -Delete the credentials associated with the authentication service. -.TP 3n -PAM_REINITIALIZE_CRED -Reinitialize the user credentials. -.TP 3n -PAM_REFRESH_CRED -Extend the lifetime of the user credentials. -.PP -The way the -\fBauth\fR -stack is navigated in order to evaluate the -\fBpam_setcred\fR() function call, independent of the -\fBpam_sm_setcred\fR() return codes, is exactly the same way that it was navigated when evaluating the -\fBpam_authenticate\fR() library call. Typically, if a stack entry was ignored in evaluating -\fBpam_authenticate\fR(), it will be ignored when libpam evaluates the -\fBpam_setcred\fR() function call. Otherwise, the return codes from each module specific -\fBpam_sm_setcred\fR() call are treated as -\fBrequired\fR. -.SH "RETURN VALUES" -.TP 3n -PAM_CRED_UNAVAIL -This module cannot retrieve the user's credentials. -.TP 3n -PAM_CRED_EXPIRED -The user's credentials have expired. -.TP 3n -PAM_CRED_ERR -This module was unable to set the credentials of the user. -.TP 3n -PAM_SUCCESS -The user credential was successfully set. -.TP 3n -PAM_USER_UNKNOWN -The user is not known to this authentication module. -.PP -These, non\-\fIPAM_SUCCESS\fR, return values will typically lead to the credential stack -\fIfailing\fR. The first such error will dominate in the return value of -\fBpam_setcred\fR(). -.SH "SEE ALSO" -.PP - -\fBpam\fR(3), -\fBpam_authenticate\fR(3), -\fBpam_setcred\fR(3), -\fBpam_sm_authenticate\fR(3), -\fBpam_strerror\fR(3), -\fBPAM\fR(8) |