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