xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_sm_setcred.3 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\"	$NetBSD: pam_sm_setcred.3,v 1.4 2013/12/27 20:10:20 christos Exp $
2.\"
3.\" Generated from pam_sm_setcred.c by gendoc.pl
4.\" Id: pam_sm_setcred.c 648 2013-03-05 17:54:27Z des
5.Dd September 7, 2013
6.Dt PAM_SM_SETCRED 3
7.Os
8.Sh NAME
9.Nm pam_sm_setcred
10.Nd service module implementation for pam_setcred
11.Sh LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.In security/pam_modules.h
17.Ft "int"
18.Fn pam_sm_setcred "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
19.Sh DESCRIPTION
20The
21.Fn pam_sm_setcred
22function is the service module's implementation of
23the
24.Xr pam_setcred 3
25API function.
26.Sh RETURN VALUES
27The
28.Fn pam_sm_setcred
29function returns one of the following values:
30.Bl -tag -width 18n
31.It Bq Er PAM_ABORT
32General failure.
33.It Bq Er PAM_BUF_ERR
34Memory buffer error.
35.It Bq Er PAM_CONV_ERR
36Conversation failure.
37.It Bq Er PAM_CRED_ERR
38Failed to set user credentials.
39.It Bq Er PAM_CRED_EXPIRED
40User credentials have expired.
41.It Bq Er PAM_CRED_UNAVAIL
42Failed to retrieve user credentials.
43.It Bq Er PAM_IGNORE
44Ignore this module.
45.It Bq Er PAM_PERM_DENIED
46Permission denied.
47.It Bq Er PAM_SERVICE_ERR
48Error in service module.
49.It Bq Er PAM_SYSTEM_ERR
50System error.
51.It Bq Er PAM_USER_UNKNOWN
52Unknown user.
53.El
54.Sh SEE ALSO
55.Xr pam 3 ,
56.Xr pam_setcred 3 ,
57.Xr pam_strerror 3
58.Sh STANDARDS
59.Rs
60.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
61.%D "June 1997"
62.Re
63.Sh AUTHORS
64The
65.Fn pam_sm_setcred
66function and this manual page were
67developed for the
68.Fx
69Project by ThinkSec AS and Network Associates Laboratories, the
70Security Research Division of Network Associates, Inc.\& under
71DARPA/SPAWAR contract N66001-01-C-8035
72.Pq Dq CBOSS ,
73as part of the DARPA CHATS research program.
74.Pp
75The OpenPAM library is maintained by
76.An Dag-Erling Sm\(/orgrav Aq des@des.no .
77