xref: /freebsd/contrib/openpam/doc/man/pam_sm_setcred.3 (revision 7431dfd4580e850375fe5478d92ec770344db098)
1.\" Generated from pam_sm_setcred.c by gendoc.pl
2.\" $Id: pam_sm_setcred.c 648 2013-03-05 17:54:27Z des $
3.Dd September 12, 2014
4.Dt PAM_SM_SETCRED 3
5.Os
6.Sh NAME
7.Nm pam_sm_setcred
8.Nd service module implementation for pam_setcred
9.Sh LIBRARY
10.Lb libpam
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_ABORT
30General failure.
31.It Bq Er PAM_BUF_ERR
32Memory buffer error.
33.It Bq Er PAM_CONV_ERR
34Conversation failure.
35.It Bq Er PAM_CRED_ERR
36Failed to set user credentials.
37.It Bq Er PAM_CRED_EXPIRED
38User credentials have expired.
39.It Bq Er PAM_CRED_UNAVAIL
40Failed to retrieve user credentials.
41.It Bq Er PAM_IGNORE
42Ignore this module.
43.It Bq Er PAM_PERM_DENIED
44Permission denied.
45.It Bq Er PAM_SERVICE_ERR
46Error in service module.
47.It Bq Er PAM_SYSTEM_ERR
48System error.
49.It Bq Er PAM_USER_UNKNOWN
50Unknown user.
51.El
52.Sh SEE ALSO
53.Xr pam 3 ,
54.Xr pam_setcred 3 ,
55.Xr pam_strerror 3
56.Sh STANDARDS
57.Rs
58.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
59.%D "June 1997"
60.Re
61.Sh AUTHORS
62The
63.Fn pam_sm_setcred
64function and this manual page were
65developed for the
66.Fx
67Project by ThinkSec AS and Network Associates Laboratories, the
68Security Research Division of Network Associates, Inc.\& under
69DARPA/SPAWAR contract N66001-01-C-8035
70.Pq Dq CBOSS ,
71as part of the DARPA CHATS research program.
72.Pp
73The OpenPAM library is maintained by
74.An Dag-Erling Sm\(/orgrav Aq des@des.no .
75