1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sodium-base642bin" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>sodium_base642bin</refname>
<refpurpose>Decodes a base64-encoded string into raw binary.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sodium_base642bin</methodname>
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>id</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>ignore</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Converts a base64 encoded string into raw binary. Unlike <function>base64_decode</function>,
<function>sodium_base642bin</function> 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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
<type>string</type>; Encoded string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
<simplelist>
<member>
<constant>SODIUM_BASE64_VARIANT_ORIGINAL</constant> for standard (<literal>A-Za-z0-9/\+</literal>)
Base64 encoding.
</member>
<member>
<constant>SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING</constant> for standard (<literal>A-Za-z0-9/\+</literal>)
Base64 encoding, without <literal>=</literal> padding characters.
</member>
<member>
<constant>SODIUM_BASE64_VARIANT_URLSAFE</constant> for URL-safe (<literal>A-Za-z0-9\-_</literal>) Base64 encoding.
</member>
<member>
<constant>SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING</constant> for URL-safe (<literal>A-Za-z0-9\-_</literal>)
Base64 encoding, without <literal>=</literal> padding characters.
</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ignore</parameter></term>
<listitem>
<para>
Characters to ignore when decoding (e.g. whitespace characters).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Decoded string.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
