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