contrib/openpam/doc/man/pam_set_data.3

   1 .\"-
   2 .\" Copyright (c) 2002 Networks Associates Technology, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   6 .\" NAI Labs, the Security Research Division of Network Associates, Inc.
   7 .\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
   8 .\" DARPA CHATS research program.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. The name of the author may not be used to endorse or promote
  19 .\"    products derived from this software without specific prior written
  20 .\"    permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" $P4: //depot/projects/openpam/doc/man/pam_set_data.3#11 $
  35 .\"
  36 .Dd April 14, 2002
  37 .Dt PAM_SET_DATA 3
  38 .Os
  39 .Sh NAME
  40 .Nm pam_set_data
  41 .Nd set module information
  42 .Sh LIBRARY
  43 .Lb libpam
  44 .Sh SYNOPSIS
  45 .In security/pam_appl.h
  46 .Ft int
  47 .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)"
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 function associates a pointer to an opaque object
  52 with an arbitrary string specified by the
  53 .Va module_data_name
  54 argument,
  55 in the PAM context specified by the
  56 .Va pamh
  57 argument.
  58 .Pp
  59 If not
  60 .Dv NULL ,
  61 the
  62 .Xr cleanup 3
  63 argument should point to a function
  64 responsible for releasing the resources associated with the object.
  65 .Pp
  66 This function and its counterpart
  67 .Xr pam_get_data 3
  68 are useful for managing
  69 data that are meaningful only to a particular service module.
  70 .Sh RETURN VALUES
  71 The
  72 .Nm
  73 function returns one of the following values:
  74 .Bl -tag -width 18n
  75 .It Bq Er PAM_BUF_ERR
  76 Memory buffer error.
  77 .It Bq Er PAM_SYSTEM_ERR
  78 System error.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr cleanup 3 ,
  82 .Xr pam 3 ,
  83 .Xr pam_get_data 3 ,
  84 .Xr pam_strerror 3
  85 .Sh STANDARDS
  86 .Rs
  87 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  88 .%D "June 1997"
  89 .Re
  90 .Sh AUTHORS
  91 The
  92 .Nm
  93 function and this manual page were developed for the FreeBSD Project
  94 by ThinkSec AS and NAI Labs, the Security Research Division of Network
  95 Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
  96 .Pq Dq CBOSS ,
  97 as part of the DARPA CHATS research program.