xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_sm_setcred.3 (revision 4cb4af11b1521f1626a9baaf40ae4f58e0929844)
1.\"	$NetBSD: pam_sm_setcred.3,v 1.7 2017/05/06 19:50:09 christos Exp $
2.\"
3.\" Generated from pam_sm_setcred.c by gendoc.pl
4.\" $OpenPAM: pam_sm_setcred.c 938 2017-04-30 21:34:42Z des $
5.Dd April 30, 2017
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 SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.In security/pam_modules.h
15.Ft "int"
16.Fn pam_sm_setcred "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
17.Sh DESCRIPTION
18The
19.Fn pam_sm_setcred
20function is the service module's implementation of
21the
22.Xr pam_setcred 3
23API function.
24.Sh RETURN VALUES
25The
26.Fn pam_sm_setcred
27function returns one of the following values:
28.Bl -tag -width 18n
29.It Bq Er PAM_SUCCESS
30Success.
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 Mt des@des.no .
77