Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.wildfly.security.password.util.ModularCrypt Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.wildfly.security.password.util;
import static java.lang.Math.max;
import static org.wildfly.security.credential._private.ElytronMessages.log;
import static org.wildfly.security.password.interfaces.BSDUnixDESCryptPassword.ALGORITHM_BSD_CRYPT_DES;
import static org.wildfly.security.password.interfaces.SunUnixMD5CryptPassword.ALGORITHM_SUN_CRYPT_MD5;
import static org.wildfly.security.password.interfaces.SunUnixMD5CryptPassword.ALGORITHM_SUN_CRYPT_MD5_BARE_SALT;
import static org.wildfly.security.password.interfaces.UnixDESCryptPassword.ALGORITHM_CRYPT_DES;
import static org.wildfly.security.password.interfaces.UnixSHACryptPassword.ALGORITHM_CRYPT_SHA_256;
import static org.wildfly.security.password.interfaces.UnixSHACryptPassword.ALGORITHM_CRYPT_SHA_512;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.security.spec.InvalidKeySpecException;
import java.util.NoSuchElementException;
import org.wildfly.common.Assert;
import org.wildfly.common.codec.Base64Alphabet;
import org.wildfly.common.iteration.ByteIterator;
import org.wildfly.common.iteration.CodePointIterator;
import org.wildfly.security.password.Password;
import org.wildfly.security.password.interfaces.BCryptPassword;
import org.wildfly.security.password.interfaces.BSDUnixDESCryptPassword;
import org.wildfly.security.password.interfaces.MaskedPassword;
import org.wildfly.security.password.interfaces.SunUnixMD5CryptPassword;
import org.wildfly.security.password.interfaces.UnixDESCryptPassword;
import org.wildfly.security.password.interfaces.UnixMD5CryptPassword;
import org.wildfly.security.password.interfaces.UnixSHACryptPassword;
/**
* Helper utility methods for operation on passwords based on the Modular Crypt Format(MCF).
*
* @author Juraci Paixão Kröhling
* @author David M. Lloyd
*/
public final class ModularCrypt {
private ModularCrypt() {}
// the order or value of these numbers is not important, just their uniqueness
private static final int A_CRYPT_MD5 = 1;
private static final int A_BCRYPT = 2;
private static final int A_BSD_NT_HASH = 3;
private static final int A_CRYPT_SHA_256 = 4;
private static final int A_CRYPT_SHA_512 = 5;
private static final int A_SUN_CRYPT_MD5 = 6;
private static final int A_APACHE_HTDIGEST = 7;
private static final int A_BSD_CRYPT_DES = 8;
private static final int A_CRYPT_DES = 9;
private static final int A_SUN_CRYPT_MD5_BARE_SALT = 10;
private static final int A_MASKED = 11;
private static int doIdentifyAlgorithm(char[] chars) {
if (chars.length < 5) {
return 0;
}
if (chars[0] == '$') {
if (chars[2] == '$') {
switch (chars[1]) {
case '1': return A_CRYPT_MD5;
case '2': return A_BCRYPT;
case '3': return A_BSD_NT_HASH;
case '5': return A_CRYPT_SHA_256;
case '6': return A_CRYPT_SHA_512;
// 'P' == phpass
// 'H' == phpass
default: return 0;
}
} else if (chars[3] == '$') {
if (chars[1] == '2') {
if (chars[2] == 'a' || chars[2] == 'x' || chars[2] == 'y') {
// todo decide if we need a variation here
return A_BCRYPT;
} else {
return 0;
}
} else {
return 0;
}
} else if (chars[4] == '$' || chars[4] == ',') {
if (chars[1] == 'm' && chars[2] == 'd' && chars[3] == '5') { //$md5$
int idx = lastIndexOf(chars, '$');
if (idx > 0) {
if (chars[idx - 1] == '$') {
return A_SUN_CRYPT_MD5;
} else {
return A_SUN_CRYPT_MD5_BARE_SALT;
}
} else {
return 0;
}
} else {
return 0;
}
} else if (chars[5] == '$') {
if (chars[1] == 'a' && chars[2] == 'p' && chars[3] == 'r' && chars[4] == '1') { //$apr1$
return A_APACHE_HTDIGEST;
} else {
return 0;
}
} else if (chars[1] == 'm' && chars[2] == 'a' && chars[3] == 's' && chars[4] == 'k' && chars[5] == 'e' && chars[6] == 'd' && chars[7] == '-') { // $masked-
return A_MASKED;
}
else {
return 0;
}
} else if (chars[0] == '_') {
return A_BSD_CRYPT_DES;
} else if (chars.length == 13) {
return A_CRYPT_DES;
} else {
return 0;
}
}
/**
* Attempt to identify the algorithm used by the given crypt string password.
*
* @param chars the password crypt string characters
* @return the algorithm name, or {@code null} if no algorithm could be guessed
*/
public static String identifyAlgorithm(char[] chars) {
return getAlgorithmNameString(doIdentifyAlgorithm(chars));
}
private static String getAlgorithmNameString(final int id) {
switch (id) {
case A_CRYPT_MD5: return "crypt-md5";
case A_BCRYPT: return "bcrypt";
case A_BSD_NT_HASH: return "bsd-nt-hash";
case A_CRYPT_SHA_256: return ALGORITHM_CRYPT_SHA_256;
case A_CRYPT_SHA_512: return ALGORITHM_CRYPT_SHA_512;
case A_SUN_CRYPT_MD5: return ALGORITHM_SUN_CRYPT_MD5;
case A_APACHE_HTDIGEST: return "apache-htdigest";
case A_BSD_CRYPT_DES: return "bsd-crypt-des";
case A_CRYPT_DES: return "crypt-des";
case A_SUN_CRYPT_MD5_BARE_SALT: return ALGORITHM_SUN_CRYPT_MD5_BARE_SALT;
default: return null;
}
}
/**
* Encode the given {@link Password} to a char array.
*
* @param password the password to encode
* @return a char array representing the encoded password
* @throws InvalidKeySpecException if the given password is not supported or could be encoded
*/
public static char[] encode(Password password) throws InvalidKeySpecException {
StringBuilder b = getCryptStringToBuilder(password);
char[] chars = new char[b.length()];
b.getChars(0, b.length(), chars, 0);
return chars;
}
/**
* Encode the given {@link Password} to a string.
*
* @param password the password to encode
* @return a string representing the encoded password
* @throws InvalidKeySpecException if the given password is not supported or could be encoded
*/
public static String encodeAsString(Password password) throws InvalidKeySpecException {
return getCryptStringToBuilder(password).toString();
}
private static StringBuilder getCryptStringToBuilder(Password password) throws InvalidKeySpecException {
Assert.checkNotNullParam("password", password);
final StringBuilder b = new StringBuilder();
if (password instanceof BCryptPassword) {
BCryptPassword spec = (BCryptPassword) password;
b.append("$2a$");
if (spec.getIterationCount() < 10)
b.append(0);
b.append(spec.getIterationCount());
b.append("$");
ByteIterator.ofBytes(spec.getSalt()).base64Encode(BCRYPT, false).drainTo(b);
ByteIterator.ofBytes(spec.getHash()).base64Encode(BCRYPT, false).drainTo(b);
} else if (password instanceof BSDUnixDESCryptPassword) {
b.append('_');
final BSDUnixDESCryptPassword spec = (BSDUnixDESCryptPassword) password;
final int iterationCount = spec.getIterationCount();
b.appendCodePoint(MOD_CRYPT.encode(iterationCount & 0x3f));
b.appendCodePoint(MOD_CRYPT.encode((iterationCount >> 6) & 0x3f));
b.appendCodePoint(MOD_CRYPT.encode((iterationCount >> 12) & 0x3f));
b.appendCodePoint(MOD_CRYPT.encode((iterationCount >> 18) & 0x3f));
final int salt = spec.getSalt();
b.appendCodePoint(MOD_CRYPT.encode(salt & 0x3f));
b.appendCodePoint(MOD_CRYPT.encode((salt >> 6) & 0x3f));
b.appendCodePoint(MOD_CRYPT.encode((salt >> 12) & 0x3f));
b.appendCodePoint(MOD_CRYPT.encode((salt >> 18) & 0x3f));
ByteIterator.ofBytes(spec.getHash()).base64Encode(MOD_CRYPT, false).drainTo(b);
} else if (password instanceof UnixDESCryptPassword) {
final UnixDESCryptPassword spec = (UnixDESCryptPassword) password;
final short salt = spec.getSalt();
b.appendCodePoint(MOD_CRYPT.encode(salt & 0x3f));
b.appendCodePoint(MOD_CRYPT.encode((salt >> 6) & 0x3f));
ByteIterator.ofBytes(spec.getHash()).base64Encode(MOD_CRYPT, false).drainTo(b);
} else if (password instanceof UnixMD5CryptPassword) {
b.append("$1$");
final UnixMD5CryptPassword spec = (UnixMD5CryptPassword) password;
final byte[] salt = spec.getSalt();
for (final byte sb : salt) {
b.append((char) (sb & 0xff));
}
b.append('$');
ByteIterator.ofBytes(spec.getHash(), MD5_IDX).base64Encode(MOD_CRYPT_LE, false).drainTo(b);
} else if (password instanceof SunUnixMD5CryptPassword) {
final SunUnixMD5CryptPassword spec = (SunUnixMD5CryptPassword) password;
final int iterationCount = spec.getIterationCount();
if (iterationCount > 0) {
b.append("$md5,rounds=").append(iterationCount).append('$');
} else {
b.append("$md5$");
}
final byte[] salt = spec.getSalt();
for (final byte sb : salt) {
b.append((char) (sb & 0xff));
}
switch (spec.getAlgorithm()) {
case ALGORITHM_SUN_CRYPT_MD5: {
b.append("$$");
break;
}
case ALGORITHM_SUN_CRYPT_MD5_BARE_SALT: {
b.append("$");
break;
}
default: {
throw log.invalidKeySpecUnrecognizedKeySpecAlgorithm();
}
}
ByteIterator.ofBytes(spec.getHash(), MD5_IDX).base64Encode(MOD_CRYPT_LE, false).drainTo(b);
} else if (password instanceof UnixSHACryptPassword) {
final UnixSHACryptPassword spec = (UnixSHACryptPassword) password;
final int[] interleave;
switch (spec.getAlgorithm()) {
case ALGORITHM_CRYPT_SHA_256: {
b.append("$5$");
interleave = SHA_256_IDX;
break;
}
case ALGORITHM_CRYPT_SHA_512: {
b.append("$6$");
interleave = SHA_512_IDX;
break;
}
default: {
throw log.invalidKeySpecUnrecognizedKeySpecAlgorithm();
}
}
final int iterationCount = spec.getIterationCount();
if (iterationCount != 5_000) {
b.append("rounds=").append(iterationCount).append('$');
}
final byte[] salt = spec.getSalt();
for (final byte sb : salt) {
b.append((char) (sb & 0xff));
}
b.append('$');
ByteIterator.ofBytes(spec.getHash(), interleave).base64Encode(MOD_CRYPT_LE, false).drainTo(b);
} else if (password instanceof MaskedPassword) {
final MaskedPassword spec = (MaskedPassword) password;
b.append('$').append(spec.getAlgorithm()).append('$');
b.append(spec.getInitialKeyMaterial()).append('$');
b.append(spec.getIterationCount()).append('$');
ByteIterator.ofBytes(spec.getSalt()).base64Encode().drainTo(b).append('$');
ByteIterator.ofBytes(spec.getMaskedPasswordBytes()).base64Encode().drainTo(b);
if (spec.getInitializationVector() != null) {
b.append('$');
ByteIterator.ofBytes(spec.getInitializationVector()).base64Encode().drainTo(b);
}
} else {
throw log.invalidKeySpecPasswordSpecCannotBeRenderedAsString();
}
return b;
}
/**
* Decode the given string and creates a {@link Password} instance.
*
* @param cryptString the string representing the encoded format of the password
* @return a {@link Password} instance created from the given string
* @throws InvalidKeySpecException if the given password is not supported or could be decoded
*/
public static Password decode(String cryptString) throws InvalidKeySpecException {
Assert.checkNotNullParam("cryptString", cryptString);
return decode(cryptString.toCharArray());
}
/**
* Decode the given char array and creates a {@link Password} instance.
*
* @param cryptString the char array representing the encoded format of the password
* @return a {@link Password} instance created from the given string
* @throws InvalidKeySpecException if the given password is not supported or could be decoded
*/
public static Password decode(char[] cryptString) throws InvalidKeySpecException {
Assert.checkNotNullParam("cryptString", cryptString);
final int algorithmId = doIdentifyAlgorithm(cryptString);
switch (algorithmId) {
case A_CRYPT_MD5: {
return parseUnixMD5CryptPasswordString(cryptString);
}
case A_BCRYPT: {
return parseBCryptPasswordString(cryptString);
}
case A_BSD_NT_HASH: {
throw new UnsupportedOperationException("not supported yet");
}
case A_CRYPT_SHA_256: {
return parseUnixSHA256CryptPasswordString(cryptString);
}
case A_CRYPT_SHA_512: {
return parseUnixSHA512CryptPasswordString(cryptString);
}
case A_SUN_CRYPT_MD5: {
return parseSunUnixMD5CryptPasswordString(ALGORITHM_SUN_CRYPT_MD5, cryptString);
}
case A_SUN_CRYPT_MD5_BARE_SALT: {
return parseSunUnixMD5CryptPasswordString(ALGORITHM_SUN_CRYPT_MD5_BARE_SALT, cryptString);
}
case A_APACHE_HTDIGEST: {
throw new UnsupportedOperationException("not supported yet");
}
case A_BSD_CRYPT_DES: {
return parseBSDUnixDESCryptPasswordString(cryptString);
}
case A_CRYPT_DES: {
return parseUnixDESCryptPasswordString(cryptString);
}
case A_MASKED: {
return parseMaskedPasswordString(cryptString);
}
default: throw log.invalidKeySpecUnknownCryptStringAlgorithm();
}
}
public static Password createPassword(byte[] password, String algorithm) throws InvalidKeySpecException {
Assert.checkNotNullParam("password", password);
Assert.checkNotNullParam("algorithm", algorithm);
switch(algorithm) {
case UnixDESCryptPassword.ALGORITHM_CRYPT_DES: {
return createCryptBasedPassword(password);
}
case BSDUnixDESCryptPassword.ALGORITHM_BSD_CRYPT_DES: {
return createBsdCryptBasedPassword(password);
}
default: throw log.invalidKeySpecUnknownCryptStringAlgorithm();
}
}
public static void composePassword(ByteArrayOutputStream out, Password password) throws IOException {
Assert.checkNotNullParam("out", out);
Assert.checkNotNullParam("password", password);
if (password instanceof UnixDESCryptPassword) {
composeCryptBasedPassword(out, (UnixDESCryptPassword) password);
} else if (password instanceof BSDUnixDESCryptPassword) {
composeBsdCryptBasedPassword(out, (BSDUnixDESCryptPassword) password);
}
}
private static int parseModCryptIterationCount(final CodePointIterator reader, final int minIterations, final int maxIterations,
final int defaultIterations) throws InvalidKeySpecException {
int iterationCount;
final CodePointIterator dr = reader.delimitedBy('$');
try {
if (dr.limitedTo(7).contentEquals(CodePointIterator.ofString("rounds="))) {
iterationCount = 0;
int ch;
while (dr.hasNext()) {
ch = dr.next();
if (iterationCount != maxIterations) {
if (ch >= '0' && ch <= '9') {
// multiply by 10, add next
iterationCount = (iterationCount << 3) + (iterationCount << 1) + ch - '0';
if (iterationCount > maxIterations) {
// stop overflow
iterationCount = maxIterations;
}
}
} else {
throw log.invalidKeySpecInvalidCharacterEncountered();
}
}
if (! reader.hasNext()) {
throw log.invalidKeySpecNoIterationCountTerminatorGiven();
}
reader.next(); // skip $
} else {
iterationCount = defaultIterations;
}
} catch (NoSuchElementException ignored) {
throw log.invalidKeySpecUnexpectedEndOfInputString();
}
return max(minIterations, iterationCount);
}
private static int[] inverse(int[] orig) {
final int[] n = new int[orig.length];
for (int i = 0; i < orig.length; i ++) {
n[orig[i]] = i;
}
return n;
}
private static final int[] MD5_IDX = {
12, 6, 0,
13, 7, 1,
14, 8, 2,
15, 9, 3,
5, 10, 4,
11
};
private static final int[] MD5_IDX_REV = inverse(MD5_IDX);
private static final int[] SHA_256_IDX = {
20, 10, 0,
11, 1, 21,
2, 22, 12,
23, 13, 3,
14, 4, 24,
5, 25, 15,
26, 16, 6,
17, 7, 27,
8, 28, 18,
29, 19, 9,
30,
31
};
private static final int[] SHA_256_IDX_REV = inverse(SHA_256_IDX);
private static final int[] SHA_512_IDX = {
42, 21, 0,
1, 43, 22,
23, 2, 44,
45, 24, 3,
4, 46, 25,
26, 5, 47,
48, 27, 6,
7, 49, 28,
29, 8, 50,
51, 30, 9,
10, 52, 31,
32, 11, 53,
54, 33, 12,
13, 55, 34,
35, 14, 56,
57, 36, 15,
16, 58, 37,
38, 17, 59,
60, 39, 18,
19, 61, 40,
41, 20, 62,
63
};
private static final int[] SHA_512_IDX_REV = inverse(SHA_512_IDX);
private static Password parseUnixSHA256CryptPasswordString(char[] cryptString) throws InvalidKeySpecException {
assert cryptString[0] == '$'; // previously tested by doIdentifyAlgorithm
assert cryptString[1] == '5'; // previously tested by doIdentifyAlgorithm
assert cryptString[2] == '$'; // previously tested by doIdentifyAlgorithm
return parseUnixSHACryptPassword(cryptString, SHA_256_IDX_REV, ALGORITHM_CRYPT_SHA_256);
}
private static Password parseUnixSHA512CryptPasswordString(char[] cryptString) throws InvalidKeySpecException {
assert cryptString[0] == '$'; // previously tested by doIdentifyAlgorithm
assert cryptString[1] == '6'; // previously tested by doIdentifyAlgorithm
assert cryptString[2] == '$'; // previously tested by doIdentifyAlgorithm
return parseUnixSHACryptPassword(cryptString, SHA_512_IDX_REV, ALGORITHM_CRYPT_SHA_512);
}
private static Password parseUnixSHACryptPassword(final char[] cryptString, final int[] table, final String algorithm) throws InvalidKeySpecException {
CodePointIterator r = CodePointIterator.ofChars(cryptString, 3);
try {
final int iterationCount; // spec default
// iteration count
iterationCount = parseModCryptIterationCount(r, 1_000, 999_999_999, 5_000);
byte[] salt = r.delimitedBy('$').drainToString().getBytes(StandardCharsets.ISO_8859_1);
if (! r.hasNext()) {
throw log.invalidKeySpecNoSaltTerminatorGiven();
}
r.next(); // skip $
final byte[] decoded = r.base64Decode(MOD_CRYPT_LE, false).limitedTo(table.length).drain();
if (decoded.length != table.length) {
throw log.invalidHashLength();
}
byte[] hash = ByteIterator.ofBytes(decoded, table).drain();
return UnixSHACryptPassword.createRaw(algorithm, salt, hash, iterationCount);
} catch (NoSuchElementException e) {
throw log.invalidKeySpecUnexpectedEndOfPasswordStringWithCause(e);
}
}
private static Password parseUnixMD5CryptPasswordString(final char[] cryptString) throws InvalidKeySpecException {
assert cryptString[0] == '$'; // previously tested by doIdentifyAlgorithm
assert cryptString[1] == '1'; // previously tested by doIdentifyAlgorithm
assert cryptString[2] == '$'; // previously tested by doIdentifyAlgorithm
CodePointIterator r = CodePointIterator.ofChars(cryptString, 3);
try {
final byte[] salt = r.delimitedBy('$').drainToString().getBytes(StandardCharsets.ISO_8859_1);
if (! r.hasNext()) {
throw log.invalidKeySpecNoSaltTerminatorGiven();
}
r.next(); // skip $
final byte[] decoded = r.base64Decode(MOD_CRYPT_LE, false).limitedTo(MD5_IDX_REV.length).drain();
if (decoded.length != MD5_IDX.length) {
throw log.invalidHashLength();
}
byte[] hash = ByteIterator.ofBytes(decoded, MD5_IDX_REV).drain();
return UnixMD5CryptPassword.createRaw(UnixMD5CryptPassword.ALGORITHM_CRYPT_MD5, salt, hash);
} catch (NoSuchElementException e) {
throw log.invalidKeySpecUnexpectedEndOfPasswordStringWithCause(e);
}
}
private static Password parseSunUnixMD5CryptPasswordString(final String algorithm, final char[] cryptString) throws InvalidKeySpecException {
assert cryptString[0] == '$'; // previously tested by doIdentifyAlgorithm
assert cryptString[1] == 'm'; // previously tested by doIdentifyAlgorithm
assert cryptString[2] == 'd'; // previously tested by doIdentifyAlgorithm
assert cryptString[3] == '5'; // previously tested by doIdentifyAlgorithm
assert (cryptString[4] == '$' || cryptString[4] == ','); // previously tested by doIdentifyAlgorithm
CodePointIterator r = CodePointIterator.ofChars(cryptString, 5);
try {
final int iterationCount;
if (cryptString[4] == ',') {
// The spec doesn't specify a maximum number of rounds but we're using 2,147,479,551
// to prevent overflow (2,147,483,647 - 4,096 = 2,147,479,551)
iterationCount = parseModCryptIterationCount(r, 0, 2_147_479_551, 0);
} else {
iterationCount = 0;
}
final byte[] salt = r.delimitedBy('$').drainToString().getBytes(StandardCharsets.ISO_8859_1);
if (! r.hasNext()) {
throw log.invalidKeySpecNoSaltTerminatorGiven();
}
r.next();
// Consume the second '$' after the salt, if present. Note that crypt strings returned
// by the Sun implementation can have one of the following two formats:
// 1) $md5[,rounds={rounds}]${salt}$${hash} (this format is more common)
// 2) $md5[,rounds={rounds}]${salt}${hash} (because there's only a single '$' after the
// salt, this is referred to as a "bare salt")
if (algorithm.equals(ALGORITHM_SUN_CRYPT_MD5) && r.hasNext() && r.peekNext() == '$') {
r.next(); // discard $
}
byte[] decoded = r.base64Decode(MOD_CRYPT_LE, false).limitedTo(MD5_IDX_REV.length).drain();
if (decoded.length != MD5_IDX.length) {
throw log.invalidHashLength();
}
byte[] hash = ByteIterator.ofBytes(decoded, MD5_IDX_REV).drain();
return SunUnixMD5CryptPassword.createRaw(algorithm, salt, hash, iterationCount);
} catch (NoSuchElementException e) {
throw log.invalidKeySpecUnexpectedEndOfPasswordStringWithCause(e);
}
}
private static Password parseBCryptPasswordString(final char[] cryptString) throws InvalidKeySpecException {
assert cryptString[0] == '$'; // previously tested by doIdentifyAlgorithm
assert cryptString[1] == '2'; // previously tested by doIdentifyAlgorithm
char minor = 0;
if (cryptString[2] != '$') {
minor = cryptString[2];
if (minor != 'a' && minor != 'x' && minor != 'y') {
throw log.invalidKeySpecInvalidMinorVersion();
}
assert cryptString[3] == '$';
}
CodePointIterator r = CodePointIterator.ofChars(cryptString, minor == 0 ? 3 : 4);
try {
// read the bcrypt cost (number of rounds in log format)
int cost = Integer.parseInt(r.limitedTo(2).drainToString());
if (r.hasNext() && r.peekNext() != '$') {
throw log.invalidKeySpecCostMustBeTwoDigitInteger();
}
// discard the '$'
if (! r.hasNext()) {
throw log.invalidKeySpecUnexpectedEndOfPasswordString();
}
r.next();
// the next 22 characters correspond to the encoded salt - it is mapped to a 16-byte array after decoding.
byte[] decodedSalt = r.limitedTo(22).base64Decode(BCRYPT, false).drain();
// the final 31 characters correspond to the encoded password - it is mapped to a 23-byte array after decoding.
byte[] decodedPassword = r.limitedTo(31).base64Decode(BCRYPT, false).drain();
return BCryptPassword.createRaw(BCryptPassword.ALGORITHM_BCRYPT, decodedPassword, decodedSalt, cost);
} catch (NoSuchElementException e) {
throw log.invalidKeySpecUnexpectedEndOfPasswordStringWithCause(e);
}
}
private static Password parseUnixDESCryptPasswordString(char[] cryptString) throws InvalidKeySpecException {
assert cryptString.length == 13; // previously tested by doIdentifyAlgorithm
CodePointIterator r = CodePointIterator.ofChars(cryptString);
// 12 bit salt
int s0 = MOD_CRYPT.decode(r.next());
int s1 = MOD_CRYPT.decode(r.next());
short salt = (short) (s0 | s1 << 6);
// 64 bit hash
byte[] hash = r.base64Decode(MOD_CRYPT, false).limitedTo(8).drain();
return UnixDESCryptPassword.createRaw(UnixDESCryptPassword.ALGORITHM_CRYPT_DES, salt, hash);
}
private static Password parseBSDUnixDESCryptPasswordString(char[] cryptString) throws InvalidKeySpecException {
// Note that crypt strings have the format: "_{rounds}{salt}{hash}" as described
// in the "DES Extended Format" section here: http://www.freebsd.org/cgi/man.cgi?crypt(3)
assert cryptString.length == 20;
assert cryptString[0] == '_'; // previously tested by doIdentifyAlgorithm
CodePointIterator r = CodePointIterator.ofChars(cryptString, 1);
// The next 4 characters correspond to the encoded number of rounds - this is decoded to a 24-bit integer
int s0 = MOD_CRYPT.decode(r.next());
int s1 = MOD_CRYPT.decode(r.next());
int s2 = MOD_CRYPT.decode(r.next());
int s3 = MOD_CRYPT.decode(r.next());
int iterationCount = s0 | s1 << 6 | s2 << 12 | s3 << 18;
// The next 4 characters correspond to the encoded salt - this is decoded to a 24-bit integer
s0 = MOD_CRYPT.decode(r.next());
s1 = MOD_CRYPT.decode(r.next());
s2 = MOD_CRYPT.decode(r.next());
s3 = MOD_CRYPT.decode(r.next());
int salt = s0 | s1 << 6 | s2 << 12 | s3 << 18;
// The final 11 characters correspond to the encoded password - this is decoded to a 64-bit hash
byte[] hash = r.base64Decode(MOD_CRYPT, false).limitedTo(11).drain();
return BSDUnixDESCryptPassword.createRaw(BSDUnixDESCryptPassword.ALGORITHM_BSD_CRYPT_DES, hash, salt, iterationCount);
}
private static Password parseMaskedPasswordString(char[] chars) throws InvalidKeySpecException {
assert chars[0] == '$' && chars[7] == '-';
CodePointIterator r = CodePointIterator.ofChars(chars, 1);
String algorithm = r.delimitedBy('$').drainToString();
if (! MaskedPassword.isMaskedAlgorithm(algorithm)) {
throw log.invalidKeySpecInvalidMinorVersion();
}
if (! r.hasNext()) throw log.invalidKeySpecNoSaltTerminatorGiven();
r.next(); // skip $ delimiter
char[] keyMaterial = r.delimitedBy('$').drainToString().toCharArray();
if (! r.hasNext()) throw log.invalidKeySpecNoSaltTerminatorGiven();
r.next(); // skip $ delimiter
int iterationCount = Integer.valueOf(r.delimitedBy('$').drainToString());
if (! r.hasNext()) throw log.invalidKeySpecNoSaltTerminatorGiven();
r.next(); // skip $ delimiter
byte[] salt = r.delimitedBy('$').base64Decode().drain();
if (! r.hasNext()) throw log.invalidKeySpecNoSaltTerminatorGiven();
r.next(); // skip $ delimiter
byte[] maskedPasswordBytes = r.delimitedBy('$').base64Decode().drain();
byte[] initializationVector = null;
if (r.hasNext()) { // has IV
r.next(); // skip $ delimiter
initializationVector = r.base64Decode().drain();
}
return MaskedPassword.createRaw(algorithm, keyMaterial, iterationCount, salt, maskedPasswordBytes, initializationVector);
}
private static int lastIndexOf(final char[] chars, final char c) {
for (int i = (chars.length - 1); i >= 0; i--) {
if (chars[i] == c) return i;
}
return -1;
}
private static Password createCryptBasedPassword(byte[] userPassword) throws InvalidKeySpecException {
if (userPassword.length != 20) {
throw log.insufficientDataToFormDigestAndSalt();
}
final int lo = MOD_CRYPT.decode(userPassword[7] & 0xff);
final int hi = MOD_CRYPT.decode(userPassword[8] & 0xff);
if (lo == -1 || hi == -1) {
throw log.invalidSalt((char) lo, (char) hi);
}
short salt = (short) (lo | hi << 6);
byte[] hash = CodePointIterator.ofUtf8Bytes(userPassword, 9, 11).base64Decode(MOD_CRYPT, false).drain();
return UnixDESCryptPassword.createRaw(ALGORITHM_CRYPT_DES, salt, hash);
}
private static Password createBsdCryptBasedPassword(byte[] userPassword) throws InvalidKeySpecException {
if (userPassword.length != 27) {
throw log.insufficientDataToFormDigestAndSalt();
}
int b0 = MOD_CRYPT.decode(userPassword[8] & 0xff);
int b1 = MOD_CRYPT.decode(userPassword[9] & 0xff);
int b2 = MOD_CRYPT.decode(userPassword[10] & 0xff);
int b3 = MOD_CRYPT.decode(userPassword[11] & 0xff);
if (b0 == -1 || b1 == -1 || b2 == -1 || b3 == -1) {
throw log.invalidRounds((char) b0, (char) b1, (char) b2, (char) b3);
}
int iterationCount = b0 | b1 << 6 | b2 << 12 | b3 << 18;
b0 = MOD_CRYPT.decode(userPassword[12] & 0xff);
b1 = MOD_CRYPT.decode(userPassword[13] & 0xff);
b2 = MOD_CRYPT.decode(userPassword[14] & 0xff);
b3 = MOD_CRYPT.decode(userPassword[15] & 0xff);
if (b0 == -1 || b1 == -1 || b2 == -1 || b3 == -1) {
throw log.invalidSalt((char) b0, (char) b1, (char) b2, (char) b3);
}
int salt = b0 | b1 << 6 | b2 << 12 | b3 << 18;
byte[] hash = CodePointIterator.ofUtf8Bytes(userPassword, 16, 11).base64Decode(MOD_CRYPT, false).drain();
return BSDUnixDESCryptPassword.createRaw(ALGORITHM_BSD_CRYPT_DES, hash, salt, iterationCount);
}
private static void composeCryptBasedPassword(ByteArrayOutputStream out, UnixDESCryptPassword password) throws IOException {
out.write(MOD_CRYPT.encode(password.getSalt() & 0x3f));
out.write(MOD_CRYPT.encode(password.getSalt() >> 6 & 0x3f));
out.write(ByteIterator.ofBytes(password.getHash()).base64Encode(MOD_CRYPT, false).asUtf8().drain());
}
private static void composeBsdCryptBasedPassword(ByteArrayOutputStream out, BSDUnixDESCryptPassword password) throws IOException {
out.write(MOD_CRYPT.encode(password.getIterationCount() & 0x3f));
out.write(MOD_CRYPT.encode(password.getIterationCount() >> 6 & 0x3f));
out.write(MOD_CRYPT.encode(password.getIterationCount() >> 12 & 0x3f));
out.write(MOD_CRYPT.encode(password.getIterationCount() >> 18 & 0x3f));
out.write(MOD_CRYPT.encode(password.getSalt() & 0x3f));
out.write(MOD_CRYPT.encode(password.getSalt() >> 6 & 0x3f));
out.write(MOD_CRYPT.encode(password.getSalt() >> 12 & 0x3f));
out.write(MOD_CRYPT.encode(password.getSalt() >> 18 & 0x3f));
out.write(ByteIterator.ofBytes(password.getHash()).base64Encode(MOD_CRYPT, false).asUtf8().drain());
}
/**
* The modular crypt alphabet, used in various modular crypt password types.
*/
static final Base64Alphabet MOD_CRYPT = new ModCryptBase64Alphabet(false);
/**
* The modular crypt alphabet, used in various modular crypt password types.
*/
static final Base64Alphabet MOD_CRYPT_LE = new ModCryptBase64Alphabet(true);
/**
* The BCrypt alphabet.
*/
static final Base64Alphabet BCRYPT = new Base64Alphabet(false) {
public int encode(final int val) {
if (val == 0) {
return '.';
} else if (val == 1) {
return '/';
} else if (val <= 27) {
return 'A' + val - 2;
} else if (val <= 53) {
return 'a' + val - 28;
} else {
assert val < 64;
return '0' + val - 54;
}
}
public int decode(final int codePoint) {
if (codePoint == '.') {
return 0;
} else if (codePoint == '/') {
return 1;
} else if ('A' <= codePoint && codePoint <= 'Z') {
return codePoint - 'A' + 2;
} else if ('a' <= codePoint && codePoint <= 'z') {
return codePoint - 'a' + 28;
} else if ('0' <= codePoint && codePoint <= '9') {
return codePoint - '0' + 54;
} else {
return -1;
}
}
};
private static class ModCryptBase64Alphabet extends Base64Alphabet {
ModCryptBase64Alphabet(final boolean littleEndian) {
super(littleEndian);
}
public int encode(final int val) {
if (val == 0) {
return '.';
} else if (val == 1) {
return '/';
} else if (val <= 11) {
return '0' + val - 2;
} else if (val <= 37) {
return 'A' + val - 12;
} else {
assert val < 64;
return 'a' + val - 38;
}
}
public int decode(final int codePoint) throws IllegalArgumentException {
if (codePoint == '.') {
return 0;
} else if (codePoint == '/') {
return 1;
} else if ('0' <= codePoint && codePoint <= '9') {
return codePoint - '0' + 2;
} else if ('A' <= codePoint && codePoint <= 'Z') {
return codePoint - 'A' + 12;
} else if ('a' <= codePoint && codePoint <= 'z') {
return codePoint - 'a' + 38;
} else {
return -1;
}
}
}
}
