Apply new ed25519s module to stdlib module

Author: ForteScarlet

build.gradle.kts

@@ -108,7 +108,8 @@ apiValidation {
             "love.forte.simbot.annotations.InternalSimbotAPI",
             "love.forte.simbot.qguild.QGInternalApi",
             "love.forte.simbot.component.qguild.ExperimentalQGApi",
-            "love.forte.simbot.qguild.ExperimentalQGMediaApi"
+            "love.forte.simbot.qguild.ExperimentalQGMediaApi",
+            "love.forte.simbot.qguild.ed25519.annotations.InternalEd25519Api"
         ),
     )
 

buildSrc/src/main/kotlin/JvmConfig.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024. ForteScarlet.
+ * Copyright (c) 2024-2025. ForteScarlet.
  *
  * This file is part of simbot-component-qq-guild.
  *
@@ -21,13 +21,11 @@ import org.gradle.api.tasks.compile.JavaCompile
 import org.gradle.kotlin.dsl.assign
 import org.gradle.kotlin.dsl.get
 import org.gradle.kotlin.dsl.getByName
-import org.gradle.kotlin.dsl.withType
 import org.gradle.process.CommandLineArgumentProvider
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
-import org.jetbrains.kotlin.gradle.dsl.KotlinTopLevelExtension
 import org.jetbrains.kotlin.gradle.targets.jvm.KotlinJvmTarget
 
 
@@ -52,25 +50,23 @@ inline fun KotlinJvmTarget.configJava(crossinline block: KotlinJvmTarget.() -> U
 }
 
 
