ladybird/AK/Base64.h

/*
 * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/ByteBuffer.h>
#include <AK/Error.h>
#include <AK/String.h>
#include <AK/StringView.h>

namespace AK {

size_t size_required_to_decode_base64(StringView);

ErrorOr<ByteBuffer> decode_base64(StringView);
ErrorOr<ByteBuffer> decode_base64url(StringView);

enum class OmitPadding {
    No,
    Yes,
};

ErrorOr<String> encode_base64(ReadonlyBytes, OmitPadding = OmitPadding::No);
ErrorOr<String> encode_base64url(ReadonlyBytes, OmitPadding = OmitPadding::No);

}

#if USING_AK_GLOBALLY
using AK::decode_base64;
using AK::decode_base64url;
using AK::encode_base64;
using AK::encode_base64url;
#endif
AK: Add a simple and inefficient Base64 decoder 2020-04-26 23:49:19 +03:00			`/*`
			`* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>`
			`*`
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt * 2021-04-22 11:24:48 +03:00			`* SPDX-License-Identifier: BSD-2-Clause`
AK: Add a simple and inefficient Base64 decoder 2020-04-26 23:49:19 +03:00			`*/`

Meta: Add a script check the presence of "#pragma once" in header files .. and make travis run it. I renamed check-license-headers.sh to check-style.sh and expanded it so that it now also checks for the presence of "#pragma once" in .h files. It also checks the presence of a (single) blank line above and below the "#pragma once" line. I also added "#pragma once" to all the files that need it: even the ones we are not check. I also added/removed blank lines in order to make the script not fail. I also ran clang-format on the files I modified. 2020-05-28 21:40:53 +03:00			`#pragma once`

Base64: Pre-allocate size of input and output Problem: - Output of decode and encode grow as the decode and encode happen. This is inefficient because a large size will require many reallocations. - `const` qualifiers are missing on variables which are not intended to change. Solution: - Since the size of the decoded or encoded message is known prior to starting, calculate the size and set the output to that size immediately. All appends will not incur the reallocation overhead. - Add `const` qualifiers to show intent. 2020-10-13 17:48:48 +03:00			`#include <AK/ByteBuffer.h>`
AK+Userland: Make AK::decode_hex() return ErrorOr This lets us propagate the reason why it failed up to the caller. :^) 2022-01-20 20:01:39 +03:00			`#include <AK/Error.h>`
AK: Stop using `DeprecatedString` in Base64 encoding 2022-12-19 02:23:47 +03:00			`#include <AK/String.h>`
Base64: Pre-allocate size of input and output Problem: - Output of decode and encode grow as the decode and encode happen. This is inefficient because a large size will require many reallocations. - `const` qualifiers are missing on variables which are not intended to change. Solution: - Since the size of the decoded or encoded message is known prior to starting, calculate the size and set the output to that size immediately. All appends will not incur the reallocation overhead. - Add `const` qualifiers to show intent. 2020-10-13 17:48:48 +03:00			`#include <AK/StringView.h>`
AK: Add a simple and inefficient Base64 decoder 2020-04-26 23:49:19 +03:00
			`namespace AK {`

AK: Add a public helper to count the decoded length of a Base64 string 2024-09-01 18:49:23 +03:00			`size_t size_required_to_decode_base64(StringView);`

AK+LibWeb: Replace our home-grown base64 encoder/decoders with simdutf We currently have 2 base64 coders: one in AK, another in LibWeb for a "forgiving" implementation. ECMA-262 has an upcoming proposal which will require a third implementation. Instead, let's use the base64 implementation that is used by Node.js and recommended by the upcoming proposal. It handles forgiving decoding as well. Our users of AK's implementation should be fine with the forgiving implementation. The AK impl originally had naive forgiving behavior, but that was removed solely for performance reasons. Using http://mattmahoney.net/dc/enwik8.zip (100MB unzipped) as a test, performance of our old home-grown implementations vs. the simdutf implementation (on Linux x64): Encode Decode AK base64 0.226s 0.169s LibWeb base64 N/A 1.244s simdutf 0.161s 0.047s 2024-07-15 22:25:08 +03:00			`ErrorOr<ByteBuffer> decode_base64(StringView);`
			`ErrorOr<ByteBuffer> decode_base64url(StringView);`
AK: Expose Base64 tables from Base64.h This change is necessary to move the forgiving base64 decoder to LibWeb 2023-01-10 11:34:29 +03:00
AK: Add an option to the base64 encoder to omit padding Will be used by an upcoming JS prototype 2024-07-15 23:12:21 +03:00			`enum class OmitPadding {`
			`No,`
			`Yes,`
			`};`

			`ErrorOr<String> encode_base64(ReadonlyBytes, OmitPadding = OmitPadding::No);`
			`ErrorOr<String> encode_base64url(ReadonlyBytes, OmitPadding = OmitPadding::No);`
AK: Add base64url encoding and decoding methods This encoding scheme comes from section 5 of RFC 4648, as an alternative to the standard base64 encode/decode methods. The only difference is that the last two characters are replaced with '-' and '_', as '+' and '/' are not safe in URLs or filenames. 2024-03-20 15:21:59 +03:00
AK: Add a simple and inefficient Base64 decoder 2020-04-26 23:49:19 +03:00			`}`

AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types. 2022-11-26 14:18:30 +03:00			`#if USING_AK_GLOBALLY`
AK: Add a simple and inefficient Base64 decoder 2020-04-26 23:49:19 +03:00			`using AK::decode_base64;`
AK: Add base64url encoding and decoding methods This encoding scheme comes from section 5 of RFC 4648, as an alternative to the standard base64 encode/decode methods. The only difference is that the last two characters are replaced with '-' and '_', as '+' and '/' are not safe in URLs or filenames. 2024-03-20 15:21:59 +03:00			`using AK::decode_base64url;`
AK: Add a simple and inefficient Base64 encoder The test cases are taken from RFC 4648. 2020-06-13 05:09:31 +03:00			`using AK::encode_base64;`
AK: Add base64url encoding and decoding methods This encoding scheme comes from section 5 of RFC 4648, as an alternative to the standard base64 encode/decode methods. The only difference is that the last two characters are replaced with '-' and '_', as '+' and '/' are not safe in URLs or filenames. 2024-03-20 15:21:59 +03:00			`using AK::encode_base64url;`
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types. 2022-11-26 14:18:30 +03:00			`#endif`