xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/pam_prompt.c (revision 4724848cf0da353df257f730694b7882798e5daf)
1 /*	$NetBSD: pam_prompt.c,v 1.3 2017/05/06 19:50:10 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  * $OpenPAM: pam_prompt.c 938 2017-04-30 21:34:42Z des $
38  */
39 
40 #ifdef HAVE_CONFIG_H
41 # include "config.h"
42 #endif
43 
44 #include <sys/cdefs.h>
45 __RCSID("$NetBSD: pam_prompt.c,v 1.3 2017/05/06 19:50:10 christos Exp $");
46 
47 #include <sys/types.h>
48 
49 #include <stdarg.h>
50 
51 #include <security/pam_appl.h>
52 #include <security/openpam.h>
53 
54 /*
55  * OpenPAM extension
56  *
57  * Call the conversation function
58  */
59 
60 int
61 pam_prompt(const pam_handle_t *pamh,
62 	int style,
63 	char **resp,
64 	const char *fmt,
65 	...)
66 {
67 	va_list ap;
68 	int r;
69 
70 	va_start(ap, fmt);
71 	r = pam_vprompt(pamh, style, resp, fmt, ap);
72 	va_end(ap);
73 	return (r);
74 }
75 
76 /*
77  * Error codes:
78  *
79  *     !PAM_SYMBOL_ERR
80  *	PAM_SYSTEM_ERR
81  *	PAM_BUF_ERR
82  *	PAM_CONV_ERR
83  */
84 
85 /**
86  * The =pam_prompt function constructs a message from the specified format
87  * string and arguments and passes it to the given PAM context's
88  * conversation function.
89  *
90  * A pointer to the response, or =NULL if the conversation function did
91  * not return one, is stored in the location pointed to by the =resp
92  * argument.
93  *
94  * See =pam_vprompt for further details.
95  *
96  * >pam_error
97  * >pam_info
98  * >pam_vprompt
99  */
100