1 | /**
|
---|
2 | * \file base64.h
|
---|
3 | *
|
---|
4 | * \brief RFC 1521 base64 encoding/decoding
|
---|
5 | */
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
|
---|
8 | * SPDX-License-Identifier: Apache-2.0
|
---|
9 | *
|
---|
10 | * Licensed under the Apache License, Version 2.0 (the "License"); you may
|
---|
11 | * not use this file except in compliance with the License.
|
---|
12 | * You may obtain a copy of the License at
|
---|
13 | *
|
---|
14 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
15 | *
|
---|
16 | * Unless required by applicable law or agreed to in writing, software
|
---|
17 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
18 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
19 | * See the License for the specific language governing permissions and
|
---|
20 | * limitations under the License.
|
---|
21 | *
|
---|
22 | * This file is part of mbed TLS (https://tls.mbed.org)
|
---|
23 | */
|
---|
24 | #ifndef MBEDTLS_BASE64_H
|
---|
25 | #define MBEDTLS_BASE64_H
|
---|
26 |
|
---|
27 | #if !defined(MBEDTLS_CONFIG_FILE)
|
---|
28 | #include "config.h"
|
---|
29 | #else
|
---|
30 | #include MBEDTLS_CONFIG_FILE
|
---|
31 | #endif
|
---|
32 |
|
---|
33 | #include <stddef.h>
|
---|
34 |
|
---|
35 | #define MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL -0x002A /**< Output buffer too small. */
|
---|
36 | #define MBEDTLS_ERR_BASE64_INVALID_CHARACTER -0x002C /**< Invalid character in input. */
|
---|
37 |
|
---|
38 | #ifdef __cplusplus
|
---|
39 | extern "C" {
|
---|
40 | #endif
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * \brief Encode a buffer into base64 format
|
---|
44 | *
|
---|
45 | * \param dst destination buffer
|
---|
46 | * \param dlen size of the destination buffer
|
---|
47 | * \param olen number of bytes written
|
---|
48 | * \param src source buffer
|
---|
49 | * \param slen amount of data to be encoded
|
---|
50 | *
|
---|
51 | * \return 0 if successful, or MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL.
|
---|
52 | * *olen is always updated to reflect the amount
|
---|
53 | * of data that has (or would have) been written.
|
---|
54 | * If that length cannot be represented, then no data is
|
---|
55 | * written to the buffer and *olen is set to the maximum
|
---|
56 | * length representable as a size_t.
|
---|
57 | *
|
---|
58 | * \note Call this function with dlen = 0 to obtain the
|
---|
59 | * required buffer size in *olen
|
---|
60 | */
|
---|
61 | int mbedtls_base64_encode( unsigned char *dst, size_t dlen, size_t *olen,
|
---|
62 | const unsigned char *src, size_t slen );
|
---|
63 |
|
---|
64 | /**
|
---|
65 | * \brief Decode a base64-formatted buffer
|
---|
66 | *
|
---|
67 | * \param dst destination buffer (can be NULL for checking size)
|
---|
68 | * \param dlen size of the destination buffer
|
---|
69 | * \param olen number of bytes written
|
---|
70 | * \param src source buffer
|
---|
71 | * \param slen amount of data to be decoded
|
---|
72 | *
|
---|
73 | * \return 0 if successful, MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL, or
|
---|
74 | * MBEDTLS_ERR_BASE64_INVALID_CHARACTER if the input data is
|
---|
75 | * not correct. *olen is always updated to reflect the amount
|
---|
76 | * of data that has (or would have) been written.
|
---|
77 | *
|
---|
78 | * \note Call this function with *dst = NULL or dlen = 0 to obtain
|
---|
79 | * the required buffer size in *olen
|
---|
80 | */
|
---|
81 | int mbedtls_base64_decode( unsigned char *dst, size_t dlen, size_t *olen,
|
---|
82 | const unsigned char *src, size_t slen );
|
---|
83 |
|
---|
84 | #if defined(MBEDTLS_SELF_TEST)
|
---|
85 | /**
|
---|
86 | * \brief Checkup routine
|
---|
87 | *
|
---|
88 | * \return 0 if successful, or 1 if the test failed
|
---|
89 | */
|
---|
90 | int mbedtls_base64_self_test( int verbose );
|
---|
91 |
|
---|
92 | #endif /* MBEDTLS_SELF_TEST */
|
---|
93 |
|
---|
94 | #ifdef __cplusplus
|
---|
95 | }
|
---|
96 | #endif
|
---|
97 |
|
---|
98 | #endif /* base64.h */
|
---|