-fun KotlinTopLevelExtension.configJavaToolchain(jdkVersion: Int) {
-    jvmToolchain(jdkVersion)
-}
-
 inline fun KotlinMultiplatformExtension.configKotlinJvm(
     jdkVersion: Int = JVMConstants.KT_JVM_TARGET_VALUE,
     crossinline block: KotlinJvmTarget.() -> Unit = {}
 ) {
-    configJavaToolchain(jdkVersion)
+    jvmToolchain(jdkVersion)
     jvm {
         configJava(block)
+        compilerOptions {
+        }
     }
 }
 
 inline fun KotlinJvmProjectExtension.configKotlinJvm(
     jdkVersion: Int = JVMConstants.KT_JVM_TARGET_VALUE,
     crossinline block: KotlinJvmProjectExtension.() -> Unit = {}
 ) {
-    configJavaToolchain(jdkVersion)
+    jvmToolchain(jdkVersion)
     compilerOptions {
         javaParameters = true
         jvmTarget.set(JvmTarget.fromTarget(jdkVersion.toString()))
@@ -80,16 +76,23 @@ inline fun KotlinJvmProjectExtension.configKotlinJvm(
     block()
 }
 
+/**
+ * 要放在 `kotlin {}` 下面
+ */
 inline fun Project.configJavaCompileWithModule(
     moduleName: String? = null,
     jvmVersion: String = JVMConstants.KT_JVM_TARGET,
     crossinline block: JavaCompile.() -> Unit = {}
 ) {
-    tasks.withType<JavaCompile> {
+    tasks.named("compileJava", JavaCompile::class.java) {
         options.encoding = "UTF-8"
         sourceCompatibility = jvmVersion
         targetCompatibility = jvmVersion
 
+        println("$this sourceSets[\"main\"]: ${sourceSets["main"]}")
+        println("$this sourceSets[\"main\"].output: ${sourceSets["main"].output}")
+        println("$this sourceSets[\"main\"].output.asPath: ${sourceSets["main"].output.asPath}")
+
         if (moduleName != null) {
             options.compilerArgumentProviders.add(CommandLineArgumentProvider {
                 // Provide compiled Kotlin classes to javac – needed for Java/Kotlin mixed sources to work

simbot-component-qq-guild-api/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023-2024. ForteScarlet.
+ * Copyright (c) 2023-2025. ForteScarlet.
  *
  * This file is part of simbot-component-qq-guild.
  *
@@ -34,8 +34,6 @@ plugins {
 
 setup(P.ComponentQQGuild)
 
-configJavaCompileWithModule("simbot.component.qqguild.api")
-//apply(plugin = "qq-guild-dokka-partial-configure")
 apply(plugin = "qq-guild-multiplatform-maven-publish")
 
 //configJsTestTasks()
@@ -133,3 +131,5 @@ tasks.withType<DokkaTaskPartial>().configureEach {
         suppressGeneratedFiles.set(false)
     }
 }
+
+configJavaCompileWithModule("simbot.component.qqguild.api")

simbot-component-qq-guild-core/build.gradle.kts

@@ -30,7 +30,6 @@ plugins {
 
 setup(P.ComponentQQGuild)
 
-configJavaCompileWithModule("simbot.component.qqguild.core")
 apply(plugin = "qq-guild-multiplatform-maven-publish")
 
 configJsTestTasks()
@@ -98,3 +97,5 @@ kotlin {
         }
     }
 }
+
+configJavaCompileWithModule("simbot.component.qqguild.core")

simbot-component-qq-guild-internal-ed25519/README.md

@@ -1,14 +1,32 @@
 # internal ed25519 module
 
 一个内部使用的用于提供对 ed25519 签名的支持的模块。
-
-JVM 中优先尝试通过 `Security.getProvider("BC")` 检测是否存在 bouncycastle，如果存在则使用它的 `Ed25519` 类库。
+通过 `ed25519KeyPairGenerator()` 获取一个当前平台支持的 `Ed25519KeyPairGenerator` 实例。
 
 ```Kotlin
-import org.bouncycastle.crypto.params.Ed25519PrivateKeyParameters
-import org.bouncycastle.crypto.params.Ed25519PublicKeyParameters
+val generator = ed25519KeyPairGenerator()
+val (privateKey, publicKey) = generator.generate(seed)
+```
+
+非 JVM 平台中，均使用 [libsodium bindings](https://github.com/ionspin/kotlin-multiplatform-libsodium)
+作为实现。
+
+JVM 中优先尝试检测是否存在以下类：
+
+- `org.bouncycastle.crypto.params.Ed25519PrivateKeyParameters`
+- `org.bouncycastle.crypto.params.Ed25519PublicKeyParameters`
+- `org.bouncycastle.crypto.signers.Ed25519Signer`
 
-val seedBytes = seed.toByteArray()
-val privateKeyParams = Ed25519PrivateKeyParameters(seedBytes, 0)
-val publicKeyParams = privateKeyParams.generatePublicKey()
+如果存在，则使用这些类进行签名操作，也就是使用 [BouncyCastle](https://www.bouncycastle.org/) 
+(编译时使用的是 `org.bouncycastle:bcprov-jdk18on:1.80`)
+进行密钥的生成或签名/验签。
+
+当 BouncyCastle 的相关类存在时，使用 `ed25519KeyPairGenerator().generate(seed)`  相当于：
+
+```Kotlin
+val (privateKey, publicKey) = BouncyCastleEd25519KeyPair(seed)
 ```
+
+如果 BouncyCastle 的相关类不存在，则使用 [ed25519-java](https://github.com/str4d/ed25519-java)
+作为实现库。此库默认作为 `implementation` 加载于 classpath 中。
+相比于 BouncyCastle (≈8,480 KB ≈8.48 MB)，它轻量得多 (≈62 KB)。 

simbot-component-qq-guild-internal-ed25519/api/simbot-component-qq-guild-internal-ed25519.api

@@ -0,0 +1,3 @@
+public abstract interface annotation class love/forte/simbot/qguild/ed25519/annotations/InternalEd25519Api : java/lang/annotation/Annotation {
+}
+

simbot-component-qq-guild-internal-ed25519/build.gradle.kts

@@ -28,7 +28,6 @@ plugins {
 
 setup(P.ComponentQQGuild)
 
-configJavaCompileWithModule("simbot.component.qqguild.internal.ed25519")
 apply(plugin = "qq-guild-multiplatform-maven-publish")
 
 configJsTestTasks()
@@ -91,3 +90,6 @@ kotlin {
         }
     }
 }
+
+configJavaCompileWithModule("simbot.component.qqguild.internal.ed25519s")
+

simbot-component-qq-guild-internal-ed25519/src/commonMain/kotlin/love/forte/simbot/qguild/ed25519/Ed25519s.kt

@@ -61,6 +61,11 @@ public expect fun ed25519KeyPairGenerator(): Ed25519KeyPairGenerator
 public interface Ed25519KeyPair {
     public val privateKey: Ed25519PrivateKey
     public val publicKey: Ed25519PublicKey
+
+    @InternalEd25519Api
+    public companion object {
+        public const val CRYPTO_SIGN_BYTES: Int = 64
+    }
 }
 
 @InternalEd25519Api

simbot-component-qq-guild-internal-ed25519/src/jvmMain/java/module-info.java

@@ -0,0 +1,11 @@
+module simbot.component.qqguild.internal.ed25519s {
+    requires kotlin.stdlib;
+    requires static org.bouncycastle.provider;
+    requires simbot.logger;
+    requires net.i2p.crypto.eddsa;
+
+    exports love.forte.simbot.qguild.ed25519 to
+            simbot.component.qqguild.stdlib,
+            simbot.component.qqguild.core;
+    exports love.forte.simbot.qguild.ed25519.annotations;
+}

simbot-component-qq-guild-internal-ed25519/src/jvmMain/kotlin/love/forte/simbot/qguild/ed25519/Ed25519s.jvm.kt

@@ -40,7 +40,7 @@ public actual fun ed25519KeyPairGenerator(): Ed25519KeyPairGenerator {
     return if (bouncyCastleAccessible) {
         BouncyCastleEd25519KeyPairGenerator
     } else {
-        TODO()
+        EddsaEd25519KeyPairGenerator
     }
 }
 
@@ -65,13 +65,11 @@ private val bouncyCastleAccessible: Boolean by lazy {
         }
     }.also {
         if (!it) {
-            // TODO log debug
             val msg = "BouncyCastle is inaccessible because of the classes {} are not found in classpath. " +
                     "`ed25519-java` will be used instead."
 
             ed25519sLogger.info(msg, bouncyCastleRequiredClasses.asList())
             ed25519sLogger.debug(msg, bouncyCastleRequiredClasses.asList(), bouncyCastleInaccessible)
-
         }
 
     }

simbot-component-qq-guild-stdlib/build.gradle.kts

@@ -30,7 +30,6 @@ plugins {
 
 setup(P.ComponentQQGuild)
 
-configJavaCompileWithModule("simbot.component.qqguild.stdlib")
 apply(plugin = "qq-guild-multiplatform-maven-publish")
 
 configJsTestTasks()
@@ -71,17 +70,12 @@ kotlin {
             api(libs.ktor.client.contentNegotiation)
             api(libs.ktor.serialization.kotlinxJson)
             api(libs.ktor.client.ws)
-
-            // https://github.com/ionspin/kotlin-multiplatform-libsodium
-            implementation("com.ionspin.kotlin:multiplatform-crypto-libsodium-bindings:0.9.2")
         }
 
         commonTest.dependencies {
             implementation(kotlin("test"))
             implementation(libs.kotlinx.coroutines.test)
             implementation(libs.ktor.client.mock)
-            // https://github.com/diglol/crypto
-//            implementation("com.diglol.crypto:pkc:0.2.0")
         }
 
         jvmTest.dependencies {
@@ -90,12 +84,6 @@ kotlin {
             implementation(libs.log4j.core)
             implementation(libs.log4j.slf4j2)
             implementation(libs.bouncycastle.bcprov.jdk18on)
-//            implementation("dev.whyoleg.cryptography:cryptography-core:0.4.0")
-//            implementation(kotlincrypto.core.digest)
-//            implementation(kotlincrypto.core.mac)
-//            implementation(kotlincrypto.core.xof)
-//            implementation(kotlincrypto.macs.hmac.sha1)
-//            implementation(kotlincrypto.macs.kmac)
         }
 
         jsMain.dependencies {
@@ -107,3 +95,5 @@ kotlin {
         }
     }
 }
+
+configJavaCompileWithModule("simbot.component.qqguild.stdlib")

simbot-component-qq-guild-stdlib/src/commonMain/kotlin/love/forte/simbot/qguild/stdlib/internal/BotImpl.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2024. ForteScarlet.
+ * Copyright (c) 2022-2025. ForteScarlet.
  *
  * This file is part of simbot-component-qq-guild.
  *
@@ -17,7 +17,6 @@
 
 package love.forte.simbot.qguild.stdlib.internal
 
-import com.ionspin.kotlin.crypto.signature.crypto_sign_BYTES
 import io.ktor.client.*
 import io.ktor.client.plugins.*
 import io.ktor.client.plugins.contentnegotiation.*
@@ -50,6 +49,10 @@ import love.forte.simbot.qguild.api.app.AppAccessToken
 import love.forte.simbot.qguild.api.app.GetAppAccessTokenApi
 import love.forte.simbot.qguild.api.requestData
 import love.forte.simbot.qguild.api.user.GetBotInfoApi
+import love.forte.simbot.qguild.ed25519.Ed25519KeyPair
+import love.forte.simbot.qguild.ed25519.Signature
+import love.forte.simbot.qguild.ed25519.annotations.InternalEd25519Api
+import love.forte.simbot.qguild.ed25519.paddingEd25519Seed
 import love.forte.simbot.qguild.event.*
 import love.forte.simbot.qguild.model.User
 import love.forte.simbot.qguild.stdlib.*
@@ -65,7 +68,7 @@ import kotlin.time.Duration.Companion.seconds
  * implementation for [Bot].
  * @author ForteScarlet
  */
-@OptIn(ExperimentalSimbotCollectionApi::class)
+@OptIn(ExperimentalSimbotCollectionApi::class, InternalEd25519Api::class)
 internal class BotImpl(
     override val ticket: Bot.Ticket,
     override val configuration: BotConfiguration,
@@ -106,7 +109,7 @@ internal class BotImpl(
         }
     }
 
-    private val ed25519KeyPair: Ed25519Keypair by lazy {
+    private val ed25519KeyPair: Ed25519KeyPair by lazy {
         genEd25519Keypair(ticket.secret.paddingEd25519Seed().toByteArray())
     }
 
@@ -411,7 +414,7 @@ internal class BotImpl(
             }
         }
 
-    @OptIn(ExperimentalStdlibApi::class)
+    @OptIn(ExperimentalStdlibApi::class, InternalEd25519Api::class)
     override suspend fun emitEvent(
         payload: String,
         options: EmitEventOptions?,
@@ -427,9 +430,9 @@ internal class BotImpl(
 
             val signatureBytes = signature.hexToByteArray()
 
-            check(crypto_sign_BYTES == signatureBytes.size) {
+            check(Ed25519KeyPair.CRYPTO_SIGN_BYTES == signatureBytes.size) {
                 "Invalid signature hex size, " +
-                        "expect ${crypto_sign_BYTES}, " +
+                        "expect ${Ed25519KeyPair.CRYPTO_SIGN_BYTES}, " +
                         "actual ${signatureBytes.size}"
             }
 
@@ -443,7 +446,7 @@ internal class BotImpl(
 
             val msg = "$signatureTimestamp$payload"
 
-            check(ed25519PublicKey.verify(signature = signatureBytes, message = msg.toByteArray())) {
+            check(ed25519PublicKey.verify(signature = Signature(signatureBytes), data = msg.toByteArray())) {
                 "Ed25519 verify failed"
             }
         }
@@ -454,9 +457,11 @@ internal class BotImpl(
 
             val signature = ed25519PrivateKey.sign(msg.toByteArray())
 
+            signature.data
+
             val verified = Signal.CallbackVerify.Verified(
                 plainToken,
-                signature.signatureBytes().toHexString()
+                signature.data.toHexString()
             )
 
             return EmitResult.Verified(verified)
@@ -625,27 +630,3 @@ internal suspend fun BotImpl.emitEvent(dispatch: Signal.Dispatch, raw: String) {
         }
     }
 }
-
-
-/**
- * Repeat to `length` == 32
- */
-internal fun String.paddingEd25519Seed(): String {
-    return when {
-        length == 32 || isEmpty() -> this
-        length > 32 -> substring(32)
-        else -> {
-            buildString(32) {
-                append(this@paddingEd25519Seed)
-                while (length < 32) {
-                    append(
-                        this@paddingEd25519Seed,
-                        0,
-                        kotlin.math.min(32 - length, this@paddingEd25519Seed.length)
-                    )
-                }
-            }
-
-        }
-    }
-}