Go to main content

man pages section 3: Networking Library Functions

Exit Print View

Updated: July 2017
 
 

sasl_encodev(3SASL)

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 TYPE
ATTRIBUTE VALUE
Availability
system/library/security/libsasl
Interface Stability
Committed
MT-Level
Safe

See Also

attributes(5)