xref: /dflybsd-src/contrib/openpam/doc/man/pam_getenvlist.3 (revision 4c84ab30f7dd59ef873b5a6d4e27bcea89d9f848)
110b5fe87SSascha Wildner.\" Generated from pam_getenvlist.c by gendoc.pl
210b5fe87SSascha Wildner.\" $OpenPAM: pam_getenvlist.c 938 2017-04-30 21:34:42Z des $
3*4c84ab30SSascha Wildner.Dd February 24, 2019
4ade90846SJoerg Sonnenberger.Dt PAM_GETENVLIST 3
5ade90846SJoerg Sonnenberger.Os
6ade90846SJoerg Sonnenberger.Sh NAME
7ade90846SJoerg Sonnenberger.Nm pam_getenvlist
8ade90846SJoerg Sonnenberger.Nd returns a list of all the PAM environment variables
9ade90846SJoerg Sonnenberger.Sh SYNOPSIS
10ade90846SJoerg Sonnenberger.In sys/types.h
11ade90846SJoerg Sonnenberger.In security/pam_appl.h
12ade90846SJoerg Sonnenberger.Ft "char **"
13ade90846SJoerg Sonnenberger.Fn pam_getenvlist "pam_handle_t *pamh"
14ade90846SJoerg Sonnenberger.Sh DESCRIPTION
15ade90846SJoerg SonnenbergerThe
16577efdeeSPeter Avalos.Fn pam_getenvlist
17ade90846SJoerg Sonnenbergerfunction returns a copy of the given PAM context's
18ade90846SJoerg Sonnenbergerenvironment list as a pointer to an array of strings.
19ade90846SJoerg SonnenbergerThe last element in the array is
20ade90846SJoerg Sonnenberger.Dv NULL .
21ade90846SJoerg SonnenbergerThe pointer is suitable for assignment to
22ade90846SJoerg Sonnenberger.Va environ .
23ade90846SJoerg Sonnenberger.Pp
24ade90846SJoerg SonnenbergerThe array and the strings it lists are allocated using
25ade90846SJoerg Sonnenberger.Xr malloc 3 ,
26ade90846SJoerg Sonnenbergerand
27ade90846SJoerg Sonnenbergershould be released using
28ade90846SJoerg Sonnenberger.Xr free 3
29ade90846SJoerg Sonnenbergerafter use:
30ade90846SJoerg Sonnenberger.Pp
31ade90846SJoerg Sonnenberger.Bd -literal
32ade90846SJoerg Sonnenberger    char **envlist, **env;
33ade90846SJoerg Sonnenberger
34ade90846SJoerg Sonnenberger    envlist = environ;
35ade90846SJoerg Sonnenberger    environ = pam_getenvlist(pamh);
36ade90846SJoerg Sonnenberger    /* do something nifty */
37ade90846SJoerg Sonnenberger    for (env = environ; *env != NULL; env++)
38ade90846SJoerg Sonnenberger        free(*env);
39ade90846SJoerg Sonnenberger    free(environ);
40ade90846SJoerg Sonnenberger    environ = envlist;
41ade90846SJoerg Sonnenberger.Ed
42ade90846SJoerg Sonnenberger.Sh RETURN VALUES
43ade90846SJoerg SonnenbergerThe
44577efdeeSPeter Avalos.Fn pam_getenvlist
45ade90846SJoerg Sonnenbergerfunction returns
46ade90846SJoerg Sonnenberger.Dv NULL
47ade90846SJoerg Sonnenbergeron failure.
48ade90846SJoerg Sonnenberger.Sh SEE ALSO
49ade90846SJoerg Sonnenberger.Xr free 3 ,
50ade90846SJoerg Sonnenberger.Xr malloc 3 ,
51ade90846SJoerg Sonnenberger.Xr pam 3 ,
52ade90846SJoerg Sonnenberger.Xr pam_getenv 3 ,
53ade90846SJoerg Sonnenberger.Xr pam_putenv 3 ,
54ade90846SJoerg Sonnenberger.Xr pam_setenv 3 ,
55ade90846SJoerg Sonnenberger.Xr environ 7
56ade90846SJoerg Sonnenberger.Sh STANDARDS
57ade90846SJoerg Sonnenberger.Rs
58ade90846SJoerg Sonnenberger.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
59ade90846SJoerg Sonnenberger.%D "June 1997"
60ade90846SJoerg Sonnenberger.Re
61ade90846SJoerg Sonnenberger.Sh AUTHORS
62ade90846SJoerg SonnenbergerThe
63577efdeeSPeter Avalos.Fn pam_getenvlist
64577efdeeSPeter Avalosfunction and this manual page were
65577efdeeSPeter Avalosdeveloped for the
66ade90846SJoerg Sonnenberger.Fx
67577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the
68f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under
69ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035
70ade90846SJoerg Sonnenberger.Pq Dq CBOSS ,
71ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program.
7210b5fe87SSascha Wildner.Pp
7310b5fe87SSascha WildnerThe OpenPAM library is maintained by
7410b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
75