Top Description Inners Fields Constructors Methods
org.bouncycastle.crypto.general

public final Class Serpent

extends Object
Class Inheritance
Imports
java.security.SecureRandom, org.bouncycastle.crypto.Algorithm, .IllegalKeyException, .ParametersWithIV, .SymmetricKey, .SymmetricSecretKey, org.bouncycastle.crypto.internal.BlockCipher, .BufferedBlockCipher, .KeyGenerationParameters, .Mac, .ValidatedSymmetricKey, .Wrapper, org.bouncycastle.crypto.internal.modes.AEADBlockCipher, org.bouncycastle.crypto.internal.params.KeyParameter, .KeyParameterImpl, org.bouncycastle.util.Arrays, org.bouncycastle.util.encoders.Hex

The Serpent encryption algorithm.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
Serpent.AEADOperatorFactory

Factory for Serpent AEAD encryption/decryption operators.

public static class
Serpent.AuthParameters

Parameters for Serpent AEAD and MAC modes.

private static class
public static class
Serpent.KeyGenerator

Serpent key generator.

public static class
Serpent.KeyWrapOperatorFactory

Factory for Serpent key wrap/unwrap operators.

public static class
Serpent.MACOperatorFactory

Factory for producing Serpent MAC calculators.

public static class
Serpent.OperatorFactory

Factory for basic Serpent encryption/decryption operators.

public static class
Serpent.Parameters

Parameters for general Serpent block cipher modes.

public static class
Serpent.WrapParameters

Serpent key wrap/unwrap operator parameters for KW and KWP.

Field Summary

Modifier and TypeField and Description
public static final GeneralAlgorithm
ALGORITHM

Raw Serpent algorithm, can be used for creating general purpose Serpent keys.

public static final Serpent.Parameters
CBC

Serpent in cipher block chaining (CBC) mode.

public static final Serpent.Parameters
CBCwithCS1

Serpent in cipher block chaining mode cipher text stealing type 1.

public static final Serpent.Parameters
CBCwithCS2

Serpent in cipher block chaining mode cipher text stealing type 2.

public static final Serpent.Parameters
CBCwithCS3

Serpent in cipher block chaining mode cipher text stealing type 3.

public static final Serpent.Parameters
CBCwithISO10126_2

Serpent in cipher block chaining mode with ISO10126-2 padding.

public static final Serpent.Parameters
CBCwithISO7816_4

Serpent in cipher block chaining mode with ISO7816-4 padding.

public static final Serpent.Parameters
CBCwithPKCS7

Serpent in cipher block chaining mode with PKCS#7/PKCS#5 padding.

public static final Serpent.Parameters
CBCwithTBC

Serpent in cipher block chaining mode with trailing bit complement (TBC) padding.

public static final Serpent.Parameters
CBCwithX923

Serpent in cipher block chaining mode with X9.23 padding.

public static final Serpent.AuthParameters
CCM

Serpent in counter with CBC-MAC (CCM).

public static final Serpent.Parameters
CFB128

Serpent in cipher feedback (CFB) mode, 128 bit block size.

public static final Serpent.Parameters
CFB8

Serpent in cipher feedback (CFB) mode, 8 bit block size.

public static final Serpent.AuthParameters
CMAC

Serpent cipher-based MAC algorithm.

public static final Serpent.Parameters
CTR

Serpent in counter (CTR) mode.

public static final Serpent.AuthParameters
EAX

Serpent in EAX mode.

public static final Serpent.Parameters
ECB

Serpent in electronic code book (ECB) mode.

public static final Serpent.Parameters
ECBwithISO10126_2

Serpent in electronic code book mode with ISO10126-2 padding.

public static final Serpent.Parameters
ECBwithISO7816_4

Serpent in electronic code book mode with ISO7816-4 padding.

public static final Serpent.Parameters
ECBwithPKCS7

Serpent in electronic code book mode with PKCS#7/PKCS#5 padding.

public static final Serpent.Parameters
ECBwithTBC

Serpent in electronic code book mode with trailing bit complement (TBC) padding.

public static final Serpent.Parameters
ECBwithX923

Serpent in electronic code book mode with X9.23 padding.

