xref: /freebsd/contrib/openpam/lib/libpam/pam_get_data.c (revision ef90af83a58199ef3980d8c9a7dad07ec9b4bea3)
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: pam_get_data.c 648 2013-03-05 17:54:27Z des $
36  */
37 
38 #ifdef HAVE_CONFIG_H
39 # include "config.h"
40 #endif
41 
42 #include <string.h>
43 
44 #include <security/pam_appl.h>
45 
46 #include "openpam_impl.h"
47 
48 /*
49  * XSSO 4.2.1
50  * XSSO 6 page 43
51  *
52  * Get module information
53  */
54 
55 int
56 pam_get_data(const pam_handle_t *pamh,
57 	const char *module_data_name,
58 	const void **data)
59 {
60 	pam_data_t *dp;
61 
62 	ENTERS(module_data_name);
63 	if (pamh == NULL)
64 		RETURNC(PAM_SYSTEM_ERR);
65 	for (dp = pamh->module_data; dp != NULL; dp = dp->next) {
66 		if (strcmp(dp->name, module_data_name) == 0) {
67 			*data = (void *)dp->data;
68 			RETURNC(PAM_SUCCESS);
69 		}
70 	}
71 	RETURNC(PAM_NO_MODULE_DATA);
72 }
73 
74 /*
75  * Error codes:
76  *
77  *	PAM_SYSTEM_ERR
78  *	PAM_NO_MODULE_DATA
79  */
80 
81 /**
82  * The =pam_get_data function looks up the opaque object associated with
83  * the string specified by the =module_data_name argument, in the PAM
84  * context specified by the =pamh argument.
85  * A pointer to the object is stored in the location pointed to by the
86  * =data argument.
87  * If =pam_get_data fails, the =data argument is untouched.
88  *
89  * This function and its counterpart =pam_set_data are useful for managing
90  * data that are meaningful only to a particular service module.
91  */
92