xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_get_data.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: pam_get_data.3,v 1.9 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from pam_get_data.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt PAM_GET_DATA 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm pam_get_data
944269bb5Schristos.Nd get module information
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.Ft "int"
1444269bb5Schristos.Fn pam_get_data "const pam_handle_t *pamh" "const char *module_data_name" "const void **data"
1544269bb5Schristos.Sh DESCRIPTION
1644269bb5SchristosThe
17e1b25b17Schristos.Fn pam_get_data
1844269bb5Schristosfunction looks up the opaque object associated with
1944269bb5Schristosthe string specified by the
2044269bb5Schristos.Fa module_data_name
2144269bb5Schristosargument, in the PAM
2244269bb5Schristoscontext specified by the
2344269bb5Schristos.Fa pamh
2444269bb5Schristosargument.
2544269bb5SchristosA pointer to the object is stored in the location pointed to by the
2644269bb5Schristos.Fa data
2744269bb5Schristosargument.
2844269bb5SchristosIf
29e1b25b17Schristos.Fn pam_get_data
3044269bb5Schristosfails, the
3144269bb5Schristos.Fa data
3244269bb5Schristosargument is untouched.
3344269bb5Schristos.Pp
3444269bb5SchristosThis function and its counterpart
3544269bb5Schristos.Xr pam_set_data 3
3644269bb5Schristosare useful for managing
3744269bb5Schristosdata that are meaningful only to a particular service module.
3844269bb5Schristos.Sh RETURN VALUES
3944269bb5SchristosThe
40e1b25b17Schristos.Fn pam_get_data
4144269bb5Schristosfunction returns one of the following values:
4244269bb5Schristos.Bl -tag -width 18n
434cb4af11Schristos.It Bq Er PAM_SUCCESS
444cb4af11SchristosSuccess.
4544269bb5Schristos.It Bq Er PAM_NO_MODULE_DATA
4644269bb5SchristosModule data not found.
4744269bb5Schristos.El
4844269bb5Schristos.Sh SEE ALSO
4944269bb5Schristos.Xr pam 3 ,
5044269bb5Schristos.Xr pam_set_data 3 ,
5144269bb5Schristos.Xr pam_strerror 3
5244269bb5Schristos.Sh STANDARDS
5344269bb5Schristos.Rs
5444269bb5Schristos.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
5544269bb5Schristos.%D "June 1997"
5644269bb5Schristos.Re
5744269bb5Schristos.Sh AUTHORS
5844269bb5SchristosThe
59e1b25b17Schristos.Fn pam_get_data
60e1b25b17Schristosfunction and this manual page were
61e1b25b17Schristosdeveloped for the
6244269bb5Schristos.Fx
63e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
6444269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
6544269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
6644269bb5Schristos.Pq Dq CBOSS ,
6744269bb5Schristosas part of the DARPA CHATS research program.
688fa0fefeSchristos.Pp
698fa0fefeSchristosThe OpenPAM library is maintained by
704cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
71