pam_getenvlist.c revision 107937 
1/*-
2 * Copyright (c) 2002 Networks Associates Technology, Inc.
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by ThinkSec AS and
6 * Network Associates Laboratories, the Security Research Division of
7 * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
8 * ("CBOSS"), as part of the DARPA CHATS research program.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote
19 *    products derived from this software without specific prior written
20 *    permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * $P4: //depot/projects/openpam/lib/pam_getenvlist.c#10 $
35 */
36
37#include <stdlib.h>
38#include <string.h>
39
40#include <security/pam_appl.h>
41
42#include "openpam_impl.h"
43
44/*
45 * XSSO 4.2.1
46 * XSSO 6 page 45
47 *
48 * Returns a list of all the PAM environment variables
49 */
50
51char **
52pam_getenvlist(pam_handle_t *pamh)
53{
54	char **envlist;
55	int i;
56
57	ENTER();
58	if (pamh == NULL)
59		RETURNP(NULL);
60	envlist = malloc(sizeof(char *) * (pamh->env_count + 1));
61	if (envlist == NULL) {
62		openpam_log(PAM_LOG_ERROR, "%s",
63			pam_strerror(pamh, PAM_BUF_ERR));
64		RETURNP(NULL);
65	}
66	for (i = 0; i < pamh->env_count; ++i) {
67		if ((envlist[i] = strdup(pamh->env[i])) == NULL) {
68			while (i)
69				free(envlist[--i]);
70			free(envlist);
71			openpam_log(PAM_LOG_ERROR, "%s",
72				pam_strerror(pamh, PAM_BUF_ERR));
73			RETURNP(NULL);
74		}
75	}
76	envlist[i] = NULL;
77	RETURNP(envlist);
78}
79
80/**
81 * The =pam_getenvlist function returns a copy of the given PAM context's
82 * environment list as a pointer to an array of strings.
83 * The last element in the array is =NULL.
84 * The pointer is suitable for assignment to {Va environ}.
85 *
86 * The array and the strings it lists are allocated using =malloc, and
87 * should be released using =free after use:
88 *
89 *     char **envlist, **env;
90 *
91 *     envlist = environ;
92 *     environ = pam_getenvlist(pamh);
93 *     \/\* do something nifty \*\/
94 *     for (env = environ; *env != NULL; env++)
95 *         free(*env);
96 *     free(environ);
97 *     environ = envlist;
98 *
99 * >environ 7
100 * >pam_getenv
101 * >pam_putenv
102 * >pam_setenv
103 */
104