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