contrib/openpam/lib/libpam/pam_getenvlist.c

   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  * $OpenPAM: pam_getenvlist.c 938 2017-04-30 21:34:42Z 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         envlist = malloc(sizeof(char *) * (pamh->env_count + 1));
  64         if (envlist == NULL) {
  65                 openpam_log(PAM_LOG_ERROR, "%s",
  66                     pam_err_text[PAM_BUF_ERR]);
  67                 RETURNP(NULL);
  68         }
  69         for (i = 0; i < pamh->env_count; ++i) {
  70                 if ((envlist[i] = strdup(pamh->env[i])) == NULL) {
  71                         while (i) {
  72                                 --i;
  73                                 FREE(envlist[i]);
  74                         }
  75                         FREE(envlist);
  76                         openpam_log(PAM_LOG_ERROR, "%s",
  77                             pam_err_text[PAM_BUF_ERR]);
  78                         RETURNP(NULL);
  79                 }
  80         }
  81         envlist[i] = NULL;
  82         RETURNP(envlist);
  83 }
  84
  85 /**
  86  * The =pam_getenvlist function returns a copy of the given PAM context's
  87  * environment list as a pointer to an array of strings.
  88  * The last element in the array is =NULL.
  89  * The pointer is suitable for assignment to {Va environ}.
  90  *
  91  * The array and the strings it lists are allocated using =malloc, and
  92  * should be released using =free after use:
  93  *
  94  *     char **envlist, **env;
  95  *
  96  *     envlist = environ;
  97  *     environ = pam_getenvlist(pamh);
  98  *     \/\* do something nifty \*\/
  99  *     for (env = environ; *env != NULL; env++)
 100  *         free(*env);
 101  *     free(environ);
 102  *     environ = envlist;
 103  *
 104  * >environ 7
 105  * >pam_getenv
 106  * >pam_putenv
 107  * >pam_setenv
 108  */