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