source: openpam/trunk/lib/pam_getenvlist.c @ 63

Last change on this file since 63 was 63, checked in by Dag-Erling Smørgrav, 19 years ago

Add in-line documentation. Some functions still lack descriptions.

Sponsored by: DARPA, NAI Labs

  • Property svn:keywords set to Id LastChangedRevision HeadURL LastChangedDate LastChangedBy
File size: 3.2 KB
Line 
1/*-
2 * Copyright (c) 2002 Networks Associates Technologies, Inc.
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by ThinkSec AS and
6 * NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * 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 * $Id: pam_getenvlist.c 63 2002-02-18 19:31:10Z des $
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        if (pamh == NULL)
58                return (NULL);
59
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                return (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                        return (NULL);
74                }
75        }
76        return (envlist);
77}
78
79/**
80 * The =pam_getenvlist function returns a copy of the given PAM context's
81 * environment list as a pointer to an array of strings.
82 * The last element in the array is =NULL.
83 * The pointer is suitable for assignment to {Va environ}.
84 *
85 * The array and the strings it lists are allocated using =malloc, and
86 * should be released using =free after use:
87 *
88 *     char **envlist, **env;
89 *     
90 *     envlist = environ;
91 *     environ = pam_getenvlist(pamh);
92 *     \/\* do something nifty \*\/
93 *     for (env = environ; *env != NULL; env++)
94 *         free(*env);
95 *     free(environ);
96 *     environ = envlist;
97 *
98 * >environ 7
99 * >pam_getenv
100 * >pam_putenv
101 * >pam_setenv
102 */
Note: See TracBrowser for help on using the repository browser.