private static final Serpent.EngineProvider
public static final Serpent.AuthParameters
GCM

Serpent in Galois/Counter Mode (GCM).

public static final Serpent.AuthParameters
GMAC

Serpent cipher-based GMAC algorithm.

public static final Serpent.WrapParameters
KW

Serpent as a FIPS/RFC 3394 key wrapper.

public static final Serpent.WrapParameters
KWP

Serpent as a FIPS/RFC 3394 key wrapper with padding.

public static final Serpent.AuthParameters
OCB

Serpent in offset code book (OCB) mode.

public static final Serpent.Parameters
OFB

Serpent in output feedback (OFB) mode.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private static boolean
invalidKeySize(int keyLength)

private static ValidatedSymmetricKey
validateKey(SymmetricKey key, Algorithm paramAlgorithm)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALGORITHMback to summary
public static final GeneralAlgorithm ALGORITHM

Raw Serpent algorithm, can be used for creating general purpose Serpent keys.

CBCback to summary
public static final Serpent.Parameters CBC

Serpent in cipher block chaining (CBC) mode.

CBCwithCS1back to summary
public static final Serpent.Parameters CBCwithCS1

Serpent in cipher block chaining mode cipher text stealing type 1.

CBCwithCS2back to summary
public static final Serpent.Parameters CBCwithCS2

Serpent in cipher block chaining mode cipher text stealing type 2.

CBCwithCS3back to summary
public static final Serpent.Parameters CBCwithCS3

Serpent in cipher block chaining mode cipher text stealing type 3.

CBCwithISO10126_2back to summary
public static final Serpent.Parameters CBCwithISO10126_2

Serpent in cipher block chaining mode with ISO10126-2 padding.

CBCwithISO7816_4back to summary
public static final Serpent.Parameters CBCwithISO7816_4

Serpent in cipher block chaining mode with ISO7816-4 padding.

CBCwithPKCS7back to summary
public static final Serpent.Parameters CBCwithPKCS7

Serpent in cipher block chaining mode with PKCS#7/PKCS#5 padding.

CBCwithTBCback to summary
public static final Serpent.Parameters CBCwithTBC

Serpent in cipher block chaining mode with trailing bit complement (TBC) padding.

CBCwithX923back to summary
public static final Serpent.Parameters CBCwithX923

Serpent in cipher block chaining mode with X9.23 padding.

CCMback to summary
public static final Serpent.AuthParameters CCM

Serpent in counter with CBC-MAC (CCM).

CFB128back to summary
public static final Serpent.Parameters CFB128

Serpent in cipher feedback (CFB) mode, 128 bit block size.

CFB8back to summary
public static final Serpent.Parameters CFB8

Serpent in cipher feedback (CFB) mode, 8 bit block size.

CMACback to summary
public static final Serpent.AuthParameters CMAC

Serpent cipher-based MAC algorithm.

CTRback to summary
public static final Serpent.Parameters CTR

Serpent in counter (CTR) mode.

EAXback to summary
public static final Serpent.AuthParameters EAX

Serpent in EAX mode.

ECBback to summary
public static final Serpent.Parameters ECB

Serpent in electronic code book (ECB) mode.

ECBwithISO10126_2back to summary
public static final Serpent.Parameters ECBwithISO10126_2

Serpent in electronic code book mode with ISO10126-2 padding.

ECBwithISO7816_4back to summary
public static final Serpent.Parameters ECBwithISO7816_4

Serpent in electronic code book mode with ISO7816-4 padding.

ECBwithPKCS7back to summary
public static final Serpent.Parameters ECBwithPKCS7

Serpent in electronic code book mode with PKCS#7/PKCS#5 padding.

ECBwithTBCback to summary
public static final Serpent.Parameters ECBwithTBC

Serpent in electronic code book mode with trailing bit complement (TBC) padding.

ECBwithX923back to summary
public static final Serpent.Parameters ECBwithX923

Serpent in electronic code book mode with X9.23 padding.

ENGINE_PROVIDERback to summary
private static final Serpent.EngineProvider ENGINE_PROVIDER
GCMback to summary
public static final Serpent.AuthParameters GCM

Serpent in Galois/Counter Mode (GCM).

