refactor internals module

a-sit-plus · Dec 6, 2024 · b69d9d4 · b69d9d4
1 parent f53f502
commit b69d9d4
Show file tree

Hide file tree

Showing 30 changed files with 38 additions and 44 deletions.
diff --git a/docs/docs/indispensable.md b/docs/docs/indispensable.md
@@ -57,9 +57,9 @@ It contains essentials such as:
 * `CryptoPrivateKey` representing a private key. Currently, we support RSA and EC private keys on NIST curves. RSA keys always include the public key, EC keys may or may not contain a public key and/or curve.
     * Has an additional specialization `CryptoPrivateKey.WithPublicKey` that always includes a public key
     * Encodes to PKCS#8 by default
-    * RSA keys also support `pkcs1Encode()`
-    * EC keys also support  `sec1Encode()`
-* `Digest` containing an enumeration of supported
+    * RSA keys also support PKCS#1 encoding (`.asPKCS1`)
+    * EC keys also support SEC1 encoding (`.asSEC1`)
+* `Digest` containing an enumeration of supported digests
 * `ECCurve` representing an EC Curve
 * `ECPoint` representing a point on an elliptic curve
 * `CryptoSignatre` representing a cryptographic signature including descriptive information regarding the algorithms and signature data

diff --git a/...pensable-asn1/src/commonMain/kotlin/at/asitplus/signum/indispensable/asn1/Asn1Elements.kt b/...pensable-asn1/src/commonMain/kotlin/at/asitplus/signum/indispensable/asn1/Asn1Elements.kt
@@ -16,7 +16,6 @@ import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
 import kotlin.experimental.ExperimentalObjCName
 import kotlin.native.ObjCName
