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