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