Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_encode64 (3sasl)

Name

sasl_encode64 - encode base64 string

Synopsis

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

int sasl_encode64(const char *in ,
unsigned inlen,
char *out,
unsigned outmax,
unsigned *outlen);

Description

sasl_encode64(3sasl)            SASL man pages            sasl_encode64(3sasl)



NAME
       sasl_encode64 - encode base64 string


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

       int sasl_encode64(const char *in ,
                         unsigned inlen,
                         char *out,
                         unsigned outmax,
                         unsigned *outlen);


DESCRIPTION
       Use  the  sasl_encode64()  interface  to convert an octet string into a
       base64 string. This routine  is  useful  for  SASL  profiles  that  use
       base64,  such as the IMAP (IMAP4) and POP (POP_AUTH) profiles. The out-
       put is null-terminated. If outlen is non-NULL, the length is placed  in
       the outlen.


PARAMETERS
       in Input data.

       inlen The length of the input data.

       out  The  output data. The value of out can be the same as in. However,
       there must be enough space.

       outlen The length of the actual output.

       outmax The maximum size of the output buffer.


RETURN VALUES
       sasl_encode64() returns an integer that corresponds  to  a  SASL  error
       code.


ERRORS
       SASL_OK The call to sasl_encode64() was successful.

       SASL_BUFOVER
               The output buffer was too small.



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_errors(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                              16 Sep 2003             sasl_encode64(3sasl)