Merge from vendor branch OPENSSH:
[dragonfly.git] / contrib / openpam / lib / openpam_nullconv.c
1 /*-
2  * Copyright (c) 2002-2003 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/openpam_nullconv.c#7 $
35  */
36
37 #include <sys/types.h>
38
39 #include <security/pam_appl.h>
40
41 #include "openpam_impl.h"
42
43 /*
44  * OpenPAM extension
45  *
46  * Null conversation function
47  */
48
49 int
50 openpam_nullconv(int n,
51          const struct pam_message **msg,
52          struct pam_response **resp,
53          void *data)
54 {
55
56         ENTER();
57         (void)n;
58         (void)msg;
59         (void)resp;
60         (void)data;
61         RETURNC(PAM_CONV_ERR);
62 }
63
64 /*
65  * Error codes:
66  *
67  *      PAM_CONV_ERR
68  */
69
70 /**
71  * The =openpam_nullconv function is a null conversation function suitable
72  * for applications that want to use PAM but don't support interactive
73  * dialog with the user.
74  * Such applications should set =PAM_AUTHTOK to whatever authentication
75  * token they've obtained on their own before calling =pam_authenticate
76  * and / or =pam_chauthtok, and their PAM configuration should specify the
77  * ;use_first_pass option for all modules that require access to the
78  * authentication token, to make sure they use =PAM_AUTHTOK rather than
79  * try to query the user.
80  *
81  * >openpam_ttyconv
82  * >pam_prompt
83  * >pam_set_item
84  * >pam_vprompt
85  */