xref: /illumos-gate/usr/src/man/man3sasl/sasl_setpass.3sasl (revision 8533946bd264dca901fdf56bf3da1d81e728b423)
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_SETPASS 3SASL "Oct 15, 2003"
NAME
sasl_setpass - set the password for a user
SYNOPSIS

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

int sasl_setpass(sasl_conn_t *conn, const char *user, const char *pass,
 unsigned passlen, const char *oldpass, unsigned oldpasslen,
 unsigned flags);
DESCRIPTION

Use the sasl_setpass() interface to set passwords. sasl_setpass() uses the SASL_CB_SERVER_USERDB_SETPASS callback, if one is supplied. Additionally, if any server mechanism plugins supply a setpass callback, the setpass callback would be called. None of the server mechanism plugins currently supply a setpass callback.

PARAMETERS
conn

The SASL connection context

user

The username for which the password is set

pass

The password to set

passlen

The length of pass

oldpass

The old password, which is optional

oldpasslen

The length of oldpass, which is optional

flags

Refers to flags, including, SASL_SET_CREATE and SASL_SET_DISABLE. Use these flags to create and disable accounts.

RETURN VALUES

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

ERRORS
SASL_OK

The call to sasl_setpass() 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), sasl_getprop(3SASL), attributes(5)