xref: /freebsd/contrib/openpam/lib/libpam/pam_getenvlist.c (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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 45
50  *
51  * Returns a list of all the PAM environment variables
52  */
53 
54 char **
55 pam_getenvlist(pam_handle_t *pamh)
56 {
57 	char **envlist;
58 	int i;
59 
60 	ENTER();
61 	envlist = malloc(sizeof(char *) * (pamh->env_count + 1));
62 	if (envlist == NULL) {
63 		openpam_log(PAM_LOG_ERROR, "%s",
64 		    pam_err_text[PAM_BUF_ERR]);
65 		RETURNP(NULL);
66 	}
67 	for (i = 0; i < pamh->env_count; ++i) {
68 		if ((envlist[i] = strdup(pamh->env[i])) == NULL) {
69 			while (i) {
70 				--i;
71 				FREE(envlist[i]);
72 			}
73 			FREE(envlist);
74 			openpam_log(PAM_LOG_ERROR, "%s",
75 			    pam_err_text[PAM_BUF_ERR]);
76 			RETURNP(NULL);
77 		}
78 	}
79 	envlist[i] = NULL;
80 	RETURNP(envlist);
81 }
82 
83 /**
84  * The =pam_getenvlist function returns a copy of the given PAM context's
85  * environment list as a pointer to an array of strings.
86  * The last element in the array is =NULL.
87  * The pointer is suitable for assignment to {Va environ}.
88  *
89  * The array and the strings it lists are allocated using =malloc, and
90  * should be released using =free after use:
91  *
92  *     char **envlist, **env;
93  *
94  *     envlist = environ;
95  *     environ = pam_getenvlist(pamh);
96  *     \/\* do something nifty \*\/
97  *     for (env = environ; *env != NULL; env++)
98  *         free(*env);
99  *     free(environ);
100  *     environ = envlist;
101  *
102  * >environ 7
103  * >pam_getenv
104  * >pam_putenv
105  * >pam_setenv
106  */
107