contrib/openpam/doc/man/pam_set_data.3

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