Class OpenSslJnaCipher

java.lang.Object
org.apache.commons.crypto.jna.OpenSslJnaCipher
All Implemented Interfaces:
Closeable, AutoCloseable, CryptoCipher
final class OpenSslJnaCipher extends Object implements CryptoCipher
Implements the CryptoCipher using JNA into OpenSSL.

  • Field Details

    • algo

      private com.sun.jna.ptr.PointerByReference algo

    • context

      private final com.sun.jna.ptr.PointerByReference context

    • algorithmMode

      private final OpenSslJnaCipher.AlgorithmMode algorithmMode

    • padding

      private final int padding

    • transformation

      private final String transformation

    • IV_LENGTH

      private final int IV_LENGTH
      See Also:

  • Constructor Details

  • Method Details

    • close

      public void close()
      Closes the OpenSSL cipher. Clean the OpenSsl native context.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • doFinal

      public int doFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException, IllegalBlockSizeException, BadPaddingException
      Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
      Specified by:
      doFinal in interface CryptoCipher
      Parameters:
      input - the input byte array
      inputOffset - the offset in input where the input starts
      inputLen - the input length
      output - the byte array for the result
      outputOffset - the offset in output where the result is stored
      Returns:
      the number of bytes stored in output
      Throws:
      ShortBufferException - if the given output byte array is too small to hold the result
      BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
      IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.

    • doFinal

      public int doFinal(ByteBuffer inBuffer, ByteBuffer outBuffer) throws ShortBufferException, IllegalBlockSizeException, BadPaddingException
      Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this cipher was initialized.
      Specified by:
      doFinal in interface CryptoCipher
      Parameters:
      inBuffer - the input ByteBuffer
      outBuffer - the output ByteBuffer
      Returns:
      int number of bytes stored in output
      Throws:
      BadPaddingException - if this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes
      IllegalBlockSizeException - if this cipher is a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.
      ShortBufferException - if the given output buffer is too small to hold the result

    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Object
      Throws:
      Throwable

    • getAlgorithm

      public String getAlgorithm()
      Description copied from interface: CryptoCipher
      Returns the algorithm name of this CryptoCipher object.

      This is the same name that was specified in one of the CryptoCipherFactory#getInstance calls that created this CryptoCipher object..

      Specified by:
      getAlgorithm in interface CryptoCipher
      Returns:
      the algorithm name of this CryptoCipher object.

    • getBlockSize

      public int getBlockSize()
      Description copied from interface: CryptoCipher
      Returns the block size (in bytes).
      Specified by:
      getBlockSize in interface CryptoCipher
      Returns:
      the block size (in bytes), or 0 if the underlying algorithm is not a block cipher

    • init

      public void init(int mode, Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException
      Initializes the cipher with mode, key and iv.
      Specified by:
      init in interface CryptoCipher
      Parameters:
      mode - Cipher.ENCRYPT_MODE or Cipher.DECRYPT_MODE
      key - crypto key for the cipher
      params - the algorithm parameters
      Throws:
      InvalidKeyException - If key length is invalid
      InvalidAlgorithmParameterException - if IV length is wrong

    • throwOnError

      private void throwOnError(int retVal)
      Parameters:
      retVal - the result value of error.

    • update

      public int update(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws ShortBufferException
      Continues a multiple-part encryption/decryption operation. The data is encrypted or decrypted, depending on how this cipher was initialized.
      Specified by:
      update in interface CryptoCipher
      Parameters:
      input - the input byte array
      inputOffset - the offset in input where the input starts
      inputLen - the input length
      output - the byte array for the result
      outputOffset - the offset in output where the result is stored
      Returns:
      the number of bytes stored in output
      Throws:
      ShortBufferException - if there is insufficient space in the output byte array

    • update

      public int update(ByteBuffer inBuffer, ByteBuffer outBuffer) throws ShortBufferException
      Continues a multiple-part encryption/decryption operation. The data is encrypted or decrypted, depending on how this cipher was initialized.
      Specified by:
      update in interface CryptoCipher
      Parameters:
      inBuffer - the input ByteBuffer
      outBuffer - the output ByteBuffer
      Returns:
      int number of bytes stored in output
      Throws:
      ShortBufferException - if there is insufficient space in the output buffer

    • updateAAD

      public void updateAAD(byte[] aad) throws IllegalArgumentException, IllegalStateException, UnsupportedOperationException
      Continues a multi-part update of the Additional Authentication Data (AAD).

      Calls to this method provide AAD to the opensslEngine when operating in modes such as AEAD (GCM). If this opensslEngine is operating in either GCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

      Specified by:
      updateAAD in interface CryptoCipher
      Parameters:
      aad - the buffer containing the Additional Authentication Data
      Throws:
      IllegalArgumentException - if the aad byte array is null
      IllegalStateException - if this opensslEngine is in a wrong state (e.g., has not been initialized), does not accept AAD, or if operating in either GCM mode and one of the update methods has already been called for the active encryption/decryption operation
      UnsupportedOperationException - if the implementation opensslEngine doesn't support this operation.

    • updateAAD

      public void updateAAD(ByteBuffer aad) throws IllegalArgumentException, IllegalStateException, UnsupportedOperationException
      Continues a multi-part update of the Additional Authentication Data (AAD).

      Calls to this method provide AAD to the opensslEngine when operating in modes such as AEAD (GCM). If this opensslEngine is operating in either GCM mode, all AAD must be supplied before beginning operations on the ciphertext (via the update and doFinal methods).

      Specified by:
      updateAAD in interface CryptoCipher
      Parameters:
      aad - the buffer containing the Additional Authentication Data
      Throws:
      IllegalArgumentException - if the aad byte array is null
      IllegalStateException - if this opensslEngine is in a wrong state (e.g., has not been initialized), does not accept AAD, or if operating in either GCM mode and one of the update methods has already been called for the active encryption/decryption operation
      UnsupportedOperationException - if the implementation opensslEngine doesn't support this operation.