]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/openpam/doc/man/pam_sm_setcred.3
Upgrade to OpenPAM Radula.
[FreeBSD/FreeBSD.git] / contrib / openpam / doc / man / pam_sm_setcred.3
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 February 19, 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
16 The
17 .Fn pam_sm_setcred
18 function is the service module's implementation of
19 the
20 .Xr pam_setcred 3
21 API function.
22 .Sh RETURN VALUES
23 The
24 .Fn pam_sm_setcred
25 function returns one of the following values:
26 .Bl -tag -width 18n
27 .It Bq Er PAM_ABORT
28 General failure.
29 .It Bq Er PAM_BUF_ERR
30 Memory buffer error.
31 .It Bq Er PAM_CONV_ERR
32 Conversation failure.
33 .It Bq Er PAM_CRED_ERR
34 Failed to set user credentials.
35 .It Bq Er PAM_CRED_EXPIRED
36 User credentials have expired.
37 .It Bq Er PAM_CRED_UNAVAIL
38 Failed to retrieve user credentials.
39 .It Bq Er PAM_IGNORE
40 Ignore this module.
41 .It Bq Er PAM_PERM_DENIED
42 Permission denied.
43 .It Bq Er PAM_SERVICE_ERR
44 Error in service module.
45 .It Bq Er PAM_SYSTEM_ERR
46 System error.
47 .It Bq Er PAM_USER_UNKNOWN
48 Unknown user.
49 .El
50 .Sh SEE ALSO
51 .Xr pam 3 ,
52 .Xr pam_setcred 3 ,
53 .Xr pam_strerror 3
54 .Sh STANDARDS
55 .Rs
56 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
57 .%D "June 1997"
58 .Re
59 .Sh AUTHORS
60 The
61 .Fn pam_sm_setcred
62 function and this manual page were
63 developed for the
64 .Fx
65 Project by ThinkSec AS and Network Associates Laboratories, the
66 Security Research Division of Network Associates, Inc.\& under
67 DARPA/SPAWAR contract N66001-01-C-8035
68 .Pq Dq CBOSS ,
69 as part of the DARPA CHATS research program.
70 .Pp
71 The OpenPAM library is maintained by
72 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .