xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_set_item.3 (revision 2b3d1ee8a773e028429b331332895d44f445d720)
1.\"	$NetBSD: pam_set_item.3,v 1.2 2011/12/25 22:27:55 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 December 18, 2011
40.Dt PAM_SET_ITEM 3
41.Os
42.Sh NAME
43.Nm pam_set_item
44.Nd set authentication information
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_set_item "pam_handle_t *pamh" "int item_type" "const void *item"
52.Sh DESCRIPTION
53The
54.Nm
55function sets the item specified by the
56.Fa item_type
57argument to a copy of the object pointed to by the
58.Fa item
59argument.
60The item is stored in the PAM context specified by the
61.Fa pamh
62argument.
63See
64.Xr pam_get_item 3
65for a list of recognized item types.
66.Sh RETURN VALUES
67The
68.Nm
69function returns one of the following values:
70.Bl -tag -width 18n
71.It Bq Er PAM_BUF_ERR
72Memory buffer error.
73.It Bq Er PAM_SYMBOL_ERR
74Invalid symbol.
75.It Bq Er PAM_SYSTEM_ERR
76System error.
77.El
78.Sh SEE ALSO
79.Xr pam 3 ,
80.Xr pam_get_item 3 ,
81.Xr pam_strerror 3
82.Sh STANDARDS
83.Rs
84.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
85.%D "June 1997"
86.Re
87.Sh AUTHORS
88The
89.Nm
90function and this manual page were developed for the
91.Fx
92Project by
93ThinkSec AS and Network Associates Laboratories, the
94Security Research Division of Network Associates, Inc.\& under
95DARPA/SPAWAR contract N66001-01-C-8035
96.Pq Dq CBOSS ,
97as part of the DARPA CHATS research program.
98