Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_encode (3sasl)

Name

sasl_encode - Encode data for transport to authenticated host

Synopsis

#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 ** output,
unsigned * outputlen);

Description

sasl_encode(3sasl)              SASL man pages              sasl_encode(3sasl)



NAME
       sasl_encode - Encode data for transport to authenticated host



SYNOPSIS
       #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 ** output,
                      unsigned * outputlen);


DESCRIPTION
       sasl_encode  encodes  data  to  be sent to be sent to a remote host who
       we've had a successful authentication session with. If there is a nego-
       tiated  security  the data in signed/encrypted and the output should be
       sent without modification to the remote host. If there is  no  security
       layer the output is identical to the input.

       sasl_encodev does the same, but for a struct iovec instead of a charac-
       ter buffer.

       output contains the encoded data and is allocated/freed by the library.


RETURN VALUE
       Returns SASL_OK on success.  See  sasl_errors(3SASL)  for  meanings  of
       other return codes.


CONFORMING TO
       RFC 4422


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------------+
       |ATTRIBUTE TYPE |         ATTRIBUTE VALUE          |
       +---------------+----------------------------------+
       |Availability   | system/library/security/libsasl2 |
       +---------------+----------------------------------+
       |Stability      | Pass-through volatile            |
       +---------------+----------------------------------+

SEE ALSO
       sasl(3SASL), sasl_errors(3SASL), sasl_decode(3SASL)


NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was  downloaded from  ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-
       sasl-2.1.26.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.cyrusimap.org/sasl/.



SASL                             10 July 2001               sasl_encode(3sasl)