kumi/Android-Password-Store
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

crypto: consistently use secret key nomenclature

Browse source
This commit is contained in:
Harsh Shandilya 2022-07-18 00:01:06 +05:30
parent 1f4ed1b194
commit 15f2489550
No known key found for this signature in database
GPG key ID: 366D7BBAD1031E80
8 changed files with 41 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
crypto-common/src/main/kotlin/app/passwordstore/crypto/CryptoHandler.kt
View file

@ -14,13 +14,13 @@ import java.io.OutputStream
public interface CryptoHandler<Key> { public interface CryptoHandler<Key> {
/** /**
* Decrypt the given [ciphertextStream] using a [privateKey] and [passphrase], and writes the * Decrypt the given [ciphertextStream] using a [secretKey] and [passphrase], and writes the
* resultant plaintext to [outputStream]. The returned [Result] should be checked to ensure it is * resultant plaintext to [outputStream]. The returned [Result] should be checked to ensure it is
* **not** an instance of [com.github.michaelbull.result.Err] before the contents of * **not** an instance of [com.github.michaelbull.result.Err] before the contents of
* [outputStream] are used. * [outputStream] are used.
*/ */
public fun decrypt( public fun decrypt(
privateKey: Key, secretKey: Key,
passphrase: String, passphrase: String,
ciphertextStream: InputStream, ciphertextStream: InputStream,
outputStream: OutputStream, outputStream: OutputStream,

4
crypto-pgpainless/src/main/kotlin/app/passwordstore/crypto/PGPainlessCryptoHandler.kt
View file

@ -31,13 +31,13 @@ import org.pgpainless.util.Passphrase
public class PGPainlessCryptoHandler @Inject constructor() : CryptoHandler<PGPKey> { public class PGPainlessCryptoHandler @Inject constructor() : CryptoHandler<PGPKey> {
public override fun decrypt( public override fun decrypt(
privateKey: PGPKey, secretKey: PGPKey,
passphrase: String, passphrase: String,
ciphertextStream: InputStream, ciphertextStream: InputStream,
outputStream: OutputStream, outputStream: OutputStream,
): Result<Unit, CryptoHandlerException> = ): Result<Unit, CryptoHandlerException> =
runCatching { runCatching {
val pgpSecretKeyRing = PGPainless.readKeyRing().secretKeyRing(privateKey.contents) val pgpSecretKeyRing = PGPainless.readKeyRing().secretKeyRing(secretKey.contents)
val keyringCollection = PGPSecretKeyRingCollection(listOf(pgpSecretKeyRing)) val keyringCollection = PGPSecretKeyRingCollection(listOf(pgpSecretKeyRing))
val protector = val protector =
PasswordBasedSecretKeyRingProtector.forKey( PasswordBasedSecretKeyRingProtector.forKey(

4
crypto-pgpainless/src/test/kotlin/app/passwordstore/crypto/KeyUtilsTest.kt
View file

@ -2,7 +2,7 @@ package app.passwordstore.crypto
import app.passwordstore.crypto.KeyUtils.tryGetId import app.passwordstore.crypto.KeyUtils.tryGetId
import app.passwordstore.crypto.KeyUtils.tryParseKeyring import app.passwordstore.crypto.KeyUtils.tryParseKeyring
import app.passwordstore.crypto.TestUtils.getArmoredPrivateKeyWithMultipleIdentities import app.passwordstore.crypto.TestUtils.getArmoredSecretKeyWithMultipleIdentities
import kotlin.test.Test import kotlin.test.Test
import kotlin.test.assertEquals import kotlin.test.assertEquals
import kotlin.test.assertIs import kotlin.test.assertIs
@ -12,7 +12,7 @@ import org.bouncycastle.openpgp.PGPSecretKeyRing
class KeyUtilsTest { class KeyUtilsTest {
@Test @Test
fun parseKeyWithMultipleIdentities() { fun parseKeyWithMultipleIdentities() {
val key = PGPKey(getArmoredPrivateKeyWithMultipleIdentities()) val key = PGPKey(getArmoredSecretKeyWithMultipleIdentities())
val keyring = tryParseKeyring(key) val keyring = tryParseKeyring(key)
assertNotNull(keyring) assertNotNull(keyring)
assertIs<PGPSecretKeyRing>(keyring) assertIs<PGPSecretKeyRing>(keyring)

55
crypto-pgpainless/src/test/kotlin/app/passwordstore/crypto/PGPKeyManagerTest.kt
View file

@ -2,7 +2,6 @@ package app.passwordstore.crypto
import app.passwordstore.crypto.GpgIdentifier.KeyId import app.passwordstore.crypto.GpgIdentifier.KeyId
import app.passwordstore.crypto.GpgIdentifier.UserId import app.passwordstore.crypto.GpgIdentifier.UserId
import app.passwordstore.crypto.TestUtils.getArmoredPrivateKeyWithMultipleIdentities
import app.passwordstore.crypto.errors.KeyAlreadyExistsException import app.passwordstore.crypto.errors.KeyAlreadyExistsException
import app.passwordstore.crypto.errors.KeyNotFoundException import app.passwordstore.crypto.errors.KeyNotFoundException
import app.passwordstore.crypto.errors.NoKeysAvailableException import app.passwordstore.crypto.errors.NoKeysAvailableException
@ -32,12 +31,12 @@ import org.junit.rules.TemporaryFolder
class PGPKeyManagerTest { class PGPKeyManagerTest {
@get:Rule val temporaryFolder: TemporaryFolder = TemporaryFolder() @get:Rule val temporaryFolder: TemporaryFolder = TemporaryFolder()
private val filesDir by unsafeLazy { temporaryFolder.root }
private val keysDir by unsafeLazy { File(filesDir, PGPKeyManager.KEY_DIR_NAME) }
private val dispatcher = StandardTestDispatcher() private val dispatcher = StandardTestDispatcher()
private val scope = TestScope(dispatcher) private val scope = TestScope(dispatcher)
private val filesDir by unsafeLazy { temporaryFolder.root }
private val keysDir by unsafeLazy { File(filesDir, PGPKeyManager.KEY_DIR_NAME) }
private val keyManager by unsafeLazy { PGPKeyManager(filesDir.absolutePath, dispatcher) } private val keyManager by unsafeLazy { PGPKeyManager(filesDir.absolutePath, dispatcher) }
private val privateKey = PGPKey(TestUtils.getArmoredPrivateKey()) private val secretKey = PGPKey(TestUtils.getArmoredSecretKey())
private val publicKey = PGPKey(TestUtils.getArmoredPublicKey()) private val publicKey = PGPKey(TestUtils.getArmoredPublicKey())
private fun <T> unsafeLazy(initializer: () -> T) = private fun <T> unsafeLazy(initializer: () -> T) =
@ -57,7 +56,7 @@ class PGPKeyManagerTest {
fun addKey() = fun addKey() =
scope.runTest { scope.runTest {
// Check if the key id returned is correct // Check if the key id returned is correct
val keyId = keyManager.getKeyId(keyManager.addKey(privateKey).unwrap()) val keyId = keyManager.getKeyId(keyManager.addKey(secretKey).unwrap())
assertEquals(KeyId(CryptoConstants.KEY_ID), keyId) assertEquals(KeyId(CryptoConstants.KEY_ID), keyId)
// Check if the keys directory have one file // Check if the keys directory have one file
@ -72,8 +71,8 @@ class PGPKeyManagerTest {
fun addKeyWithoutReplaceFlag() = fun addKeyWithoutReplaceFlag() =
scope.runTest { scope.runTest {
// Check adding the keys twice // Check adding the keys twice
keyManager.addKey(privateKey, false).unwrap() keyManager.addKey(secretKey, false).unwrap()
val error = keyManager.addKey(privateKey, false).unwrapError() val error = keyManager.addKey(secretKey, false).unwrapError()
assertIs<KeyAlreadyExistsException>(error) assertIs<KeyAlreadyExistsException>(error)
} }
@ -82,8 +81,8 @@ class PGPKeyManagerTest {
fun addKeyWithReplaceFlag() = fun addKeyWithReplaceFlag() =
scope.runTest { scope.runTest {
// Check adding the keys twice // Check adding the keys twice
keyManager.addKey(privateKey, true).unwrap() keyManager.addKey(secretKey, true).unwrap()
val keyId = keyManager.getKeyId(keyManager.addKey(privateKey, true).unwrap()) val keyId = keyManager.getKeyId(keyManager.addKey(secretKey, true).unwrap())
assertEquals(KeyId(CryptoConstants.KEY_ID), keyId) assertEquals(KeyId(CryptoConstants.KEY_ID), keyId)
} }
@ -92,10 +91,10 @@ class PGPKeyManagerTest {
fun removeKey() = fun removeKey() =
scope.runTest { scope.runTest {
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(privateKey).unwrap() keyManager.addKey(secretKey).unwrap()
// Check if the key id returned is correct // Check if the key id returned is correct
val keyId = keyManager.getKeyId(keyManager.removeKey(privateKey).unwrap()) val keyId = keyManager.getKeyId(keyManager.removeKey(secretKey).unwrap())
assertEquals(KeyId(CryptoConstants.KEY_ID), keyId) assertEquals(KeyId(CryptoConstants.KEY_ID), keyId)
// Check if the keys directory have 0 files // Check if the keys directory have 0 files
@ -107,42 +106,42 @@ class PGPKeyManagerTest {
fun getKeyById() = fun getKeyById() =
scope.runTest { scope.runTest {
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(privateKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = keyManager.getKeyId(privateKey) val keyId = keyManager.getKeyId(secretKey)
assertNotNull(keyId) assertNotNull(keyId)
assertEquals(KeyId(CryptoConstants.KEY_ID), keyManager.getKeyId(privateKey)) assertEquals(KeyId(CryptoConstants.KEY_ID), keyManager.getKeyId(secretKey))
// Check returned key id matches the expected id and the created key id // Check returned key id matches the expected id and the created key id
val returnedKey = keyManager.getKeyById(keyId).unwrap() val returnedKey = keyManager.getKeyById(keyId).unwrap()
assertEquals(keyManager.getKeyId(privateKey), keyManager.getKeyId(returnedKey)) assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey))
} }
@Test @Test
fun getKeyByFullUserId() = fun getKeyByFullUserId() =
scope.runTest { scope.runTest {
keyManager.addKey(privateKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = "${CryptoConstants.KEY_NAME} <${CryptoConstants.KEY_EMAIL}>" val keyId = "${CryptoConstants.KEY_NAME} <${CryptoConstants.KEY_EMAIL}>"
val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap() val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap()
assertEquals(keyManager.getKeyId(privateKey), keyManager.getKeyId(returnedKey)) assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey))
} }
@Test @Test
fun getKeyByEmailUserId() = fun getKeyByEmailUserId() =
scope.runTest { scope.runTest {
keyManager.addKey(privateKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = CryptoConstants.KEY_EMAIL val keyId = CryptoConstants.KEY_EMAIL
val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap() val returnedKey = keyManager.getKeyById(UserId(keyId)).unwrap()
assertEquals(keyManager.getKeyId(privateKey), keyManager.getKeyId(returnedKey)) assertEquals(keyManager.getKeyId(secretKey), keyManager.getKeyId(returnedKey))
} }
@Test @Test
fun getNonExistentKey() = fun getNonExistentKey() =
scope.runTest { scope.runTest {
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(privateKey).unwrap() keyManager.addKey(secretKey).unwrap()
val keyId = KeyId(0x08edf7567183ce44) val keyId = KeyId(0x08edf7567183ce44)
@ -169,8 +168,8 @@ class PGPKeyManagerTest {
assertEquals(0, noKeyList.size) assertEquals(0, noKeyList.size)
// Add key using KeyManager // Add key using KeyManager
keyManager.addKey(privateKey).unwrap() keyManager.addKey(secretKey).unwrap()
keyManager.addKey(PGPKey(getArmoredPrivateKeyWithMultipleIdentities())).unwrap() keyManager.addKey(PGPKey(TestUtils.getArmoredSecretKeyWithMultipleIdentities())).unwrap()
// Check if KeyManager returns one key // Check if KeyManager returns one key
val singleKeyList = keyManager.getAllKeys().unwrap() val singleKeyList = keyManager.getAllKeys().unwrap()
@ -180,7 +179,7 @@ class PGPKeyManagerTest {
@Test @Test
fun getMultipleIdentityKeyWithAllIdentities() { fun getMultipleIdentityKeyWithAllIdentities() {
scope.runTest { scope.runTest {
val key = PGPKey(getArmoredPrivateKeyWithMultipleIdentities()) val key = PGPKey(TestUtils.getArmoredSecretKeyWithMultipleIdentities())
keyManager.addKey(key).unwrap() keyManager.addKey(key).unwrap()
val johnKey = keyManager.getKeyById(UserId("john@doe.org")).unwrap() val johnKey = keyManager.getKeyById(UserId("john@doe.org")).unwrap()
@ -191,9 +190,9 @@ class PGPKeyManagerTest {
} }
@Test @Test
fun replacePrivateKeyWithPublicKey() { fun replaceSecretKeyWithPublicKey() {
scope.runTest { scope.runTest {
assertIs<Ok<PGPKey>>(keyManager.addKey(privateKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey))
assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(publicKey)) assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(publicKey))
} }
} }
@ -202,7 +201,7 @@ class PGPKeyManagerTest {
fun replacePublicKeyWithSecretKey() { fun replacePublicKeyWithSecretKey() {
scope.runTest { scope.runTest {
assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(publicKey))
assertIs<Ok<PGPKey>>(keyManager.addKey(privateKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey))
} }
} }
@ -222,8 +221,8 @@ class PGPKeyManagerTest {
@Test @Test
fun replaceSecretKeyWithSecretKey() { fun replaceSecretKeyWithSecretKey() {
scope.runTest { scope.runTest {
assertIs<Ok<PGPKey>>(keyManager.addKey(privateKey)) assertIs<Ok<PGPKey>>(keyManager.addKey(secretKey))
assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(privateKey)) assertIs<Err<KeyAlreadyExistsException>>(keyManager.addKey(secretKey))
} }
} }
} }

10
crypto-pgpainless/src/test/kotlin/app/passwordstore/crypto/PGPainlessCryptoHandlerTest.kt
View file

@ -22,8 +22,8 @@ import org.junit.runner.RunWith
@Suppress("Unused") // Test runner handles it internally @Suppress("Unused") // Test runner handles it internally
enum class EncryptionKey(val keySet: List<PGPKey>) { enum class EncryptionKey(val keySet: List<PGPKey>) {
PUBLIC(listOf(PGPKey(TestUtils.getArmoredPublicKey()))), PUBLIC(listOf(PGPKey(TestUtils.getArmoredPublicKey()))),
SECRET(listOf(PGPKey(TestUtils.getArmoredPrivateKey()))), SECRET(listOf(PGPKey(TestUtils.getArmoredSecretKey()))),
ALL(listOf(PGPKey(TestUtils.getArmoredPublicKey()), PGPKey(TestUtils.getArmoredPrivateKey()))), ALL(listOf(PGPKey(TestUtils.getArmoredPublicKey()), PGPKey(TestUtils.getArmoredSecretKey()))),
} }
@RunWith(TestParameterInjector::class) @RunWith(TestParameterInjector::class)
@ -31,7 +31,7 @@ class PGPainlessCryptoHandlerTest {
@TestParameter private lateinit var encryptionKey: EncryptionKey @TestParameter private lateinit var encryptionKey: EncryptionKey
private val cryptoHandler = PGPainlessCryptoHandler() private val cryptoHandler = PGPainlessCryptoHandler()
private val privateKey = PGPKey(TestUtils.getArmoredPrivateKey()) private val secretKey = PGPKey(TestUtils.getArmoredSecretKey())
@Test @Test
fun encryptAndDecrypt() { fun encryptAndDecrypt() {
@ -46,7 +46,7 @@ class PGPainlessCryptoHandlerTest {
val plaintextStream = ByteArrayOutputStream() val plaintextStream = ByteArrayOutputStream()
val decryptRes = val decryptRes =
cryptoHandler.decrypt( cryptoHandler.decrypt(
privateKey, secretKey,
CryptoConstants.KEY_PASSPHRASE, CryptoConstants.KEY_PASSPHRASE,
ciphertextStream.toByteArray().inputStream(), ciphertextStream.toByteArray().inputStream(),
plaintextStream, plaintextStream,
@ -68,7 +68,7 @@ class PGPainlessCryptoHandlerTest {
val plaintextStream = ByteArrayOutputStream() val plaintextStream = ByteArrayOutputStream()
val result = val result =
cryptoHandler.decrypt( cryptoHandler.decrypt(
privateKey, secretKey,
"very incorrect passphrase", "very incorrect passphrase",
ciphertextStream.toByteArray().inputStream(), ciphertextStream.toByteArray().inputStream(),
plaintextStream, plaintextStream,

6
crypto-pgpainless/src/test/kotlin/app/passwordstore/crypto/TestUtils.kt
View file

@ -7,10 +7,10 @@
package app.passwordstore.crypto package app.passwordstore.crypto
object TestUtils { object TestUtils {
fun getArmoredPrivateKey() = this::class.java.classLoader.getResource("private_key").readBytes() fun getArmoredSecretKey() = this::class.java.classLoader.getResource("secret_key").readBytes()
fun getArmoredPublicKey() = this::class.java.classLoader.getResource("public_key").readBytes() fun getArmoredPublicKey() = this::class.java.classLoader.getResource("public_key").readBytes()
fun getArmoredPrivateKeyWithMultipleIdentities() = fun getArmoredSecretKeyWithMultipleIdentities() =
this::class.java.classLoader.getResource("private_key_multiple_identities").readBytes() this::class.java.classLoader.getResource("secret_key_multiple_identities").readBytes()
fun getArmoredPublicKeyWithMultipleIdentities() = fun getArmoredPublicKeyWithMultipleIdentities() =
this::class.java.classLoader.getResource("public_key_multiple_identities").readBytes() this::class.java.classLoader.getResource("public_key_multiple_identities").readBytes()
} }

0
crypto-pgpainless/src/test/resources/private_key → crypto-pgpainless/src/test/resources/secret_key
View file

0
crypto-pgpainless/src/test/resources/private_key_multiple_identities → crypto-pgpainless/src/test/resources/secret_key_multiple_identities
View file