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