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