contrib/openpam/doc/man/pam_get_data.3

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