xref: /netbsd-src/external/bsd/openpam/dist/lib/libpam/pam_getenvlist.c (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1 /*	$NetBSD: pam_getenvlist.c,v 1.5 2023/06/30 21:46:21 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 
38 #ifdef HAVE_CONFIG_H
39 # include "config.h"
40 #endif
41 
42 #include <sys/cdefs.h>
43 __RCSID("$NetBSD: pam_getenvlist.c,v 1.5 2023/06/30 21:46:21 christos Exp $");
44 
45 #include <stdlib.h>
46 #include <string.h>
47 
48 #include <security/pam_appl.h>
49 
50 #include "openpam_impl.h"
51 
52 /*
53  * XSSO 4.2.1
54  * XSSO 6 page 45
55  *
56  * Returns a list of all the PAM environment variables
57  */
58 
59 char **
pam_getenvlist(pam_handle_t * pamh)60 pam_getenvlist(pam_handle_t *pamh)
61 {
62 	char **envlist;
63 	size_t i;
64 
65 	ENTER();
66 #ifdef notdef
67 	if (pamh == NULL)
68 		RETURNP(NULL);
69 #endif
70 	envlist = malloc(sizeof(*envlist) * ((size_t)pamh->env_count + 1));
71 	if (envlist == NULL) {
72 		openpam_log(PAM_LOG_ERROR, "%s",
73 		    pam_err_text[PAM_BUF_ERR]);
74 		RETURNP(NULL);
75 	}
76 	for (i = 0; i < pamh->env_count; ++i) {
77 		if ((envlist[i] = strdup(pamh->env[i])) == NULL) {
78 			while (i) {
79 				--i;
80 				FREE(envlist[i]);
81 			}
82 			FREE(envlist);
83 			openpam_log(PAM_LOG_ERROR, "%s",
84 			    pam_err_text[PAM_BUF_ERR]);
85 			RETURNP(NULL);
86 		}
87 	}
88 	envlist[i] = NULL;
89 	RETURNP(envlist);
90 }
91 
92 /**
93  * The =pam_getenvlist function returns a copy of the given PAM context's
94  * environment list as a pointer to an array of strings.
95  * The last element in the array is =NULL.
96  * The pointer is suitable for assignment to {Va environ}.
97  *
98  * The array and the strings it lists are allocated using =malloc, and
99  * should be released using =free after use:
100  *
101  *     char **envlist, **env;
102  *
103  *     envlist = environ;
104  *     environ = pam_getenvlist(pamh);
105  *     \/\* do something nifty \*\/
106  *     for (env = environ; *env != NULL; env++)
107  *         free(*env);
108  *     free(environ);
109  *     environ = envlist;
110  *
111  * >environ 7
112  * >pam_getenv
113  * >pam_putenv
114  * >pam_setenv
115  */
116