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 Vector{UInt8}:
 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および、要素の型がUInt8である配列風オブジェクト(NTupleおよびVector)を受け取ります。

SHA-1

SHA.sha1 — Function
sha1(data)

sha1アルゴリズムを使ってデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA1_CTXも参照してください。

source
sha1(io::IO)

sha1アルゴリズムを使用して、ioからデータをハッシュ化します。

source

SHA-2

SHA.sha224 — Function
sha224(data)

sha224アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。詳細はSHA.SHA2_224_CTXも参照してください。

source
sha224(io::IO)

io からデータを読み込み、sha224 アルゴリズムでハッシュ化します。

source
SHA.sha256 — Function
sha256(data)

sha256アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_256_CTXも参照してください。

source
sha256(io::IO)

sha256アルゴリズムを使用して、ioからデータのハッシュ値を計算します。

source
SHA.sha384 — Function
sha384(data)

sha384アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_384_CTXも参照してください。

source
sha384(io::IO)

io のデータを sha384 アルゴリズムでハッシュ化します。

source
SHA.sha512 — Function
sha512(data)

sha512アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_512_CTXも参照してください。

source
sha512(io::IO)

sha512アルゴリズムを使用して、ioからデータのハッシュを計算します。

source
SHA.sha2_224 — Function
sha2_224(data)

sha2_224アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_224_CTXも参照してください。

source
sha2_224(io::IO)

sha2_224アルゴリズムを使用して、ioからデータのハッシュを計算します。

source
SHA.sha2_256 — Function
sha2_256(data)

sha2_256アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_256_CTXも参照してください。

source
sha2_256(io::IO)

io からデータを読み込み、sha2_256 アルゴリズムでハッシュ化します。

source
SHA.sha2_384 — Function
sha2_384(data)

sha2_384アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_384_CTXも参照してください。

source
sha2_384(io::IO)

sha2_384アルゴリズムを使用して、ioからデータのハッシュを計算します。

source
SHA.sha2_512 — Function
sha2_512(data)

sha2_512アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_512_CTXも参照してください。

source
sha2_512(io::IO)

io からデータを読み込み、sha2_512 アルゴリズムでハッシュ化します。

source
SHA.sha2_512_224 — Function
sha2_512_224(data)

sha2_512_224アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_512_224_CTXも参照してください。

source
sha2_512_224(io::IO)

sha2_512_224アルゴリズムを使用して、ioからデータのハッシュを計算します。

source
SHA.sha2_512_256 — Function
sha2_512_256(data)

sha2_512_256アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA2_512_256_CTXも参照してください。

source
sha2_512_256(io::IO)

sha2_512_256アルゴリズムを使用して、ioからデータのハッシュを計算します。

source

SHA-3

SHA.sha3_224 — Function
sha3_224(data)

sha3_224アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。詳細については、SHA.SHA3_224_CTXも参照してください。

source
sha3_224(io::IO)

sha3_224アルゴリズムを使用して、ioからデータをハッシュ化します。

source
SHA.sha3_256 — Function
sha3_256(data)

sha3_256アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA3_256_CTXも参照してください。

source
sha3_256(io::IO)

sha3_256アルゴリズムを使用して、ioからデータのハッシュを計算します。

source
SHA.sha3_384 — Function
sha3_384(data)

sha3_384アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。SHA.SHA3_384_CTXも参照してください。

source
sha3_384(io::IO)

sha3_384アルゴリズムを使用して、ioからデータをハッシュ化します。

source
SHA.sha3_512 — Function
sha3_512(data)

sha3_512アルゴリズムを使用してデータをハッシュ化し、生成されたダイジェストを返します。詳細はSHA.SHA3_512_CTXも参照してください。

source
sha3_512(io::IO)

sha3_512アルゴリズムを使用して、ioからデータをハッシュ化します。

source

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よりおよそ1桁遅くなります。

SHA.update! — Function
update!(context, data[, datalen])

data 内のバイト列で SHA コンテキストを更新します。ハッシュの確定については、digest! も参照してください。

Examples

