]> CyberLeo.Net >> Repos - FreeBSD/releng/10.2.git/blob - contrib/openpam/doc/man/pam_sm_setcred.3
- Copy stable/10@285827 to releng/10.2 in preparation for 10.2-RC1
[FreeBSD/releng/10.2.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 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
18 The
19 .Fn pam_sm_setcred
20 function is the service module's implementation of
21 the
22 .Xr pam_setcred 3
23 API function.
24 .Sh RETURN VALUES
25 The
26 .Fn pam_sm_setcred
27 function returns one of the following values:
28 .Bl -tag -width 18n
29 .It Bq Er PAM_ABORT
30 General failure.
31 .It Bq Er PAM_BUF_ERR
32 Memory buffer error.
33 .It Bq Er PAM_CONV_ERR
34 Conversation failure.
35 .It Bq Er PAM_CRED_ERR
36 Failed to set user credentials.
37 .It Bq Er PAM_CRED_EXPIRED
38 User credentials have expired.
39 .It Bq Er PAM_CRED_UNAVAIL
40 Failed to retrieve user credentials.
41 .It Bq Er PAM_IGNORE
42 Ignore this module.
43 .It Bq Er PAM_PERM_DENIED
44 Permission denied.
45 .It Bq Er PAM_SERVICE_ERR
46 Error in service module.
47 .It Bq Er PAM_SYSTEM_ERR
48 System error.
49 .It Bq Er PAM_USER_UNKNOWN
50 Unknown 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
62 The
63 .Fn pam_sm_setcred
64 function and this manual page were
65 developed for the
66 .Fx
67 Project by ThinkSec AS and Network Associates Laboratories, the
68 Security Research Division of Network Associates, Inc.\& under
69 DARPA/SPAWAR contract N66001-01-C-8035
70 .Pq Dq CBOSS ,
71 as part of the DARPA CHATS research program.
72 .Pp
73 The OpenPAM library is maintained by
74 .An Dag-Erling Sm\(/orgrav Aq des@des.no .