xref: /titanic_51/usr/src/man/man3sasl/sasl_encode.3sasl (revision 036abaca93ddab92ba33036159c30112ab844810) 
 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_encode 3SASL "22 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_encode, sasl_encodev - encode data for transport to an authenticated host

 SYNOPSIS


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

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






int sasl_encodev(sasl_conn_t *conn, const struct iovec *invec,
 unsigned numiov, const char *outputlen);




 DESCRIPTION

The sasl_encode() interface encodes data to be sent to a remote host for
which there has been a successful authentication session. If there is a
negotiated security, the data is signed or encrypted, and the output is sent
without modification to the remote host. If there is no security layer, the
output is identical to the input.


The sasl_encodev() interface functions the same as the
sasl_encode() interface, but operates on a struct iovec instead of
a character buffer.

 PARAMETERS

conn


The SASL connection context.





input


Data.





inputlen


input length.





output


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





outputlen


The length of output.





invec


A pointer to set of iovec structures.





numiov


The number of iovec structures in the invec set.




 RETURN VALUES

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

 ERRORS

SASL_OK


The call to sasl_encode() or sasl_encodev()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

attributes(5)