PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-12-25 04:17:59 +01:00
Code Issues Releases Wiki Activity

Use BCs Arrays.constantTimeAreEqual(char[], char[])

Browse source
This commit is contained in:
Paul Schaub 2022-09-29 12:50:32 +02:00
parent 749ce4b400
commit 4d68c22977
3 changed files with 10 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
pgpainless-core/src/main/java/org/pgpainless/util/BCUtil.java
View file

@ -1,54 +0,0 @@
// SPDX-FileCopyrightText: 2018 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0
package org.pgpainless.util;
public final class BCUtil {
private BCUtil() {
}
/**
* A constant time equals comparison - does not terminate early if
* test will fail. For best results always pass the expected value
* as the first parameter.
*
* TODO: This method was proposed as a patch to BC:
* https://github.com/bcgit/bc-java/pull/1141
* Replace usage of this method with upstream eventually.
* Remove once BC 172 gets released, given it contains the patch.
*
* @param expected first array
* @param supplied second array
* @return true if arrays equal, false otherwise.
*/
public static boolean constantTimeAreEqual(
char[] expected,
char[] supplied) {
if (expected == null || supplied == null) {
return false;
}
if (expected == supplied) {
return true;
}
int len = Math.min(expected.length, supplied.length);
int nonEqual = expected.length ^ supplied.length;
// do the char-wise comparison
for (int i = 0; i != len; i++) {
nonEqual |= (expected[i] ^ supplied[i]);
}
// If supplied is longer than expected, iterate over rest of supplied with NOPs
for (int i = len; i < supplied.length; i++) {
nonEqual |= ((byte) supplied[i] ^ (byte) ~supplied[i]);
}
return nonEqual == 0;
}
}

4
pgpainless-core/src/main/java/org/pgpainless/util/Passphrase.java
View file

@ -8,8 +8,6 @@ import javax.annotation.Nonnull;
import javax.annotation.Nullable; import javax.annotation.Nullable;
import java.util.Arrays; import java.util.Arrays;
import static org.pgpainless.util.BCUtil.constantTimeAreEqual;
public class Passphrase { public class Passphrase {
public final Object lock = new Object(); public final Object lock = new Object();
@ -165,6 +163,6 @@ public class Passphrase {
} }
Passphrase other = (Passphrase) obj; Passphrase other = (Passphrase) obj;
return (getChars() == null && other.getChars() == null) || return (getChars() == null && other.getChars() == null) ||
constantTimeAreEqual(getChars(), other.getChars()); org.bouncycastle.util.Arrays.constantTimeAreEqual(getChars(), other.getChars());
} }
} }

17
pgpainless-core/src/test/java/org/pgpainless/util/BCUtilTest.java
View file

@ -19,6 +19,7 @@ import org.bouncycastle.openpgp.PGPPublicKeyRing;
import org.bouncycastle.openpgp.PGPPublicKeyRingCollection; import org.bouncycastle.openpgp.PGPPublicKeyRingCollection;
import org.bouncycastle.openpgp.PGPSecretKeyRing; import org.bouncycastle.openpgp.PGPSecretKeyRing;
import org.bouncycastle.openpgp.PGPSecretKeyRingCollection; import org.bouncycastle.openpgp.PGPSecretKeyRingCollection;
import org.bouncycastle.util.Arrays;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.pgpainless.PGPainless; import org.pgpainless.PGPainless;
import org.pgpainless.algorithm.KeyFlag; import org.pgpainless.algorithm.KeyFlag;
@ -94,14 +95,14 @@ public class BCUtilTest {
@Test @Test
public void constantTimeAreEqualsTest() { public void constantTimeAreEqualsTest() {
char[] b = "Hello".toCharArray(); char[] b = "Hello".toCharArray();
assertTrue(BCUtil.constantTimeAreEqual(b, b)); assertTrue(Arrays.constantTimeAreEqual(b, b));
assertTrue(BCUtil.constantTimeAreEqual("Hello".toCharArray(), "Hello".toCharArray())); assertTrue(Arrays.constantTimeAreEqual("Hello".toCharArray(), "Hello".toCharArray()));
assertTrue(BCUtil.constantTimeAreEqual(new char[0], new char[0])); assertTrue(Arrays.constantTimeAreEqual(new char[0], new char[0]));
assertTrue(BCUtil.constantTimeAreEqual(new char[] {'H', 'e', 'l', 'l', 'o'}, "Hello".toCharArray())); assertTrue(Arrays.constantTimeAreEqual(new char[] {'H', 'e', 'l', 'l', 'o'}, "Hello".toCharArray()));
assertFalse(BCUtil.constantTimeAreEqual("Hello".toCharArray(), "Hello World".toCharArray())); assertFalse(Arrays.constantTimeAreEqual("Hello".toCharArray(), "Hello World".toCharArray()));
assertFalse(BCUtil.constantTimeAreEqual(null, "Hello".toCharArray())); assertFalse(Arrays.constantTimeAreEqual(null, "Hello".toCharArray()));
assertFalse(BCUtil.constantTimeAreEqual("Hello".toCharArray(), null)); assertFalse(Arrays.constantTimeAreEqual("Hello".toCharArray(), null));
assertFalse(BCUtil.constantTimeAreEqual(null, null)); assertFalse(Arrays.constantTimeAreEqual((char[]) null, null));
} }
} }