GMACback to summary
public static final Serpent.AuthParameters GMAC

Serpent cipher-based GMAC algorithm.

KWback to summary
public static final Serpent.WrapParameters KW

Serpent as a FIPS/RFC 3394 key wrapper.

KWPback to summary
public static final Serpent.WrapParameters KWP

Serpent as a FIPS/RFC 3394 key wrapper with padding.

OCBback to summary
public static final Serpent.AuthParameters OCB

Serpent in offset code book (OCB) mode.

OFBback to summary
public static final Serpent.Parameters OFB

Serpent in output feedback (OFB) mode.

Constructor Detail

Serpentback to summary
private Serpent()

Method Detail

invalidKeySizeback to summary
private static boolean invalidKeySize(int keyLength)
validateKeyback to summary
private static ValidatedSymmetricKey validateKey(SymmetricKey key, Algorithm paramAlgorithm)
org.bouncycastle.crypto.general back to summary

public final Class Serpent.AEADOperatorFactory

extends GuardedAEADOperatorFactory<Serpent.AuthParameters>
Class Inheritance

Factory for Serpent AEAD encryption/decryption operators.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected AEADBlockCipher
Inherited from org.bouncycastle.crypto.general.GuardedAEADOperatorFactory:
createInputAEADDecryptorcreateOutputAEADDecryptorcreateOutputAEADEncryptor

Constructor Detail

AEADOperatorFactoryback to summary
public AEADOperatorFactory()

Method Detail

createAEADCipherback to summary
protected AEADBlockCipher createAEADCipher(boolean forEncryption, SymmetricKey key, Serpent.AuthParameters parameters)

Implements abstract org.bouncycastle.crypto.general.GuardedAEADOperatorFactory.createAEADCipher.

Annotations
@Override
org.bouncycastle.crypto.general back to summary

public final Class Serpent.AuthParameters

extends GeneralAuthParameters<Serpent.AuthParameters>
Class Inheritance

Parameters for Serpent AEAD and MAC modes.

Field Summary

Inherited from org.bouncycastle.crypto.general.GeneralAuthParameters:
macLenInBits

Constructor Summary

AccessConstructor and Description
private
AuthParameters(GeneralAlgorithm algorithm, byte[] iv, int macLenInBits)

pack-priv
AuthParameters(GeneralAlgorithm
algorithm mode.
algorithm
)

Base constructor - the algorithm, null IV.

Method Summary

Modifier and TypeMethod and Description
protected Serpent.AuthParameters
create(GeneralAlgorithm algorithm, byte[] iv, int macSizeInBits)

Implements abstract org.bouncycastle.crypto.general.GeneralAuthParameters.create.

Inherited from org.bouncycastle.crypto.general.GeneralAuthParameters:
creategetMACSizeInBitswithIVwithMACSize

Constructor Detail

AuthParametersback to summary
private AuthParameters(GeneralAlgorithm algorithm, byte[] iv, int macLenInBits)
AuthParametersback to summary
pack-priv AuthParameters(GeneralAlgorithm algorithm)

Base constructor - the algorithm, null IV. In this case the tag length defaults to the 128 for GCM, CMAC, or GMAC, 64 bits otherwise.

Parameters
algorithm:GeneralAlgorithm

algorithm mode.

Method Detail

createback to summary
protected Serpent.AuthParameters create(GeneralAlgorithm algorithm, byte[] iv, int macSizeInBits)

Implements abstract org.bouncycastle.crypto.general.GeneralAuthParameters.create.

org.bouncycastle.crypto.general back to summary

private final Class Serpent.EngineProvider

extends Object
implements EngineProvider<BlockCipher>
Class Inheritance
All Implemented Interfaces
org.bouncycastle.crypto.internal.EngineProvider

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public BlockCipher
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

EngineProviderback to summary
private EngineProvider()

Method Detail

createEngineback to summary
public BlockCipher createEngine()

Implements org.bouncycastle.crypto.internal.EngineProvider.createEngine.

org.bouncycastle.crypto.general back to summary

public final Class Serpent.KeyGenerator

extends GuardedSymmetricKeyGenerator
Class Inheritance

Serpent key generator.

Field Summary

Modifier and TypeField and Description
private final GeneralAlgorithm
private final int
private final SecureRandom

