xref: /illumos-gate/usr/src/man/man3sasl/sasl_encode64.3sasl (revision 4c87aefe8930bd07275b8dd2e96ea5f24d93a52e)
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_ENCODE64 3SASL "Sep 16, 2003"
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 output 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(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

sasl_errors(3SASL), attributes(5)