pam_vprompt.c revision 92289 
1/*-
2 * Copyright (c) 2002 Networks Associates Technology, Inc.
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by ThinkSec AS and
6 * NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * DARPA CHATS research program.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote
19 *    products derived from this software without specific prior written
20 *    permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * $P4: //depot/projects/openpam/lib/pam_vprompt.c#5 $
35 */
36
37#include <stdarg.h>
38#include <stdio.h>
39#include <stdlib.h>
40
41#include <security/pam_appl.h>
42#include <security/openpam.h>
43
44/*
45 * OpenPAM extension
46 *
47 * Call the conversation function
48 */
49
50int
51pam_vprompt(pam_handle_t *pamh,
52	int style,
53	char **resp,
54	const char *fmt,
55	va_list ap)
56{
57	char msgbuf[PAM_MAX_MSG_SIZE];
58	struct pam_message msg;
59	const struct pam_message *msgp;
60	struct pam_response *rsp;
61	struct pam_conv *conv;
62	int r;
63
64	r = pam_get_item(pamh, PAM_CONV, (const void **)&conv);
65	if (r != PAM_SUCCESS)
66		return (r);
67	if (conv == NULL) {
68		openpam_log(PAM_LOG_ERROR, "no conversation function");
69		return (PAM_SYSTEM_ERR);
70	}
71	vsnprintf(msgbuf, PAM_MAX_MSG_SIZE, fmt, ap);
72	msg.msg_style = style;
73	msg.msg = msgbuf;
74	msgp = &msg;
75	r = (conv->conv)(1, &msgp, &rsp, conv->appdata_ptr);
76	*resp = rsp == NULL ? NULL : rsp->resp;
77	free(rsp);
78	return (r);
79}
80
81/*
82 * Error codes:
83 *
84 *     !PAM_SYMBOL_ERR
85 *	PAM_SYSTEM_ERR
86 *	PAM_BUF_ERR
87 *	PAM_CONV_ERR
88 */
89
90/**
91 * The =pam_vprompt function constructs a string from the =fmt and =ap
92 * arguments using =vsnprintf, and passes it to the given PAM context's
93 * conversation function.
94 *
95 * The =style argument specifies the type of interaction requested, and
96 * must be one of the following:
97 *
98 *	=PAM_PROMPT_ECHO_OFF:
99 *		Display the message and obtain the user's response without
100 *		displaying it.
101 *	=PAM_PROMPT_ECHO_ON:
102 *		Display the message and obtain the user's response.
103 *	=PAM_ERROR_MSG:
104 *		Display the message as an error message, and do not wait
105 *		for a response.
106 *	=PAM_TEXT_INFO:
107 *		Display the message as an informational message, and do
108 *		not wait for a response.
109 *
110 * A pointer to the response, or =NULL if the conversation function did
111 * not return one, is stored in the location pointed to by the =resp
112 * argument.
113 *
114 * The message and response should not exceed =PAM_MAX_MSG_SIZE or
115 * =PAM_MAX_RESP_SIZE, respectively.
116 * If they do, they may be truncated.
117 *
118 * >pam_error
119 * >pam_info
120 * >pam_prompt
121 * >pam_verror
122 * >pam_vinfo
123 */
124