xref: /freebsd/contrib/openpam/doc/man/pam_set_item.3 (revision 4f29da19bd44f0e99f021510460a81bf754c21d2)
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 June 16, 2005
37.Dt PAM_SET_ITEM 3
38.Os
39.Sh NAME
40.Nm pam_set_item
41.Nd set authentication information
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In sys/types.h
46.In security/pam_appl.h
47.Ft "int"
48.Fn pam_set_item "pam_handle_t *pamh" "int item_type" "const void *item"
49.Sh DESCRIPTION
50The
51.Nm
52function sets the item specified by the
53.Fa item_type
54argument to a copy of the object pointed to by the
55.Fa item
56argument.
57The item is stored in the PAM context specified by the
58.Fa pamh
59argument.
60See
61.Xr pam_get_item 3
62for a list of recognized item types.
63.Sh RETURN VALUES
64The
65.Nm
66function returns one of the following values:
67.Bl -tag -width 18n
68.It Bq Er PAM_BUF_ERR
69Memory buffer error.
70.It Bq Er PAM_SYMBOL_ERR
71Invalid symbol.
72.It Bq Er PAM_SYSTEM_ERR
73System error.
74.El
75.Sh SEE ALSO
76.Xr pam 3 ,
77.Xr pam_get_item 3 ,
78.Xr pam_strerror 3
79.Sh STANDARDS
80.Rs
81.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
82.%D "June 1997"
83.Re
84.Sh AUTHORS
85The
86.Nm
87function and this manual page were developed for the
88.Fx
89Project by ThinkSec AS and Network Associates Laboratories, the
90Security Research Division of Network Associates, Inc.\& under
91DARPA/SPAWAR contract N66001-01-C-8035
92.Pq Dq CBOSS ,
93as part of the DARPA CHATS research program.
94