xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_prompt.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: pam_prompt.3,v 1.9 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from pam_prompt.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt PAM_PROMPT 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm pam_prompt
944269bb5Schristos.Nd call the conversation function
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.Ft "int"
1444269bb5Schristos.Fn pam_prompt "const pam_handle_t *pamh" "int style" "char **resp" "const char *fmt" "..."
1544269bb5Schristos.Sh DESCRIPTION
1644269bb5SchristosThe
17e1b25b17Schristos.Fn pam_prompt
1844269bb5Schristosfunction constructs a message from the specified format
1944269bb5Schristosstring and arguments and passes it to the given PAM context's
2044269bb5Schristosconversation function.
2144269bb5Schristos.Pp
2244269bb5SchristosA pointer to the response, or
2344269bb5Schristos.Dv NULL
2444269bb5Schristosif the conversation function did
2544269bb5Schristosnot return one, is stored in the location pointed to by the
2644269bb5Schristos.Fa resp
2744269bb5Schristosargument.
2844269bb5Schristos.Pp
2944269bb5SchristosSee
3044269bb5Schristos.Xr pam_vprompt 3
3144269bb5Schristosfor further details.
3244269bb5Schristos.Sh RETURN VALUES
3344269bb5SchristosThe
34e1b25b17Schristos.Fn pam_prompt
3544269bb5Schristosfunction returns one of the following values:
3644269bb5Schristos.Bl -tag -width 18n
374cb4af11Schristos.It Bq Er PAM_SUCCESS
384cb4af11SchristosSuccess.
3944269bb5Schristos.It Bq Er PAM_BUF_ERR
4044269bb5SchristosMemory buffer error.
4144269bb5Schristos.It Bq Er PAM_CONV_ERR
4244269bb5SchristosConversation failure.
4344269bb5Schristos.It Bq Er PAM_SYSTEM_ERR
4444269bb5SchristosSystem error.
4544269bb5Schristos.El
4644269bb5Schristos.Sh SEE ALSO
4744269bb5Schristos.Xr pam 3 ,
4844269bb5Schristos.Xr pam_error 3 ,
4944269bb5Schristos.Xr pam_info 3 ,
5044269bb5Schristos.Xr pam_strerror 3 ,
5144269bb5Schristos.Xr pam_vprompt 3
5244269bb5Schristos.Sh STANDARDS
5344269bb5SchristosThe
54e1b25b17Schristos.Fn pam_prompt
5544269bb5Schristosfunction is an OpenPAM extension.
5644269bb5Schristos.Sh AUTHORS
5744269bb5SchristosThe
58e1b25b17Schristos.Fn pam_prompt
59e1b25b17Schristosfunction and this manual page were
60e1b25b17Schristosdeveloped for the
6144269bb5Schristos.Fx
62e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
6344269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
6444269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
6544269bb5Schristos.Pq Dq CBOSS ,
6644269bb5Schristosas part of the DARPA CHATS research program.
678fa0fefeSchristos.Pp
688fa0fefeSchristosThe OpenPAM library is maintained by
694cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
70