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