pam_prompt.c revision 174832 
1/*-
2 * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
3 * Copyright (c) 2004-2007 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 * $Id: pam_prompt.c 408 2007-12-21 11:36:24Z des $
36 */
37
38#include <sys/types.h>
39
40#include <stdarg.h>
41
42#include <security/pam_appl.h>
43#include <security/openpam.h>
44
45/*
46 * OpenPAM extension
47 *
48 * Call the conversation function
49 */
50
51int
52pam_prompt(const pam_handle_t *pamh,
53	int style,
54	char **resp,
55	const char *fmt,
56	...)
57{
58	va_list ap;
59	int r;
60
61	va_start(ap, fmt);
62	r = pam_vprompt(pamh, style, resp, fmt, ap);
63	va_end(ap);
64	return (r);
65}
66
67/*
68 * Error codes:
69 *
70 *     !PAM_SYMBOL_ERR
71 *	PAM_SYSTEM_ERR
72 *	PAM_BUF_ERR
73 *	PAM_CONV_ERR
74 */
75
76/**
77 * The =pam_prompt function constructs a message from the specified format
78 * string and arguments and passes it to the given PAM context's
79 * conversation function.
80 *
81 * A pointer to the response, or =NULL if the conversation function did
82 * not return one, is stored in the location pointed to by the =resp
83 * argument.
84 *
85 * See =pam_vprompt for further details.
86 *
87 * >pam_error
88 * >pam_info
89 * >pam_vprompt
90 */
91