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