110b5fe87SSascha Wildner.\" Generated from pam_get_user.c by gendoc.pl 210b5fe87SSascha Wildner.\" $OpenPAM: pam_get_user.c 938 2017-04-30 21:34:42Z des $ 3*4c84ab30SSascha Wildner.Dd February 24, 2019 4ade90846SJoerg Sonnenberger.Dt PAM_GET_USER 3 5ade90846SJoerg Sonnenberger.Os 6ade90846SJoerg Sonnenberger.Sh NAME 7ade90846SJoerg Sonnenberger.Nm pam_get_user 8ade90846SJoerg Sonnenberger.Nd retrieve user name 9ade90846SJoerg Sonnenberger.Sh SYNOPSIS 10ade90846SJoerg Sonnenberger.In sys/types.h 11ade90846SJoerg Sonnenberger.In security/pam_appl.h 12ade90846SJoerg Sonnenberger.Ft "int" 13ade90846SJoerg Sonnenberger.Fn pam_get_user "pam_handle_t *pamh" "const char **user" "const char *prompt" 14ade90846SJoerg Sonnenberger.Sh DESCRIPTION 15ade90846SJoerg SonnenbergerThe 16577efdeeSPeter Avalos.Fn pam_get_user 17ade90846SJoerg Sonnenbergerfunction returns the name of the target user, as 18ade90846SJoerg Sonnenbergerspecified to 19ade90846SJoerg Sonnenberger.Xr pam_start 3 . 20ade90846SJoerg SonnenbergerIf no user was specified, nor set using 21ade90846SJoerg Sonnenberger.Xr pam_set_item 3 , 22577efdeeSPeter Avalos.Fn pam_get_user 23ade90846SJoerg Sonnenbergerwill prompt for a user name. 24ade90846SJoerg SonnenbergerEither way, a pointer to the user name is stored in the location 25ade90846SJoerg Sonnenbergerpointed to by the 26ade90846SJoerg Sonnenberger.Fa user 2710b5fe87SSascha Wildnerargument, and the corresponding PAM item is 2810b5fe87SSascha Wildnerupdated. 29ade90846SJoerg Sonnenberger.Pp 30ade90846SJoerg SonnenbergerThe 31ade90846SJoerg Sonnenberger.Fa prompt 32ade90846SJoerg Sonnenbergerargument specifies a prompt to use if no user name is 33ade90846SJoerg Sonnenbergercached. 34ade90846SJoerg SonnenbergerIf it is 35ade90846SJoerg Sonnenberger.Dv NULL , 36ade90846SJoerg Sonnenbergerthe 37ade90846SJoerg Sonnenberger.Dv PAM_USER_PROMPT 38a474e9feSPeter Avalositem will be used. 39ade90846SJoerg SonnenbergerIf that item is also 40ade90846SJoerg Sonnenberger.Dv NULL , 41ade90846SJoerg Sonnenbergera hardcoded default prompt will be used. 4210b5fe87SSascha WildnerAdditionally, when 43577efdeeSPeter Avalos.Fn pam_get_user 4410b5fe87SSascha Wildneris called from a service module, the 4510b5fe87SSascha Wildnerprompt may be affected by module options as described below. 4610b5fe87SSascha WildnerThe prompt is then expanded using 4710b5fe87SSascha Wildner.Xr openpam_subst 3 4810b5fe87SSascha Wildnerbefore it is passed to 4910b5fe87SSascha Wildnerthe conversation function. 5010b5fe87SSascha Wildner.Sh MODULE OPTIONS 5110b5fe87SSascha WildnerWhen called by a service module, 5210b5fe87SSascha Wildner.Fn pam_get_user 5310b5fe87SSascha Wildnerwill recognize the 5410b5fe87SSascha Wildnerfollowing module options: 5510b5fe87SSascha Wildner.Bl -tag -width 18n 5610b5fe87SSascha Wildner.It Dv user_prompt 5710b5fe87SSascha WildnerPrompt to use when asking for the user name. 5810b5fe87SSascha WildnerThis option overrides both the 59a474e9feSPeter Avalos.Fa prompt 60a474e9feSPeter Avalosargument and the 61a474e9feSPeter Avalos.Dv PAM_USER_PROMPT 62a474e9feSPeter Avalositem. 6310b5fe87SSascha Wildner.El 64ade90846SJoerg Sonnenberger.Sh RETURN VALUES 65ade90846SJoerg SonnenbergerThe 66577efdeeSPeter Avalos.Fn pam_get_user 67ade90846SJoerg Sonnenbergerfunction returns one of the following values: 68ade90846SJoerg Sonnenberger.Bl -tag -width 18n 6910b5fe87SSascha Wildner.It Bq Er PAM_SUCCESS 7010b5fe87SSascha WildnerSuccess. 7110b5fe87SSascha Wildner.It Bq Er PAM_BAD_ITEM 7210b5fe87SSascha WildnerUnrecognized or restricted item. 73ade90846SJoerg Sonnenberger.It Bq Er PAM_BUF_ERR 74ade90846SJoerg SonnenbergerMemory buffer error. 75ade90846SJoerg Sonnenberger.It Bq Er PAM_CONV_ERR 76ade90846SJoerg SonnenbergerConversation failure. 77ade90846SJoerg Sonnenberger.It Bq Er PAM_SYSTEM_ERR 78ade90846SJoerg SonnenbergerSystem error. 79ade90846SJoerg Sonnenberger.El 80ade90846SJoerg Sonnenberger.Sh SEE ALSO 8110b5fe87SSascha Wildner.Xr openpam_get_option 3 , 82a474e9feSPeter Avalos.Xr openpam_subst 3 , 83ade90846SJoerg Sonnenberger.Xr pam 3 , 8410b5fe87SSascha Wildner.Xr pam_conv 3 , 85ade90846SJoerg Sonnenberger.Xr pam_get_authtok 3 , 86ade90846SJoerg Sonnenberger.Xr pam_get_item 3 , 87ade90846SJoerg Sonnenberger.Xr pam_set_item 3 , 88ade90846SJoerg Sonnenberger.Xr pam_start 3 , 89ade90846SJoerg Sonnenberger.Xr pam_strerror 3 90ade90846SJoerg Sonnenberger.Sh STANDARDS 91ade90846SJoerg Sonnenberger.Rs 92ade90846SJoerg Sonnenberger.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 93ade90846SJoerg Sonnenberger.%D "June 1997" 94ade90846SJoerg Sonnenberger.Re 95ade90846SJoerg Sonnenberger.Sh AUTHORS 96ade90846SJoerg SonnenbergerThe 97577efdeeSPeter Avalos.Fn pam_get_user 98577efdeeSPeter Avalosfunction and this manual page were 99577efdeeSPeter Avalosdeveloped for the 100ade90846SJoerg Sonnenberger.Fx 101577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the 102f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under 103ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035 104ade90846SJoerg Sonnenberger.Pq Dq CBOSS , 105ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program. 10610b5fe87SSascha Wildner.Pp 10710b5fe87SSascha WildnerThe OpenPAM library is maintained by 10810b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no . 109