SHA

SHA functions

Использование очень простое:

julia> using SHA

julia> bytes2hex(sha256("test"))
"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"

Каждая экспортированная функция (на момент написания этой статьи реализованы функции SHA-1, SHA-2 224, 256, 384 и 512, а также SHA-3 224, 256, 384 и 512) принимает либо AbstractVector{UInt8}, либо AbstractString, либо объект IO. Это делает проверку контрольной суммы файла тривиальной:

shell> cat /tmp/test.txt
test
julia> using SHA

julia> open("/tmp/test.txt") do f
           sha2_256(f)
       end
32-element Array{UInt8,1}:
 0x9f
 0x86
 0xd0
 0x81
 0x88
 0x4c
 0x7d
 0x65
    ⋮
 0x5d
 0x6c
 0x15
 0xb0
 0xf0
 0x0a
 0x08

All SHA functions

Из-за разговорного использования sha256 для обозначения sha2_256 предоставляются функции удобства, сопоставляющие вызовы функции shaxxx() с sha2_xxx(). Для SHA-3 таких разговорных терминов не существует, и пользователю необходимо использовать полные имена sha3_xxx().

shaxxx() принимает AbstractString и объекты, похожие на массивы (NTuple и Array), с элементами типа UInt8.

SHA-1

SHA.sha1 — Function

sha1(data)

Хэшируйте данные с использованием алгоритма sha1 и верните полученный дайджест. См. также SHA.SHA1_CTX.

sha1(io::IO)

Хешируйте данные из io, используя алгоритм sha1.

SHA-2

SHA.sha224 — Function

sha224(data)

Хешируйте данные с использованием алгоритма sha224 и верните полученный дайджест. См. также SHA.SHA2_224_CTX.

sha224(io::IO)

Хешируйте данные из io, используя алгоритм sha224.

SHA.sha256 — Function

sha256(data)

Хешируйте данные с использованием алгоритма sha256 и верните полученный дайджест. См. также SHA.SHA2_256_CTX.

sha256(io::IO)

Хешируйте данные из io, используя алгоритм sha256.

SHA.sha384 — Function

sha384(data)

Хешируйте данные с использованием алгоритма sha384 и верните полученный дайджест. См. также SHA.SHA2_384_CTX.

sha384(io::IO)

Хешируйте данные из io, используя алгоритм sha384.

SHA.sha512 — Function

sha512(data)

Хешируйте данные с использованием алгоритма sha512 и верните полученный дайджест. См. также SHA.SHA2_512_CTX.

sha512(io::IO)

Хешируйте данные из io, используя алгоритм sha512.

SHA.sha2_224 — Function

sha2_224(data)

Хешируйте данные с использованием алгоритма sha2_224 и верните полученный дайджест. См. также SHA.SHA2_224_CTX.

sha2_224(io::IO)

Хешируйте данные из io, используя алгоритм sha2_224.

SHA.sha2_256 — Function

sha2_256(data)

Хешируйте данные с использованием алгоритма sha2_256 и верните полученный дайджест. См. также SHA.SHA2_256_CTX.

sha2_256(io::IO)

Хешируйте данные из io, используя алгоритм sha2_256.

SHA.sha2_384 — Function

sha2_384(data)

Хешируйте данные с использованием алгоритма sha2_384 и верните полученный дайджест. См. также SHA.SHA2_384_CTX.

sha2_384(io::IO)

Хешируйте данные из io, используя алгоритм sha2_384.

SHA.sha2_512 — Function

sha2_512(data)

Хешируйте данные с использованием алгоритма sha2_512 и верните полученный дайджест. См. также SHA.SHA2_512_CTX.

sha2_512(io::IO)

Хешируйте данные из io, используя алгоритм sha2_512.

SHA-3

SHA.sha3_224 — Function

sha3_224(data)

Хешируйте данные с использованием алгоритма sha3_224 и верните полученный дайджест. См. также SHA.SHA3_224_CTX.

sha3_224(io::IO)

Хешируйте данные из io, используя алгоритм sha3_224.

SHA.sha3_256 — Function

sha3_256(data)

Хешируйте данные с использованием алгоритма sha3_256 и верните полученный дайджест. См. также SHA.SHA3_256_CTX.

sha3_256(io::IO)

Хешируйте данные из io, используя алгоритм sha3_256.

SHA.sha3_384 — Function

