contrib/openpam/doc/man/pam_getenvlist.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 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$
  35 .\"
  36 .Dd June 16, 2005
  37 .Dt PAM_GETENVLIST 3
  38 .Os
  39 .Sh NAME
  40 .Nm pam_getenvlist
  41 .Nd returns a list of all the PAM environment variables
  42 .Sh LIBRARY
  43 .Lb libpam
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In security/pam_appl.h
  47 .Ft "char **"
  48 .Fn pam_getenvlist "pam_handle_t *pamh"
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 function returns a copy of the given PAM context's
  53 environment list as a pointer to an array of strings.
  54 The last element in the array is
  55 .Dv NULL .
  56 The pointer is suitable for assignment to
  57 .Va environ .
  58 .Pp
  59 The array and the strings it lists are allocated using
  60 .Xr malloc 3 ,
  61 and
  62 should be released using
  63 .Xr free 3
  64 after use:
  65 .Pp
  66 .Bd -literal
  67     char **envlist, **env;
  68
  69     envlist = environ;
  70     environ = pam_getenvlist(pamh);
  71     /* do something nifty */
  72     for (env = environ; *env != NULL; env++)
  73         free(*env);
  74     free(environ);
  75     environ = envlist;
  76 .Ed
  77 .Sh RETURN VALUES
  78 The
  79 .Nm
  80 function returns
  81 .Dv NULL
  82 on failure.
  83 .Sh SEE ALSO
  84 .Xr free 3 ,
  85 .Xr malloc 3 ,
  86 .Xr pam 3 ,
  87 .Xr pam_getenv 3 ,
  88 .Xr pam_putenv 3 ,
  89 .Xr pam_setenv 3 ,
  90 .Xr environ 7
  91 .Sh STANDARDS
  92 .Rs
  93 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  94 .%D "June 1997"
  95 .Re
  96 .Sh AUTHORS
  97 The
  98 .Nm
  99 function and this manual page were developed for the
 100 .Fx
 101 Project by ThinkSec AS and Network Associates Laboratories, the
 102 Security Research Division of Network Associates, Inc.& under
 103 DARPA/SPAWAR contract N66001-01-C-8035
 104 .Pq Dq CBOSS ,
 105 as part of the DARPA CHATS research program.