base/base64.h

   1 // Copyright 2011 The Chromium Authors
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_BASE64_H_
   6 #define BASE_BASE64_H_
   7
   8 #include <stdint.h>
   9
  10 #include <string>
  11 #include <vector>
  12
  13 #include "base/base_export.h"
  14 #include "base/containers/span.h"
  15 #include "base/strings/string_piece.h"
  16 #include "third_party/abseil-cpp/absl/types/optional.h"
  17
  18 namespace base {
  19
  20 // Encodes the input binary data in base64.
  21 BASE_EXPORT std::string Base64Encode(span<const uint8_t> input);
  22
  23 // Encodes the input binary data in base64 and appends it to the output.
  24 BASE_EXPORT void Base64EncodeAppend(span<const uint8_t> input,
  25                                     std::string* output);
  26
  27 // Encodes the input string in base64.
  28 // DEPRECATED, use `std::string Base64Encode(StringPiece input)` instead.
  29 // TODO(crbug.com/1486214): Remove this.
  30 BASE_EXPORT void Base64Encode(StringPiece input, std::string* output);
  31
  32 // Encodes the input string in base64.
  33 BASE_EXPORT std::string Base64Encode(StringPiece input);
  34
  35 // Decodes the base64 input string.  Returns true if successful and false
  36 // otherwise. The output string is only modified if successful. The decoding can
  37 // be done in-place.
  38 enum class Base64DecodePolicy {
  39   // Input should match the output format of Base64Encode. i.e.
  40   // - Input length should be divisible by 4
  41   // - Maximum of 2 padding characters
  42   // - No non-base64 characters.
  43   kStrict,
  44
  45   // Matches https://infra.spec.whatwg.org/#forgiving-base64-decode.
  46   // - Removes all ascii whitespace
  47   // - Maximum of 2 padding characters
  48   // - Allows input length not divisible by 4 if no padding chars are added.
  49   kForgiving,
  50 };
  51 BASE_EXPORT bool Base64Decode(
  52     StringPiece input,
  53     std::string* output,
  54     Base64DecodePolicy policy = Base64DecodePolicy::kStrict);
  55
  56 // Decodes the base64 input string. Returns `absl::nullopt` if unsuccessful.
  57 BASE_EXPORT absl::optional<std::vector<uint8_t>> Base64Decode(
  58     StringPiece input);
  59
  60 }  // namespace base
  61
  62 #endif  // BASE_BASE64_H_