KyberKotlin v0.4.9

* Sealed KyberKeyGenerator and KyberAgreement classes. * Updated keyBytes to 'internal' to prevent unwanted modifications. * Added explicit JvmName for parameters of KyberEncapsulationResult.
ronhombre · Mar 9, 2024 · f1e1680 · f1e1680
1 parent 9e5cd4c
commit f1e1680
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ This benchmark is for performance tracking through the development.
 
 ```Kotlin
 dependencies {
-    implementation("asia.hombre:kyber:0.4.8")
+    implementation("asia.hombre:kyber:0.4.9")
 }
 ```
 
@@ -101,7 +101,7 @@ dependencies {
 
 ## JS NPM Installation
 ```
-npm i kyberkotlin@0.4.8
+npm i kyberkotlin@0.4.9
 ```
 
 ## Native C# Installation

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -13,7 +13,7 @@ plugins {
 }
 
 group = "asia.hombre.kyber" //The value after the last '.' is considered the maven name i.e. asia.hombre:kyber:+
-version = "0.4.8"
+version = "0.4.9"
 
 val projectName = project.group.toString().split(".").last() //Grab maven name
 val baseProjectName = projectName.plus("-").plus(project.version)
@@ -173,6 +173,20 @@ kotlin {
     }
 }
 
+tasks.dokkaHtml.configure {
+    dokkaSourceSets {
+        named("commonMain") {
+            // Adjust visibility to include internal and private members
+            perPackageOption {
+                matchingRegex.set(".*") // Match all packages
+                includeNonPublic.set(false)
+            }
+            // Optionally, report undocumented members
+            reportUndocumented.set(true)
+        }
+    }
+}
+
 fun saveHash(file: File, hash: String, suffix: String) {
     val filePath = file.toPath()
     Files.write(filePath.resolveSibling(filePath.fileName.toString() + suffix), hash.toByteArray())

diff --git a/pom.xml b/pom.xml
@@ -39,11 +39,11 @@
 
     <groupId>asia.hombre</groupId>
     <artifactId>kyber</artifactId>
-    <version>0.4.8</version>
+    <version>0.4.9</version>
     <packaging>jar</packaging>
 
     <scm>
-        <tag>v0.4.8</tag>
+        <tag>v0.4.9</tag>
         <connection>scm:git:https://github.com/ronhombre/KyberKotlin.git</connection>
         <url>https://github.com/ronhombre/KyberKotlin.git</url>
     </scm>

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberAgreement.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberAgreement.kt
@@ -41,7 +41,7 @@ import kotlin.jvm.JvmSynthetic
  */
 @OptIn(ExperimentalJsExport::class)
 @JsExport
-class KyberAgreement(kemKeyPair: KyberKEMKeyPair) {
+sealed class KyberAgreement(kemKeyPair: KyberKEMKeyPair) {
     /**
      * The [KyberParameter] of this agreement.
      */

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberDecryptionKey.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberDecryptionKey.kt
@@ -40,7 +40,7 @@ import kotlin.jvm.JvmStatic
  */
 @OptIn(ExperimentalJsExport::class)
 @JsExport
-class KyberDecryptionKey internal constructor(override val parameter: KyberParameter, override val keyBytes: ByteArray) : KyberPKEKey {
+class KyberDecryptionKey internal constructor(override val parameter: KyberParameter, internal val keyBytes: ByteArray) : KyberPKEKey {
     /**
      * All the bytes of the Decryption Key.
      *

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberEncapsulationResult.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberEncapsulationResult.kt
@@ -20,6 +20,7 @@ package asia.hombre.kyber
 
 import kotlin.js.ExperimentalJsExport
 import kotlin.js.JsExport
+import kotlin.jvm.JvmName
 
 /**
  * A class for ML-KEM Encapsulation Results.
@@ -33,4 +34,9 @@ import kotlin.js.JsExport
  */
 @OptIn(ExperimentalJsExport::class)
 @JsExport
-class KyberEncapsulationResult internal constructor(val secretKey: ByteArray, val cipherText: KyberCipherText)
+class KyberEncapsulationResult internal constructor(
+    @get:JvmName("getSecretKey")
+    val secretKey: ByteArray,
+    @get:JvmName("getCipherText")
+    val cipherText: KyberCipherText
+)
diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberEncryptionKey.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberEncryptionKey.kt
@@ -43,7 +43,7 @@ import kotlin.jvm.JvmStatic
 @JsExport
 class KyberEncryptionKey internal constructor(
     override val parameter: KyberParameter,
-    override val keyBytes: ByteArray,
+    internal val keyBytes: ByteArray,
     internal val nttSeed: ByteArray) : KyberPKEKey {
 
     /**

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/KyberKeyGenerator.kt b/src/commonMain/kotlin/asia/hombre/kyber/KyberKeyGenerator.kt
@@ -36,7 +36,7 @@ import kotlin.jvm.JvmSynthetic
  */
 @OptIn(ExperimentalJsExport::class)
 @JsExport
-class KyberKeyGenerator private constructor() {
+sealed class KyberKeyGenerator private constructor() {
 
     companion object {
         /**

diff --git a/src/commonMain/kotlin/asia/hombre/kyber/interfaces/KyberPKEKey.kt b/src/commonMain/kotlin/asia/hombre/kyber/interfaces/KyberPKEKey.kt
@@ -29,5 +29,4 @@ import kotlin.js.JsExport
 @JsExport
 internal interface KyberPKEKey: Convertible {
     val parameter: KyberParameter
-    val keyBytes: ByteArray
 }