Constructor Summary

AccessConstructor and Description
public
KeyGenerator(int keySizeInBits, SecureRandom random)

public
KeyGenerator(GeneralParameters<T extends Algorithm> parameterSet, int keySizeInBits, SecureRandom random)

private
KeyGenerator(GeneralAlgorithm algorithm, int keySizeInBits, SecureRandom random)

Method Summary

Modifier and TypeMethod and Description
public SymmetricKey
Inherited from org.bouncycastle.crypto.general.GuardedSymmetricKeyGenerator:
generateKey

Field Detail

algorithmback to summary
private final GeneralAlgorithm algorithm
keySizeInBitsback to summary
private final int keySizeInBits
randomback to summary
private final SecureRandom random

Constructor Detail

KeyGeneratorback to summary
public KeyGenerator(int keySizeInBits, SecureRandom random)
KeyGeneratorback to summary
public KeyGenerator(GeneralParameters<T extends Algorithm> parameterSet, int keySizeInBits, SecureRandom random)
KeyGeneratorback to summary
private KeyGenerator(GeneralAlgorithm algorithm, int keySizeInBits, SecureRandom random)

Method Detail

doGenerateKeyback to summary
public SymmetricKey doGenerateKey()

Implements abstract org.bouncycastle.crypto.general.GuardedSymmetricKeyGenerator.doGenerateKey.

org.bouncycastle.crypto.general back to summary

public final Class Serpent.KeyWrapOperatorFactory

extends GuardedKeyWrapOperatorFactory<Serpent.WrapParameters, SymmetricKey>
Class Inheritance

Factory for Serpent key wrap/unwrap operators.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected Wrapper
Inherited from org.bouncycastle.crypto.general.GuardedKeyWrapOperatorFactory:
createKeyUnwrappercreateKeyWrapper

Constructor Detail

KeyWrapOperatorFactoryback to summary
public KeyWrapOperatorFactory()

Method Detail

createWrapperback to summary
protected Wrapper createWrapper(boolean forWrapping, SymmetricKey key, Serpent.WrapParameters parameters, SecureRandom random)

Implements abstract org.bouncycastle.crypto.general.GuardedKeyWrapOperatorFactory.createWrapper.

org.bouncycastle.crypto.general back to summary

public final Class Serpent.MACOperatorFactory

extends GuardedMACOperatorFactory<Serpent.AuthParameters>
Class Inheritance

Factory for producing Serpent MAC calculators.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected int
protected Mac
Inherited from org.bouncycastle.crypto.general.GuardedMACOperatorFactory:
createOutputMACCalculator

Constructor Detail

MACOperatorFactoryback to summary
public MACOperatorFactory()

Method Detail

calculateMACSizeback to summary
protected int calculateMACSize(Serpent.AuthParameters parameters)

Implements abstract org.bouncycastle.crypto.general.GuardedMACOperatorFactory.calculateMACSize.

Annotations
@Override
createMACback to summary
protected Mac createMAC(SymmetricKey key, final Serpent.AuthParameters parameters)

Implements abstract org.bouncycastle.crypto.general.GuardedMACOperatorFactory.createMAC.

Annotations
@Override
org.bouncycastle.crypto.general back to summary

public final Class Serpent.OperatorFactory

extends GuardedSymmetricOperatorFactory<Serpent.Parameters>
Class Inheritance

Factory for basic Serpent encryption/decryption operators.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected BufferedBlockCipher
Inherited from org.bouncycastle.crypto.general.GuardedSymmetricOperatorFactory:
createInputDecryptorcreateOutputDecryptorcreateOutputEncryptor

Constructor Detail

OperatorFactoryback to summary
public OperatorFactory()

Method Detail

createCipherback to summary
protected BufferedBlockCipher createCipher(boolean forEncryption, SymmetricKey key, Serpent.Parameters parameters, SecureRandom random)

Implements abstract org.bouncycastle.crypto.general.GuardedSymmetricOperatorFactory.createCipher.

Annotations
@Override
org.bouncycastle.crypto.general back to summary

public final Class Serpent.Parameters

extends GeneralParametersWithIV<Serpent.Parameters>
Class Inheritance

