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