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