Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_decode (3sasl)

Name

sasl_decode - Decode data received

Synopsis

#include <sasl/sasl.h>


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

Description

sasl_decode(3sasl)              SASL man pages              sasl_decode(3sasl)



NAME
       sasl_decode - Decode data received



SYNOPSIS
       #include <sasl/sasl.h>


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


DESCRIPTION
       sasl_decode decodes data received. After successful authentication this
       function should be called on all data received.  It  decodes  the  data
       from  encrypted  or signed form to plain data. If there was no security
       layer negotiated the output is identical to the input.

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

       One should not to  give  sasl_decode  more  data  than  the  negotiated
       maxbufsize (see sasl_getprop).

       Note that sasl_decode can succeed and outputlen can be zero. If this is
       the case simply wait for more data and call sasl_decode again.


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_encode(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_decode(3sasl)