sha3_384(data)

Хешируйте данные с использованием алгоритма sha3_384 и верните полученный дайджест. См. также SHA.SHA3_384_CTX.

sha3_384(io::IO)

Хешируйте данные из io, используя алгоритм sha3_384.

SHA.sha3_512 — Function

sha3_512(data)

Хешируйте данные с использованием алгоритма sha3_512 и верните полученный дайджест. См. также SHA.SHA3_512_CTX.

sha3_512(io::IO)

Хешируйте данные из io, используя алгоритм sha3_512.

Working with context

Чтобы создать хеш из нескольких элементов, можно использовать типы SHAX_XXX_CTX(), чтобы создать объект хеша с состоянием, который обновляется с помощью update! и завершается с помощью digest!

julia> using SHA

julia> ctx = SHA2_256_CTX()
SHA2 256-bit hash state

julia> update!(ctx, b"some data")
0x0000000000000009

julia> update!(ctx, b"some more data")
0x0000000000000017

julia> digest!(ctx)
32-element Vector{UInt8}:
 0xbe
 0xcf
 0x23
 0xda
 0xaf
 0x02
 0xf7
 0xa3
 0x57
 0x92
    ⋮
 0x89
 0x4f
 0x59
 0xd8
 0xb3
 0xb4
 0x81
 0x8b
 0xc5

Обратите внимание, что на момент написания этого текста код SHA3 не оптимизирован, и, как таковой, он примерно в десять раз медленнее, чем SHA2.

SHA.update! — Function

update!(context, data[, datalen])

Обновите контекст SHA с байтами в data. См. также digest! для завершения хеширования.

Примеры

julia> ctx = SHA1_CTX()
SHA1 hash state

julia> update!(ctx, b"data to to be hashed")

SHA.digest! — Function

digest!(context)

Завершите контекст SHA и верните хэш в виде массива байтов (Array{Uint8, 1}). Обновление контекста после вызова digest! приведет к ошибке.

Примеры

julia> ctx = SHA1_CTX()
SHA1 hash state

julia> update!(ctx, b"data to to be hashed")

julia> digest!(ctx)
20-element Array{UInt8,1}:
 0x83
 0xe4
 ⋮
 0x89
 0xf5

julia> update!(ctx, b"more data")
ERROR: Cannot update CTX after `digest!` has been called on it
[...]

All SHA context types

SHA-1

SHA.SHA1_CTX — Type

SHA1_CTX()

Создайте пустой контекст SHA1.

SHA-2

Типы удобства также предоставлены, где SHAXXX_CTX является псевдонимом типа для SHA2_XXX_CTX.

SHA.SHA224_CTX — Type

SHA2_224_CTX()

Создайте пустой контекст SHA2_224.

SHA.SHA256_CTX — Type

SHA2_256_CTX()

Создайте пустой контекст SHA2_256.

SHA.SHA384_CTX — Type

SHA2_384()

Создайте пустой контекст SHA2_384.

SHA.SHA512_CTX — Type

SHA2_512_CTX()

Создайте пустой контекст SHA2_512.

SHA.SHA2_224_CTX — Type

SHA2_224_CTX()

Создайте пустой контекст SHA2_224.

SHA.SHA2_256_CTX — Type

SHA2_256_CTX()

Создайте пустой контекст SHA2_256.

SHA.SHA2_384_CTX — Type

SHA2_384()

Создайте пустой контекст SHA2_384.

SHA.SHA2_512_CTX — Type

SHA2_512_CTX()

Создайте пустой контекст SHA2_512.

SHA-3

SHA.SHA3_224_CTX — Type

SHA3_224_CTX()

Создайте пустой контекст SHA3_224.

SHA.SHA3_256_CTX — Type

SHA3_256_CTX()

Создайте пустой контекст SHA3_256.

SHA.SHA3_384_CTX — Type

SHA3_384_CTX()

Создайте пустой контекст SHA3_384.

SHA.SHA3_512_CTX — Type

SHA3_512_CTX()

Создайте пустой контекст SHA3_512.

HMAC functions

julia> using SHA

julia> key = collect(codeunits("key_string"))
10-element Vector{UInt8}:
 0x6b
 0x65
 0x79
 0x5f
 0x73
 0x74
 0x72
 0x69
 0x6e
 0x67

