|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | SEE ALSO | COLOPHON |
PAM_GET_USER(3) Linux-PAM Manual PAM_GET_USER(3)
pam_get_user - get user name
#include <security/pam_modules.h>
int pam_get_user(const pam_handle_t *pamh, const char **user,
const char *prompt);
The pam_get_user function returns the name of the user specified by
pam_start(3). If no user was specified it what pam_get_item (pamh,
PAM_USER, ... ); would have returned. If this is NULL it obtains the
username via the pam_conv(3) mechanism, it prompts the user with the
first non-NULL string in the following list:
· The prompt argument passed to the function.
· What is returned by pam_get_item (pamh, PAM_USER_PROMPT, ... );
· The default prompt: "login: "
By whatever means the username is obtained, a pointer to it is
returned as the contents of *user. Note, this memory should not be
free()'d or modified by the module.
This function sets the PAM_USER item associated with the
pam_set_item(3) and pam_get_item(3) functions.
PAM_SUCCESS
User name was successful retrieved.
PAM_SYSTEM_ERR
A NULL pointer was submitted.
PAM_CONV_ERR
The conversation method supplied by the application failed to
obtain the username.
pam_end(3), pam_get_item(3), pam_set_item(3), pam_strerror(3)
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.gz fetched from
⟨http://www.linux-pam.org/library/⟩ on 2017-07-05. 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_GET_USER(3)
Pages that refer to this page: pam(3), pam_get_item(3)