Add support for RIPEMD160 digest (#55)

huskcasaca · web-flow · commit 186a42095596 · 2024-12-13T17:44:39.000+02:00
* Use ubuntu 24.04 with OpenSSL >= 3.0.8 for native builds (#55 (comment))
diff --git a/.github/workflows/run-tests-compatibility.yml b/.github/workflows/run-tests-compatibility.yml
@@ -18,12 +18,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ 'ubuntu-latest' ]
-        target: [ 'jvm', 'js', 'wasm',  'native' ]
+        target: [ 'jvm', 'js', 'wasm' ]
         include:
           - os: 'macos-latest'
             target: 'macos'
           - os: 'windows-latest'
             target: 'native'
+          - os: 'ubuntu-24.04'
+            target: 'native'
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-environment
@@ -66,12 +68,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ 'ubuntu-latest' ]
-        target: [ 'jvm', 'js', 'wasm',  'native' ]
+        target: [ 'jvm', 'js', 'wasm' ]
         include:
           - os: 'macos-latest'
             target: 'macos'
           - os: 'windows-latest'
             target: 'native'
+          - os: 'ubuntu-24.04'
+            target: 'native'
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-environment
diff --git a/.github/workflows/run-tests-default.yml b/.github/workflows/run-tests-default.yml
@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ 'ubuntu-latest' ]
-        target: [ 'jvmAll', 'js', 'wasm', 'native' ]
+        target: [ 'jvmAll', 'js', 'wasm' ]
         include:
           - os: 'macos-latest'
             target: 'macos'
@@ -35,6 +35,8 @@ jobs:
           - os: 'ubuntu-22.04'
             target: 'connectedAndroid'
             android-api-level: 33
