xref: /freebsd/contrib/openpam/doc/man/openpam_log.3 (revision b740c88bfb6453416926271c089262e7164dace3)
1.\" Generated from openpam_log.c by gendoc.pl
2.\" $Id: openpam_log.c 686 2013-07-11 16:36:02Z des $
3.Dd September 12, 2014
4.Dt OPENPAM_LOG 3
5.Os
6.Sh NAME
7.Nm openpam_log
8.Nd log a message through syslog
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.In security/openpam.h
15.Ft "void"
16.Fn openpam_log "int level" "const char *fmt" "..."
17.Sh DESCRIPTION
18The
19.Fn openpam_log
20function logs messages using
21.Xr syslog 3 .
22It is primarily intended for internal use by the library and modules.
23.Pp
24The
25.Fa level
26argument indicates the importance of the message.
27The following levels are defined:
28.Bl -tag -width 18n
29.It Dv PAM_LOG_LIBDEBUG
30Debugging messages.
31For internal use only.
32.It Dv PAM_LOG_DEBUG
33Debugging messages.
34These messages are normally not logged unless the global
35integer variable
36.Va openpam_debug
37is set to a non-zero
38value, in which case they are logged with a
39.Xr syslog 3
40priority of
41.Dv LOG_DEBUG .
42.It Dv PAM_LOG_VERBOSE
43Information about the progress of the authentication
44process, or other non-essential messages.
45These messages are logged with a
46.Xr syslog 3
47priority of
48.Dv LOG_INFO .
49.It Dv PAM_LOG_NOTICE
50Messages relating to non-fatal errors.
51These messages are logged with a
52.Xr syslog 3
53priority of
54.Dv LOG_NOTICE .
55.It Dv PAM_LOG_ERROR
56Messages relating to serious errors.
57These messages are logged with a
58.Xr syslog 3
59priority of
60.Dv LOG_ERR .
61.El
62.Pp
63The remaining arguments are a
64.Xr printf 3
65format string and the
66corresponding arguments.
67.Pp
68The
69.Fn openpam_log
70function does not modify the value of
71.Va errno .
72.Sh SEE ALSO
73.Xr pam 3 ,
74.Xr printf 3 ,
75.Xr syslog 3
76.Sh STANDARDS
77The
78.Fn openpam_log
79function is an OpenPAM extension.
80.Sh AUTHORS
81The
82.Fn openpam_log
83function and this manual page were
84developed for the
85.Fx
86Project by ThinkSec AS and Network Associates Laboratories, the
87Security Research Division of Network Associates, Inc.\& under
88DARPA/SPAWAR contract N66001-01-C-8035
89.Pq Dq CBOSS ,
90as part of the DARPA CHATS research program.
91.Pp
92The OpenPAM library is maintained by
93.An Dag-Erling Sm\(/orgrav Aq des@des.no .
94