php8.5
/
Download
Home/ Manual/ sodium / functions/ sodium_base642bin

sodium_base642bin

PHP function Edit on GitHub ✎

(PHP 7 >= 7.2.0, PHP 8)

Decodes a base64-encoded string into raw binary.

Description

sodium_base642bin(string $string, int $id, string $ignore = ""): string

Converts a base64 encoded string into raw binary. Unlike base64_decode(), sodium_base642bin() is constant-time (a property that is important for any code that touches cryptographic inputs, such as plaintexts or keys) and supports multiple character sets.

Parameters

string

string; Encoded string.

id
  • SODIUM_BASE64_VARIANT_ORIGINAL for standard (A-Za-z0-9/\+) Base64 encoding.
  • SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING for standard (A-Za-z0-9/\+) Base64 encoding, without = padding characters.
  • SODIUM_BASE64_VARIANT_URLSAFE for URL-safe (A-Za-z0-9\-_) Base64 encoding.
  • SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING for URL-safe (A-Za-z0-9\-_) Base64 encoding, without = padding characters.
ignore

Characters to ignore when decoding (e.g. whitespace characters).

Return Values

Decoded string.

Source: reference/sodium/functions/sodium-base642bin.xml · from the official PHP manual (php/doc-en)