usr/src/man/man3sasl/sasl_log_t.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_LOG_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_log_t \- the SASL logging callback function
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_log_t\fR(\fBvoid *\fR\fIcontext\fR, \fBint\fR \fIlevel\fR, \fBconst char *\fR\fImessage\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_log_t()\fR function to log warning and error messages from the
  24 SASL library. \fBsyslog\fR(3C) is used, unless another logging function is
  25 specified.
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIcontext\fR\fR
  31 .ad
  32 .RS 11n
  33 The logging context from the callback record.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIlevel\fR\fR
  40 .ad
  41 .RS 11n
  42 The logging level. Possible values for \fIlevel\fR include:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBSASL_LOG_NONE\fR\fR
  47 .ad
  48 .RS 18n
  49 Do not log anything.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBSASL_LOG_ERR\fR\fR
  56 .ad
  57 .RS 18n
  58 Log unusual errors. This is the default log level.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBSASL_LOG_FAIL\fR\fR
  65 .ad
  66 .RS 18n
  67 Log all authentication failures.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBSASL_LOG_WARN\fR\fR
  74 .ad
  75 .RS 18n
  76 Log non-fatal warnings.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBSASL_LOG_NOTE\fR\fR
  83 .ad
  84 .RS 18n
  85 Log non-fatal warnings (more verbose than \fBSASL_LOG_WARN\fR).
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBSASL_LOG_DEBUG\fR\fR
  92 .ad
  93 .RS 18n
  94 Log non-fatal warnings (more verbose than \fBSASL_LOG_NOTE\fR).
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBSASL_LOG_TRACE\fR\fR
 101 .ad
 102 .RS 18n
 103 Log traces of internal protocols.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBSASL_LOG_PASS\fR\fR
 110 .ad
 111 .RS 18n
 112 Log traces of internal protocols, including passwords.
 113 .RE
 114
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fImessage\fR\fR
 121 .ad
 122 .RS 11n
 123 The message to log
 124 .RE
 125
 126 .SH RETURN VALUES
 127 .sp
 128 .LP
 129 Like other SASL callback functions, \fBsasl_log_t()\fR returns an integer that
 130 corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list of
 131 SASL error codes.
 132 .SH ERRORS
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBSASL_OK\fR\fR
 137 .ad
 138 .RS 11n
 139 The call to \fBsasl_log_t()\fR was successful.
 140 .RE
 141
 142 .sp
 143 .LP
 144 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 145 .SH ATTRIBUTES
 146 .sp
 147 .LP
 148 See \fBattributes\fR(5) for descriptions of the following attributes:
 149 .sp
 150
 151 .sp
 152 .TS
 153 box;
 154 c | c
 155 l | l .
 156 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 157 _
 158 Interface Stability     Evolving
 159 _
 160 MT-Level        MT-Safe
 161 .TE
 162
 163 .SH SEE ALSO
 164 .sp
 165 .LP
 166 \fBsasl_errors\fR(3SASL), \fBsyslog\fR(3C), \fBattributes\fR(5)