xref: /freebsd/contrib/openpam/doc/man/pam_sm_setcred.3 (revision 6780ab54325a71e7e70112b11657973edde8655e)
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.\" 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 January 6, 2003
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 sys/types.h
46.In security/pam_appl.h
47.In security/pam_modules.h
48.Ft int
49.Fn pam_sm_setcred "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
50.Sh DESCRIPTION
51The
52.Nm
53function is the service module's implementation of
54the
55.Xr pam_setcred 3
56API function.
57.Sh RETURN VALUES
58The
59.Nm
60function returns one of the following values:
61.Bl -tag -width 18n
62.It Bq Er PAM_ABORT
63General failure.
64.It Bq Er PAM_BUF_ERR
65Memory buffer error.
66.It Bq Er PAM_CONV_ERR
67Conversation failure.
68.It Bq Er PAM_CRED_ERR
69Failed to set user credentials.
70.It Bq Er PAM_CRED_EXPIRED
71User credentials have expired.
72.It Bq Er PAM_CRED_UNAVAIL
73Failed to retrieve user credentials.
74.It Bq Er PAM_IGNORE
75Ignore this module.
76.It Bq Er PAM_PERM_DENIED
77Permission denied.
78.It Bq Er PAM_SERVICE_ERR
79Error in service module.
80.It Bq Er PAM_SYSTEM_ERR
81System error.
82.It Bq Er PAM_USER_UNKNOWN
83Unknown user.
84.El
85.Sh SEE ALSO
86.Xr pam 3 ,
87.Xr pam_setcred 3 ,
88.Xr pam_strerror 3
89.Sh STANDARDS
90.Rs
91.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
92.%D "June 1997"
93.Re
94.Sh AUTHORS
95The
96.Nm
97function and this manual page were developed for the FreeBSD Project
98by ThinkSec AS and Network Associates Laboratories, the Security
99Research Division of Network Associates, Inc.  under DARPA/SPAWAR
100contract N66001-01-C-8035
101.Pq Dq CBOSS ,
102as part of the DARPA CHATS research program.
103