io.gatling.recorder.internal.bouncycastle.pkcs.jcajce.JcePBMac1CalculatorBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gatling-recorder-bc-shaded Show documentation
Show all versions of gatling-recorder-bc-shaded Show documentation
Shaded BouncyCastle for Gatling Recorder
package io.gatling.recorder.internal.bouncycastle.pkcs.jcajce;
import java.io.OutputStream;
import java.security.Provider;
import java.security.SecureRandom;
import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.SecretKeyFactory;
import io.gatling.recorder.internal.bouncycastle.asn1.DERNull;
import io.gatling.recorder.internal.bouncycastle.asn1.nist.NISTObjectIdentifiers;
import io.gatling.recorder.internal.bouncycastle.asn1.pkcs.PBKDF2Params;
import io.gatling.recorder.internal.bouncycastle.asn1.pkcs.PBMAC1Params;
import io.gatling.recorder.internal.bouncycastle.asn1.pkcs.PKCSObjectIdentifiers;
import io.gatling.recorder.internal.bouncycastle.asn1.x509.AlgorithmIdentifier;
import io.gatling.recorder.internal.bouncycastle.jcajce.io.MacOutputStream;
import io.gatling.recorder.internal.bouncycastle.jcajce.spec.PBKDF2KeySpec;
import io.gatling.recorder.internal.bouncycastle.jcajce.util.DefaultJcaJceHelper;
import io.gatling.recorder.internal.bouncycastle.jcajce.util.JcaJceHelper;
import io.gatling.recorder.internal.bouncycastle.jcajce.util.NamedJcaJceHelper;
import io.gatling.recorder.internal.bouncycastle.jcajce.util.ProviderJcaJceHelper;
import io.gatling.recorder.internal.bouncycastle.operator.DefaultMacAlgorithmIdentifierFinder;
import io.gatling.recorder.internal.bouncycastle.operator.GenericKey;
import io.gatling.recorder.internal.bouncycastle.operator.MacAlgorithmIdentifierFinder;
import io.gatling.recorder.internal.bouncycastle.operator.MacCalculator;
import io.gatling.recorder.internal.bouncycastle.operator.OperatorCreationException;
import io.gatling.recorder.internal.bouncycastle.util.BigIntegers;
/**
* A builder for RFC 8018 PBE based MAC calculators.
*
* By default the class uses HMAC-SHA256 as the PRF, with an iteration count of 8192. The default salt length
* is the output size of the MAC being used.
*
*/
public class JcePBMac1CalculatorBuilder
{
public static final AlgorithmIdentifier PRF_SHA224 = new AlgorithmIdentifier(PKCSObjectIdentifiers.id_hmacWithSHA224, DERNull.INSTANCE);
public static final AlgorithmIdentifier PRF_SHA256 = new AlgorithmIdentifier(PKCSObjectIdentifiers.id_hmacWithSHA256, DERNull.INSTANCE);
public static final AlgorithmIdentifier PRF_SHA384 = new AlgorithmIdentifier(PKCSObjectIdentifiers.id_hmacWithSHA384, DERNull.INSTANCE);
public static final AlgorithmIdentifier PRF_SHA512 = new AlgorithmIdentifier(PKCSObjectIdentifiers.id_hmacWithSHA512, DERNull.INSTANCE);
public static final AlgorithmIdentifier PRF_SHA3_224 = new AlgorithmIdentifier(NISTObjectIdentifiers.id_hmacWithSHA3_224);
public static final AlgorithmIdentifier PRF_SHA3_256 = new AlgorithmIdentifier(NISTObjectIdentifiers.id_hmacWithSHA3_256);
public static final AlgorithmIdentifier PRF_SHA3_384 = new AlgorithmIdentifier(NISTObjectIdentifiers.id_hmacWithSHA3_384);
public static final AlgorithmIdentifier PRF_SHA3_512 = new AlgorithmIdentifier(NISTObjectIdentifiers.id_hmacWithSHA3_512);
private static final DefaultMacAlgorithmIdentifierFinder defaultFinder = new DefaultMacAlgorithmIdentifierFinder();
private JcaJceHelper helper = new DefaultJcaJceHelper();
private AlgorithmIdentifier macAlgorithm;
private SecureRandom random;
private int saltLength = -1;
private int iterationCount = 8192;
private int keySize;
private PBKDF2Params pbeParams = null;
private AlgorithmIdentifier prf = PRF_SHA256;
private byte[] salt = null;
/**
* Base constructor - MAC name and key size.
*
* @param macAlgorithm name of the MAC algorithm.
* @param keySize the key size in bits.
*/
public JcePBMac1CalculatorBuilder(String macAlgorithm, int keySize)
{
this(macAlgorithm, keySize, defaultFinder);
}
/**
* Base constructor - MAC name and key size with a custom AlgorithmIdentifier finder for the MAC algorithm.
*
* @param macAlgorithm name of the MAC algorithm.
* @param keySize the key size in bits.
* @param algIdFinder an AlgorithmIdentifier finder containing the specified MAC name.
*/
public JcePBMac1CalculatorBuilder(String macAlgorithm, int keySize, MacAlgorithmIdentifierFinder algIdFinder)
{
this.macAlgorithm = algIdFinder.find(macAlgorithm);
this.keySize = keySize;
}
/**
* Base constructor from an ASN.1 parameter set. See RFC 8108 for details.
*
* @param pbeMacParams the ASN.1 parameters for the MAC calculator we want to create.
*/
public JcePBMac1CalculatorBuilder(PBMAC1Params pbeMacParams)
{
this.macAlgorithm = pbeMacParams.getMessageAuthScheme();
// TODO validate PBE scheme
this.pbeParams = PBKDF2Params.getInstance(pbeMacParams.getKeyDerivationFunc().getParameters());
}
public JcePBMac1CalculatorBuilder setProvider(Provider provider)
{
this.helper = new ProviderJcaJceHelper(provider);
return this;
}
public JcePBMac1CalculatorBuilder setProvider(String providerName)
{
this.helper = new NamedJcaJceHelper(providerName);
return this;
}
JcePBMac1CalculatorBuilder setHelper(JcaJceHelper helper)
{
this.helper = helper;
return this;
}
public JcePBMac1CalculatorBuilder setIterationCount(int iterationCount)
{
this.iterationCount = iterationCount;
return this;
}
/**
* Set the length of the salt in bytes.
* @param saltLength
* @return
*/
public JcePBMac1CalculatorBuilder setSaltLength(int saltLength)
{
this.saltLength = saltLength;
return this;
}
public JcePBMac1CalculatorBuilder setSalt(byte[] salt)
{
this.salt = salt;
return this;
}
public JcePBMac1CalculatorBuilder setRandom(SecureRandom random)
{
this.random = random;
return this;
}
public JcePBMac1CalculatorBuilder setPrf(AlgorithmIdentifier prf)
{
this.prf = prf;
return this;
}
public MacCalculator build(final char[] password)
throws OperatorCreationException
{
if (random == null)
{
random = new SecureRandom();
}
try
{
final Mac mac = helper.createMac(macAlgorithm.getAlgorithm().getId());
if (pbeParams == null)
{
if (salt == null)
{
if (saltLength < 0)
{
saltLength = mac.getMacLength();
}
salt = new byte[saltLength];
random.nextBytes(salt);
}
}
else
{
salt = pbeParams.getSalt();
iterationCount = BigIntegers.intValueExact(pbeParams.getIterationCount());
keySize = BigIntegers.intValueExact(pbeParams.getKeyLength()) * 8;
}
SecretKeyFactory secFact = helper.createSecretKeyFactory("PBKDF2");
final SecretKey key = secFact.generateSecret(new PBKDF2KeySpec(password, salt, iterationCount, keySize, prf));
mac.init(key);
return new MacCalculator()
{
public AlgorithmIdentifier getAlgorithmIdentifier()
{
return new AlgorithmIdentifier(PKCSObjectIdentifiers.id_PBMAC1,
new PBMAC1Params(
new AlgorithmIdentifier(PKCSObjectIdentifiers.id_PBES2, new PBKDF2Params(salt, iterationCount, (keySize + 7) / 8, prf)),
macAlgorithm));
}
public OutputStream getOutputStream()
{
return new MacOutputStream(mac);
}
public byte[] getMac()
{
return mac.doFinal();
}
public GenericKey getKey()
{
return new GenericKey(getAlgorithmIdentifier(), key.getEncoded());
}
};
}
catch (Exception e)
{
throw new OperatorCreationException("unable to create MAC calculator: " + e.getMessage(), e);
}
}
}