org.bouncycastle.crypto.general.CAST5 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bc-fips Show documentation
Show all versions of bc-fips Show documentation
The FIPS 140-3 Bouncy Castle Crypto package is a Java implementation of cryptographic algorithms certified to FIPS 140-3 level 1. This jar contains JCE provider and low-level API for the BC-FJA version 2.0.0, FIPS Certificate #4743. Please see certificate for certified platform details.
package org.bouncycastle.crypto.general;
import java.security.SecureRandom;
import org.bouncycastle.crypto.Algorithm;
import org.bouncycastle.crypto.IllegalKeyException;
import org.bouncycastle.crypto.SymmetricKey;
import org.bouncycastle.crypto.SymmetricSecretKey;
import org.bouncycastle.crypto.internal.BlockCipher;
import org.bouncycastle.crypto.internal.BufferedBlockCipher;
import org.bouncycastle.crypto.internal.KeyGenerationParameters;
import org.bouncycastle.crypto.internal.Mac;
import org.bouncycastle.crypto.internal.ValidatedSymmetricKey;
import org.bouncycastle.crypto.internal.modes.AEADBlockCipher;
import org.bouncycastle.crypto.internal.params.KeyParameter;
import org.bouncycastle.crypto.internal.params.KeyParameterImpl;
import org.bouncycastle.util.Arrays;
import org.bouncycastle.util.encoders.Hex;
/**
* Source class for implementations of CAST5 based algorithms.
*/
public final class CAST5
{
private CAST5()
{
}
/**
* Raw CAST5 algorithm, can be used for creating general purpose CAST5 keys.
*/
public static final GeneralAlgorithm ALGORITHM = new GeneralAlgorithm("CAST5");
private static final EngineProvider ENGINE_PROVIDER;
static
{
EngineProvider provider = new EngineProvider();
provider.createEngine();
ENGINE_PROVIDER = provider;
}
/**
* CAST5 in electronic code book (ECB) mode.
*/
public static final Parameters ECB = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.ECB));
/**
* CAST5 in electronic code book mode with PKCS#7/PKCS#5 padding.
*/
public static final Parameters ECBwithPKCS7 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.ECB, Padding.PKCS7));
/**
* CAST5 in electronic code book mode with ISO10126-2 padding.
*/
public static final Parameters ECBwithISO10126_2 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.ECB, Padding.ISO10126_2));
/**
* CAST5 in electronic code book mode with X9.23 padding.
*/
public static final Parameters ECBwithX923 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.ECB, Padding.X923));
/**
* CAST5 in electronic code book mode with ISO7816-4 padding.
*/
public static final Parameters ECBwithISO7816_4 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.ECB, Padding.ISO7816_4));
/**
* CAST5 in electronic code book mode with trailing bit complement (TBC) padding.
*/
public static final Parameters ECBwithTBC = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.ECB, Padding.TBC));
/**
* CAST5 in cipher block chaining (CBC) mode.
*/
public static final Parameters CBC = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC));
/**
* CAST5 in cipher block chaining mode with PKCS#7/PKCS#5 padding.
*/
public static final Parameters CBCwithPKCS7 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.PKCS7));
/**
* CAST5 in cipher block chaining mode with ISO10126-2 padding.
*/
public static final Parameters CBCwithISO10126_2 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.ISO10126_2));
/**
* CAST5 in cipher block chaining mode with X9.23 padding.
*/
public static final Parameters CBCwithX923 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.X923));
/**
* CAST5 in cipher block chaining mode with ISO7816-4 padding.
*/
public static final Parameters CBCwithISO7816_4 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.ISO7816_4));
/**
* CAST5 in cipher block chaining mode with trailing bit complement (TBC) padding.
*/
public static final Parameters CBCwithTBC = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.TBC));
/**
* CAST5 in cipher block chaining mode cipher text stealing type 1.
*/
public static final Parameters CBCwithCS1 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.CS1));
/**
* CAST5 in cipher block chaining mode cipher text stealing type 2.
*/
public static final Parameters CBCwithCS2 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.CS2));
/**
* CAST5 in cipher block chaining mode cipher text stealing type 3.
*/
public static final Parameters CBCwithCS3 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CBC, Padding.CS3));
/**
* CAST5 in cipher feedback (CFB) mode, 8 bit block size.
*/
public static final Parameters CFB8 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CFB8));
/**
* CAST5 in cipher feedback (CFB) mode, 64 bit block size.
*/
public static final Parameters CFB64 = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CFB64));
/**
* CAST5 in output feedback (OFB) mode, 64 bit block size.
*/
public static final Parameters OFB = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.OFB64));
/**
* CAST5 in counter (CTR) mode.
*/
public static final Parameters CTR = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.CTR));
/**
* CAST5 in EAX mode..
*/
public static final AuthParameters EAX = new AuthParameters(new GeneralAlgorithm(ALGORITHM, Mode.EAX));
/**
* CAST5 in OpenPGP cipher feedback (CFB) mode.
*/
public static final Parameters OpenPGPCFB = new Parameters(new GeneralAlgorithm(ALGORITHM, Mode.OpenPGPCFB));
/**
* CAST5 cipher-based MAC algorithm.
*/
public static final AuthParameters CMAC = new AuthParameters(new GeneralAlgorithm(ALGORITHM, Mode.CMAC));
/**
* Parameters for general CAST5 block cipher modes.
*/
public static final class Parameters
extends GeneralParametersWithIV
{
private Parameters(GeneralAlgorithm algorithm, byte[] iv)
{
super(algorithm, 8, algorithm.checkIv(iv, 8));
}
Parameters(GeneralAlgorithm algorithm)
{
this(algorithm, null);
}
protected Parameters create(GeneralAlgorithm algorithm, byte[] iv)
{
return new Parameters(algorithm, iv);
}
}
/**
* Parameters for CAST5 AEAD and MAC modes..
*/
public static final class AuthParameters
extends GeneralAuthParameters
{
private AuthParameters(GeneralAlgorithm algorithm, byte[] iv, int macLenInBits)
{
super(algorithm, 8, iv, macLenInBits);
}
/**
* Base constructor - the algorithm, null IV.
* In this case the tag length defaults to the 64 for CMAC, 32 bits otherwise.
*
* @param algorithm algorithm mode.
*/
AuthParameters(GeneralAlgorithm algorithm)
{
this(algorithm, null, Utils.getDefaultMacSize(algorithm, 64)); // tag full blocksize or half
}
protected AuthParameters create(GeneralAlgorithm algorithm, byte[] iv, int macSizeInBits)
{
return new AuthParameters(algorithm, iv, macSizeInBits);
}
}
/**
* CAST5 key generator.
*/
public static final class KeyGenerator
extends GuardedSymmetricKeyGenerator
{
private final GeneralAlgorithm algorithm;
private final int keySizeInBits;
private final SecureRandom random;
public KeyGenerator(int keySizeInBits, SecureRandom random)
{
this(ALGORITHM, keySizeInBits, random);
}
public KeyGenerator(GeneralParameters parameterSet, int keySizeInBits, SecureRandom random)
{
this((GeneralAlgorithm)parameterSet.getAlgorithm(), keySizeInBits, random);
}
private KeyGenerator(GeneralAlgorithm algorithm, int keySizeInBits, SecureRandom random)
{
this.algorithm = algorithm;
if (invalidKeySize(keySizeInBits))
{
throw new IllegalArgumentException("Attempt to create key with invalid key size [" + keySizeInBits + "]: " + algorithm.getName());
}
this.keySizeInBits = keySizeInBits;
this.random = random;
}
public SymmetricKey doGenerateKey()
{
CipherKeyGenerator cipherKeyGenerator = new CipherKeyGenerator();
cipherKeyGenerator.init(new KeyGenerationParameters(random, keySizeInBits));
return new SymmetricSecretKey(algorithm, cipherKeyGenerator.generateKey());
}
}
/**
* Factory for basic CAST5 encryption/decryption operators.
*/
public static final class OperatorFactory
extends GuardedSymmetricOperatorFactory
{
@Override
protected BufferedBlockCipher createCipher(boolean forEncryption, SymmetricKey key, Parameters parameters, SecureRandom random)
{
return CipherUtils.createStandardCipher(forEncryption, validateKey(key, parameters.getAlgorithm()), ENGINE_PROVIDER, parameters, random);
}
}
/**
* Factory for CAST5 AEAD encryption/decryption operators.
*/
public static final class AEADOperatorFactory
extends GuardedAEADOperatorFactory
{
@Override
protected AEADBlockCipher createAEADCipher(boolean forEncryption, SymmetricKey key, AuthParameters parameters)
{
return CipherUtils.createStandardAEADCipher(forEncryption, validateKey(key, parameters.getAlgorithm()), ENGINE_PROVIDER, parameters);
}
}
/**
* Factory for producing CAST5 MAC calculators.
*/
public static final class MACOperatorFactory
extends GuardedMACOperatorFactory
{
@Override
protected Mac createMAC(SymmetricKey key, final AuthParameters parameters)
{
return CipherUtils.createStandardMac(validateKey(key, parameters.getAlgorithm()), ENGINE_PROVIDER, parameters);
}
@Override
protected int calculateMACSize(AuthParameters parameters)
{
return Utils.bitsToBytes(parameters.macLenInBits);
}
}
private static ValidatedSymmetricKey validateKey(SymmetricKey key, Algorithm algorithm)
{
ValidatedSymmetricKey vKey = PrivilegedUtils.getValidatedKey(key);
int keyLength = vKey.getKeySizeInBits();
if (invalidKeySize(keyLength))
{
throw new IllegalKeyException("CAST5 key must be between 40 and 128 bits inclusive");
}
Utils.checkKeyAlgorithm(vKey, ALGORITHM, algorithm);
return vKey;
}
private static boolean invalidKeySize(int keyLength)
{
return keyLength < 40 || keyLength > 128;
}
private static final class EngineProvider
implements org.bouncycastle.crypto.internal.EngineProvider
{
public BlockCipher createEngine()
{
return SelfTestExecutor.validate(ALGORITHM, new CAST5Engine(), new VariantKatTest()
{
public void evaluate(CAST5Engine engine)
{
byte[] input = Hex.decode("00112233445566778899aabbccddeeff");
byte[] output = Hex.decode("d211ebd0ac42e44ba357819b935d8470");
byte[] tmp = new byte[input.length];
KeyParameter key = new KeyParameterImpl(Hex.decode("101112131415161718191a1b1c1d1e1f"));
engine.init(true, key);
engine.processBlock(input, 0, tmp, 0);
engine.processBlock(input, 8, tmp, 8);
if (!Arrays.areEqual(output, tmp))
{
fail("Failed self test on encryption");
}
engine.init(false, key);
engine.processBlock(tmp, 0, tmp, 0);
engine.processBlock(tmp, 8, tmp, 8);
if (!Arrays.areEqual(input, tmp))
{
fail("Failed self test on decryption");
}
}
});
}
}
}