dist/openpam/doc/man/pam_get_data.3

   1 .\"     $NetBSD: pam_get_data.3,v 1.4 2006/02/05 02:37:45 christos Exp $
   2 .\"
   3 .\"-
   4 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   5 .\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
   6 .\" All rights reserved.
   7 .\"
   8 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   9 .\" Network Associates Laboratories, the Security Research Division of
  10 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
  11 .\" ("CBOSS"), as part of the DARPA CHATS research program.
  12 .\"
  13 .\" Redistribution and use in source and binary forms, with or without
  14 .\" modification, are permitted provided that the following conditions
  15 .\" are met:
  16 .\" 1. Redistributions of source code must retain the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer.
  18 .\" 2. Redistributions in binary form must reproduce the above copyright
  19 .\"    notice, this list of conditions and the following disclaimer in the
  20 .\"    documentation and/or other materials provided with the distribution.
  21 .\" 3. The name of the author may not be used to endorse or promote
  22 .\"    products derived from this software without specific prior written
  23 .\"    permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .\" $P4$
  38 .\"
  39 .Dd December 21, 2007
  40 .Dt PAM_GET_DATA 3
  41 .Os
  42 .Sh NAME
  43 .Nm pam_get_data
  44 .Nd get module information
  45 .Sh LIBRARY
  46 .Lb libpam
  47 .Sh SYNOPSIS
  48 .In sys/types.h
  49 .In security/pam_appl.h
  50 .Ft "int"
  51 .Fn pam_get_data "const pam_handle_t *pamh" "const char *module_data_name" "const void **data"
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 function looks up the opaque object associated with
  56 the string specified by the
  57 .Fa module_data_name
  58 argument, in the PAM
  59 context specified by the
  60 .Fa pamh
  61 argument.
  62 A pointer to the object is stored in the location pointed to by the
  63 .Fa data
  64 argument.
  65 .Pp
  66 This function and its counterpart
  67 .Xr pam_set_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_NO_MODULE_DATA
  76 Module data not found.
  77 .It Bq Er PAM_SYSTEM_ERR
  78 System error.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr pam 3 ,
  82 .Xr pam_set_data 3 ,
  83 .Xr pam_strerror 3
  84 .Sh STANDARDS
  85 .Rs
  86 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  87 .%D "June 1997"
  88 .Re
  89 .Sh AUTHORS
  90 The
  91 .Nm
  92 function and this manual page were developed for the
  93 .Fx
  94 Project by ThinkSec AS and Network Associates Laboratories, the
  95 Security Research Division of Network Associates, Inc.\& under
  96 DARPA/SPAWAR contract N66001-01-C-8035
  97 .Pq Dq CBOSS ,
  98 as part of the DARPA CHATS research program.