1.\"-
2.\" Copyright (c) 2002 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" NAI Labs, the Security Research Division of Network Associates, Inc.
7.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8.\" 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: //depot/projects/openpam/doc/man/pam_sm_setcred.3#5 $
35.\"
36.Dd March 7, 2002
37.Dt PAM_SM_SETCRED 3
38.Os
39.Sh NAME
40.Nm pam_sm_setcred
41.Nd service module implementation for pam_setcred
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In security/pam_appl.h
46.In security/pam_modules.h
47.Ft int
48.Fn pam_sm_setcred "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
49.Sh DESCRIPTION
50The
51.Nm
52function is the service module's implementation of
53the
54.Xr pam_setcred 3
55API function.
56.Sh RETURN VALUES
57The
58.Nm
59function returns one of the following values:
60.Bl -tag -width 18n
61.It Bq Er PAM_ABORT
62General failure.
63.It Bq Er PAM_BUF_ERR
64Memory buffer error.
65.It Bq Er PAM_CONV_ERR
66Conversation failure.
67.It Bq Er PAM_CRED_ERR
68Failed to set user credentials.
69.It Bq Er PAM_CRED_EXPIRED
70User credentials have expired.
71.It Bq Er PAM_CRED_UNAVAIL
72Failed to retrieve user credentials.
73.It Bq Er PAM_IGNORE
74Ignore this module.
75.It Bq Er PAM_PERM_DENIED
76Permission denied.
77.It Bq Er PAM_SERVICE_ERR
78Error in service module.
79.It Bq Er PAM_SYSTEM_ERR
80System error.
81.It Bq Er PAM_USER_UNKNOWN
82Unknown user.
83.El
84.Sh SEE ALSO
85.Xr pam 3 ,
86.Xr pam_setcred 3 ,
87.Xr pam_strerror 3
88.Sh STANDARDS
89.Rs
90.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
91.%D "June 1997"
92.Re
93.Sh AUTHORS
94The
95.Nm
96function and this manual page were developed for the FreeBSD Project
97by ThinkSec AS and NAI Labs, the Security Research Division of Network
98Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
99.Pq Dq CBOSS ,
100as part of the DARPA CHATS research program.
101