xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_setenv.3 (revision 7788a0781fe6ff2cce37368b4578a7ade0850cb1)
1.\"	$NetBSD: pam_setenv.3,v 1.3 2013/04/06 02:20:29 christos Exp $
2.\"
3.\"-
4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
5.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav
6.\" All rights reserved.
7.\"
8.\" This software was developed for the FreeBSD Project by ThinkSec AS and
9.\" Network Associates Laboratories, the Security Research Division of
10.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
11.\" ("CBOSS"), as part of the DARPA CHATS research program.
12.\"
13.\" Redistribution and use in source and binary forms, with or without
14.\" modification, are permitted provided that the following conditions
15.\" are met:
16.\" 1. Redistributions of source code must retain the above copyright
17.\"    notice, this list of conditions and the following disclaimer.
18.\" 2. Redistributions in binary form must reproduce the above copyright
19.\"    notice, this list of conditions and the following disclaimer in the
20.\"    documentation and/or other materials provided with the distribution.
21.\" 3. The name of the author may not be used to endorse or promote
22.\"    products derived from this software without specific prior written
23.\"    permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.\" Id
38.\"
39.Dd May 26, 2012
40.Dt PAM_SETENV 3
41.Os
42.Sh NAME
43.Nm pam_setenv
44.Nd mirrors setenv(3)
45.Sh LIBRARY
46.Lb libpam
47.Sh SYNOPSIS
48.In sys/types.h
49.In security/pam_appl.h
50.Ft "int"
51.Fn pam_setenv "pam_handle_t *pamh" "const char *name" "const char *value" "int overwrite"
52.Sh DESCRIPTION
53The
54.Fn pam_setenv
55function sets an environment variable.
56Its semantics are similar to those of
57.Xr setenv 3 ,
58but it modifies the PAM
59context's environment list instead of the application's.
60.Sh RETURN VALUES
61The
62.Fn pam_setenv
63function returns one of the following values:
64.Bl -tag -width 18n
65.It Bq Er PAM_BUF_ERR
66Memory buffer error.
67.It Bq Er PAM_SYSTEM_ERR
68System error.
69.El
70.Sh SEE ALSO
71.Xr pam 3 ,
72.Xr pam_getenv 3 ,
73.Xr pam_getenvlist 3 ,
74.Xr pam_putenv 3 ,
75.Xr pam_strerror 3 ,
76.Xr setenv 3
77.Sh STANDARDS
78The
79.Fn pam_setenv
80function is an OpenPAM extension.
81.Sh AUTHORS
82The
83.Fn pam_setenv
84function and this manual page were
85developed for the
86.Fx
87Project by ThinkSec AS and Network Associates Laboratories, the
88Security Research Division of Network Associates, Inc.\& under
89DARPA/SPAWAR contract N66001-01-C-8035
90.Pq Dq CBOSS ,
91as part of the DARPA CHATS research program.
92