xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_get_data.3 (revision d1d9b6fefeebf66b7ad610860b6b2e06ea088afe)
1.\"	$NetBSD: pam_get_data.3,v 1.6 2014/10/24 18:25:14 christos Exp $
2.\"
3.\" Generated from pam_get_data.c by gendoc.pl
4.\" Id: pam_get_data.c 648 2013-03-05 17:54:27Z des
5.Dd September 12, 2014
6.Dt PAM_GET_DATA 3
7.Os
8.Sh NAME
9.Nm pam_get_data
10.Nd get module information
11.Sh LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.Ft "int"
17.Fn pam_get_data "const pam_handle_t *pamh" "const char *module_data_name" "const void **data"
18.Sh DESCRIPTION
19The
20.Fn pam_get_data
21function looks up the opaque object associated with
22the string specified by the
23.Fa module_data_name
24argument, in the PAM
25context specified by the
26.Fa pamh
27argument.
28A pointer to the object is stored in the location pointed to by the
29.Fa data
30argument.
31If
32.Fn pam_get_data
33fails, the
34.Fa data
35argument is untouched.
36.Pp
37This function and its counterpart
38.Xr pam_set_data 3
39are useful for managing
40data that are meaningful only to a particular service module.
41.Sh RETURN VALUES
42The
43.Fn pam_get_data
44function returns one of the following values:
45.Bl -tag -width 18n
46.It Bq Er PAM_NO_MODULE_DATA
47Module data not found.
48.It Bq Er PAM_SYSTEM_ERR
49System error.
50.El
51.Sh SEE ALSO
52.Xr pam 3 ,
53.Xr pam_set_data 3 ,
54.Xr pam_strerror 3
55.Sh STANDARDS
56.Rs
57.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
58.%D "June 1997"
59.Re
60.Sh AUTHORS
61The
62.Fn pam_get_data
63function and this manual page were
64developed for the
65.Fx
66Project by ThinkSec AS and Network Associates Laboratories, the
67Security Research Division of Network Associates, Inc.\& under
68DARPA/SPAWAR contract N66001-01-C-8035
69.Pq Dq CBOSS ,
70as part of the DARPA CHATS research program.
71.Pp
72The OpenPAM library is maintained by
73.An Dag-Erling Sm\(/orgrav Aq des@des.no .
74