julia> ctx = SHA1_CTX()
SHA1 hash state

julia> update!(ctx, b"data to to be hashed")
source
SHA.digest! — Function
digest!(context)

SHAコンテキストを確定し、ハッシュをバイト配列(Vector{Uint8})として返します。コンテキストに対してdigest!を呼び出した後に更新しようとすると、エラーになります。

Examples

julia> ctx = SHA1_CTX()
SHA1 hash state

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

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

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

All SHA context types

SHA-1

SHA-2

便利な型も用意されています。SHAXXX_CTXは、SHA2_XXX_CTXの型エイリアスです。

SHA-3

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 コンテキストを構築します。

source

SHA-1

SHA.hmac_sha1 — Function
hmac_sha1(key, data)

渡されたキーを使用して、sha1アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha1(key, io::IO)

渡されたキーを使い、sha1アルゴリズムでioのデータをハッシュ化します。

source

SHA-2

SHA.hmac_sha224 — Function
hmac_sha224(key, data)

渡されたキーを使って、sha224アルゴリズムでデータをハッシュ化します。詳しくはHMAC_CTXも参照してください。

source
hmac_sha224(key, io::IO)

渡されたキーを使用して、sha224アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha256 — Function
hmac_sha256(key, data)

渡されたキーを使用して、sha256アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha256(key, io::IO)

渡されたキーを使用して、sha256アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha384 — Function
hmac_sha384(key, data)

渡されたキーを使用して、sha384アルゴリズムでデータをハッシュ化します。詳しくはHMAC_CTXも参照してください。

source
hmac_sha384(key, io::IO)

渡されたキーを使用して、io のデータを sha384 アルゴリズムでハッシュ化します。

source
SHA.hmac_sha512 — Function
hmac_sha512(key, data)

渡されたキーを使って、sha512アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha512(key, io::IO)

渡されたキーを使用して、sha512アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha2_224 — Function
hmac_sha2_224(key, data)

渡されたキーを使って、sha2_224アルゴリズムでデータをハッシュ化します。詳細はHMAC_CTXも参照してください。

source
hmac_sha2_224(key, io::IO)

渡されたキーを使って、io のデータを sha2_224 アルゴリズムでハッシュ化します。

source
SHA.hmac_sha2_256 — Function
hmac_sha2_256(key, data)

渡されたキーを使用して、sha2_256アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha2_256(key, io::IO)

渡されたキーを使って、sha2_256アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha2_384 — Function
hmac_sha2_384(key, data)

渡されたキーを使って、sha2_384アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha2_384(key, io::IO)

渡されたキーを使用して、sha2_384アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha2_512 — Function
hmac_sha2_512(key, data)

渡されたキーを使用して、sha2_512アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha2_512(key, io::IO)

渡されたキーを使用して、sha2_512アルゴリズムでioのデータをハッシュ化します。

source

SHA-3

SHA.hmac_sha3_224 — Function
hmac_sha3_224(key, data)

渡されたキーを使用して、sha3_224アルゴリズムでデータをハッシュ化します。詳細はHMAC_CTXも参照してください。

source
hmac_sha3_224(key, io::IO)

渡されたキーを使用して、sha3_224アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha3_256 — Function
hmac_sha3_256(key, data)

渡されたキーを使用して、sha3_256アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha3_256(key, io::IO)

渡されたキーを使用して、sha3_256アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha3_384 — Function
hmac_sha3_384(key, data)

渡されたキーを使用して、sha3_384アルゴリズムでデータをハッシュ化します。HMAC_CTXも参照してください。

source
hmac_sha3_384(key, io::IO)

渡されたキーを使用して、sha3_384アルゴリズムでioのデータをハッシュ化します。

source
SHA.hmac_sha3_512 — Function
hmac_sha3_512(key, data)

渡されたキーを使用して、sha3_512アルゴリズムでデータをハッシュ化します。詳しくはHMAC_CTXも参照してください。

source
hmac_sha3_512(key, io::IO)

渡されたキーを使用して、sha3_512アルゴリズムでioのデータをハッシュ化します。

source