contrib/openpam/doc/man/pam_set_item.3

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