xref: /illumos-gate/usr/src/man/man3sasl/sasl_auxprop_request.3sasl (revision 66582b606a8194f7f3ba5b3a3a6dca5b0d346361)
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_AUXPROP_REQUEST 3SASL "Aug 22, 2003"
NAME
sasl_auxprop_request - request auxialliary properties from SASL
SYNOPSIS

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

int sasl_auxprop_request(sasl_conn_t *conn, const char **propnames);
DESCRIPTION

The sasl_auxprop_request() interface requests that the SASL library obtain properties form any auxialiary property plugins that might be installed, for example, the user's home directory from an LDAP server. The lookup occurs just after username canonicalization is complete. Therefore, the request should be made before the call to sasl_server_start(3SASL), but after the call to sasl_server_new(3SASL).

PARAMETERS
conn

The sasl_conn_t for which the request is being made

propnames

A null-terminated array of property names to request. This array must persist until a call to sasl_dispose(3SASL) on the sasl_conn_t.

ERRORS

sasl_auxprop_request() returns SASL_OK upon success. See sasl_errors(3SASL) for a discussion of other SASL error codes.

ATTRIBUTES

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

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

sasl_dispose(3SASL), sasl_errors(3SASL), sasl_server_new(3SASL), sasl_server_start(3SASL), attributes(5)