Package anbxj

Class Crypto_Config

java.lang.Object
anbxj.Crypto_Config
public class Crypto_Config extends Object
An abstract class for encryption configuration.

  • Field Details

    • cipherScheme

      protected String cipherScheme
      The cipher scheme.

    • keySize

      protected int keySize
      The key size.

    • keyGenerationScheme

      protected String keyGenerationScheme
      The key generation scheme.

    • keyGenerationSize

      protected int keyGenerationSize
      s The key generation size.

    • keyGenerationSchemePBE

      protected String keyGenerationSchemePBE
      The key generation scheme for password-based encryption (PBE).

    • keyPairGenerationScheme

      protected String keyPairGenerationScheme
      The key pair generation scheme.

    • keyPairGenerationSize

      protected int keyPairGenerationSize
      The key pair generation size.

    • secureRandomAlgorithm

      protected String secureRandomAlgorithm
      The secure random algorithm.

    • nonceSize

      protected int nonceSize
      Nonce length in bytes for protocol-level nonces and sequence numbers.

    • hmacAlgorithm

      protected String hmacAlgorithm
      The HMAC algorithm.

    • hmacKeySize

      protected int hmacKeySize
      The HMAC algorithm key size.

    • messageDigestAlgorithm

      protected String messageDigestAlgorithm
      The message digest algorithm.

    • messageDigestSignatureAlgorithm

      protected String messageDigestSignatureAlgorithm
      The message digest algorithm.

    • keyAgreementAlgorithm

      protected String keyAgreementAlgorithm
      The key agreement algorithm.

    • keyAgreementKeyPairGenerationScheme

      protected String keyAgreementKeyPairGenerationScheme
      The key pair generation for key agreement algorithm.

    • dhModulusSize

      protected int dhModulusSize
      The Diffie-Hellman random exponent size.

    • ecGenParameterSpec

      protected String ecGenParameterSpec
      The Elliptic Curve.

    • asymCipherSchemeBlock

      protected String asymCipherSchemeBlock
      The asymmetric cipher scheme block.

    • sslContext

      protected String sslContext
      The SSL context.

    • keyTypeToCipherMap

      protected Map<String,String> keyTypeToCipherMap
      Mapping of key algorithm names to cipher transformation strings. This map is pre-populated with the default entries defined in Crypto_Config_Default.defaultKeyTypeToCipherMap. You can override or extend it via your configuration file (e.g. properties entry "keyTypeToCipher") to handle any custom or provider-specific cipher transformations per key type.

    • keyTypeToSignatureMap

      protected Map<String,String> keyTypeToSignatureMap
      Mapping of asymmetric key algorithm names to signature algorithm names. This map is pre-populated with the default entries defined in Crypto_Config_Default.defaultKeyTypeToSignatureMap. You can override or extend it via your configuration file (e.g. properties entry "keyTypeToSignature") to handle any special or non-standard algorithm naming cases.

    • securityProvider

      protected String securityProvider
      The global security provider.

    • cipherSchemeProvider

      protected String cipherSchemeProvider
      The provider for cipher scheme.

    • keyGenerationSchemeProvider

      protected String keyGenerationSchemeProvider
      The provider for key generation.

    • keyGenerationSchemePBEProvider

      protected String keyGenerationSchemePBEProvider
      The provider for PBE key generation.

    • keyPairGenerationSchemeProvider

      protected String keyPairGenerationSchemeProvider
      The provider for key pair generation.

    • secureRandomProvider

      protected String secureRandomProvider
      The provider for secure random algorithm.

    • hmacProvider

      protected String hmacProvider
      The provider for HMAC algorithm.

    • messageDigestProvider

      protected String messageDigestProvider
      The provider for message digest algorithm.

    • signatureProvider

      protected String signatureProvider
      The provider for signature algorithm.

    • asymEncProvider

      protected String asymEncProvider
      The provider for signature algorithm.

    • keyAgreementProvider

      protected String keyAgreementProvider
      The provider for key agreement algorithm.

    • sslContextProvider

      protected String sslContextProvider
      The provider for ssl context.

    • useKeyEx

      protected boolean useKeyEx
      The protocol uses key exchange

    • useKeyStore

      protected boolean useKeyStore
      The protocol uses key a key store

    • sessions

      protected long sessions
      Number of sessions

    • parallelClients

      protected int parallelClients
      Number of parallel clients

    • multiThreadedTimeout

      protected long multiThreadedTimeout
      Idle timeout in milliseconds for the multi-threaded server. After this period of inactivity the server stops accepting new connections. Default value is 5000 (5 seconds).

    • parellelClientsInterval

      protected long parellelClientsInterval
      Sleep interval in milliseconds between two consecutive parallel client sessions. This delay is applied after each session to avoid overwhelming the system. Default value is 100.

    • multiThreaded

      protected boolean multiThreaded
      Flag indicating whether multi-threaded execution is enabled. When true the engine may start servers or parallel clients depending on the channel configuration. Default value is false.

    • useWarmUp

      protected boolean useWarmUp
      WarmUp crypto engine flag

  • Constructor Details

    • Crypto_Config

      public Crypto_Config()
      Constructs a Crypto_Config object with default values.

    • Crypto_Config

      public Crypto_Config(String cipherScheme, int keySize, String keyGenerationScheme, String keyGenerationSchemePBE, int keyGenerationSize, String keyPairGenerationScheme, int keyPairGenerationSize, String secureRandomAlgorithm, int nonceSize, String hmacAlgorithm, int hmacKeySize, String messageDigestAlgorithm, String messageDigestSignatureAlgorithm, String keyAgreementAlgorithm, String keyAgreementKeyPairGenerationScheme, int dhModulusSize, String ecGenParameterSpec, String asymCipherSchemeBlock, String sslContext, String keyTypeToCipher, String keyTypeToSignature, String securityProvider)
      Constructs a Crypto_Config object with a global provider.
      Parameters:
      cipherScheme - The cipher scheme.
      keySize - The key size.
      keyGenerationScheme - The key generation scheme.
      keyGenerationSchemePBE - The key generation scheme for password-based encryption (PBE).
      keyGenerationSize - The key generation size.
      keyPairGenerationScheme - The key pair generation scheme.
      keyPairGenerationSize - The key pair generation size.
      secureRandomAlgorithm - The secure random algorithm.
      nonceSize - The nonce size in bytes.
      hmacAlgorithm - The HMAC algorithm.
      hmacKeySize - The HMAC algorithm key size.
      messageDigestAlgorithm - The message digest algorithm.
      messageDigestSignatureAlgorithm - The message digest algorithm for signature.
      keyAgreementAlgorithm - The key agreement algorithm.
      keyAgreementKeyPairGenerationScheme - The key pair generation scheme for key agreement algorithm
      dhModulusSize - The Diffie-Hellman random exponent size.
      ecGenParameterSpec - The elliptic curve
      asymCipherSchemeBlock - The asymmetric cipher scheme block.
      sslContext - The SSL context.
      keyTypeToCipher - The key type to cipher mapping.
      keyTypeToSignature - The key type to signature algorithm mapping.
      securityProvider - The security provider.

    • Crypto_Config

      public Crypto_Config(String cipherScheme, int keySize, String keyGenerationScheme, String keyGenerationSchemePBE, int keyGenerationSize, String keyPairGenerationScheme, int keyPairGenerationSize, String secureRandomAlgorithm, int nonceSize, String hmacAlgorithm, int hmacKeySize, String messageDigestAlgorithm, String messageDigestSignatureAlgorithm, String keyAgreementAlgorithm, String keyAgreementKeyPairGenerationScheme, int dhModulusSize, String ecGenParameterSpec, String asymCipherSchemeBlock, String sslContext, String keyTypeToCipher, String keyTypeToSignature, String securityProvider, String cipherSchemeProvider, String keyGenerationSchemeProvider, String keyGenerationSchemePBEProvider, String keyPairGenerationSchemeProvider, String secureRandomProvider, String hmacProvider, String messageDigestProvider, String signatureProvider, String asymEncProvider, String keyAgreementProvider, String sslContextProvider)
      Constructs a Crypto_Config object with all the fine-grained providers.
      Parameters:
      cipherScheme - The cipher scheme.
      keySize - The key size.
      keyGenerationScheme - The key generation scheme.
      keyGenerationSchemePBE - The key generation scheme for password-based encryption (PBE).
      keyGenerationSize - The key generation size.
      keyPairGenerationScheme - The key pair generation scheme.
      keyPairGenerationSize - The key pair generation size.
      secureRandomAlgorithm - The secure random algorithm.
      nonceSize - The nonce size in bytes.
      hmacAlgorithm - The HMAC algorithm.
      hmacKeySize - The HMAC algorithm key size.
      messageDigestAlgorithm - The message digest algorithm.
      messageDigestSignatureAlgorithm - The message digest signature algorithm.
      keyAgreementAlgorithm - The key agreement algorithm.
      keyAgreementKeyPairGenerationScheme - The key pair generation scheme for key agreement algorithm
      dhModulusSize - The Diffie-Hellman random exponent size.
      ecGenParameterSpec - The elliptic curve
      asymCipherSchemeBlock - The asymmetric cipher scheme block.
      sslContext - The SSL context.
      keyTypeToCipher - The key type to cipher mapping.
      keyTypeToSignature - The key type to signature algorithm mapping.
      securityProvider - The global security provider.
      cipherSchemeProvider - The provider for cipher scheme.
      keyGenerationSchemeProvider - The provider for key generation.
      keyGenerationSchemePBEProvider - The provider for PBE key generation.
      keyPairGenerationSchemeProvider - The provider for key pair generation.
      secureRandomProvider - The provider for secure random algorithm.
      hmacProvider - The provider for HMAC algorithm.
      messageDigestProvider - The provider for message digest algorithm.
      signatureProvider - The provider for Signature
      asymEncProvider - The provider for asymmetric encryption.
      keyAgreementProvider - The provider for key agreement algorithm.
      sslContextProvider - The provider for SSL context.

    • Crypto_Config

      public Crypto_Config(Properties configFile)
      Constructs a Crypto_Config object from the properties specified in the given configuration file.
      Parameters:
      configFile - The properties configuration file.

  • Method Details

    • testStr

      public static boolean testStr(String str)
      Checks if a string is not null and not empty.
      Parameters:
      str - The string to test.
      Returns:
      true if the string is not null and not empty; false otherwise.

    • getInfo

      public void getInfo()
      Prints debug information about the crypto configuration.

    • getCipherScheme

      public String getCipherScheme()
      Returns the cipher scheme.
      Returns:
      The cipher scheme.

    • getKeySize

      public int getKeySize()
      Returns the key size.
      Returns:
      The key size.

    • getKeyGenerationScheme

      public String getKeyGenerationScheme()
      Returns the key generation scheme.
      Returns:
      The key generation scheme.

    • getKeyGenerationSize

      public int getKeyGenerationSize()
      Returns the key generation size.
      Returns:
      The key generation size.

    • getKeyPairGenerationScheme

      public String getKeyPairGenerationScheme()
      Returns the key pair generation scheme.
      Returns:
      The key pair generation scheme.

    • getKeyPairGenerationSize

      public int getKeyPairGenerationSize()
      Returns the key pair generation size.
      Returns:
      The key pair generation size.

    • getSecureRandomAlgorithm

      public String getSecureRandomAlgorithm()
      Returns the secure random algorithm.
      Returns:
      The secure random algorithm.

    • getNonceSize

      public int getNonceSize()
      Returns the nonce length in bytes.
      Returns:
      the nonce size in bytes

    • getHmacAlgorithm

      public String getHmacAlgorithm()
      Returns the HMAC algorithm.
      Returns:
      The HMAC algorithm.

    • getMessageDigestAlgorithm

      public String getMessageDigestAlgorithm()
      Returns the message digest algorithm.
      Returns:
      The message digest algorithm.

    • getMessageDigestSignatureAlgorithm

      public String getMessageDigestSignatureAlgorithm()
      Returns the message digest signature algorithm.
      Returns:
      The message digest signature algorithm.

    • getKeyAgreementAlgorithm

      public String getKeyAgreementAlgorithm()
      Returns the key agreement algorithm.
      Returns:
      The key agreement algorithm.

    • getKeyAgreementKeyPairGenerationScheme

      public String getKeyAgreementKeyPairGenerationScheme()
      Returns the key pair generation scheme for key agreement algorithm.
      Returns:
      The key pair generation scheme for key agreement algorithm.

    • getdhModulusSize

      public int getdhModulusSize()
      Returns the Diffie-Hellman random exponent size.
      Returns:
      The Diffie-Hellman random exponent size.

    • getEcGenParameterSpec

      public String getEcGenParameterSpec()
      Returns the Elliptic Curve.
      Returns:
      The Elliptic Curve

    • getAsymCipherSchemeBlock

      public String getAsymCipherSchemeBlock()
      Returns the asymmetric cipher scheme block.
      Returns:
      The asymmetric cipher scheme block.

    • getSslContext

      public String getSslContext()
      Returns the SSL context.
      Returns:
      The SSL context.

    • getAsymKeyTypeToCipherMap

      public Map<String,String> getAsymKeyTypeToCipherMap()
      Returns the asymmetric Key type to Cipher Map
      Returns:
      the asymmetric Key type to Cipher Map

    • getAsymKeyTypeToSignatureMap

      public Map<String,String> getAsymKeyTypeToSignatureMap()
      Returns the asymmetric Key type to Signature Map
      Returns:
      the asymmetric Key type to Signature Map

    • getSecurityProvider

      public String getSecurityProvider()
      Returns the global security provider.
      Returns:
      The global security provider.

    • getCipherSchemeProvider

      public String getCipherSchemeProvider()
      Returns the provider for the cipher scheme.
      Returns:
      The provider for the cipher scheme.

    • getkeyGenerationSchemeProvider

      public String getkeyGenerationSchemeProvider()
      Returns the provider for key generation.
      Returns:
      The provider for key generation.

    • getkeyGenerationSchemePBEProvider

      public String getkeyGenerationSchemePBEProvider()
      Returns the provider for PBE key generation.
      Returns:
      The provider for PBE key generation.

    • getKeyPairGenerationProvider

      public String getKeyPairGenerationProvider()
      Returns the provider for key pair generation.
      Returns:
      The provider for key pair generation.

    • getSecureRandomProvider

      public String getSecureRandomProvider()
      Returns the provider for secure random algorithm.
      Returns:
      The provider for secure random algorithm.

    • getHmacProvider

      public String getHmacProvider()
      Returns the provider for HMAC algorithm.
      Returns:
      The provider for HMAC algorithm.

    • getMessageDigestProvider

      public String getMessageDigestProvider()
      Returns the provider for message digest algorithm.
      Returns:
      The provider for message digest algorithm.

    • getSignatureProvider

      public String getSignatureProvider()
      Returns the provider for signature algorithm.
      Returns:
      The provider for signature algorithm.

    • getAsymEncProvider

      public String getAsymEncProvider()
      Returns the provider for asymmetric encryption algorithm.
      Returns:
      The provider for asymmetric encryption algorithm.

    • getKeyAgreementProvider

      public String getKeyAgreementProvider()
      Returns the provider for key agreement algorithm.
      Returns:
      The provider for key agreement algorithm.

    • getSslContextProvider

      public String getSslContextProvider()
      Returns the provider for SSL context.
      Returns:
      The provider for SSL context.

    • setUseKeyEx

      public void setUseKeyEx(boolean useKeyEx)
      Sets whether the protocol uses key exchange (e.g., Diffie-Hellman).
      Parameters:
      useKeyEx - true if the protocol uses key exchange, false otherwise

    • setUseKeyStore

      public void setUseKeyStore(boolean useKeyStore)
      Sets whether the protocol uses a key store (for asymmetric keys).
      Parameters:
      useKeyStore - true if the protocol uses a key store, false otherwise

    • setSessions

      public void setSessions(long sessions)
      Sets the number of sequential sessions to be executed.
      Parameters:
      sessions - the number of sessions (must be >= 1)

    • getUseKeyEx

      public boolean getUseKeyEx()
      Returns whether the protocol uses key exchange (e.g., Diffie-Hellman).
      Returns:
      true if the protocol uses key exchange, false otherwise

    • getUseKeyStore

      public boolean getUseKeyStore()
      Returns whether the protocol uses a key store (for asymmetric keys).
      Returns:
      true if the protocol uses a key store, false otherwise

    • getSessions

      public long getSessions()
      Returns the number of sequential sessions to be executed.
      Returns:
      the number of sessions

    • getParallelClients

      public int getParallelClients()
      Returns the configured number of parallel clients.
      Returns:
      the parallelClients

    • isMultiThreaded

      public boolean isMultiThreaded()
      Returns whether multi-threaded execution is enabled.
      Returns:
      the multiThreaded

    • getmultiThreadedTimeout

      public long getmultiThreadedTimeout()
      Returns the idle timeout (in milliseconds) for the multi-threaded server.
      Returns:
      the multiThreadedTimeout

    • getParellelClientsInterval

      public long getParellelClientsInterval()
      Returns the sleep interval (in milliseconds) between two consecutive parallel client sessions.
      Returns:
      the parellelClientsInterval

    • setProtocolFeatures

      public void setProtocolFeatures(boolean useWarmUp, boolean useKeyEx, boolean useKeyStore, long sessions, int parallelClients, long parellelClientsInterval, boolean multiThreaded, long multiThreadedTimeout)
      Configures the protocol usage parameters in one call.
      Parameters:
      useWarmUp - true to enable cryptographic engine warm-up, false otherwise
      useKeyEx - true if the crypto engine uses key exchange, false otherwise
      useKeyStore - true if the protocol uses a key store (for asymmetric keys), false otherwise
      sessions - the number of sequential sessions to be executed (must be >= 1)
      parallelClients - the number of parallel client sessions
      parellelClientsInterval - the sleep interval in milliseconds between two consecutive parallel client sessions
      multiThreaded - true to enable multi-threaded execution, false otherwise
      multiThreadedTimeout - the idle timeout in milliseconds for the multi-threaded server