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