-import kotlin.reflect.typeOf
 
 /**
  * Base ASN.1 data class. Can either be a primitive (holding a value), or a structure (holding other ASN.1 elements)

diff --git a/...spensable-asn1/src/commonTest/kotlin/at/asitplus/signum/indispensable/asn1/CastingTest.kt b/...spensable-asn1/src/commonTest/kotlin/at/asitplus/signum/indispensable/asn1/CastingTest.kt
@@ -34,7 +34,7 @@ class CastingTest : FreeSpec({
 
         Asn1.OctetStringEncapsulating { +Asn1.Null() }.let { it.asEncapsulatingOctetString() shouldBe it }
         //Reinterpreting this way must always work
-        Asn1.OctetStringEncapsulating { +Asn1.Null() }.let { it.asPrimitiveOctetString() shouldBe it.asPrimitiveOctetString() }
+        Asn1.OctetStringEncapsulating { +Asn1.Null() }.let { it.asPrimitive() shouldBe it }
         Asn1.OctetStringEncapsulating { +Asn1.Null() }.let { it.asStructure() shouldBe it }
     }
 

diff --git a/indispensable-cosef/build.gradle.kts b/indispensable-cosef/build.gradle.kts
@@ -47,6 +47,7 @@ kotlin {
         commonMain {
             dependencies {
                 api(project(":indispensable"))
+                implementation(project(":internals"))
                 api(serialization("cbor"))
                 implementation(libs.multibase)
                 implementation(libs.bignum) //Intellij bug work-around

diff --git a/...sable-internals/src/commonMain/kotlin/at/asitplus/signum/indispensable/internals/Utils.kt b/...sable-internals/src/commonMain/kotlin/at/asitplus/signum/indispensable/internals/Utils.kt
diff --git a/indispensable-josef/build.gradle.kts b/indispensable-josef/build.gradle.kts
@@ -46,6 +46,7 @@ kotlin {
          commonMain {
             dependencies {
                 api(project(":indispensable"))
+                implementation(project(":internals"))
                 implementation(libs.okio)
                 api(libs.multibase)
                 implementation(libs.bignum) //Intellij bug work-around

diff --git a/...able-josef/src/jvmTest/kotlin/at/asitplus/signum/indispensable/josef/JsonWebKeyJvmTest.kt b/...able-josef/src/jvmTest/kotlin/at/asitplus/signum/indispensable/josef/JsonWebKeyJvmTest.kt
@@ -4,9 +4,7 @@ import at.asitplus.signum.indispensable.CryptoPublicKey
 import at.asitplus.signum.indispensable.CryptoPublicKey.EC.Companion.fromUncompressed
 import at.asitplus.signum.indispensable.ECCurve
 import at.asitplus.signum.indispensable.asn1.Asn1Integer
-import at.asitplus.signum.indispensable.misc.ensureSize
-import at.asitplus.signum.indispensable.asn1.encoding.toTwosComplementByteArray
-import at.asitplus.signum.indispensable.asn1.encoding.toUnsignedByteArray
+import at.asitplus.signum.internals.ensureSize
 import at.asitplus.signum.indispensable.asn1.toAsn1Integer
 import io.kotest.core.spec.style.FreeSpec
 import io.kotest.matchers.nulls.shouldNotBeNull

diff --git a/indispensable/build.gradle.kts b/indispensable/build.gradle.kts
@@ -60,7 +60,7 @@ kotlin {
             api(project(":indispensable-asn1"))
             api(libs.multibase)
             api(libs.bignum)
-            implementation(project(":indispensable-internals"))
+            implementation(project(":internals"))
         }
 
 

diff --git a/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/CryptoPrivateKey.kt b/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/CryptoPrivateKey.kt
@@ -7,7 +7,7 @@ import at.asitplus.signum.indispensable.CryptoPublicKey.EC.Companion.asPublicKey
 import at.asitplus.signum.indispensable.asn1.*
 import at.asitplus.signum.indispensable.asn1.encoding.*
 import at.asitplus.signum.indispensable.misc.ANSIECPrefix
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import com.ionspin.kotlin.bignum.integer.BigInteger
 import com.ionspin.kotlin.bignum.integer.Sign
 

diff --git a/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/CryptoPublicKey.kt b/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/CryptoPublicKey.kt
@@ -5,7 +5,6 @@ import at.asitplus.catching
 import at.asitplus.signum.indispensable.asn1.*
 import at.asitplus.signum.indispensable.asn1.encoding.Asn1.BitString
 import at.asitplus.signum.indispensable.asn1.encoding.Asn1.Null
-import at.asitplus.signum.indispensable.io.ByteArrayBase64Serializer
 import at.asitplus.signum.indispensable.misc.ANSIECPrefix
 import at.asitplus.signum.indispensable.misc.ANSIECPrefix.Companion.hasPrefix
 import at.asitplus.io.BaseN
@@ -14,7 +13,6 @@ import at.asitplus.io.UVarInt
 import at.asitplus.io.multibaseDecode
 import at.asitplus.io.multibaseEncode
 import at.asitplus.signum.indispensable.asn1.encoding.*
-import at.asitplus.signum.indispensable.misc.ensureSize
 import com.ionspin.kotlin.bignum.integer.BigInteger
 import com.ionspin.kotlin.bignum.integer.Sign
 import kotlinx.serialization.SerialName

diff --git a/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/CryptoSignature.kt b/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/CryptoSignature.kt
@@ -3,10 +3,10 @@ package at.asitplus.signum.indispensable
 import at.asitplus.signum.indispensable.asn1.*
 import at.asitplus.signum.indispensable.asn1.encoding.*
 import at.asitplus.signum.indispensable.io.Base64Strict
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import at.asitplus.signum.indispensable.misc.BitLength
 import at.asitplus.signum.indispensable.misc.max
-import at.asitplus.signum.indispensable.internals.orLazy
+import at.asitplus.signum.internals.orLazy
 import at.asitplus.signum.indispensable.pki.X509Certificate
 import com.ionspin.kotlin.bignum.integer.BigInteger
 import com.ionspin.kotlin.bignum.integer.Sign

diff --git a/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/ECPoint.kt b/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/ECPoint.kt
@@ -1,6 +1,6 @@
 package at.asitplus.signum.indispensable
 
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import at.asitplus.signum.indispensable.io.ByteArrayBase64Serializer
 import at.asitplus.signum.indispensable.misc.compressY
 import at.asitplus.signum.indispensable.misc.decompressY

diff --git a/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/asn1/Asn1Addons.kt b/indispensable/src/commonMain/kotlin/at/asitplus/signum/indispensable/asn1/Asn1Addons.kt
@@ -3,7 +3,7 @@ package at.asitplus.signum.indispensable.asn1
 import at.asitplus.catching
 import at.asitplus.catchingUnwrapped
 import at.asitplus.signum.indispensable.asn1.encoding.*
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import com.ionspin.kotlin.bignum.integer.BigInteger
 import com.ionspin.kotlin.bignum.integer.Sign
 import com.ionspin.kotlin.bignum.integer.util.fromTwosComplementByteArray

diff --git a/indispensable/src/commonTest/kotlin/UtilTest.kt b/indispensable/src/commonTest/kotlin/UtilTest.kt
@@ -1,6 +1,6 @@
 package at.asitplus.signum.indispensable
 
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import at.asitplus.signum.indispensable.misc.BitLength
 import at.asitplus.signum.indispensable.misc.max
 import at.asitplus.signum.indispensable.misc.min

diff --git a/indispensable/src/iosMain/kotlin/CommonCryptoExtensions.kt b/indispensable/src/iosMain/kotlin/CommonCryptoExtensions.kt
@@ -7,7 +7,7 @@ import at.asitplus.catching
 import kotlinx.cinterop.ExperimentalForeignApi
 import kotlinx.cinterop.memScoped
 import platform.Security.*
-import at.asitplus.signum.indispensable.internals.*
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.*
 
 val SignatureAlgorithm.secKeyAlgorithm: SecKeyAlgorithm
     get() = when (this) {

diff --git a/indispensable/src/jvmMain/kotlin/at/asitplus/signum/indispensable/JcaExtensions.kt b/indispensable/src/jvmMain/kotlin/at/asitplus/signum/indispensable/JcaExtensions.kt
@@ -4,7 +4,7 @@ import at.asitplus.KmmResult
 import at.asitplus.catching
 import at.asitplus.signum.indispensable.asn1.toAsn1Integer
 import at.asitplus.signum.indispensable.asn1.toJavaBigInteger
-import at.asitplus.signum.indispensable.internals.isAndroid
+import at.asitplus.signum.internals.isAndroid
 import at.asitplus.signum.indispensable.pki.X509Certificate
 import com.ionspin.kotlin.bignum.integer.base63.toJavaBigInteger
 import kotlinx.coroutines.runBlocking

diff --git a/.../jvmTest/kotlin/at/asitplus/signum/indispensable/pki/Pkcs10CertificationRequestJvmTest.kt b/.../jvmTest/kotlin/at/asitplus/signum/indispensable/pki/Pkcs10CertificationRequestJvmTest.kt
@@ -3,7 +3,7 @@ package at.asitplus.signum.indispensable.pki
 import at.asitplus.signum.indispensable.*
 import at.asitplus.signum.indispensable.asn1.*
 import at.asitplus.signum.indispensable.asn1.encoding.encodeToAsn1Primitive
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import at.asitplus.signum.indispensable.asn1.encoding.parse
 import io.kotest.assertions.withClue
 import io.kotest.core.spec.style.FreeSpec

diff --git a/...ensable/src/jvmTest/kotlin/at/asitplus/signum/indispensable/pki/X509CertificateJvmTest.kt b/...ensable/src/jvmTest/kotlin/at/asitplus/signum/indispensable/pki/X509CertificateJvmTest.kt
@@ -2,7 +2,7 @@ package at.asitplus.signum.indispensable.pki
 
 import at.asitplus.signum.indispensable.*
 import at.asitplus.signum.indispensable.asn1.*
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import at.asitplus.signum.indispensable.asn1.encoding.parse
 import io.kotest.core.spec.style.FreeSpec
 import io.kotest.matchers.nulls.shouldNotBeNull

diff --git a/indispensable-internals/.gitignore → internals/.gitignore b/indispensable-internals/.gitignore → internals/.gitignore
diff --git a/indispensable-internals/build.gradle.kts → internals/build.gradle.kts b/indispensable-internals/build.gradle.kts → internals/build.gradle.kts
@@ -64,7 +64,7 @@ kotlin {
 }
 
 exportIosFramework(
-    "Indispensable-Internals",
+    "Internals",
     transitiveExports = false,
     serialization("json"),
     datetime(),
@@ -81,8 +81,8 @@ publishing {
         withType<MavenPublication> {
             if (this.name != "relocation") artifact(javadocJar)
             pom {
-                name.set("Indispensable Internals")
-                description.set("Kotlin Multiplatform Crypto Core Library, Internal Shared Helpers")
+                name.set("Internals")
+                description.set("Kotlin Multiplatform Crypto Library, Internal Shared Helpers")
                 url.set("https://github.com/a-sit-plus/signum")
                 licenses {
                     license {

diff --git a/...itplus/signum/indispensable/misc/Utils.kt → ...lin/at/asitplus/signum/internals/Utils.kt b/...itplus/signum/indispensable/misc/Utils.kt → ...lin/at/asitplus/signum/internals/Utils.kt
@@ -1,8 +1,8 @@
-package at.asitplus.signum.indispensable.misc
+package at.asitplus.signum.internals
 
-/**
- * Drops bytes at the start, or adds zero bytes at the start, until the [size] is reached
- */
+infix fun <T: Any> T?.orLazy(block: ()->T) = if (this != null) lazyOf(this) else lazy(block)
+
+/** Drops bytes at the start, or adds zero bytes at the start, until the [size] is reached */
 fun ByteArray.ensureSize(size: Int): ByteArray = (this.size - size).let { toDrop ->
     when {
         toDrop > 0 -> this.copyOfRange(toDrop, this.size)

diff --git a/...e-internals/src/iosMain/kotlin/Interop.kt → ...asitplus/signum/internals/InteropUtils.kt b/...e-internals/src/iosMain/kotlin/Interop.kt → ...asitplus/signum/internals/InteropUtils.kt
@@ -1,6 +1,6 @@
 @file:OptIn(ExperimentalForeignApi::class)
 
-package at.asitplus.signum.indispensable.internals
+package at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals
 
 import kotlinx.cinterop.*
 import platform.CoreFoundation.CFDictionaryCreateMutable

diff --git a/.../indispensable/internals/JcaExtensions.kt → ...n/at/asitplus/signum/internals/JcaUtil.kt b/.../indispensable/internals/JcaExtensions.kt → ...n/at/asitplus/signum/internals/JcaUtil.kt
@@ -1,4 +1,4 @@
-package at.asitplus.signum.indispensable.internals
+package at.asitplus.signum.internals
 
 val isAndroid by lazy {
     try {

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -19,7 +19,7 @@ dependencyResolutionManagement {
     }
 }
 
-include(":indispensable-internals")
+include(":internals")
 include(":indispensable-asn1")
 include(":indispensable")
 include(":indispensable-josef")

diff --git a/supreme/build.gradle.kts b/supreme/build.gradle.kts
@@ -44,10 +44,11 @@ kotlin {
     iosSimulatorArm64()
 
     sourceSets.commonMain.dependencies {
+        api(project(":indispensable"))
+        implementation(project(":internals"))
         implementation(coroutines())
         implementation(napier())
         implementation(libs.securerandom)
-        api(project(":indispensable"))
     }
 
     sourceSets.androidMain.dependencies {

diff --git a/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/InteropUtils.kt b/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/InteropUtils.kt
@@ -2,9 +2,9 @@
 
 package at.asitplus.signum.supreme
 
-import at.asitplus.signum.indispensable.internals.SwiftException
-import at.asitplus.signum.indispensable.internals.takeFromCF
-import at.asitplus.signum.indispensable.internals.toNiceString
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.SwiftException
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.takeFromCF
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.toNiceString
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
 import kotlinx.cinterop.*

diff --git a/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/os/IosKeychainProvider.kt b/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/os/IosKeychainProvider.kt
@@ -4,7 +4,7 @@ package at.asitplus.signum.supreme.os
 import at.asitplus.KmmResult
 import at.asitplus.catching
 import at.asitplus.signum.indispensable.*
-import at.asitplus.signum.indispensable.internals.*
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.*
 import at.asitplus.signum.supreme.swiftasync
 import at.asitplus.signum.supreme.CFCryptoOperationFailed
 import at.asitplus.signum.supreme.CryptoOperationFailed

diff --git a/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/sign/EphemeralKeysImpl.kt b/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/sign/EphemeralKeysImpl.kt
@@ -7,7 +7,7 @@ import at.asitplus.catching
 import at.asitplus.signum.indispensable.*
 import at.asitplus.signum.supreme.*
 import at.asitplus.signum.supreme.AutofreeVariable
-import at.asitplus.signum.indispensable.internals.*
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.*
 import kotlinx.cinterop.*
 import platform.Foundation.NSData
 import platform.Security.*

diff --git a/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/sign/PrivateKeySignerImpl.kt b/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/sign/PrivateKeySignerImpl.kt
@@ -3,7 +3,7 @@ package at.asitplus.signum.supreme.sign
 import at.asitplus.KmmResult
 import at.asitplus.signum.indispensable.*
 import at.asitplus.signum.supreme.*
-import at.asitplus.signum.indispensable.internals.*
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.*
 import kotlinx.cinterop.ExperimentalForeignApi
 import platform.Foundation.NSData
 import platform.Security.SecKeyCreateSignature

diff --git a/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/sign/VerifierImpl.kt b/supreme/src/iosMain/kotlin/at/asitplus/signum/supreme/sign/VerifierImpl.kt
@@ -5,11 +5,11 @@ import at.asitplus.signum.indispensable.CryptoPublicKey
 import at.asitplus.signum.indispensable.CryptoSignature
 import at.asitplus.signum.indispensable.ECCurve
 import at.asitplus.signum.indispensable.SignatureAlgorithm
-import at.asitplus.signum.indispensable.misc.ensureSize
+import at.asitplus.signum.internals.ensureSize
 import at.asitplus.signum.indispensable.iosEncoded
 import at.asitplus.signum.indispensable.nativeDigest
 import at.asitplus.signum.indispensable.secKeyAlgorithmPreHashed
-import at.asitplus.signum.indispensable.internals.*
+import at.asitplus.signum.indispensable.internals.at.asitplus.signum.internals.*
 import at.asitplus.signum.supreme.dsl.DSL
 import at.asitplus.signum.supreme.UnsupportedCryptoException
 import kotlinx.cinterop.ExperimentalForeignApi