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