Skip to content

Commit 5024e64

Browse files
committed
Add user guide entry for Blake3
1 parent de35b0b commit 5024e64

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

src/site/xdoc/userguide.xml

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,26 @@
100100
tasks and provides GNU libc crypt(3) compatible password hashing functions.
101101
</td>
102102
</tr>
103+
<tr>
104+
<td width="150">
105+
<a href="apidocs/org/apache/commons/codec/digest/Blake3.html">Blake3</a>
106+
</td>
107+
<td>
108+
Provides a pure Java implementation of the
109+
<a href="https://github.com/BLAKE3-team/BLAKE3">Blake3 hash function</a> which can be used for computing
110+
<a href="https://en.wikipedia.org/wiki/Cryptographic_hash_function">cryptographic hashes</a>
111+
(message digests) which are extensible to arbitrary output lengths (known as an <i>extensible-output
112+
function</i> or <i>XOF</i>), computing
113+
<a href="https://en.wikipedia.org/wiki/Message_authentication_code">message authentication codes</a>
114+
using a 32 byte (256-bit) secret key, computing subkeys from a primary key using a
115+
<a href="https://en.wikipedia.org/wiki/Key_derivation_function">key derivation function</a>, and can be
116+
used as the basis for a
117+
<a href="https://en.wikipedia.org/wiki/Cryptographically-secure_pseudorandom_number_generator">
118+
cryptographically-secure pseudorandom number generator</a>. <strong>WARNING:</strong> Blake3 is
119+
<em>not</em> a password hashing algorithm! An algorithm such as
120+
<a href="https://github.com/P-H-C/phc-winner-argon2">Argon2</a> is more appropriate for password hashing.
121+
</td>
122+
</tr>
103123
</table>
104124
</subsection>
105125
<subsection name="Language Encoders">
@@ -224,4 +244,4 @@
224244
</section>
225245
<!-- ================================================== -->
226246
</body>
227-
</document>
247+
</document>

0 commit comments

Comments
 (0)