dist/openpam/doc/man/openpam_log.3

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