Merge remote-tracking branch 'origin/vendor/GCC80'
[dragonfly.git] / contrib / openpam / doc / man / openpam_restore_cred.3
1 .\" Generated from openpam_restore_cred.c by gendoc.pl
2 .\" $OpenPAM: openpam_restore_cred.c 938 2017-04-30 21:34:42Z des $
3 .Dd April 30, 2017
4 .Dt OPENPAM_RESTORE_CRED 3
5 .Os
6 .Sh NAME
7 .Nm openpam_restore_cred
8 .Nd restore credentials
9 .Sh SYNOPSIS
10 .In sys/types.h
11 .In security/pam_appl.h
12 .In security/openpam.h
13 .Ft "int"
14 .Fn openpam_restore_cred "pam_handle_t *pamh"
15 .Sh DESCRIPTION
16 The
17 .Fn openpam_restore_cred
18 function restores the credentials saved by
19 .Xr openpam_borrow_cred 3 .
20 .Pp
21 .Sh RETURN VALUES
22 The
23 .Fn openpam_restore_cred
24 function returns one of the following values:
25 .Bl -tag -width 18n
26 .It Bq Er PAM_SUCCESS
27 Success.
28 .It Bq Er PAM_NO_MODULE_DATA
29 Module data not found.
30 .It Bq Er PAM_SYSTEM_ERR
31 System error.
32 .El
33 .Sh SEE ALSO
34 .Xr setegid 2 ,
35 .Xr seteuid 2 ,
36 .Xr setgroups 2 ,
37 .Xr openpam_borrow_cred 3 ,
38 .Xr pam 3 ,
39 .Xr pam_strerror 3
40 .Sh STANDARDS
41 The
42 .Fn openpam_restore_cred
43 function is an OpenPAM extension.
44 .Sh AUTHORS
45 The
46 .Fn openpam_restore_cred
47 function and this manual page were
48 developed for the
49 .Fx
50 Project by ThinkSec AS and Network Associates Laboratories, the
51 Security Research Division of Network Associates, Inc.\& under
52 DARPA/SPAWAR contract N66001-01-C-8035
53 .Pq Dq CBOSS ,
54 as part of the DARPA CHATS research program.
55 .Pp
56 The OpenPAM library is maintained by
57 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .