xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/pam_prompt.c (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1 /*	$NetBSD: pam_prompt.c,v 1.4 2023/06/30 21:46:21 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
5  * Copyright (c) 2004-2011 Dag-Erling Smørgrav
6  * All rights reserved.
7  *
8  * This software was developed for the FreeBSD Project by ThinkSec AS and
9  * Network Associates Laboratories, the Security Research Division of
10  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
11  * ("CBOSS"), as part of the DARPA CHATS research program.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. The name of the author may not be used to endorse or promote
22  *    products derived from this software without specific prior written
23  *    permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37 
38 #ifdef HAVE_CONFIG_H
39 # include "config.h"
40 #endif
41 
42 #include <sys/cdefs.h>
43 __RCSID("$NetBSD: pam_prompt.c,v 1.4 2023/06/30 21:46:21 christos Exp $");
44 
45 #include <sys/types.h>
46 
47 #include <stdarg.h>
48 
49 #include <security/pam_appl.h>
50 #include <security/openpam.h>
51 
52 /*
53  * OpenPAM extension
54  *
55  * Call the conversation function
56  */
57 
58 int
pam_prompt(const pam_handle_t * pamh,int style,char ** resp,const char * fmt,...)59 pam_prompt(const pam_handle_t *pamh,
60 	int style,
61 	char **resp,
62 	const char *fmt,
63 	...)
64 {
65 	va_list ap;
66 	int r;
67 
68 	va_start(ap, fmt);
69 	r = pam_vprompt(pamh, style, resp, fmt, ap);
70 	va_end(ap);
71 	return (r);
72 }
73 
74 /*
75  * Error codes:
76  *
77  *     !PAM_SYMBOL_ERR
78  *	PAM_SYSTEM_ERR
79  *	PAM_BUF_ERR
80  *	PAM_CONV_ERR
81  */
82 
83 /**
84  * The =pam_prompt function constructs a message from the specified format
85  * string and arguments and passes it to the given PAM context's
86  * conversation function.
87  *
88  * A pointer to the response, or =NULL if the conversation function did
89  * not return one, is stored in the location pointed to by the =resp
90  * argument.
91  *
92  * See =pam_vprompt for further details.
93  *
94  * >pam_error
95  * >pam_info
96  * >pam_vprompt
97  */
98