diff options
author | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 12:48:14 -0800 |
---|---|---|
committer | Steve Langasek <steve.langasek@ubuntu.com> | 2019-01-03 12:48:14 -0800 |
commit | d5b06b67bbeeed7c05c0eb2e05d6a972ad050d1c (patch) | |
tree | ba5654cffacfd2002eefc5bc3764a7971afff1dc /Linux-PAM/doc/man/pam_sm_authenticate.3 | |
parent | 4c51da22e068907adb7857d50f5109a467c94d7c (diff) | |
parent | 7cbfa335c57d068d59508c844f3957165cccfb9b (diff) | |
download | pam-d5b06b67bbeeed7c05c0eb2e05d6a972ad050d1c.tar.gz pam-d5b06b67bbeeed7c05c0eb2e05d6a972ad050d1c.tar.bz2 pam-d5b06b67bbeeed7c05c0eb2e05d6a972ad050d1c.zip |
New upstream version 0.99.7.1
Diffstat (limited to 'Linux-PAM/doc/man/pam_sm_authenticate.3')
-rw-r--r-- | Linux-PAM/doc/man/pam_sm_authenticate.3 | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/Linux-PAM/doc/man/pam_sm_authenticate.3 b/Linux-PAM/doc/man/pam_sm_authenticate.3 new file mode 100644 index 00000000..7487f6af --- /dev/null +++ b/Linux-PAM/doc/man/pam_sm_authenticate.3 @@ -0,0 +1,80 @@ +.\" Title: pam_sm_authenticate +.\" 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_AUTHENTICATE" "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_authenticate \- PAM service function for user authentication +.SH "SYNOPSIS" +.sp +.ft B +.nf +#define PAM_SM_AUTH +.fi +.ft +.sp +.ft B +.nf +#include <security/pam_modules.h> +.fi +.ft +.HP 35 +.BI "PAM_EXTERN int pam_sm_authenticate(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");" +.SH "DESCRIPTION" +.PP +The +\fBpam_sm_authenticate\fR +function is the service module's implementation of the +\fBpam_authenticate\fR(3) +interface. +.PP +This function performs the task of authenticating the user. +.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_DISALLOW_NULL_AUTHTOK +Return +\fBPAM_AUTH_ERR\fR +if the database of authentication tokens for this authentication mechanism has a +\fINULL\fR +entry for the user. Without this flag, such a +\fINULL\fR +token will lead to a success without the user being prompted. +.SH "RETURN VALUES" +.TP 3n +PAM_AUTH_ERR +Authentication failure. +.TP 3n +PAM_CRED_INSUFFICIENT +For some reason the application does not have sufficient credentials to authenticate the user. +.TP 3n +PAM_AUTHINFO_UNAVAIL +The modules were not able to access the authentication information. This might be due to a network or hardware failure etc. +.TP 3n +PAM_SUCCESS +The authentication token was successfully updated. +.TP 3n +PAM_USER_UNKNOWN +The supplied username is not known to the authentication service. +.TP 3n +PAM_MAXTRIES +One or more of the authentication modules has reached its limit of tries authenticating the user. Do not try again. +.SH "SEE ALSO" +.PP + +\fBpam\fR(3), +\fBpam_authenticate\fR(3), +\fBpam_sm_setcred\fR(3), +\fBpam_strerror\fR(3), +\fBPAM\fR(8) |