contrib/openpam/doc/man/openpam_log.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   6 .\" Network Associates Laboratories, the Security Research Division of
   7 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
   8 .\" ("CBOSS"), as part of the 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$
  35 .\"
  36 .Dd June 16, 2005
  37 .Dt OPENPAM_LOG 3
  38 .Os
  39 .Sh NAME
  40 .Nm openpam_log
  41 .Nd log a message through syslog
  42 .Sh LIBRARY
  43 .Lb libpam
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In security/pam_appl.h
  47 .In security/openpam.h
  48 .Ft "void"
  49 .Fn openpam_log "int level" "const char *fmt" "..."
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 function logs messages using
  54 .Xr syslog 3 .
  55 It is primarily intended for internal use by the library and modules.
  56 .Pp
  57 The
  58 .Fa level
  59 argument indicates the importance of the message.
  60 The following levels are defined:
  61 .Bl -tag -width 18n
  62 .It Dv PAM_LOG_DEBUG
  63 Debugging messages.
  64 These messages are normally not logged unless the global
  65 integer variable
  66 .Va _openpam_debug
  67 is set to a non-zero
  68 value, in which case they are logged with a
  69 .Xr syslog 3
  70 priority of
  71 .Dv LOG_DEBUG .
  72 .It Dv PAM_LOG_VERBOSE
  73 Information about the progress of the authentication
  74 process, or other non-essential messages.
  75 These messages are logged with a
  76 .Xr syslog 3
  77 priority of
  78 .Dv LOG_INFO .
  79 .It Dv PAM_LOG_NOTICE
  80 Messages relating to non-fatal errors.
  81 These messages are logged with a
  82 .Xr syslog 3
  83 priority of
  84 .Dv LOG_NOTICE .
  85 .It Dv PAM_LOG_ERROR
  86 Messages relating to serious errors.
  87 These messages are logged with a
  88 .Xr syslog 3
  89 priority of
  90 .Dv LOG_ERR .
  91 .El
  92 .Pp
  93 The remaining arguments are a
  94 .Xr printf 3
  95 format string and the
  96 corresponding arguments.
  97 .Sh SEE ALSO
  98 .Xr pam 3 ,
  99 .Xr printf 3 ,
 100 .Xr syslog 3
 101 .Sh STANDARDS
 102 The
 103 .Nm
 104 function is an OpenPAM extension.
 105 .Sh AUTHORS
 106 The
 107 .Nm
 108 function and this manual page were developed for the
 109 .Fx
 110 Project by ThinkSec AS and Network Associates Laboratories, the
 111 Security Research Division of Network Associates, Inc.\& under
 112 DARPA/SPAWAR contract N66001-01-C-8035
 113 .Pq Dq CBOSS ,
 114 as part of the DARPA CHATS research program.