xref: /illumos-gate/usr/src/man/man3sasl/sasl_checkpass.3sasl (revision 0ae0ab6f6ac7a567d495b1daad2f6e229d097a21)
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_CHECKPASS 3SASL "Oct 14, 2003"
NAME
sasl_checkpass - check a plaintext password
SYNOPSIS

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

int sasl_checkpass(sasl_conn_t *conn, const char *user, unsigned userlen,
 const char *pass, unsigned passlen);
DESCRIPTION

The sasl_checkpass() interface checks a plaintext password. The sasl_checkpass() interface is used for protocols that had a login method before SASL, for example, the LOGIN command in IMAP. The password is checked with the pwcheck_method.

The sasl_checkpass() interface is a server interface. You cannot use it to check passwords from a client.

The sasl_checkpass() interface checks the posible repositories until it succeeds or there are no more repositories. If sasl_server_userdb_checkpass_t is registered, sasl_checkpass() tries it first.

Use the pwcheck_method SASL option to specify which pwcheck methods to use.

The sasl_checkpass() interface supports the transition of passwords if the SASL option auto_transition is on.

If user is NULL, check is plaintext passwords are enabled.

PARAMETERS
conn

The sasl_conn_t for which the request is being made

pass

Plaintext password to check

passlen

The length of pass

user

User to query in current user_domain

userlen

The length of username.

RETURN VALUES

sasl_checkpass() returns an integer that corresponds to a SASL error code.

ERRORS
SASL_OK

Indicates that the authentication is complete

All other error codes indicate an error situation that must be handled, or the authentication session should be quit. 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 Safe
SEE ALSO

sasl_errors (3SASL), attributes (7)