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