xref: /freebsd/contrib/openpam/doc/man/openpam_log.3 (revision 7aa383846770374466b1dcb2cefd71bde9acf463)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 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.\" $P4$
36.\"
37.Dd December 21, 2007
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.Nm
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_DEBUG
64Debugging messages.
65These messages are normally not logged unless the global
66integer variable
67.Va _openpam_debug
68is set to a non-zero
69value, in which case they are logged with a
70.Xr syslog 3
71priority of
72.Dv LOG_DEBUG .
73.It Dv PAM_LOG_VERBOSE
74Information about the progress of the authentication
75process, or other non-essential messages.
76These messages are logged with a
77.Xr syslog 3
78priority of
79.Dv LOG_INFO .
80.It Dv PAM_LOG_NOTICE
81Messages relating to non-fatal errors.
82These messages are logged with a
83.Xr syslog 3
84priority of
85.Dv LOG_NOTICE .
86.It Dv PAM_LOG_ERROR
87Messages relating to serious errors.
88These messages are logged with a
89.Xr syslog 3
90priority of
91.Dv LOG_ERR .
92.El
93.Pp
94The remaining arguments are a
95.Xr printf 3
96format string and the
97corresponding arguments.
98.Sh SEE ALSO
99.Xr pam 3 ,
100.Xr printf 3 ,
101.Xr syslog 3
102.Sh STANDARDS
103The
104.Nm
105function is an OpenPAM extension.
106.Sh AUTHORS
107The
108.Nm
109function and this manual page were developed for the
110.Fx
111Project by ThinkSec AS and Network Associates Laboratories, the
112Security Research Division of Network Associates, Inc.\& under
113DARPA/SPAWAR contract N66001-01-C-8035
114.Pq Dq CBOSS ,
115as part of the DARPA CHATS research program.
116