xref: /netbsd-src/external/bsd/openpam/dist/doc/man/openpam_log.3 (revision 4391d5e9d4f291db41e3b3ba26a01b5e51364aae)
1.\"	$NetBSD: openpam_log.3,v 1.3 2013/04/06 02:20:25 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 May 26, 2012
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.Fn openpam_log
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_LIBDEBUG
66Debugging messages.
67For internal use only.
68.It Dv PAM_LOG_DEBUG
69Debugging messages.
70These messages are normally not logged unless the global
71integer variable
72.Va openpam_debug
73is set to a non-zero
74value, in which case they are logged with a
75.Xr syslog 3
76priority of
77.Dv LOG_DEBUG .
78.It Dv PAM_LOG_VERBOSE
79Information about the progress of the authentication
80process, or other non-essential messages.
81These messages are logged with a
82.Xr syslog 3
83priority of
84.Dv LOG_INFO .
85.It Dv PAM_LOG_NOTICE
86Messages relating to non-fatal errors.
87These messages are logged with a
88.Xr syslog 3
89priority of
90.Dv LOG_NOTICE .
91.It Dv PAM_LOG_ERROR
92Messages relating to serious errors.
93These messages are logged with a
94.Xr syslog 3
95priority of
96.Dv LOG_ERR .
97.El
98.Pp
99The remaining arguments are a
100.Xr printf 3
101format string and the
102corresponding arguments.
103.Sh SEE ALSO
104.Xr pam 3 ,
105.Xr printf 3 ,
106.Xr syslog 3
107.Sh STANDARDS
108The
109.Fn openpam_log
110function is an OpenPAM extension.
111.Sh AUTHORS
112The
113.Fn openpam_log
114function and this manual page were
115developed for the
116.Fx
117Project by ThinkSec AS and Network Associates Laboratories, the
118Security Research Division of Network Associates, Inc.\& under
119DARPA/SPAWAR contract N66001-01-C-8035
120.Pq Dq CBOSS ,
121as part of the DARPA CHATS research program.
122