Parameters for general Serpent block cipher modes.

Field Summary

Inherited from org.bouncycastle.crypto.general.GeneralParametersWithIV:
blockSizeiv

Constructor Summary

AccessConstructor and Description
private
Parameters(GeneralAlgorithm algorithm, byte[] iv)

pack-priv

Method Summary

Modifier and TypeMethod and Description
protected Serpent.Parameters
Inherited from org.bouncycastle.crypto.general.GeneralParametersWithIV:
getIVwithIVwithIV

Constructor Detail

Parametersback to summary
private Parameters(GeneralAlgorithm algorithm, byte[] iv)
Parametersback to summary
pack-priv Parameters(GeneralAlgorithm algorithm)

Method Detail

createback to summary
protected Serpent.Parameters create(GeneralAlgorithm algorithm, byte[] iv)

Implements abstract org.bouncycastle.crypto.general.GeneralParametersWithIV.create.

org.bouncycastle.crypto.general back to summary

public final Class Serpent.WrapParameters

extends GeneralParameters<GeneralAlgorithm>
implements ParametersWithIV
Class Inheritance
All Implemented Interfaces
org.bouncycastle.crypto.ParametersWithIV, org.bouncycastle.crypto.Parameters

Serpent key wrap/unwrap operator parameters for KW and KWP.

Field Summary

Modifier and TypeField and Description
private final byte[]
private final boolean

Constructor Summary

AccessConstructor and Description
pack-priv
private
WrapParameters(GeneralAlgorithm algorithm, byte[] iv, boolean useInverse)

Method Summary

Modifier and TypeMethod and Description
public byte[]
getIV()

Implements org.bouncycastle.crypto.ParametersWithIV.getIV.

Return the initialization vector associated with this parameter set.
private int
public boolean
public Serpent.WrapParameters
withIV(byte[]
the IV to use.
iv
)

Implements org.bouncycastle.crypto.ParametersWithIV.withIV.

Create a new parameter set with a different IV.
public Serpent.WrapParameters
withIV(SecureRandom
the SecureRandom to use as the source of IV data.
random
)

Implements org.bouncycastle.crypto.ParametersWithIV.withIV.

Create a new parameter set with a different IV based on the output of the passed in random.
public Serpent.WrapParameters
withUsingInverseFunction(boolean useInverse)

Inherited from org.bouncycastle.crypto.general.GeneralParameters:
getAlgorithm

Field Detail

ivback to summary
private final byte[] iv
useInverseback to summary
private final boolean useInverse

Constructor Detail

WrapParametersback to summary
pack-priv WrapParameters(GeneralAlgorithm algorithm)
WrapParametersback to summary
private WrapParameters(GeneralAlgorithm algorithm, byte[] iv, boolean useInverse)

Method Detail

getIVback to summary
public byte[] getIV()

Implements org.bouncycastle.crypto.ParametersWithIV.getIV.

Doc from org.bouncycastle.crypto.ParametersWithIV.getIV.

Return the initialization vector associated with this parameter set.

Returns:byte[]

the IV for these parameters.

getIvLengthback to summary
private int getIvLength()
isUsingInverseFunctionback to summary
public boolean isUsingInverseFunction()
withIVback to summary
public Serpent.WrapParameters withIV(byte[] iv)

Implements org.bouncycastle.crypto.ParametersWithIV.withIV.

Doc from org.bouncycastle.crypto.ParametersWithIV.withIV.

Create a new parameter set with a different IV.

Parameters
iv:byte[]

the IV to use.

Returns:Serpent.WrapParameters

a copy of the current parameter set with the new IV.

withIVback to summary
public Serpent.WrapParameters withIV(SecureRandom random)

Implements org.bouncycastle.crypto.ParametersWithIV.withIV.

Doc from org.bouncycastle.crypto.ParametersWithIV.withIV.

Create a new parameter set with a different IV based on the output of the passed in random.

Parameters
random:SecureRandom

the SecureRandom to use as the source of IV data.

Returns:Serpent.WrapParameters

a copy of the current parameter set with the new IV.

withUsingInverseFunctionback to summary
public Serpent.WrapParameters withUsingInverseFunction(boolean useInverse)