julia> bytes2hex(hmac_sha3_256(key, "test-message"))
"bc49a6f2aa29b27ee5ed1e944edd7f3d153e8a01535d98b5e24dac9a589a6248"

Чтобы создать хеш из нескольких элементов, можно использовать типы HMAC_CTX(), чтобы создать объект хеша с состоянием, который обновляется с помощью update! и завершается с помощью digest!.

julia> using SHA

julia> key = collect(codeunits("key_string"))
10-element Vector{UInt8}:
 0x6b
 0x65
 0x79
 0x5f
 0x73
 0x74
 0x72
 0x69
 0x6e
 0x67

julia> ctx = HMAC_CTX(SHA3_256_CTX(), key);

julia> update!(ctx, b"test-")
0x0000000000000000000000000000008d

julia> update!(ctx, b"message")
0x00000000000000000000000000000094

julia> bytes2hex(digest!(ctx))
"bc49a6f2aa29b27ee5ed1e944edd7f3d153e8a01535d98b5e24dac9a589a6248"

All HMAC functions

Тип контекста HMAC

SHA.HMAC_CTX — Type

HMAC_CTX(ctx::CTX, key::Vector{UInt8}) where {CTX<:SHA_CTX}

Создайте пустой контекст HMAC_CTX.

SHA-1

SHA.hmac_sha1 — Function

hmac_sha1(key, data)

Хешируйте данные, используя алгоритм sha1 с переданным ключом. См. также HMAC_CTX.

hmac_sha1(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha1.

SHA-2

SHA.hmac_sha224 — Function

hmac_sha224(key, data)

Хешируйте данные, используя алгоритм sha224 с переданным ключом. См. также HMAC_CTX.

hmac_sha224(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha224.

SHA.hmac_sha256 — Function

hmac_sha256(key, data)

Хешируйте данные, используя алгоритм sha256 с переданным ключом. См. также HMAC_CTX.

hmac_sha256(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha256.

SHA.hmac_sha384 — Function

hmac_sha384(key, data)

Хешируйте данные, используя алгоритм sha384 с переданным ключом. См. также HMAC_CTX.

hmac_sha384(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha384.

SHA.hmac_sha512 — Function

hmac_sha512(key, data)

Хешируйте данные, используя алгоритм sha512 с переданным ключом. См. также HMAC_CTX.

hmac_sha512(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha512.

SHA.hmac_sha2_224 — Function

hmac_sha2_224(key, data)

Хешируйте данные, используя алгоритм sha2_224 с переданным ключом. См. также HMAC_CTX.

hmac_sha2_224(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha2_224.

SHA.hmac_sha2_256 — Function

hmac_sha2_256(key, data)

Хешируйте данные, используя алгоритм sha2_256 с переданным ключом. См. также HMAC_CTX.

hmac_sha2_256(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha2_256.

SHA.hmac_sha2_384 — Function

hmac_sha2_384(key, data)

Хешируйте данные, используя алгоритм sha2_384 с переданным ключом. См. также HMAC_CTX.

hmac_sha2_384(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha2_384.

SHA.hmac_sha2_512 — Function

hmac_sha2_512(key, data)

Хешируйте данные с использованием алгоритма sha2_512 с использованием переданного ключа. См. также HMAC_CTX.

hmac_sha2_512(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha2_512.

SHA-3

SHA.hmac_sha3_224 — Function

hmac_sha3_224(key, data)

Хешируйте данные, используя алгоритм sha3_224 с переданным ключом. См. также HMAC_CTX.

hmac_sha3_224(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha3_224.

SHA.hmac_sha3_256 — Function

hmac_sha3_256(key, data)

Хешируйте данные, используя алгоритм sha3_256 с переданным ключом. См. также HMAC_CTX.

hmac_sha3_256(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha3_256.

SHA.hmac_sha3_384 — Function

hmac_sha3_384(key, data)

Хешируйте данные, используя алгоритм sha3_384 с переданным ключом. См. также HMAC_CTX.

hmac_sha3_384(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha3_384.

SHA.hmac_sha3_512 — Function

hmac_sha3_512(key, data)

Хешируйте данные, используя алгоритм sha3_512 с переданным ключом. См. также HMAC_CTX.

hmac_sha3_512(key, io::IO)

Хешируйте данные из io с использованием переданного ключа и алгоритма sha3_512.