contrib/openpam/doc/man/pam_get_data.3

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