summaryrefslogtreecommitdiffstats
path: root/contrib/openpam/doc/man/pam_authenticate.3
diff options
context:
space:
mode:
authordes <des@FreeBSD.org>2002-04-08 12:30:31 +0000
committerdes <des@FreeBSD.org>2002-04-08 12:30:31 +0000
commit343af1294ca2f648272ae5428bf8fe04ec051308 (patch)
tree13fbc5f0e3fdcef7dedc9ab85b563bf59eaa3af5 /contrib/openpam/doc/man/pam_authenticate.3
parent1b3dab89b21d32019ba4c46b362a853fcdb5a062 (diff)
downloadFreeBSD-src-343af1294ca2f648272ae5428bf8fe04ec051308.zip
FreeBSD-src-343af1294ca2f648272ae5428bf8fe04ec051308.tar.gz
Vendor import of OpenPAM Cinchona.
Diffstat (limited to 'contrib/openpam/doc/man/pam_authenticate.3')
-rw-r--r--contrib/openpam/doc/man/pam_authenticate.330
1 files changed, 27 insertions, 3 deletions
diff --git a/contrib/openpam/doc/man/pam_authenticate.3 b/contrib/openpam/doc/man/pam_authenticate.3
index a1d40fa..5a8ee56 100644
--- a/contrib/openpam/doc/man/pam_authenticate.3
+++ b/contrib/openpam/doc/man/pam_authenticate.3
@@ -31,9 +31,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $P4: //depot/projects/openpam/doc/man/pam_authenticate.3#9 $
+.\" $P4: //depot/projects/openpam/doc/man/pam_authenticate.3#10 $
.\"
-.Dd March 7, 2002
+.Dd April 8, 2002
.Dt PAM_AUTHENTICATE 3
.Os
.Sh NAME
@@ -46,7 +46,31 @@
.Ft int
.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
.Sh DESCRIPTION
-No description available.
+The
+.Nm
+function attempts to authenticate the user
+associated with the pam context specified by the
+.Va pamh
+argument.
+.Pp
+The application is free to call
+.Nm
+as many times as it
+wishes, but some modules may maintain an internal retry counter and
+return
+.Dv PAM_MAXTRIES
+when it exceeds some preset or hardcoded limit.
+.Pp
+The
+.Va flags
+argument is the binary or of zero or more of the following
+values:
+.Pp
+.Bd -literal
+ =PAM_SILENT
+ Do not emit any messages.
+ =PAM_DISALLOW_NULL_AUTHTOK
+ Fail if the user's authentication token is null.
.Sh RETURN VALUES
The
.Nm
OpenPOWER on IntegriCloud