xref: /freebsd/contrib/openpam/lib/libpam/pam_get_item.c (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1 /*-
2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
3  * Copyright (c) 2004-2017 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 
36 #ifdef HAVE_CONFIG_H
37 # include "config.h"
38 #endif
39 
40 #include <sys/param.h>
41 
42 #include <security/pam_appl.h>
43 
44 #include "openpam_impl.h"
45 
46 /*
47  * XSSO 4.2.1
48  * XSSO 6 page 46
49  *
50  * Get PAM information
51  */
52 
53 int
54 pam_get_item(const pam_handle_t *pamh,
55 	int item_type,
56 	const void **item)
57 {
58 
59 	ENTERI(item_type);
60 	switch (item_type) {
61 	case PAM_SERVICE:
62 	case PAM_USER:
63 	case PAM_AUTHTOK:
64 	case PAM_OLDAUTHTOK:
65 	case PAM_TTY:
66 	case PAM_RHOST:
67 	case PAM_RUSER:
68 	case PAM_CONV:
69 	case PAM_USER_PROMPT:
70 	case PAM_REPOSITORY:
71 	case PAM_AUTHTOK_PROMPT:
72 	case PAM_OLDAUTHTOK_PROMPT:
73 	case PAM_HOST:
74 		*item = pamh->item[item_type];
75 		RETURNC(PAM_SUCCESS);
76 	default:
77 		RETURNC(PAM_BAD_ITEM);
78 	}
79 }
80 
81 /*
82  * Error codes:
83  *
84  *	PAM_BAD_ITEM
85  */
86 
87 /**
88  * The =pam_get_item function stores a pointer to the item specified by
89  * the =item_type argument in the location pointed to by the =item
90  * argument.
91  * The item is retrieved from the PAM context specified by the =pamh
92  * argument.
93  * If =pam_get_item fails, the =item argument is untouched.
94  *
95  * The following item types are recognized:
96  *
97  *	=PAM_SERVICE:
98  *		The name of the requesting service.
99  *	=PAM_USER:
100  *		The name of the user the application is trying to
101  *		authenticate.
102  *	=PAM_TTY:
103  *		The name of the current terminal.
104  *	=PAM_RHOST:
105  *		The name of the applicant's host.
106  *	=PAM_CONV:
107  *		A =struct pam_conv describing the current conversation
108  *		function.
109  *	=PAM_AUTHTOK:
110  *		The current authentication token.
111  *	=PAM_OLDAUTHTOK:
112  *		The expired authentication token.
113  *	=PAM_RUSER:
114  *		The name of the applicant.
115  *	=PAM_USER_PROMPT:
116  *		The prompt to use when asking the applicant for a user
117  *		name to authenticate as.
118  *	=PAM_AUTHTOK_PROMPT:
119  *		The prompt to use when asking the applicant for an
120  *		authentication token.
121  *	=PAM_OLDAUTHTOK_PROMPT:
122  *		The prompt to use when asking the applicant for an
123  *		expired authentication token prior to changing it.
124  *	=PAM_HOST:
125  *		The name of the host the application runs on.
126  *
127  * See =pam_start for a description of =struct pam_conv.
128  *
129  * >pam_set_item
130  */
131