xref: /freebsd/contrib/openpam/lib/libpam/pam_set_data.c (revision 02e9120893770924227138ba49df1edb3896112a)
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 <stdlib.h>
41 #include <string.h>
42 
43 #include <security/pam_appl.h>
44 
45 #include "openpam_impl.h"
46 
47 /*
48  * XSSO 4.2.1
49  * XSSO 6 page 59
50  *
51  * Set module information
52  */
53 
54 int
55 pam_set_data(pam_handle_t *pamh,
56 	const char *module_data_name,
57 	void *data,
58 	void (*cleanup)(pam_handle_t *pamh,
59 		void *data,
60 		int pam_end_status))
61 {
62 	pam_data_t *dp;
63 
64 	ENTERS(module_data_name);
65 	for (dp = pamh->module_data; dp != NULL; dp = dp->next) {
66 		if (strcmp(dp->name, module_data_name) == 0) {
67 			if (dp->cleanup)
68 				(dp->cleanup)(pamh, dp->data, PAM_SUCCESS);
69 			dp->data = data;
70 			dp->cleanup = cleanup;
71 			RETURNC(PAM_SUCCESS);
72 		}
73 	}
74 	if ((dp = malloc(sizeof *dp)) == NULL)
75 		RETURNC(PAM_BUF_ERR);
76 	if ((dp->name = strdup(module_data_name)) == NULL) {
77 		FREE(dp);
78 		RETURNC(PAM_BUF_ERR);
79 	}
80 	dp->data = data;
81 	dp->cleanup = cleanup;
82 	dp->next = pamh->module_data;
83 	pamh->module_data = dp;
84 	RETURNC(PAM_SUCCESS);
85 }
86 
87 /*
88  * Error codes:
89  *
90  *	PAM_SYSTEM_ERR
91  *	PAM_BUF_ERR
92  */
93 
94 /**
95  * The =pam_set_data function associates a pointer to an opaque object
96  * with an arbitrary string specified by the =module_data_name argument,
97  * in the PAM context specified by the =pamh argument.
98  *
99  * If not =NULL, the =cleanup argument should point to a function
100  * responsible for releasing the resources associated with the object.
101  *
102  * This function and its counterpart =pam_get_data are useful for managing
103  * data that are meaningful only to a particular service module.
104  */
105