source: openpam/trunk/lib/pam_vprompt.c @ 200

Last change on this file since 200 was 187, checked in by Dag-Erling Smørgrav, 18 years ago

Instrument entry and exit points.

File size: 3.8 KB
Line 
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 * Network Associates Laboratories, the Security Research Division of
7 * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
8 * ("CBOSS"), as part of the 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#8 $
35 */
36
37#include <stdarg.h>
38#include <stdio.h>
39#include <stdlib.h>
40
41#include <security/pam_appl.h>
42
43#include "openpam_impl.h"
44
45/*
46 * OpenPAM extension
47 *
48 * Call the conversation function
49 */
50
51int
52pam_vprompt(pam_handle_t *pamh,
53        int style,
54        char **resp,
55        const char *fmt,
56        va_list ap)
57{
58        char msgbuf[PAM_MAX_MSG_SIZE];
59        struct pam_message msg;
60        const struct pam_message *msgp;
61        struct pam_response *rsp;
62        struct pam_conv *conv;
63        int r;
64
65        ENTER();
66        r = pam_get_item(pamh, PAM_CONV, (const void **)&conv);
67        if (r != PAM_SUCCESS)
68                RETURNC(r);
69        if (conv == NULL) {
70                openpam_log(PAM_LOG_ERROR, "no conversation function");
71                RETURNC(PAM_SYSTEM_ERR);
72        }
73        vsnprintf(msgbuf, PAM_MAX_MSG_SIZE, fmt, ap);
74        msg.msg_style = style;
75        msg.msg = msgbuf;
76        msgp = &msg;
77        rsp = NULL;
78        r = (conv->conv)(1, &msgp, &rsp, conv->appdata_ptr);
79        *resp = rsp == NULL ? NULL : rsp->resp;
80        free(rsp);
81        RETURNC(r);
82}
83
84/*
85 * Error codes:
86 *
87 *     !PAM_SYMBOL_ERR
88 *      PAM_SYSTEM_ERR
89 *      PAM_BUF_ERR
90 *      PAM_CONV_ERR
91 */
92
93/**
94 * The =pam_vprompt function constructs a string from the =fmt and =ap
95 * arguments using =vsnprintf, and passes it to the given PAM context's
96 * conversation function.
97 *
98 * The =style argument specifies the type of interaction requested, and
99 * must be one of the following:
100 *
101 *      =PAM_PROMPT_ECHO_OFF:
102 *              Display the message and obtain the user's response without
103 *              displaying it.
104 *      =PAM_PROMPT_ECHO_ON:
105 *              Display the message and obtain the user's response.
106 *      =PAM_ERROR_MSG:
107 *              Display the message as an error message, and do not wait
108 *              for a response.
109 *      =PAM_TEXT_INFO:
110 *              Display the message as an informational message, and do
111 *              not wait for a response.
112 *
113 * A pointer to the response, or =NULL if the conversation function did
114 * not return one, is stored in the location pointed to by the =resp
115 * argument.
116 *
117 * The message and response should not exceed =PAM_MAX_MSG_SIZE or
118 * =PAM_MAX_RESP_SIZE, respectively.
119 * If they do, they may be truncated.
120 *
121 * >pam_error
122 * >pam_info
123 * >pam_prompt
124 * >pam_verror
125 * >pam_vinfo
126 */
Note: See TracBrowser for help on using the repository browser.