Prepare 0.6.1 release

Author: 05nelsonm

CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## Version 0.6.1 (2025-02-09)
+ - Adds `Digest.digestInto` API for populating an existing `ByteArray` with output [[#108]][108]
+ - Adds `Mac.doFinalInto` API for populating an existing `ByteArray` with output [[#109]][109]
+ - Adds `Mac.Engine.resetOnDoFinal` constructor argument for providing implementations the ability
+   to disable automatic `Engine.reset` call when `doFinal` or `doFinalInto` gets executed [[#111]][111]
+     - Mitigates double resets when implementation is backed by a `Digest`.
+ - Adds `dokka` documentation at `https://core.kotlincrypto.org`
+ - Adds API dependency `org.kotlincrypto.error:error` to module `core` [[#118]][118]
+
 ## Version 0.6.0 (2025-01-15)
  - `@Throws` annotation removed from `Updatable.update` (it is documented).
  - Finalizes `Digest` internal API and removes `InternalKotlinCryptoApi` opt-in requirement from constructors.
@@ -172,3 +181,7 @@
 [64]: https://github.com/KotlinCrypto/core/pull/64
 [66]: https://github.com/KotlinCrypto/core/pull/66
 [70]: https://github.com/KotlinCrypto/core/pull/70
+[108]: https://github.com/KotlinCrypto/core/pull/108
+[109]: https://github.com/KotlinCrypto/core/pull/109
+[111]: https://github.com/KotlinCrypto/core/pull/111
+[118]: https://github.com/KotlinCrypto/core/pull/118

README.md

@@ -68,15 +68,15 @@ The best way to keep `KotlinCrypto` dependencies up to date is by using the
 ```kotlin
 // build.gradle.kts
 dependencies {
-    val core = "0.6.0"
+    val core = "0.6.1"
     implementation("org.kotlincrypto.core:digest:$core")
     implementation("org.kotlincrypto.core:mac:$core")
     implementation("org.kotlincrypto.core:xof:$core")
 }
 ```
 
 <!-- TAG_VERSION -->
-[badge-latest-release]: https://img.shields.io/badge/latest--release-0.6.0-blue.svg?style=flat
+[badge-latest-release]: https://img.shields.io/badge/latest--release-0.6.1-blue.svg?style=flat
 [badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat
 
 <!-- TAG_DEPENDENCIES -->

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.1-SNAPSHOT
+VERSION_NAME=0.6.1
 # 0.1.0-alpha01 = 00 01 00 11
 # 0.1.0-beta01  = 00 01 00 21
 # 0.1.0-rc01    = 00 01 00 31

library/core/README.md

@@ -1,3 +1,3 @@
 # Module core
 
-Very small module, only containing public interfaces and exceptions. Is exported by all other modules.
+Very small module, only containing public interfaces and annotations. Is exported by all other modules.

library/digest/README.md

@@ -5,7 +5,7 @@
 Implementations can be found at [KotlinCrypto/hash][url-hash]
 
 ```kotlin
-// Using SHA256 from hash repo as an example
+// Using SHA256 from KotlinCrypto/hash repo as an example
 import org.kotlincrypto.hash.sha2.SHA256
 
 fun main() {

library/mac/README.md

@@ -5,13 +5,13 @@
 Implementations can be found at [KotlinCrypto/MACs][url-macs]
 
 ```kotlin
-// Using SecureRandom from the secure-random repo as an example
-import org.kotlincrypto.SecureRandom
-// Using HmacSHA3_256 from the MACs repo as an example
+// Using CryptoRand from KotlinCrypto/random repo as an example
+import org.kotlincrypto.random.CryptoRand
+// Using HmacSHA3_256 from KotlinCrypto/MACs repo as an example
 import org.kotlincrypto.macs.hmac.sha3.HmacSHA3_256
 
 fun main() {
-    val key = SecureRandom().nextBytesOf(100)
+    val key = CryptoRand.Default.nextBytes(ByteArray(100))
     val mac = HmacSHA3_256(key)
     val bytes = Random.Default.nextBytes(615)
 
@@ -40,7 +40,7 @@ fun main() {
 
     // Reinitialize Mac instance with a new key
     // to use for something else.
-    val newKey = SecureRandom().nextBytesOf(100)
+    val newKey = CryptoRand.Default.nextBytes(ByteArray(100))
     mac.reset(newKey = newKey)
 
     // Zero out key material before dereferencing

library/xof/README.md

@@ -13,7 +13,7 @@ different from those types, while implementing the same interfaces (`Algorithm`,
 Output for an `Xof` is done by reading, instead.
 
 ```kotlin
-// Using SHAKE128 from hash repo as an example
+// Using SHAKE128 from KotlinCrypto/hash repo as an example
 import org.kotlincrypto.hash.sha3.SHAKE128
 
 fun main() {
@@ -82,19 +82,19 @@ fun main() {
 ```
 
 ```kotlin
-// Using KMAC128 from MACs repo as an example
+// Using CryptoRand from KotlinCrypto/random repo as an example
+import org.kotlincrypto.random.CryptoRand
+// Using KMAC128 from KotlinCrypto/MACs repo as an example
 import org.kotlincrypto.macs.kmac.KMAC128
-// Using SecureRandom from the secure-random repo as an example
-import org.kotlincrypto.SecureRandom
 
 fun main() {
-    val key = SecureRandom().nextBytesOf(100)
+    val key = CryptoRand.Default.nextBytes(ByteArray(100))
     val kmacXof: Xof<KMAC128> = KMAC128.xOf(key)
 
     // If Xof is for a Mac that implements ReKeyableXofAlgorithm,
     // reinitialize the instance via the `Xof.Companion.reset`
     // extension function for reuse.
-    val newKey = SecureRandom().nextBytesOf(100)
+    val newKey = CryptoRand.Default.nextBytes(ByteArray(100))
     kmacXof.reset(newKey = newKey)
 
     // Or zero out key material before dereferencing