Home | History | Annotate | Line # | Download | only in man
pam_set_data.3 revision 1.5 
      1 <<<<<<< pam_set_data.3
      2 .\"	$NetBSD: pam_set_data.3,v 1.5 2014/10/24 18:17:56 christos Exp $
      3 .\"
      4 =======
      5 >>>>>>> 1.1.1.4
      6 .\" Generated from pam_set_data.c by gendoc.pl
      7 .\" Id: pam_set_data.c 648 2013-03-05 17:54:27Z des 
      8 .Dd September 12, 2014
      9 .Dt PAM_SET_DATA 3
     10 .Os
     11 .Sh NAME
     12 .Nm pam_set_data
     13 .Nd set 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_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)"
     21 .Sh DESCRIPTION
     22 The
     23 .Fn pam_set_data
     24 function associates a pointer to an opaque object
     25 with an arbitrary string specified by the
     26 .Fa module_data_name
     27 argument,
     28 in the PAM context specified by the
     29 .Fa pamh
     30 argument.
     31 .Pp
     32 If not
     33 .Dv NULL ,
     34 the
     35 .Fa cleanup
     36 argument should point to a function
     37 responsible for releasing the resources associated with the object.
     38 .Pp
     39 This function and its counterpart
     40 .Xr pam_get_data 3
     41 are useful for managing
     42 data that are meaningful only to a particular service module.
     43 .Sh RETURN VALUES
     44 The
     45 .Fn pam_set_data
     46 function returns one of the following values:
     47 .Bl -tag -width 18n
     48 .It Bq Er PAM_BUF_ERR
     49 Memory buffer error.
     50 .It Bq Er PAM_SYSTEM_ERR
     51 System error.
     52 .El
     53 .Sh SEE ALSO
     54 .Xr openpam_free_data 3 ,
     55 .Xr pam 3 ,
     56 .Xr pam_get_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_set_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