//
|
// CryptoSwift
|
//
|
// Copyright (C) 2014-2022 Marcin Krzyżanowski <marcin@krzyzanowskim.com>
|
// This software is provided 'as-is', without any express or implied warranty.
|
//
|
// In no event will the authors be held liable for any damages arising from the use of this software.
|
//
|
// Permission is granted to anyone to use this software for any purpose,including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
|
//
|
// - The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation is required.
|
// - Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
|
// - This notice may not be removed or altered from any source or binary distribution.
|
//
|
|
// http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf
|
// http://keccak.noekeon.org/specs_summary.html
|
//
|
|
#if canImport(Darwin)
|
import Darwin
|
#elseif canImport(Glibc)
|
import Glibc
|
#elseif canImport(ucrt)
|
import ucrt
|
#endif
|
|
public final class SHA3: DigestType {
|
let round_constants: Array<UInt64> = [
|
0x0000000000000001, 0x0000000000008082, 0x800000000000808a, 0x8000000080008000,
|
0x000000000000808b, 0x0000000080000001, 0x8000000080008081, 0x8000000000008009,
|
0x000000000000008a, 0x0000000000000088, 0x0000000080008009, 0x000000008000000a,
|
0x000000008000808b, 0x800000000000008b, 0x8000000000008089, 0x8000000000008003,
|
0x8000000000008002, 0x8000000000000080, 0x000000000000800a, 0x800000008000000a,
|
0x8000000080008081, 0x8000000000008080, 0x0000000080000001, 0x8000000080008008
|
]
|
|
public let blockSize: Int
|
public let digestLength: Int
|
public let markByte: UInt8
|
|
@usableFromInline
|
var accumulated = Array<UInt8>()
|
|
|
@usableFromInline
|
var accumulatedHash: Array<UInt64>
|
|
public enum Variant {
|
case sha224, sha256, sha384, sha512, keccak224, keccak256, keccak384, keccak512
|
|
var digestLength: Int {
|
100 - (self.blockSize / 2)
|
}
|
|
var blockSize: Int {
|
(1600 - self.outputLength * 2) / 8
|
}
|
|
var markByte: UInt8 {
|
switch self {
|
case .sha224, .sha256, .sha384, .sha512:
|
return 0x06 // 0x1F for SHAKE
|
case .keccak224, .keccak256, .keccak384, .keccak512:
|
return 0x01
|
}
|
}
|
|
public var outputLength: Int {
|
switch self {
|
case .sha224, .keccak224:
|
return 224
|
case .sha256, .keccak256:
|
return 256
|
case .sha384, .keccak384:
|
return 384
|
case .sha512, .keccak512:
|
return 512
|
}
|
}
|
}
|
|
public init(variant: SHA3.Variant) {
|
self.blockSize = variant.blockSize
|
self.digestLength = variant.digestLength
|
self.markByte = variant.markByte
|
self.accumulatedHash = Array<UInt64>(repeating: 0, count: self.digestLength)
|
}
|
|
@inlinable
|
public func calculate(for bytes: Array<UInt8>) -> Array<UInt8> {
|
do {
|
return try update(withBytes: bytes.slice, isLast: true)
|
} catch {
|
return []
|
}
|
}
|
|
public func callAsFunction(_ bytes: Array<UInt8>) -> Array<UInt8> {
|
calculate(for: bytes)
|
}
|
|
/// 1. For all pairs (x,z) such that 0≤x<5 and 0≤z<w, let
|
/// C[x,z]=A[x, 0,z] ⊕ A[x, 1,z] ⊕ A[x, 2,z] ⊕ A[x, 3,z] ⊕ A[x, 4,z].
|
/// 2. For all pairs (x, z) such that 0≤x<5 and 0≤z<w let
|
/// D[x,z]=C[(x1) mod 5, z] ⊕ C[(x+1) mod 5, (z –1) mod w].
|
/// 3. For all triples (x, y, z) such that 0≤x<5, 0≤y<5, and 0≤z<w, let
|
/// A′[x, y,z] = A[x, y,z] ⊕ D[x,z].
|
private func θ(_ a: inout Array<UInt64>) {
|
let c = UnsafeMutablePointer<UInt64>.allocate(capacity: 5)
|
c.initialize(repeating: 0, count: 5)
|
defer {
|
c.deinitialize(count: 5)
|
c.deallocate()
|
}
|
let d = UnsafeMutablePointer<UInt64>.allocate(capacity: 5)
|
d.initialize(repeating: 0, count: 5)
|
defer {
|
d.deinitialize(count: 5)
|
d.deallocate()
|
}
|
|
for i in 0..<5 {
|
c[i] = a[i] ^ a[i &+ 5] ^ a[i &+ 10] ^ a[i &+ 15] ^ a[i &+ 20]
|
}
|
|
d[0] = rotateLeft(c[1], by: 1) ^ c[4]
|
d[1] = rotateLeft(c[2], by: 1) ^ c[0]
|
d[2] = rotateLeft(c[3], by: 1) ^ c[1]
|
d[3] = rotateLeft(c[4], by: 1) ^ c[2]
|
d[4] = rotateLeft(c[0], by: 1) ^ c[3]
|
|
for i in 0..<5 {
|
a[i] ^= d[i]
|
a[i &+ 5] ^= d[i]
|
a[i &+ 10] ^= d[i]
|
a[i &+ 15] ^= d[i]
|
a[i &+ 20] ^= d[i]
|
}
|
}
|
|
/// A′[x, y, z]=A[(x &+ 3y) mod 5, x, z]
|
private func π(_ a: inout Array<UInt64>) {
|
let a1 = a[1]
|
a[1] = a[6]
|
a[6] = a[9]
|
a[9] = a[22]
|
a[22] = a[14]
|
a[14] = a[20]
|
a[20] = a[2]
|
a[2] = a[12]
|
a[12] = a[13]
|
a[13] = a[19]
|
a[19] = a[23]
|
a[23] = a[15]
|
a[15] = a[4]
|
a[4] = a[24]
|
a[24] = a[21]
|
a[21] = a[8]
|
a[8] = a[16]
|
a[16] = a[5]
|
a[5] = a[3]
|
a[3] = a[18]
|
a[18] = a[17]
|
a[17] = a[11]
|
a[11] = a[7]
|
a[7] = a[10]
|
a[10] = a1
|
}
|
|
/// For all triples (x, y, z) such that 0≤x<5, 0≤y<5, and 0≤z<w, let
|
/// A′[x, y,z] = A[x, y,z] ⊕ ((A[(x+1) mod 5, y, z] ⊕ 1) ⋅ A[(x+2) mod 5, y, z])
|
private func χ(_ a: inout Array<UInt64>) {
|
for i in stride(from: 0, to: 25, by: 5) {
|
let a0 = a[0 &+ i]
|
let a1 = a[1 &+ i]
|
a[0 &+ i] ^= ~a1 & a[2 &+ i]
|
a[1 &+ i] ^= ~a[2 &+ i] & a[3 &+ i]
|
a[2 &+ i] ^= ~a[3 &+ i] & a[4 &+ i]
|
a[3 &+ i] ^= ~a[4 &+ i] & a0
|
a[4 &+ i] ^= ~a0 & a1
|
}
|
}
|
|
private func ι(_ a: inout Array<UInt64>, round: Int) {
|
a[0] ^= self.round_constants[round]
|
}
|
|
@usableFromInline
|
func process(block chunk: ArraySlice<UInt64>, currentHash hh: inout Array<UInt64>) {
|
// expand
|
hh[0] ^= chunk[0].littleEndian
|
hh[1] ^= chunk[1].littleEndian
|
hh[2] ^= chunk[2].littleEndian
|
hh[3] ^= chunk[3].littleEndian
|
hh[4] ^= chunk[4].littleEndian
|
hh[5] ^= chunk[5].littleEndian
|
hh[6] ^= chunk[6].littleEndian
|
hh[7] ^= chunk[7].littleEndian
|
hh[8] ^= chunk[8].littleEndian
|
if self.blockSize > 72 { // 72 / 8, sha-512
|
hh[9] ^= chunk[9].littleEndian
|
hh[10] ^= chunk[10].littleEndian
|
hh[11] ^= chunk[11].littleEndian
|
hh[12] ^= chunk[12].littleEndian
|
if self.blockSize > 104 { // 104 / 8, sha-384
|
hh[13] ^= chunk[13].littleEndian
|
hh[14] ^= chunk[14].littleEndian
|
hh[15] ^= chunk[15].littleEndian
|
hh[16] ^= chunk[16].littleEndian
|
if self.blockSize > 136 { // 136 / 8, sha-256
|
hh[17] ^= chunk[17].littleEndian
|
// FULL_SHA3_FAMILY_SUPPORT
|
if self.blockSize > 144 { // 144 / 8, sha-224
|
hh[18] ^= chunk[18].littleEndian
|
hh[19] ^= chunk[19].littleEndian
|
hh[20] ^= chunk[20].littleEndian
|
hh[21] ^= chunk[21].littleEndian
|
hh[22] ^= chunk[22].littleEndian
|
hh[23] ^= chunk[23].littleEndian
|
hh[24] ^= chunk[24].littleEndian
|
}
|
}
|
}
|
}
|
|
// Keccak-f
|
for round in 0..<24 {
|
self.θ(&hh)
|
|
hh[1] = rotateLeft(hh[1], by: 1)
|
hh[2] = rotateLeft(hh[2], by: 62)
|
hh[3] = rotateLeft(hh[3], by: 28)
|
hh[4] = rotateLeft(hh[4], by: 27)
|
hh[5] = rotateLeft(hh[5], by: 36)
|
hh[6] = rotateLeft(hh[6], by: 44)
|
hh[7] = rotateLeft(hh[7], by: 6)
|
hh[8] = rotateLeft(hh[8], by: 55)
|
hh[9] = rotateLeft(hh[9], by: 20)
|
hh[10] = rotateLeft(hh[10], by: 3)
|
hh[11] = rotateLeft(hh[11], by: 10)
|
hh[12] = rotateLeft(hh[12], by: 43)
|
hh[13] = rotateLeft(hh[13], by: 25)
|
hh[14] = rotateLeft(hh[14], by: 39)
|
hh[15] = rotateLeft(hh[15], by: 41)
|
hh[16] = rotateLeft(hh[16], by: 45)
|
hh[17] = rotateLeft(hh[17], by: 15)
|
hh[18] = rotateLeft(hh[18], by: 21)
|
hh[19] = rotateLeft(hh[19], by: 8)
|
hh[20] = rotateLeft(hh[20], by: 18)
|
hh[21] = rotateLeft(hh[21], by: 2)
|
hh[22] = rotateLeft(hh[22], by: 61)
|
hh[23] = rotateLeft(hh[23], by: 56)
|
hh[24] = rotateLeft(hh[24], by: 14)
|
|
self.π(&hh)
|
self.χ(&hh)
|
self.ι(&hh, round: round)
|
}
|
}
|
}
|
|
extension SHA3: Updatable {
|
|
@inlinable
|
public func update(withBytes bytes: ArraySlice<UInt8>, isLast: Bool = false) throws -> Array<UInt8> {
|
self.accumulated += bytes
|
|
if isLast {
|
// Add padding
|
let markByteIndex = self.accumulated.count
|
|
// We need to always pad the input. Even if the input is a multiple of blockSize.
|
let r = self.blockSize * 8
|
let q = (r / 8) - (accumulated.count % (r / 8))
|
self.accumulated += Array<UInt8>(repeating: 0, count: q)
|
|
self.accumulated[markByteIndex] |= self.markByte
|
self.accumulated[self.accumulated.count - 1] |= 0x80
|
}
|
|
var processedBytes = 0
|
for chunk in self.accumulated.batched(by: self.blockSize) {
|
if isLast || (self.accumulated.count - processedBytes) >= self.blockSize {
|
self.process(block: chunk.toUInt64Array().slice, currentHash: &self.accumulatedHash)
|
processedBytes += chunk.count
|
}
|
}
|
self.accumulated.removeFirst(processedBytes)
|
|
// TODO: verify performance, reduce vs for..in
|
let result = self.accumulatedHash.reduce(into: Array<UInt8>()) { (result, value) in
|
result += value.bigEndian.bytes()
|
}
|
|
// reset hash value for instance
|
if isLast {
|
self.accumulatedHash = Array<UInt64>(repeating: 0, count: self.digestLength)
|
}
|
|
return Array(result[0..<self.digestLength])
|
}
|
}
|
