pam_sm_authenticate(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | SEE ALSO | COLOPHON

PAM_SM_AUTHENTICATE(3)      Linux-PAM Manual      PAM_SM_AUTHENTICATE(3)

NAME         top

       pam_sm_authenticate - PAM service function for user
       authentication

SYNOPSIS         top

       #define PAM_SM_AUTH

       #include <security/pam_modules.h>

       int pam_sm_authenticate(pam_handle_t *pamh, int flags, int argc,
                               const char **argv);

DESCRIPTION         top

       The pam_sm_authenticate function is the service module's
       implementation of the pam_authenticate(3) interface.

       This function performs the task of authenticating the user.

       Valid flags, which may be logically OR'd with PAM_SILENT, are:

       PAM_SILENT
           Do not emit any messages.

       PAM_DISALLOW_NULL_AUTHTOK
           Return PAM_AUTH_ERR if the database of authentication tokens
           for this authentication mechanism has a NULL entry for the
           user. Without this flag, such a NULL token will lead to a
           success without the user being prompted.

RETURN VALUES         top

       PAM_AUTH_ERR
           Authentication failure.

       PAM_CRED_INSUFFICIENT
           For some reason the application does not have sufficient
           credentials to authenticate the user.

       PAM_AUTHINFO_UNAVAIL
           The modules were not able to access the authentication
           information. This might be due to a network or hardware
           failure etc.

       PAM_SUCCESS
           The authentication token was successfully updated.

       PAM_USER_UNKNOWN
           The supplied username is not known to the authentication
           service.

       PAM_MAXTRIES
           One or more of the authentication modules has reached its
           limit of tries authenticating the user. Do not try again.

SEE ALSO         top

       pam(3), pam_authenticate(3), pam_sm_setcred(3), pam_strerror(3),
       PAM(8)

COLOPHON         top

       This page is part of the linux-pam (Pluggable Authentication
       Modules for Linux) project.  Information about the project can be
       found at ⟨http://www.linux-pam.org/⟩.  If you have a bug report
       for this manual page, see ⟨//www.linux-pam.org/⟩.  This page was
       obtained from the tarball Linux-PAM-1.3.0.tar.bz2 fetched from
       ⟨http://www.linux-pam.org/library/⟩ on 2021-04-01.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

Linux-PAM Manual               04/01/2016         PAM_SM_AUTHENTICATE(3)

Pages that refer to this page: pam_get_item(3)pam_set_item(3)pam_sm_setcred(3)pam_debug(8)