xref: /illumos-gate/usr/src/man/man3sasl/sasl_server_userdb_checkpass_t.3sasl (revision ed093b41a93e8563e6e1e5dae0768dda2a7bcc27)
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_SERVER_USERDB_CHECKPASS_T 3SASL "Oct 27, 2003"
NAME
sasl_server_userdb_checkpass_t - plaintext password verification callback function
SYNOPSIS

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

int sasl_sasl_server_userdb_checkpass_t(sasl_conn_t *conn, void *context,
 const char *user, const char *pass, unsigned passlen, struct propctx *propctx);
DESCRIPTION

Use the sasl_sasl_server_userdb_checkpass_t() callback function to verify a plaintext password against the callback supplier's user database. Verification allows additional ways to encode the userPassword property.

PARAMETERS
conn

The SASL connection context.

context

The context from the callback record.

user

A null-terminated user name with user@realm syntax.

pass

The password to check. This string cannot be null-terminated.

passlen

The length of pass.

propctx

The property context to fill in with userPassword.

RETURN VALUES

Like other SASL callback functions, sasl_server_userdb_checkpass_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_server_userdb_checkpass_t() was successful.

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

ATTRIBUTES

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

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

sasl_errors (3SASL), attributes (7)