xref: /freebsd/contrib/openpam/doc/man/pam_getenv.3 (revision 315ee00f)
1.\" Generated from pam_getenv.c by gendoc.pl
2.Dd June 27, 2023
3.Dt PAM_GETENV 3
4.Os
5.Sh NAME
6.Nm pam_getenv
7.Nd retrieve the value of a PAM environment variable
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.Ft "const char *"
12.Fn pam_getenv "pam_handle_t *pamh" "const char *name"
13.Sh DESCRIPTION
14The
15.Fn pam_getenv
16function returns the value of an environment variable.
17Its semantics are similar to those of
18.Xr getenv 3 ,
19but it accesses the PAM
20context's environment list instead of the application's.
21.Pp
22.Sh RETURN VALUES
23The
24.Fn pam_getenv
25function returns
26.Dv NULL
27on failure.
28.Sh SEE ALSO
29.Xr getenv 3 ,
30.Xr pam 3 ,
31.Xr pam_getenvlist 3 ,
32.Xr pam_putenv 3 ,
33.Xr pam_setenv 3
34.Sh STANDARDS
35.Rs
36.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
37.%D "June 1997"
38.Re
39.Sh AUTHORS
40The
41.Fn pam_getenv
42function and this manual page were
43developed for the
44.Fx
45Project by ThinkSec AS and Network Associates Laboratories, the
46Security Research Division of Network Associates, Inc.\& under
47DARPA/SPAWAR contract N66001-01-C-8035
48.Pq Dq CBOSS ,
49as part of the DARPA CHATS research program.
50.Pp
51The OpenPAM library is maintained by
52.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
53