xref: /titanic_41/usr/src/man/man3sasl/sasl_getsecret_t.3sasl (revision 80ac04ddcdb18d996dfcdf61bc8c55c2329bfd59) 
 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_getsecret_t 3SASL "27 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_getsecret_t - the SASL callback function for secrets (passwords)

 SYNOPSIS


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

int sasl_getsecret_t(sasl_conn_t *conn, void *context,
 int id, sasl_secret_t **psecret);




 DESCRIPTION

Use the sasl_getsecret_t() function to retrieve the secret from the
application. Allocate a sasl_secret_t to length
sizeof(sasl_secret_t)+<length of secret>. sasl_secret_t has two
fields of len which contain the length of secret in bytes and the
data contained in secret. The secret string does not need to be
null-terminated.

 PARAMETERS

conn


The connection context





context


The context from the callback structure





id


The callback ID





psecret


To cancel, set the value of psecret to NULL. Otherwise, set the
value to the password structure. The structure must persist until the next call
to sasl_getsecret_t() in the same connection. Middleware erases password
data when it is done with it.




 RETURN VALUES

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





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

 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe



 SEE ALSO

sasl_errors(3SASL), attributes(5)