xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_log.3 (revision a4ddc2c8fb9af816efe3b1c375a5530aef0e89e9)
1.\"	$NetBSD: openpam_log.3,v 1.2 2011/12/25 22:27:55 christos Exp $
2.\"
3.\"-
4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
5.\" Copyright (c) 2004-2011 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.\" Id
38.\"
39.Dd December 18, 2011
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
54The
55.Nm
56function logs messages using
57.Xr syslog 3 .
58It is primarily intended for internal use by the library and modules.
59.Pp
60The
61.Fa level
62argument indicates the importance of the message.
63The following levels are defined:
64.Bl -tag -width 18n
65.It Dv PAM_LOG_DEBUG
66Debugging messages.
67These messages are normally not logged unless the global
68integer variable
69.Va openpam_debug
70is set to a non-zero
71value, in which case they are logged with a
72.Xr syslog 3
73priority of
74.Dv LOG_DEBUG .
75.It Dv PAM_LOG_VERBOSE
76Information about the progress of the authentication
77process, or other non-essential messages.
78These messages are logged with a
79.Xr syslog 3
80priority of
81.Dv LOG_INFO .
82.It Dv PAM_LOG_NOTICE
83Messages relating to non-fatal errors.
84These messages are logged with a
85.Xr syslog 3
86priority of
87.Dv LOG_NOTICE .
88.It Dv PAM_LOG_ERROR
89Messages relating to serious errors.
90These messages are logged with a
91.Xr syslog 3
92priority of
93.Dv LOG_ERR .
94.El
95.Pp
96The remaining arguments are a
97.Xr printf 3
98format string and the
99corresponding arguments.
100.Sh SEE ALSO
101.Xr pam 3 ,
102.Xr printf 3 ,
103.Xr syslog 3
104.Sh STANDARDS
105The
106.Nm
107function is an OpenPAM extension.
108.Sh AUTHORS
109The
110.Nm
111function and this manual page were developed for the
112.Fx
113Project by
114ThinkSec AS and Network Associates Laboratories, the
115Security Research Division of Network Associates, Inc.\& under
116DARPA/SPAWAR contract N66001-01-C-8035
117.Pq Dq CBOSS ,
118as part of the DARPA CHATS research program.
119