+          - os: 'ubuntu-24.04'
+            target: 'native'
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-environment
diff --git a/build-logic/src/main/kotlin/ckbuild/tests/GenerateProviderTestsTask.kt b/build-logic/src/main/kotlin/ckbuild/tests/GenerateProviderTestsTask.kt
@@ -88,6 +88,7 @@ abstract class GenerateProviderTestsTask : DefaultTask() {
             "Sha3B256CompatibilityTest",
             "Sha3B384CompatibilityTest",
             "Sha3B512CompatibilityTest",
+            "Ripemd160CompatibilityTest",
 
             "AesCbcTest",
             "AesCbcCompatibilityTest",
diff --git a/cryptography-core/api/cryptography-core.api b/cryptography-core/api/cryptography-core.api
@@ -446,6 +446,10 @@ public abstract interface class dev/whyoleg/cryptography/algorithms/PBKDF2 : dev
 public final class dev/whyoleg/cryptography/algorithms/PBKDF2$Companion : dev/whyoleg/cryptography/CryptographyAlgorithmId {
 }
 
+public final class dev/whyoleg/cryptography/algorithms/RIPEMD160 : dev/whyoleg/cryptography/CryptographyAlgorithmId {
+	public static final field INSTANCE Ldev/whyoleg/cryptography/algorithms/RIPEMD160;
+}
+
 public abstract interface class dev/whyoleg/cryptography/algorithms/RSA : dev/whyoleg/cryptography/CryptographyAlgorithm {
 	public abstract fun keyPairGenerator-imL9hLU (ILdev/whyoleg/cryptography/CryptographyAlgorithmId;Ldev/whyoleg/cryptography/bigint/BigInt;)Ldev/whyoleg/cryptography/materials/key/KeyGenerator;
 	public static synthetic fun keyPairGenerator-imL9hLU$default (Ldev/whyoleg/cryptography/algorithms/RSA;ILdev/whyoleg/cryptography/CryptographyAlgorithmId;Ldev/whyoleg/cryptography/bigint/BigInt;ILjava/lang/Object;)Ldev/whyoleg/cryptography/materials/key/KeyGenerator;
diff --git a/cryptography-core/api/cryptography-core.klib.api b/cryptography-core/api/cryptography-core.klib.api
@@ -801,6 +801,8 @@ open class dev.whyoleg.cryptography/CryptographyException : kotlin/RuntimeExcept
 
 final object dev.whyoleg.cryptography.algorithms/MD5 : dev.whyoleg.cryptography/CryptographyAlgorithmId<dev.whyoleg.cryptography.algorithms/Digest> // dev.whyoleg.cryptography.algorithms/MD5|null[0]
 
+final object dev.whyoleg.cryptography.algorithms/RIPEMD160 : dev.whyoleg.cryptography/CryptographyAlgorithmId<dev.whyoleg.cryptography.algorithms/Digest> // dev.whyoleg.cryptography.algorithms/RIPEMD160|null[0]
+
 final object dev.whyoleg.cryptography.algorithms/SHA1 : dev.whyoleg.cryptography/CryptographyAlgorithmId<dev.whyoleg.cryptography.algorithms/Digest> // dev.whyoleg.cryptography.algorithms/SHA1|null[0]
 
 final object dev.whyoleg.cryptography.algorithms/SHA224 : dev.whyoleg.cryptography/CryptographyAlgorithmId<dev.whyoleg.cryptography.algorithms/Digest> // dev.whyoleg.cryptography.algorithms/SHA224|null[0]
diff --git a/cryptography-core/src/commonMain/kotlin/algorithms/Digest.kt b/cryptography-core/src/commonMain/kotlin/algorithms/Digest.kt
@@ -37,3 +37,6 @@ public object SHA3_384 : CryptographyAlgorithmId<Digest>("SHA3-384")
 
 @Suppress("ClassName")
 public object SHA3_512 : CryptographyAlgorithmId<Digest>("SHA3-512")
+
+@DelicateCryptographyApi
+public object RIPEMD160 : CryptographyAlgorithmId<Digest>("RIPEMD-160")
diff --git a/cryptography-providers-tests-api/src/commonMain/kotlin/support.kt b/cryptography-providers-tests-api/src/commonMain/kotlin/support.kt
@@ -29,6 +29,8 @@ fun AlgorithmTestScope<*>.supportsDigest(digest: CryptographyAlgorithmId<Digest>
         digest in sha3Algorithms &&
                 provider.isJdkDefault &&
                 (platform.isJdk { major < 17 } || platform.isAndroid) -> "${digest.name} signatures on old JDK"
+        digest == RIPEMD160 && (provider.isJdkDefault || provider.isApple || provider.isWebCrypto)
+                                                                      -> digest.name
         else                                                          -> null
     }
 }
diff --git a/cryptography-providers-tests/src/commonMain/kotlin/SupportedAlgorithmsTest.kt b/cryptography-providers-tests/src/commonMain/kotlin/SupportedAlgorithmsTest.kt
@@ -44,6 +44,8 @@ abstract class SupportedAlgorithmsTest(provider: CryptographyProvider) : Provide
         assertSupports(SHA3_384, supportsSha3)
         assertSupports(SHA3_512, supportsSha3)
 
+        assertSupports(RIPEMD160, !context.provider.isApple && !context.provider.isWebCrypto)
+
         assertSupports(ECDSA)
         assertSupports(ECDH, !context.provider.isApple)
 
diff --git a/cryptography-providers-tests/src/commonMain/kotlin/compatibility/DigestCompatibilityTest.kt b/cryptography-providers-tests/src/commonMain/kotlin/compatibility/DigestCompatibilityTest.kt
@@ -25,6 +25,7 @@ abstract class Sha3B224CompatibilityTest(provider: CryptographyProvider) : Diges
 abstract class Sha3B256CompatibilityTest(provider: CryptographyProvider) : DigestCompatibilityTest(SHA3_256, provider)
 abstract class Sha3B384CompatibilityTest(provider: CryptographyProvider) : DigestCompatibilityTest(SHA3_384, provider)
 abstract class Sha3B512CompatibilityTest(provider: CryptographyProvider) : DigestCompatibilityTest(SHA3_512, provider)
+abstract class Ripemd160CompatibilityTest(provider: CryptographyProvider) : DigestCompatibilityTest(RIPEMD160, provider)
 
 abstract class DigestCompatibilityTest(algorithmId: CryptographyAlgorithmId<Digest>, provider: CryptographyProvider) :
     CompatibilityTest<Digest>(algorithmId, provider) {
diff --git a/cryptography-providers-tests/src/commonMain/kotlin/default/DigestTest.kt b/cryptography-providers-tests/src/commonMain/kotlin/default/DigestTest.kt
@@ -98,6 +98,9 @@ abstract class DigestTest(provider: CryptographyProvider) : ProviderTest(provide
     @Test
     fun testSHA3_512() = test(SHA3_512, 64)
 
+    @Test
+    fun testRIPEMD160() = test(RIPEMD160, 20)
+
     @Test
     fun testFunctionIndexes() = testWithAlgorithm(SHA256) {
         if (!supportsFunctions()) return@testWithAlgorithm
diff --git a/cryptography-providers/jdk/src/jvmMain/kotlin/JdkCryptographyProvider.kt b/cryptography-providers/jdk/src/jvmMain/kotlin/JdkCryptographyProvider.kt
@@ -77,6 +77,7 @@ internal class JdkCryptographyProvider(
             SHA3_256  -> JdkDigest(state, "SHA3-256", SHA3_256)
             SHA3_384  -> JdkDigest(state, "SHA3-384", SHA3_384)
             SHA3_512  -> JdkDigest(state, "SHA3-512", SHA3_512)
+            RIPEMD160 -> JdkDigest(state, "RIPEMD160", RIPEMD160)
             HMAC     -> JdkHmac(state)
             AES.CBC  -> JdkAesCbc(state)
             AES.CTR  -> JdkAesCtr(state)
diff --git a/cryptography-providers/openssl3/api/src/commonMain/kotlin/Openssl3CryptographyProvider.kt b/cryptography-providers/openssl3/api/src/commonMain/kotlin/Openssl3CryptographyProvider.kt
@@ -30,6 +30,7 @@ internal object Openssl3CryptographyProvider : CryptographyProvider() {
         SHA3_256  -> Openssl3Digest("SHA3-256", SHA3_256)
         SHA3_384  -> Openssl3Digest("SHA3-384", SHA3_384)
         SHA3_512  -> Openssl3Digest("SHA3-512", SHA3_512)
+        RIPEMD160 -> Openssl3Digest("RIPEMD160", RIPEMD160)
         HMAC    -> Openssl3Hmac
         AES.CBC -> Openssl3AesCbc
         AES.CTR -> Openssl3AesCtr
diff --git a/docs/providers/index.md b/docs/providers/index.md
@@ -57,6 +57,7 @@ For additional limitation please consult provider specific documentation.
 |                                             | SHA384           |  ✅  |     ✅     |   ✅   |    ✅     |
 |                                             | SHA512           |  ✅  |     ✅     |   ✅   |    ✅     |
 |                                             | SHA3 family      |  ✅  |     ❌     |   ❌   |    ✅     |
+|                                             | ⚠️ RIPEMD160     |  ✅  |     ❌     |   ❌   |    ✅     |
 | **MAC**                                     | HMAC             |  ✅  |     ✅     |   ✅   |    ✅     |
 | **Symmetric-key<br/>encryption/decryption** | AES-CBC          |  ✅  |     ✅     |   ✅   |    ✅     |
 |                                             | AES-CTR          |  ✅  |     ✅     |   ✅   |    ✅     |

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ fun AlgorithmTestScope<*>.supportsDigest(digest: CryptographyAlgorithmId<Digest>`
`29`	`29`	`digest in sha3Algorithms &&`
`30`	`30`	`provider.isJdkDefault &&`
`31`	`31`	`(platform.isJdk { major < 17 } \|\| platform.isAndroid) -> "${digest.name} signatures on old JDK"`
	`32`	`+ digest == RIPEMD160 && (provider.isJdkDefault \|\| provider.isApple \|\| provider.isWebCrypto)`
	`33`	`+ -> digest.name`
`32`	`34`	`else -> null`
`33`	`35`	`}`
`34`	`36`	`}`