xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/pam_get_item.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: pam_get_item.c,v 1.3 2017/05/06 19:50:09 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
5  * Copyright (c) 2004-2017 Dag-Erling Smørgrav
6  * All rights reserved.
7  *
8  * This software was developed for the FreeBSD Project by ThinkSec AS and
9  * Network Associates Laboratories, the Security Research Division of
10  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
11  * ("CBOSS"), as part of the DARPA CHATS research program.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. The name of the author may not be used to endorse or promote
22  *    products derived from this software without specific prior written
23  *    permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  * $OpenPAM: pam_get_item.c 938 2017-04-30 21:34:42Z des $
38  */
39 
40 #ifdef HAVE_CONFIG_H
41 # include "config.h"
42 #endif
43 
44 #include <sys/cdefs.h>
45 __RCSID("$NetBSD: pam_get_item.c,v 1.3 2017/05/06 19:50:09 christos Exp $");
46 
47 #include <sys/param.h>
48 
49 #include <security/pam_appl.h>
50 
51 #include "openpam_impl.h"
52 
53 /*
54  * XSSO 4.2.1
55  * XSSO 6 page 46
56  *
57  * Get PAM information
58  */
59 
60 int
61 pam_get_item(const pam_handle_t *pamh,
62 	int item_type,
63 	const void **item)
64 {
65 
66 	ENTERI(item_type);
67 	switch (item_type) {
68 	case PAM_SERVICE:
69 	case PAM_USER:
70 	case PAM_AUTHTOK:
71 	case PAM_OLDAUTHTOK:
72 	case PAM_TTY:
73 	case PAM_RHOST:
74 	case PAM_RUSER:
75 	case PAM_CONV:
76 	case PAM_USER_PROMPT:
77 	case PAM_REPOSITORY:
78 	case PAM_AUTHTOK_PROMPT:
79 	case PAM_OLDAUTHTOK_PROMPT:
80 	case PAM_HOST:
81 	case PAM_SOCKADDR:
82 	case PAM_NUSER:
83 		*item = pamh->item[item_type];
84 		RETURNC(PAM_SUCCESS);
85 	default:
86 		RETURNC(PAM_BAD_ITEM);
87 	}
88 }
89 
90 /*
91  * Error codes:
92  *
93  *	PAM_BAD_ITEM
94  */
95 
96 /**
97  * The =pam_get_item function stores a pointer to the item specified by
98  * the =item_type argument in the location pointed to by the =item
99  * argument.
100  * The item is retrieved from the PAM context specified by the =pamh
101  * argument.
102  * If =pam_get_item fails, the =item argument is untouched.
103  *
104  * The following item types are recognized:
105  *
106  *	=PAM_SERVICE:
107  *		The name of the requesting service.
108  *	=PAM_USER:
109  *		The name of the user the application is trying to
110  *		authenticate.
111  *	=PAM_TTY:
112  *		The name of the current terminal.
113  *	=PAM_RHOST:
114  *		The name of the applicant's host.
115  *	=PAM_CONV:
116  *		A =struct pam_conv describing the current conversation
117  *		function.
118  *	=PAM_AUTHTOK:
119  *		The current authentication token.
120  *	=PAM_OLDAUTHTOK:
121  *		The expired authentication token.
122  *	=PAM_RUSER:
123  *		The name of the applicant.
124  *	=PAM_USER_PROMPT:
125  *		The prompt to use when asking the applicant for a user
126  *		name to authenticate as.
127  *	=PAM_AUTHTOK_PROMPT:
128  *		The prompt to use when asking the applicant for an
129  *		authentication token.
130  *	=PAM_OLDAUTHTOK_PROMPT:
131  *		The prompt to use when asking the applicant for an
132  *		expired authentication token prior to changing it.
133  *	=PAM_HOST:
134  *		The name of the host the application runs on.
135  *	=PAM_SOCKADDR:
136  *		The sockaddr_storage of the applicants's host.
137  *	=PAM_NUSER:
138  *		The "nested" user if this is a login on top of a previous one.
139  *
140  * See =pam_start for a description of =struct pam_conv.
141  *
142  * >pam_set_item
143  */
144