Prepare 0.2.4 release

CHANGELOG.md

@@ -1,10 +1,32 @@
 # CHANGELOG
 
+## Version 0.2.4 (2023-04-16)
+ - Updates `kotlincrypto.core` to `0.2.4`
+ - Implements `SHA3` derived functions [[#38]][38]
+     - Adds `ParallelHash128`
+     - Adds `ParallelHash256`
+     - Adds `TupleHash128`
+     - Adds `TupleHash256`
+ - Adds `outputLength` constructor arguments for `SHA3` `XOF` 
+   `Digest` implementations [[#39]][39]
+
 ## Version 0.2.3 (2023-04-08)
  - Updates `kotlincrypto.core` to `0.2.3` [[#31]][31]
 
 ## Version 0.2.2 (2023-04-07)
- - Adds `SHA3` [[#29]][29]
+ - Implements `SHA3` [[#29]][29]
+     - Adds `Keccak-224`
+     - Adds `Keccak-256`
+     - Adds `Keccak-384`
+     - Adds `Keccak-512`
+     - Adds `SHA3-224`
+     - Adds `SHA3-256`
+     - Adds `SHA3-384`
+     - Adds `SHA3-512`
+     - Adds `SHAKE128`
+     - Adds `SHAKE256`
+     - Adds `CSHAKE128`
+     - Adds `CSHAKE256`
  - Updates `kotlincrypto.core` to `0.2.2`
 
 ## Version 0.2.1 (2023-03-28)
@@ -14,9 +36,9 @@
      - See [[core #21]][core-21] for more info
 
 ## Version 0.2.0 (2023-03-12)
- - Adds `SHA-224` algorithm
- - Adds `SHA-384` algorithm
- - Adds `SHA-512/t` algorithm
+ - Adds `SHA-224`
+ - Adds `SHA-384`
+ - Adds `SHA-512/t`
  - Combines all `SHA2` algorithms into single `sha2` module
  - Renames `Md5` -> `MD5`
  - Renames `Sha1` -> `SHA1`
@@ -39,3 +61,5 @@
 [core-21]: https://github.com/KotlinCrypto/core/pull/21
 [29]: https://github.com/KotlinCrypto/hash/pull/29
 [31]: https://github.com/KotlinCrypto/hash/pull/31
+[38]: https://github.com/KotlinCrypto/hash/pull/38
+[39]: https://github.com/KotlinCrypto/hash/pull/39

README.md

@@ -70,10 +70,16 @@ fun main() {
     SHA3_512()
 
     SHAKE128()
-    SHAKE256()
+    SHAKE256(outputLength = 640) // returns 640 bytes instead of the default when digest() is invoked
+
+    // NIST.SP.800-185 derived functions
     val S = "My Customization".encodeToByteArray()
-    CSHAKE128(null, S)
+    CSHAKE128(null, S, outputLength = 128)
     CSHAKE256(null, S)
+    ParallelHash128(null, B = 123)
+    ParallelHash256(S, B = 456, outputLength = 123)
+    TupleHash128(S, outputLength = 320)
+    TupleHash256(null)
 }
 ```
 
@@ -85,10 +91,15 @@ See [HERE][url-core-usage] for details on what `XOFs` are, and a basic usage exa
 fun main() {
     SHAKE128.xOf()
     SHAKE256.xOf()
-
+
+    // NIST.SP.800-185 derived functions
     val S = "My Customization".encodeToByteArray()
     CSHAKE128.xOf(null, S)
     CSHAKE256.xOf(null, S)
+    ParallelHash128.xOf(S, B = 123)
+    ParallelHash256.xOf(B = 654)
+    TupleHash128.xOf(S)
+    TupleHash256.xOf()
 }
 ```
 
@@ -104,7 +115,7 @@ shown below.
 // build.gradle.kts
 dependencies {
     // define the BOM and its version
-    implementation(platform("org.kotlincrypto.hash:bom:0.2.3"))
+    implementation(platform("org.kotlincrypto.hash:bom:0.2.4"))
 
     // define artifacts without version
 
@@ -114,24 +125,26 @@ dependencies {
     // SHA-1
     implementation("org.kotlincrypto.hash:sha1")
 
-    // SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256
+    // SHA-224, SHA-256, SHA-384, SHA-512, , SHA-512/t, SHA-512/224, SHA-512/256
     implementation("org.kotlincrypto.hash:sha2")
 
     // Keccak-224, Keccak-256, Keccak-384, Keccak-512
     // SHA3-224, SHA3-256, SHA3-384, SHA3-512
     // SHAKE128, SHAKE256
     // CSHAKE128, CSHAKE256
+    // ParallelHash128, ParallelHash256
+    // TupleHash128, TupleHash256
     implementation("org.kotlincrypto.hash:sha3")
 }
 ```
 
 <!-- TAG_VERSION -->
-[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.3-blue.svg?style=flat
+[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.4-blue.svg?style=flat
 [badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat
 
 <!-- TAG_DEPENDENCIES -->
 [badge-kotlin]: https://img.shields.io/badge/kotlin-1.8.10-blue.svg?logo=kotlin
-[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.2.3-blue.svg
+[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.2.4-blue.svg
 [badge-endians]: https://img.shields.io/badge/kotlincrypto.endians-0.1.0-blue.svg
 [badge-sponges]: https://img.shields.io/badge/kotlincrypto.sponges-0.1.0-blue.svg
 

gradle.properties

@@ -29,7 +29,7 @@ POM_DEVELOPER_ID=KotlinCrypto
 POM_DEVELOPER_NAME=Kotlin Crypto
 POM_DEVELOPER_URL=https://github.com/KotlinCrypto/
 
-VERSION_NAME=0.2.4-SNAPSHOT
+VERSION_NAME=0.2.4
 # 0.1.0-alpha01 = 00 01 00 11
 # 0.1.0-beta01  = 00 01 00 21
 # 0.1.0-rc01    = 00 01 00 31

gradle/libs.versions.toml

@@ -2,7 +2,7 @@
 binaryCompat = "0.13.0"
 bouncyCastle = "1.72"
 configuration = "0.1.0-beta02"
-cryptoCore = "0.2.4-SNAPSHOT"
+cryptoCore = "0.2.4"
 encoding = "1.2.1"
 endians = "0.1.0"
 gradleVersions = "0.46.0"