Prepare 0.2.6 release

CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## Version 0.2.5 (2023-06-08)
+ - Fixes Android API 21-23 requiring a `Provider` in order to set
+   `javax.crypto.Mac.spiImpl` when `javax.crypto.Mac.init` is
+   invoked [[#44]][44]
+ - Throw `InvalidKeyException` if `javax.crypto.Mac.init` is invoked [[#43]][43]
+     - All `org.kotlincrypto.core.Mac` APIs are constructed such that
+       implementations always require a key as a constructor argument
+       and are initialized immediately. As such, if a java caller
+       attempts to re-initialize the `Mac` with a different key, they
+       may assume the output thus produced is using the new key. This
+       is not the case as `Kotlin Crypto` does not use a provider based
+       architecture so a new, uninitialized `Mac` cannot be created.
+     - Note that `Mac.init` is **not** available from `commonMain`. It is
+       a remnant of bad API design requiring ability to lazily initialize
+       things which `Kotlin Crypto` will **never** support as it leads
+       to monolithic structures, instead of building on good abstractions.
+       If `Mac.init` is required to be called, a wholly new instance of the
+       `org.kotlincrypto.core.Mac` implementation should be instantiated
+       with the new key.
+
 ## Version 0.2.5 (2023-06-07)
  - Fixes Android API 23 and below not accepting `null` for `Mac.init` key
    parameter [[#38]][38]
@@ -47,3 +67,5 @@
 [36]: https://github.com/KotlinCrypto/core/pull/36
 [38]: https://github.com/KotlinCrypto/core/pull/38
 [40]: https://github.com/KotlinCrypto/core/pull/40
+[43]: https://github.com/KotlinCrypto/core/pull/43
+[44]: https://github.com/KotlinCrypto/core/pull/44

README.md

@@ -218,7 +218,7 @@ The best way to keep `KotlinCrypto` dependencies up to date is by using the
 ```kotlin
 // build.gradle.kts
 dependencies {
-    val core = "0.2.5"
+    val core = "0.2.6"
     implementation("org.kotlincrypto.core:digest:$core")
     implementation("org.kotlincrypto.core:mac:$core")
     implementation("org.kotlincrypto.core:xof:$core")
@@ -230,15 +230,15 @@ dependencies {
 ```groovy
 // build.gradle
 dependencies {
-    def core = "0.2.5"
+    def core = "0.2.6"
     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.2.5-blue.svg?style=flat
+[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.6-blue.svg?style=flat
 [badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat
 
 <!-- TAG_DEPENDENCIES -->

gradle.properties

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