xref: /illumos-gate/usr/src/man/man3sasl/sasl_log_t.3sasl (revision 1f5207b7604fb44407eb4342aff613f7c4508508)
te
Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
Portions Copyright (C) 2003, Sun Microsystems,
Inc. All Rights Reserved
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.
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.
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]
SASL_LOG_T 3SASL "Oct 27, 2003"
NAME
sasl_log_t - the SASL logging callback function
SYNOPSIS

cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/sasl.h>

int sasl_log_t(void *context, int level, const char *message);
DESCRIPTION

Use the sasl_log_t() function to log warning and error messages from the SASL library. syslog(3C) is used, unless another logging function is specified.

PARAMETERS
context

The logging context from the callback record.

level

The logging level. Possible values for level include: SASL_LOG_NONE

Do not log anything.

SASL_LOG_ERR

Log unusual errors. This is the default log level.

SASL_LOG_FAIL

Log all authentication failures.

SASL_LOG_WARN

Log non-fatal warnings.

SASL_LOG_NOTE

Log non-fatal warnings (more verbose than SASL_LOG_WARN).

SASL_LOG_DEBUG

Log non-fatal warnings (more verbose than SASL_LOG_NOTE).

SASL_LOG_TRACE

Log traces of internal protocols.

SASL_LOG_PASS

Log traces of internal protocols, including passwords.

message

The message to log

RETURN VALUES

Like other SASL callback functions, sasl_log_t() returns an integer that corresponds to a SASL error code. See <sasl.h> for a complete list of SASL error codes.

ERRORS
SASL_OK

The call to sasl_log_t() was successful.

See sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

sasl_errors(3SASL), syslog(3C), attributes(5)