xref: /titanic_50/usr/src/man/man3sasl/sasl_decode.3sasl (revision 447603b54aaea470ed1dcdb5c52d0be1d7801f84) 
 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_decode 3SASL "28 Aug 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_decode - decode data received

 SYNOPSIS


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

int sasl_decode(sasl_conn_t *conn, const char *input, unsigned inputlen,
 const char **output, unsigned *outputlen);




 DESCRIPTION

Use the sasl_decode() interface to decode data received. After
authentication, call this function on all data received. The data is decoded
from encrypted or signed form to plain data. If no security lay is negotiated,
the output is identical to the input.


Do not give sasl_decode() more data than the negotiated maxbufsize.
See sasl_getprop(3SASL).


sasl_decode() can complete successfully although the value of
outputlen is zero. If this is the case, wait for more data and call
sasl_decode() again.

 PARAMETERS

conn


The SASL connection context.





input


Data received.





inputlen


The length of input





output


The decoded data. output must be allocated or freed by the library.





outputlen


The length of output.




 RETURN VALUES

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

 ERRORS

SASL_OK


The call to sasl_decode() 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-LevelSafe



 SEE ALSO

sasl_errors(3SASL), sasl_getprop(3SASL), attributes(5)