Initial commit.

mark.george / BouncyScrypt

Browse code Initial commit. master
0 parent commit 0835ab25757478175ed87cce357cf91b33860c23 Mark George authored on 16 Nov 2018

Patch

Showing 4 changed files

Ignore Space Show notes View .gitignore 0 → 100644
/build/ /dist/ /.gradle/ /.nb-gradle/ */nbproject/ .jar *.zip

Ignore Space Show notes View build.gradle 0 → 100644
plugins { id 'java' } repositories { jcenter() } dependencies { compile group: 'org.bouncycastle', name: 'bcprov-jdk15on', version: '1.60' testImplementation group: 'junit', name: 'junit', version: '4.12' testImplementation group: 'org.hamcrest', name: 'hamcrest-library', version: '1.3' } test.onlyIf { project.gradle.startParameter.taskNames.contains(':test'); }

Ignore Space Show notes View src/main/java/helpers/ScryptHelper.java 0 → 100644
package helpers; import java.nio.ByteBuffer; import java.nio.CharBuffer; import java.nio.charset.Charset; import java.security.NoSuchAlgorithmException; import java.security.SecureRandom; import java.util.Arrays; import java.util.Base64; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.bouncycastle.crypto.generators.SCrypt; /** * Wrapper for Bouncy Castle's scrypt implementation. * * Generates salted scrypt hashes in modular crypt format (MCF). * * @author Mark George <mark.george@otago.ac.nz> / public class ScryptHelper { // the standard work factors for scrypt private static final int N = 16384; private static final int r = 8; private static final int p = 1; private static final int saltSize = 32; private static final int dkLen = 32; private ScryptHelper() { } /* * Generates an MCF formatted salted scrypt hash for the password. * * @param password The password to hash. * @return The MCF formatted hash. / public static char[] hash(char[] password) { byte[] salt = salt(); byte[] hash = hash(password, salt, N, r, p, dkLen); Base64.Encoder encoder = Base64.getEncoder(); int costParams = (log2(N)) << 16 \| r << 8 \| p; CharBuffer mcf = CharBuffer.allocate(2 (saltSize + dkLen)); mcf.append("$").append(String.valueOf(costParams)); mcf.append("$").append(encoder.encodeToString(salt)); mcf.append("$").append(encoder.encodeToString(hash)); mcf.append("$"); return mcf.array(); } /** * Checks an MCF formatted hash (as generated by the hash method) against a * password. * * @param mcfHash The MCF formatted hash. * @param password The password. * * @return True if the password matches the hash, false if not. / public static boolean check(char[] mcfHash, char[] password) { Pattern regex = Pattern.compile("\\$(\\d+?)\\$(.+?)\\$(.+?)\\$."); CharBuffer mcfHashCb = CharBuffer.wrap(mcfHash); Matcher matcher = regex.matcher(mcfHashCb); if (matcher.matches()) { int costParams = Integer.parseInt(matcher.group(1)); Base64.Decoder decoder = Base64.getDecoder(); byte[] salt = decoder.decode(matcher.group(2)); byte[] hash = decoder.decode(matcher.group(3)); int hN = 1 << (costParams >> 16); int hr = costParams >> 8 & 255; int hp = costParams & 255; byte[] cHash = hash(password, salt, hN, hr, hp, hash.length); for (int i = 0; i < cHash.length; i++) { if (cHash[i] != hash[i]) { return false; } } return true; } else { throw new IllegalArgumentException("Hash is not in a recognisable format!"); } } /** * Overwrites the contents of a char array with zeros. * * @param chars char array to zero. / public static void zero(char[] chars) { Arrays.fill(chars, '0'); } static byte[] hash(char[] password, byte[] salt, int N, int r, int p, int dkLen) { return SCrypt.generate(toBytes(password), salt, N, r, p, dkLen); } static byte[] salt() { try { byte[] salt = new byte[saltSize]; SecureRandom.getInstance("SHA1PRNG").nextBytes(salt); return salt; } catch (NoSuchAlgorithmException ex) { throw new RuntimeException(ex); } } static int log2(int operand) { int result = 0; do { operand = operand >> 1; result++; } while (operand > 1); return result; } / * Source: https://stackoverflow.com/a/9670279 */ static byte[] toBytes(char[] chars) { CharBuffer charBuffer = CharBuffer.wrap(chars); ByteBuffer byteBuffer = Charset.forName("UTF-8").encode(charBuffer); byte[] bytes = Arrays.copyOfRange(byteBuffer.array(), byteBuffer.position(), byteBuffer.limit()); Arrays.fill(byteBuffer.array(), (byte) 0); return bytes; } public static void main(String[] args) throws Exception { // standard vector test byte[] hash = hash("pleaseletmein".toCharArray(), "SodiumChloride".getBytes("UTF-8"), 1 << 14, 8, 1, 64); // output should match https://tools.ietf.org/html/rfc7914.html#page-13 for (byte b : hash) { System.out.printf("%02x ", b); } System.out.println(); char[] aHash = hash("testing321".toCharArray()); System.out.println(aHash); System.out.println("Check (good password): " + check(aHash, "testing321".toCharArray())); System.out.println("Check (bad password): " + check(aHash, "testing123".toCharArray())); char[] bloogy = "bloogy".toCharArray(); System.out.println(bloogy); zero(bloogy); System.out.println(bloogy); } }

Ignore Space Show notes View

src/main/java/helpers/ScryptHelper.java 0 → 100644

package helpers;

import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.Charset;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.util.Arrays;
import java.util.Base64;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.bouncycastle.crypto.generators.SCrypt;

/**
 * Wrapper for Bouncy Castle's scrypt implementation.
 *
 * Generates salted scrypt hashes in modular crypt format (MCF).
 *
 * @author Mark George <mark.george@otago.ac.nz>
 */
public class ScryptHelper {

// the standard work factors for scrypt
	private static final int N = 16384;
	private static final int r = 8;
	private static final int p = 1;

private static final int saltSize = 32;
	private static final int dkLen = 32;

private ScryptHelper() {
	}

/**
	 * Generates an MCF formatted salted scrypt hash for the password.
	 *
	 * @param password The password to hash.
	 * @return The MCF formatted hash.
	 */
	public static char[] hash(char[] password) {
		byte[] salt = salt();
		byte[] hash = hash(password, salt, N, r, p, dkLen);

Base64.Encoder encoder = Base64.getEncoder();

int costParams = (log2(N)) << 16 | r << 8 | p;

CharBuffer mcf = CharBuffer.allocate(2 * (saltSize + dkLen));
		mcf.append("$").append(String.valueOf(costParams));
		mcf.append("$").append(encoder.encodeToString(salt));
		mcf.append("$").append(encoder.encodeToString(hash));
		mcf.append("$");

return mcf.array();
	}

/**
	 * Checks an MCF formatted hash (as generated by the hash method) against a
	 * password.
	 *
	 * @param mcfHash The MCF formatted hash.
	 * @param password The password.
	 *
	 * @return True if the password matches the hash, false if not.
	 */
	public static boolean check(char[] mcfHash, char[] password) {
		Pattern regex = Pattern.compile("\\$(\\d+?)\\$(.+?)\\$(.+?)\\$.*");

CharBuffer mcfHashCb = CharBuffer.wrap(mcfHash);

Matcher matcher = regex.matcher(mcfHashCb);

if (matcher.matches()) {
			int costParams = Integer.parseInt(matcher.group(1));

Base64.Decoder decoder = Base64.getDecoder();

byte[] salt = decoder.decode(matcher.group(2));
			byte[] hash = decoder.decode(matcher.group(3));

int hN = 1 << (costParams >> 16);
			int hr = costParams >> 8 & 255;
			int hp = costParams & 255;

byte[] cHash = hash(password, salt, hN, hr, hp, hash.length);

for (int i = 0; i < cHash.length; i++) {
				if (cHash[i] != hash[i]) {
					return false;
				}
			}

return true;

} else {
			throw new IllegalArgumentException("Hash is not in a recognisable format!");
		}

}

/**
	 * Overwrites the contents of a char array with zeros.
	 *
	 * @param chars char array to zero.
	 */
	public static void zero(char[] chars) {
		Arrays.fill(chars, '0');
	}

static byte[] hash(char[] password, byte[] salt, int N, int r, int p, int dkLen) {
		return SCrypt.generate(toBytes(password), salt, N, r, p, dkLen);
	}

static byte[] salt() {
		try {
			byte[] salt = new byte[saltSize];
			SecureRandom.getInstance("SHA1PRNG").nextBytes(salt);
			return salt;
		} catch (NoSuchAlgorithmException ex) {
			throw new RuntimeException(ex);
		}
	}

static int log2(int operand) {
		int result = 0;

do {
			operand = operand >> 1;
			result++;
		} while (operand > 1);

return result;
	}

/*
	 * Source: https://stackoverflow.com/a/9670279
	 */
	static byte[] toBytes(char[] chars) {
		CharBuffer charBuffer = CharBuffer.wrap(chars);
		ByteBuffer byteBuffer = Charset.forName("UTF-8").encode(charBuffer);
		byte[] bytes = Arrays.copyOfRange(byteBuffer.array(), byteBuffer.position(), byteBuffer.limit());
		Arrays.fill(byteBuffer.array(), (byte) 0);
		return bytes;
	}

public static void main(String[] args) throws Exception {
		// standard vector test
		byte[] hash = hash("pleaseletmein".toCharArray(), "SodiumChloride".getBytes("UTF-8"), 1 << 14, 8, 1, 64);

// output should match https://tools.ietf.org/html/rfc7914.html#page-13
		for (byte b : hash) {
			System.out.printf("%02x ", b);
		}
		System.out.println();

char[] aHash = hash("testing321".toCharArray());
		System.out.println(aHash);

System.out.println("Check (good password): " + check(aHash, "testing321".toCharArray()));
		System.out.println("Check (bad password): " + check(aHash, "testing123".toCharArray()));

char[] bloogy = "bloogy".toCharArray();
		System.out.println(bloogy);
		zero(bloogy);
		System.out.println(bloogy);
	}

}

Ignore Space Show notes View src/test/java/helpers/TestScryptHelper.java 0 → 100644
package helpers; import static org.hamcrest.Matchers.equalTo; import static org.junit.Assert.assertThat; import org.junit.Test; public class TestScryptHelper { @Test public void testStandardVector1() throws Exception { /* Check against the test vectors described at: https://tools.ietf.org/html/rfc7914#section-12 / byte[] standardVector = new byte[]{(byte) 0x70, (byte) 0x23, (byte) 0xbd, (byte) 0xcb, (byte) 0x3a, (byte) 0xfd, (byte) 0x73, (byte) 0x48, (byte) 0x46, (byte) 0x1c, (byte) 0x06, (byte) 0xcd, (byte) 0x81, (byte) 0xfd, (byte) 0x38, (byte) 0xeb, (byte) 0xfd, (byte) 0xa8, (byte) 0xfb, (byte) 0xba, (byte) 0x90, (byte) 0x4f, (byte) 0x8e, (byte) 0x3e, (byte) 0xa9, (byte) 0xb5, (byte) 0x43, (byte) 0xf6, (byte) 0x54, (byte) 0x5d, (byte) 0xa1, (byte) 0xf2, (byte) 0xd5, (byte) 0x43, (byte) 0x29, (byte) 0x55, (byte) 0x61, (byte) 0x3f, (byte) 0x0f, (byte) 0xcf, (byte) 0x62, (byte) 0xd4, (byte) 0x97, (byte) 0x05, (byte) 0x24, (byte) 0x2a, (byte) 0x9a, (byte) 0xf9, (byte) 0xe6, (byte) 0x1e, (byte) 0x85, (byte) 0xdc, (byte) 0x0d, (byte) 0x65, (byte) 0x1e, (byte) 0x40, (byte) 0xdf, (byte) 0xcf, (byte) 0x01, (byte) 0x7b, (byte) 0x45, (byte) 0x57, (byte) 0x58, (byte) 0x87}; char[] password = "pleaseletmein".toCharArray(); byte[] salt = "SodiumChloride".getBytes("UTF-8"); byte[] hash = ScryptHelper.hash(password, salt, 16384, 8, 1, 64); assertThat(hash, equalTo(standardVector)); } @Test public void testStandardVector2() throws Exception { / Check against the test vectors described at: https://tools.ietf.org/html/rfc7914#section-12 */ byte[] standardVector = new byte[]{(byte) 0xfd, (byte) 0xba, (byte) 0xbe, (byte) 0x1c, (byte) 0x9d, (byte) 0x34, (byte) 0x72, (byte) 0x00, (byte) 0x78, (byte) 0x56, (byte) 0xe7, (byte) 0x19, (byte) 0x0d, (byte) 0x01, (byte) 0xe9, (byte) 0xfe, (byte) 0x7c, (byte) 0x6a, (byte) 0xd7, (byte) 0xcb, (byte) 0xc8, (byte) 0x23, (byte) 0x78, (byte) 0x30, (byte) 0xe7, (byte) 0x73, (byte) 0x76, (byte) 0x63, (byte) 0x4b, (byte) 0x37, (byte) 0x31, (byte) 0x62, (byte) 0x2e, (byte) 0xaf, (byte) 0x30, (byte) 0xd9, (byte) 0x2e, (byte) 0x22, (byte) 0xa3, (byte) 0x88, (byte) 0x6f, (byte) 0xf1, (byte) 0x09, (byte) 0x27, (byte) 0x9d, (byte) 0x98, (byte) 0x30, (byte) 0xda, (byte) 0xc7, (byte) 0x27, (byte) 0xaf, (byte) 0xb9, (byte) 0x4a, (byte) 0x83, (byte) 0xee, (byte) 0x6d, (byte) 0x83, (byte) 0x60, (byte) 0xcb, (byte) 0xdf, (byte) 0xa2, (byte) 0xcc, (byte) 0x06, (byte) 0x40}; char[] password = "password".toCharArray(); byte[] salt = "NaCl".getBytes("UTF-8"); byte[] hash = ScryptHelper.hash(password, salt, 1024, 8, 16, 64); assertThat(hash, equalTo(standardVector)); } }

Ignore Space Show notes View

src/test/java/helpers/TestScryptHelper.java 0 → 100644

package helpers;

import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertThat;
import org.junit.Test;

public class TestScryptHelper {

@Test
	public void testStandardVector1() throws Exception {

/*
			Check against the test vectors described at:
				https://tools.ietf.org/html/rfc7914#section-12
		 */
		byte[] standardVector = new byte[]{(byte) 0x70, (byte) 0x23, (byte) 0xbd,
			(byte) 0xcb, (byte) 0x3a, (byte) 0xfd, (byte) 0x73, (byte) 0x48,
			(byte) 0x46, (byte) 0x1c, (byte) 0x06, (byte) 0xcd, (byte) 0x81,
			(byte) 0xfd, (byte) 0x38, (byte) 0xeb, (byte) 0xfd, (byte) 0xa8,
			(byte) 0xfb, (byte) 0xba, (byte) 0x90, (byte) 0x4f, (byte) 0x8e,
			(byte) 0x3e, (byte) 0xa9, (byte) 0xb5, (byte) 0x43, (byte) 0xf6,
			(byte) 0x54, (byte) 0x5d, (byte) 0xa1, (byte) 0xf2, (byte) 0xd5,
			(byte) 0x43, (byte) 0x29, (byte) 0x55, (byte) 0x61, (byte) 0x3f,
			(byte) 0x0f, (byte) 0xcf, (byte) 0x62, (byte) 0xd4, (byte) 0x97,
			(byte) 0x05, (byte) 0x24, (byte) 0x2a, (byte) 0x9a, (byte) 0xf9,
			(byte) 0xe6, (byte) 0x1e, (byte) 0x85, (byte) 0xdc, (byte) 0x0d,
			(byte) 0x65, (byte) 0x1e, (byte) 0x40, (byte) 0xdf, (byte) 0xcf,
			(byte) 0x01, (byte) 0x7b, (byte) 0x45, (byte) 0x57, (byte) 0x58,
			(byte) 0x87};

char[] password = "pleaseletmein".toCharArray();
		byte[] salt = "SodiumChloride".getBytes("UTF-8");

byte[] hash = ScryptHelper.hash(password, salt, 16384, 8, 1, 64);

assertThat(hash, equalTo(standardVector));
	}

@Test
	public void testStandardVector2() throws Exception {

/*
			Check against the test vectors described at:
				https://tools.ietf.org/html/rfc7914#section-12
		 */
		byte[] standardVector = new byte[]{(byte) 0xfd, (byte) 0xba, (byte) 0xbe,
			(byte) 0x1c, (byte) 0x9d, (byte) 0x34, (byte) 0x72, (byte) 0x00,
			(byte) 0x78, (byte) 0x56, (byte) 0xe7, (byte) 0x19, (byte) 0x0d,
			(byte) 0x01, (byte) 0xe9, (byte) 0xfe, (byte) 0x7c, (byte) 0x6a,
			(byte) 0xd7, (byte) 0xcb, (byte) 0xc8, (byte) 0x23, (byte) 0x78,
			(byte) 0x30, (byte) 0xe7, (byte) 0x73, (byte) 0x76, (byte) 0x63,
			(byte) 0x4b, (byte) 0x37, (byte) 0x31, (byte) 0x62, (byte) 0x2e,
			(byte) 0xaf, (byte) 0x30, (byte) 0xd9, (byte) 0x2e, (byte) 0x22,
			(byte) 0xa3, (byte) 0x88, (byte) 0x6f, (byte) 0xf1, (byte) 0x09,
			(byte) 0x27, (byte) 0x9d, (byte) 0x98, (byte) 0x30, (byte) 0xda,
			(byte) 0xc7, (byte) 0x27, (byte) 0xaf, (byte) 0xb9, (byte) 0x4a,
			(byte) 0x83, (byte) 0xee, (byte) 0x6d, (byte) 0x83, (byte) 0x60,
			(byte) 0xcb, (byte) 0xdf, (byte) 0xa2, (byte) 0xcc, (byte) 0x06,
			(byte) 0x40};

char[] password = "password".toCharArray();
		byte[] salt = "NaCl".getBytes("UTF-8");

byte[] hash = ScryptHelper.hash(password, salt, 1024, 8, 16, 64);

assertThat(hash, equalTo(standardVector));
	}

}

Show line notes below