xref: /dflybsd-src/contrib/openpam/doc/man/pam_get_data.3 (revision 4c84ab30f7dd59ef873b5a6d4e27bcea89d9f848)
110b5fe87SSascha Wildner.\" Generated from pam_get_data.c by gendoc.pl
210b5fe87SSascha Wildner.\" $OpenPAM: pam_get_data.c 938 2017-04-30 21:34:42Z des $
3*4c84ab30SSascha Wildner.Dd February 24, 2019
4ade90846SJoerg Sonnenberger.Dt PAM_GET_DATA 3
5ade90846SJoerg Sonnenberger.Os
6ade90846SJoerg Sonnenberger.Sh NAME
7ade90846SJoerg Sonnenberger.Nm pam_get_data
8ade90846SJoerg Sonnenberger.Nd get module information
9ade90846SJoerg Sonnenberger.Sh SYNOPSIS
10ade90846SJoerg Sonnenberger.In sys/types.h
11ade90846SJoerg Sonnenberger.In security/pam_appl.h
12ade90846SJoerg Sonnenberger.Ft "int"
13f23594ceSHasso Tepper.Fn pam_get_data "const pam_handle_t *pamh" "const char *module_data_name" "const void **data"
14ade90846SJoerg Sonnenberger.Sh DESCRIPTION
15ade90846SJoerg SonnenbergerThe
16577efdeeSPeter Avalos.Fn pam_get_data
17ade90846SJoerg Sonnenbergerfunction looks up the opaque object associated with
18ade90846SJoerg Sonnenbergerthe string specified by the
19ade90846SJoerg Sonnenberger.Fa module_data_name
20ade90846SJoerg Sonnenbergerargument, in the PAM
21ade90846SJoerg Sonnenbergercontext specified by the
22ade90846SJoerg Sonnenberger.Fa pamh
23ade90846SJoerg Sonnenbergerargument.
24ade90846SJoerg SonnenbergerA pointer to the object is stored in the location pointed to by the
25ade90846SJoerg Sonnenberger.Fa data
26ade90846SJoerg Sonnenbergerargument.
27a474e9feSPeter AvalosIf
28577efdeeSPeter Avalos.Fn pam_get_data
29a474e9feSPeter Avalosfails, the
30a474e9feSPeter Avalos.Fa data
31a474e9feSPeter Avalosargument is untouched.
32ade90846SJoerg Sonnenberger.Pp
33ade90846SJoerg SonnenbergerThis function and its counterpart
34ade90846SJoerg Sonnenberger.Xr pam_set_data 3
35ade90846SJoerg Sonnenbergerare useful for managing
36ade90846SJoerg Sonnenbergerdata that are meaningful only to a particular service module.
37ade90846SJoerg Sonnenberger.Sh RETURN VALUES
38ade90846SJoerg SonnenbergerThe
39577efdeeSPeter Avalos.Fn pam_get_data
40ade90846SJoerg Sonnenbergerfunction returns one of the following values:
41ade90846SJoerg Sonnenberger.Bl -tag -width 18n
4210b5fe87SSascha Wildner.It Bq Er PAM_SUCCESS
4310b5fe87SSascha WildnerSuccess.
44ade90846SJoerg Sonnenberger.It Bq Er PAM_NO_MODULE_DATA
45ade90846SJoerg SonnenbergerModule data not found.
46ade90846SJoerg Sonnenberger.El
47ade90846SJoerg Sonnenberger.Sh SEE ALSO
48ade90846SJoerg Sonnenberger.Xr pam 3 ,
49ade90846SJoerg Sonnenberger.Xr pam_set_data 3 ,
50ade90846SJoerg Sonnenberger.Xr pam_strerror 3
51ade90846SJoerg Sonnenberger.Sh STANDARDS
52ade90846SJoerg Sonnenberger.Rs
53ade90846SJoerg Sonnenberger.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
54ade90846SJoerg Sonnenberger.%D "June 1997"
55ade90846SJoerg Sonnenberger.Re
56ade90846SJoerg Sonnenberger.Sh AUTHORS
57ade90846SJoerg SonnenbergerThe
58577efdeeSPeter Avalos.Fn pam_get_data
59577efdeeSPeter Avalosfunction and this manual page were
60577efdeeSPeter Avalosdeveloped for the
61ade90846SJoerg Sonnenberger.Fx
62577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the
63f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under
64ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035
65ade90846SJoerg Sonnenberger.Pq Dq CBOSS ,
66ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program.
6710b5fe87SSascha Wildner.Pp
6810b5fe87SSascha WildnerThe OpenPAM library is maintained by
6910b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
70