pam_prompt(3) — Linux manual page

PAM_PROMPT(3)                Linux-PAM Manual               PAM_PROMPT(3)

NAME         top

       pam_prompt, pam_vprompt - interface to conversation function

SYNOPSIS         top

       #include <security/pam_ext.h>

       int pam_prompt(pam_handle_t *pamh, int style, char **response,
                      const char *fmt, ...);

       int pam_vprompt(pam_handle_t *pamh, int style, char **response,
                       const char *fmt, va_list args);

DESCRIPTION         top

       The pam_prompt function constructs a message from the specified
       format string and arguments and passes it to the conversation
       function as set by the service. Upon successful return, response
       is set to point to a string returned from the conversation
       function. This string is allocated on heap and should be freed.

RETURN VALUES         top

       PAM_BUF_ERR
           Memory buffer error.

       PAM_CONV_ERR
           Conversation failure.

       PAM_SUCCESS
           Conversation succeeded, response is set.

       PAM_SYSTEM_ERR
           System error.

SEE ALSO         top

       pam(8), pam_conv(3)

STANDARDS         top

       The pam_prompt and pam_vprompt functions are Linux-PAM extensions.

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 project's upstream Git repository
       ⟨https://github.com/linux-pam/linux-pam.git⟩ on 2023-12-22.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2023-12-18.)  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                12/22/2023                  PAM_PROMPT(3)

Pages that refer to this page: pam_error(3)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.