dist/openpam/doc/man/pam_getenvlist.3

   1 .\"     $NetBSD: pam_getenvlist.3,v 1.5 2006/02/05 02:37:45 christos Exp $
   2 .\"
   3 .\"-
   4 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   5 .\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
   6 .\" All rights reserved.
   7 .\"
   8 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   9 .\" Network Associates Laboratories, the Security Research Division of
  10 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
  11 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  12 .\"
  13 .\" Redistribution and use in source and binary forms, with or without
  14 .\" modification, are permitted provided that the following conditions
  15 .\" are met:
  16 .\" 1. Redistributions of source code must retain the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer.
  18 .\" 2. Redistributions in binary form must reproduce the above copyright
  19 .\"    notice, this list of conditions and the following disclaimer in the
  20 .\"    documentation and/or other materials provided with the distribution.
  21 .\" 3. The name of the author may not be used to endorse or promote
  22 .\"    products derived from this software without specific prior written
  23 .\"    permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\" $P4$
  38 .\"
  39 .Dd December 21, 2007
  40 .Dt PAM_GETENVLIST 3
  41 .Os
  42 .Sh NAME
  43 .Nm pam_getenvlist
  44 .Nd returns a list of all the PAM environment variables
  45 .Sh LIBRARY
  46 .Lb libpam
  47 .Sh SYNOPSIS
  48 .In sys/types.h
  49 .In security/pam_appl.h
  50 .Ft "char **"
  51 .Fn pam_getenvlist "pam_handle_t *pamh"
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 function returns a copy of the given PAM context's
  56 environment list as a pointer to an array of strings.
  57 The last element in the array is
  58 .Dv NULL .
  59 The pointer is suitable for assignment to
  60 .Va environ .
  61 .Pp
  62 The array and the strings it lists are allocated using
  63 .Xr malloc 3 ,
  64 and
  65 should be released using
  66 .Xr free 3
  67 after use:
  68 .Pp
  69 .Bd -literal
  70     char **envlist, **env;
  71
  72     envlist = environ;
  73     environ = pam_getenvlist(pamh);
  74     /* do something nifty */
  75     for (env = environ; *env != NULL; env++)
  76         free(*env);
  77     free(environ);
  78     environ = envlist;
  79 .Ed
  80 .Sh RETURN VALUES
  81 The
  82 .Nm
  83 function returns
  84 .Dv NULL
  85 on failure.
  86 .Sh SEE ALSO
  87 .Xr free 3 ,
  88 .Xr malloc 3 ,
  89 .Xr pam 3 ,
  90 .Xr pam_getenv 3 ,
  91 .Xr pam_putenv 3 ,
  92 .Xr pam_setenv 3 ,
  93 .Xr environ 7
  94 .Sh STANDARDS
  95 .Rs
  96 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  97 .%D "June 1997"
  98 .Re
  99 .Sh AUTHORS
 100 The
 101 .Nm
 102 function and this manual page were developed for the
 103 .Fx
 104 Project by ThinkSec AS and Network Associates Laboratories, the
 105 Security Research Division of Network Associates, Inc.\& under
 106 DARPA/SPAWAR contract N66001-01-C-8035
 107 .Pq Dq CBOSS ,
 108 as part of the DARPA CHATS research program.