contrib/openpam/doc/man/pam_set_data.3

   1 .\" Generated from pam_set_data.c by gendoc.pl
   2 .\" $OpenPAM: pam_set_data.c 938 2017-04-30 21:34:42Z des $
   3 .Dd April 30, 2017
   4 .Dt PAM_SET_DATA 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_set_data
   8 .Nd set module information
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .Ft "int"
  13 .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)"
  14 .Sh DESCRIPTION
  15 The
  16 .Fn pam_set_data
  17 function associates a pointer to an opaque object
  18 with an arbitrary string specified by the
  19 .Fa module_data_name
  20 argument,
  21 in the PAM context specified by the
  22 .Fa pamh
  23 argument.
  24 .Pp
  25 If not
  26 .Dv NULL ,
  27 the
  28 .Fa cleanup
  29 argument should point to a function
  30 responsible for releasing the resources associated with the object.
  31 .Pp
  32 This function and its counterpart
  33 .Xr pam_get_data 3
  34 are useful for managing
  35 data that are meaningful only to a particular service module.
  36 .Sh RETURN VALUES
  37 The
  38 .Fn pam_set_data
  39 function returns one of the following values:
  40 .Bl -tag -width 18n
  41 .It Bq Er PAM_SUCCESS
  42 Success.
  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 Mt des@des.no .