Skip to content

Commit

Permalink
Use consistent casing for BLAKE2s
Browse files Browse the repository at this point in the history
  • Loading branch information
Dekkonot committed Oct 1, 2023
1 parent b1b9bb8 commit 7391cc0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion modules/blake2s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This module returns a single function with the following type signature:
blake2s(message: string, hashLen: number, key: string?): string
```

The `message` passed to this function will be hashed using `blake2s`. The returned hash will be `hashLen` bytes in length.
The `message` passed to this function will be hashed using BLAKE2s. The returned hash will be `hashLen` bytes in length.
If provided, `key` will be used as a [pepper][Pepper] for the algorithm.

[Pepper]: https://en.wikipedia.org/wiki/Pepper_(cryptography)
4 changes: 2 additions & 2 deletions modules/blake2s/init.luau
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ local function byteswap(n: number): number
end

--[=[
The BLAKE2S compression function.
The BLAKE2s compression function.
@param h The internal digest for the algorithm
@param m A block of bytes utilized for rounds
Expand Down Expand Up @@ -150,7 +150,7 @@ local function F(h: { number }, m: { number }, t: number, f: boolean)
end

--[=[
Calculates the BLAKE2S hash of `message` and emits it as a hash of `outSize`
Calculates the BLAKE2s hash of `message` and emits it as a hash of `outSize`
bytes. If provided, `key` is used as a [pepper][Pepper] for the hash.
@param message The string to perform the hashing algorithm on
Expand Down

0 comments on commit 7391cc0

Please sign in to comment.