Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unit test on ScanEncryptorUtils. #8900

Merged
merged 2 commits into from
Sep 11, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
/*
* Copyright (c) 2024 New Vector Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.matrix.android.sdk.internal.session.contentscanner

import okio.ByteString.Companion.decodeBase64
import org.amshove.kluent.shouldBeEqualTo
import org.junit.Test
import org.matrix.android.sdk.api.session.crypto.attachments.ElementToDecrypt
import org.matrix.android.sdk.api.session.crypto.model.EncryptedFileInfo
import org.matrix.android.sdk.api.session.crypto.model.EncryptedFileKey
import org.matrix.android.sdk.internal.crypto.tools.withOlmDecryption
import org.matrix.android.sdk.internal.di.MoshiProvider
import org.matrix.android.sdk.internal.session.contentscanner.model.DownloadBody
import org.matrix.android.sdk.internal.session.contentscanner.model.EncryptedBody
import org.matrix.olm.OlmPkMessage

class ScanEncryptorUtilsTest {
private val anMxcUrl = "mxc://matrix.org/123456"
private val anElementToDecrypt = ElementToDecrypt(
k = "key",
iv = "iv",
sha256 = "sha256"
)
private val aPrivateKey = "CLYwNaeA9d0KHE0DniO1bxGgmNsPJ/pyanF4b4tcK1M="

@Test
fun whenNoServerKeyIsProvidedTheContentIsNotEncrypted() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and what happens when one is provided :D ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, at the beginning, the test was named whenServerKeyIsProvidedTheContentIsEncrypted, but then I renamed it. I will add another test to cover this.

val result = ScanEncryptorUtils.getDownloadBodyAndEncryptIfNeeded(
publicServerKey = null,
mxcUrl = anMxcUrl,
elementToDecrypt = anElementToDecrypt
)
result shouldBeEqualTo DownloadBody(
file = EncryptedFileInfo(
url = anMxcUrl,
iv = anElementToDecrypt.iv,
hashes = mapOf("sha256" to anElementToDecrypt.sha256),
key = EncryptedFileKey(
k = anElementToDecrypt.k,
alg = "A256CTR",
keyOps = listOf("encrypt", "decrypt"),
kty = "oct",
ext = true
),
v = "v2"
),
encryptedBody = null
)
}

@Test
fun checkThatTheCodeIsAbleToDecryptContent() {
System.loadLibrary("olm")
val clearInfo = ScanEncryptorUtils.getDownloadBodyAndEncryptIfNeeded(
publicServerKey = null,
mxcUrl = anMxcUrl,
elementToDecrypt = anElementToDecrypt
)
// Uncomment to get a new encrypted body
// val aPublicKey = "6n3l15JqsNhpM1OwRIoDCL/3c1B5idcwvy07Y5qFRyw="
// val encryptedBody = ScanEncryptorUtils.getDownloadBodyAndEncryptIfNeeded(
// publicServerKey = aPublicKey,
// mxcUrl = anMxcUrl,
// elementToDecrypt = anElementToDecrypt
// ).encryptedBody!!
// println("libolmEncryptedBody: $encryptedBody")
val libolmEncryptedBody = EncryptedBody(
cipherText = "GTnDhm6xe5fPe/QCr6fyGcZXheFhZlPG" +
"nJZiCK8Xwq6qTg71vSUGWtLdt3uaTmK7" +
"F7fB3PBKchHu2VVv6MMgo8fpUQ7KBbmu" +
"NWTrNmf3QdhXuRwUwz/q4GxsbGR2zjSX" +
"/UoE5S4ymVtOVhvSfXQfssN56wVIzC6S" +
"dy57y6b1IXPihlCUdvb8LMkMvViHYeNf" +
"beFrAfMlsyr1+jdZEXZF5Q7iruhsH2iu" +
"k7+Ayl9rdILCD5tjE9pezwe1V6uc/Agb",
mac = "Wk77HRg50oM",
ephemeral = "rMTK6/CGASinfX4USFS5qmD3r4meffxKc/jCSFIBczw"
)
// Try to decrypt the body
val result = withOlmDecryption { olmPkDecryption ->
olmPkDecryption.setPrivateKey(aPrivateKey.decodeBase64()!!.toByteArray())
olmPkDecryption.decrypt(
OlmPkMessage().apply {
mCipherText = libolmEncryptedBody.cipherText
mMac = libolmEncryptedBody.mac
mEphemeralKey = libolmEncryptedBody.ephemeral
}
)
}
val parseResult = MoshiProvider.providesMoshi()
.adapter(DownloadBody::class.java)
.fromJson(result)
parseResult shouldBeEqualTo clearInfo
}
}
Loading