Prepare 0.6.0 release

05nelsonm · 05nelsonm · commit df1f1cf98a85 · 2025-01-15T11:34:46.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## Version 0.6.0 (2025-01-15)
+ - Adds `BLAKE2b` and `BLAKE2s` message authentication.
+ - Updates `KotlinCrypto.core` and `KotlinCrypto.hash` to `0.6.0`
+ - Updates all implementations to conform to `KotlinCrypto.core` `0.6.0` modifications 
+   to `Mac` and `Mac.Engine` internal API.
+ - All implementations now define a proper return type for `copy` (instead of `Mac`).
+ - All implementations can now be reinitialized with a new `key` via `Mac.reset(newKey)`
+ - Removes all `@Throws` annotations from constructors (it is documented).
+ - Finalizes `Hmac` API and removes `InternalKotlinCryptoApi` opt-in requirement from constructors.
+ - Deprecates `HmacSHA512_224` and `HmacSHA512_256` top-level functions.
+ - `Kmac` now implements `ReKeyableXofAlgorithm` so that the `Xof` can be reinitialized via `Xof.Companion.reset`.
+ - `Xof<Kmac>` instances now zero out the key block for the copy of the underlying `Mac.Engine` whenever 
+   a new `Xof.Reader` is created.
+
 ## Version 0.5.6 (2024-12-28)
  - Updates `kotlincrypto.hash` to `0.5.6` [[#56]][56]
 
diff --git a/README.md b/README.md
@@ -102,6 +102,17 @@ fun main() {
 
     key.fill(0)
 }
+````
+
+`BLAKE2 Macs`
+
+```kotlin
+fun main() {
+    val key = SecureRandom().nextBytesOf(100)
+
+    BLAKE2b(key, 512)
+    BLAKE2s(key, 256)
+}
 ```
 
 ### Get Started
@@ -116,7 +127,7 @@ shown below.
 // build.gradle.kts
 dependencies {
     // define the BOM and its version
-    implementation(platform("org.kotlincrypto.macs:bom:0.5.6"))
+    implementation(platform("org.kotlincrypto.macs:bom:0.6.0"))
 
     // define artifacts without version
     
@@ -140,13 +151,13 @@ dependencies {
 ```
 
 <!-- TAG_VERSION -->
-[badge-latest-release]: https://img.shields.io/badge/latest--release-0.5.6-blue.svg?style=flat
+[badge-latest-release]: https://img.shields.io/badge/latest--release-0.6.0-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.9.24-blue.svg?logo=kotlin
-[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.5.5-blue.svg
-[badge-hash]: https://img.shields.io/badge/kotlincrypto.hash-0.5.6-blue.svg
+[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.6.0-blue.svg
+[badge-hash]: https://img.shields.io/badge/kotlincrypto.hash-0.6.0-blue.svg
 
 <!-- TAG_PLATFORMS -->
 [badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
diff --git a/gradle.properties b/gradle.properties
@@ -30,7 +30,7 @@ POM_DEVELOPER_ID=KotlinCrypto
 POM_DEVELOPER_NAME=Kotlin Crypto
 POM_DEVELOPER_URL=https://github.com/KotlinCrypto/
 
-VERSION_NAME=0.6.0-SNAPSHOT
+VERSION_NAME=0.6.0
 # 0.1.0-alpha01 = 00 01 00 11
 # 0.1.0-beta01  = 00 01 00 21
 # 0.1.0-rc01    = 00 01 00 31
diff --git a/library/blake2/gradle.properties b/library/blake2/gradle.properties
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 POM_ARTIFACT_ID=blake2
-POM_NAME=KotlinCrypto MACs BLAKE2b, BLAKE2s
-POM_DESCRIPTION=MACs for BLAKE2b, BLAKE2s
+POM_NAME=KotlinCrypto BLAKE2 Message Authentication Code
+POM_DESCRIPTION=Macs for BLAKE2b, BLAKE2s
diff --git a/library/hmac/hmac-md/gradle.properties b/library/hmac/hmac-md/gradle.properties
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 POM_ARTIFACT_ID=hmac-md
-POM_NAME=KotlinCrypto HmacMD5
-POM_DESCRIPTION=HmacMD5 Message Authentication
+POM_NAME=KotlinCrypto MD Hash-based Message Authentication Code
+POM_DESCRIPTION=Macs for HmacMD5
diff --git a/library/hmac/hmac-sha1/gradle.properties b/library/hmac/hmac-sha1/gradle.properties
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 POM_ARTIFACT_ID=hmac-sha1
-POM_NAME=KotlinCrypto HmacSHA1
-POM_DESCRIPTION=HmacSHA1 Message Authentication
+POM_NAME=KotlinCrypto SHA1 Hash-based Message Authentication Code
+POM_DESCRIPTION=Macs for HmacSHA1
diff --git a/library/hmac/hmac-sha2/gradle.properties b/library/hmac/hmac-sha2/gradle.properties
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 POM_ARTIFACT_ID=hmac-sha2
-POM_NAME=KotlinCrypto HmacSHA224, HmacSHA256, HmacSHA384, HmacSHA512, HmacSHA512/t,
-POM_DESCRIPTION=HmacSHA224, HmacSHA256, HmacSHA384, HmacSHA512, and HmacSHA512/t Message Authentication
+POM_NAME=KotlinCrypto SHA2 Hash-based Message Authentication Code
+POM_DESCRIPTION=Macs for HmacSHA224, HmacSHA256, HmacSHA384, HmacSHA512, and HmacSHA512/t
diff --git a/library/hmac/hmac-sha3/gradle.properties b/library/hmac/hmac-sha3/gradle.properties
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 POM_ARTIFACT_ID=hmac-sha3
-POM_NAME=KotlinCrypto HmacSHA3/HmacKeccak
-POM_DESCRIPTION=HmacSHA3-224, HmacSHA3-256, HmacSHA3-384, HmacSHA3-512, HmacKeccak224, HmacKeccak256, HmacKeccak384, HmacKeccak512 Message Authentication
+POM_NAME=KotlinCrypto SHA3 Hash-based Message Authentication Code
+POM_DESCRIPTION=Macs for HmacSHA3-224, HmacSHA3-256, HmacSHA3-384, HmacSHA3-512, HmacKeccak224, HmacKeccak256, HmacKeccak384, HmacKeccak512
diff --git a/library/hmac/hmac/gradle.properties b/library/hmac/hmac/gradle.properties
@@ -13,4 +13,4 @@
 # limitations under the License.
 POM_ARTIFACT_ID=hmac
 POM_NAME=KotlinCrypto Hash-based Message Authentication Code
-POM_DESCRIPTION=Component for creating Hmac implementations
+POM_DESCRIPTION=Hmac abstraction for higher level implementations
diff --git a/library/kmac/gradle.properties b/library/kmac/gradle.properties
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 POM_ARTIFACT_ID=kmac
-POM_NAME=KotlinCrypto Keccak-based Message Authentication Code
-POM_DESCRIPTION=KMAC128, KMAC256
+POM_NAME=KotlinCrypto SHA3 Keccak-based Message Authentication Code
+POM_DESCRIPTION=Macs for KMAC128, KMAC256
