Package org.bouncycastle.jcajce.provider.symmetric.util

## Class BaseWrapCipher

- java.lang.Object
- - javax.crypto.CipherSpi
  - - org.bouncycastle.jcajce.provider.symmetric.util.BaseWrapCipher

- All Implemented Interfaces:
    `PBE`
  Direct Known Subclasses:
    `AES.RFC3211Wrap`, `AES.RFC5649Wrap`, `AES.Wrap`, `AES.WrapPad`, `ARIA.RFC3211Wrap`, `ARIA.Wrap`, `ARIA.WrapPad`, `BaseBlockCipher`, `BaseStreamCipher`, `Camellia.RFC3211Wrap`, `Camellia.Wrap`, `DES.RFC3211`, `DESede.RFC3211`, `DESede.Wrap`, `DSTU7624.Wrap`, `DSTU7624.Wrap128`, `DSTU7624.Wrap256`, `DSTU7624.Wrap512`, `GOST28147.CryptoProWrap`, `GOST28147.GostWrap`, `RC2.Wrap`, `SEED.Wrap`

      public abstract class BaseWrapCipher
      extends javax.crypto.CipherSpi
      implements PBE

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class | Description
    --- | --- | ---
    `protected static class` | `BaseWrapCipher.ErasableOutputStream` |
    `protected static class` | `BaseWrapCipher.InvalidKeyOrParametersException` |

    - ### Nested classes/interfaces inherited from interface org.bouncycastle.jcajce.provider.symmetric.util.PBE

      `PBE.Util`

  - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected java.security.AlgorithmParameters` | `engineParams` |
    `protected int` | `pbeHash` |
    `protected int` | `pbeIvSize` |
    `protected int` | `pbeKeySize` |
    `protected int` | `pbeType` |
    `protected Wrapper` | `wrapEngine` |

    - ### Fields inherited from interface org.bouncycastle.jcajce.provider.symmetric.util.PBE

      `GOST3411, MD2, MD5, OPENSSL, PKCS12, PKCS5S1, PKCS5S1_UTF8, PKCS5S2, PKCS5S2_UTF8, RIPEMD160, SHA1, SHA224, SHA256, SHA3_224, SHA3_256, SHA3_384, SHA3_512, SHA384, SHA512, SM3, TIGER`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor | Description
    --- | --- | ---
    `protected` | `BaseWrapCipher()` |
    `protected` | `BaseWrapCipher​(Wrapper wrapEngine)` |
    `protected` | `BaseWrapCipher​(Wrapper wrapEngine, int ivSize)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected java.security.AlgorithmParameters` | `createParametersInstance​(java.lang.String algorithm)` |
    `protected byte[]` | `engineDoFinal​(byte[] input, int inputOffset, int inputLen)` |
    `protected int` | `engineDoFinal​(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)` |
    `protected int` | `engineGetBlockSize()` |
    `protected byte[]` | `engineGetIV()` |
    `protected int` | `engineGetKeySize​(java.security.Key key)` |
    `protected int` | `engineGetOutputSize​(int inputLen)` |
    `protected java.security.AlgorithmParameters` | `engineGetParameters()` |
    `protected void` | `engineInit​(int opmode, java.security.Key key, java.security.AlgorithmParameters params, java.security.SecureRandom random)` |
    `protected void` | `engineInit​(int opmode, java.security.Key key, java.security.SecureRandom random)` |
    `protected void` | `engineInit​(int opmode, java.security.Key key, java.security.spec.AlgorithmParameterSpec params, java.security.SecureRandom random)` |
    `protected void` | `engineSetMode​(java.lang.String mode)` |
    `protected void` | `engineSetPadding​(java.lang.String padding)` |
    `protected java.security.Key` | `engineUnwrap​(byte[] wrappedKey, java.lang.String wrappedKeyAlgorithm, int wrappedKeyType)` |
    `protected byte[]` | `engineUpdate​(byte[] input, int inputOffset, int inputLen)` |
    `protected int` | `engineUpdate​(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)` |
    `protected byte[]` | `engineWrap​(java.security.Key key)` |

    - ### Methods inherited from class javax.crypto.CipherSpi

      `engineDoFinal, engineUpdate, engineUpdateAAD, engineUpdateAAD`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### pbeType

          protected int pbeType

    - #### pbeHash

          protected int pbeHash

    - #### pbeKeySize

          protected int pbeKeySize

    - #### pbeIvSize

          protected int pbeIvSize

    - #### engineParams

          protected java.security.AlgorithmParameters engineParams

    - #### wrapEngine

          protected Wrapper wrapEngine

  - ### Constructor Detail

    - #### BaseWrapCipher

          protected BaseWrapCipher()

    - #### BaseWrapCipher

          protected BaseWrapCipher​(Wrapper wrapEngine)

    - #### BaseWrapCipher

          protected BaseWrapCipher​(Wrapper wrapEngine,
                                   int ivSize)

  - ### Method Detail

    - #### engineGetBlockSize

          protected int engineGetBlockSize()

      Specified by:
        `engineGetBlockSize` in class `javax.crypto.CipherSpi`

    - #### engineGetIV

          protected byte[] engineGetIV()

      Specified by:
        `engineGetIV` in class `javax.crypto.CipherSpi`

    - #### engineGetKeySize

          protected int engineGetKeySize​(java.security.Key key)

      Overrides:
        `engineGetKeySize` in class `javax.crypto.CipherSpi`

    - #### engineGetOutputSize

          protected int engineGetOutputSize​(int inputLen)

      Specified by:
        `engineGetOutputSize` in class `javax.crypto.CipherSpi`

    - #### engineGetParameters

          protected java.security.AlgorithmParameters engineGetParameters()

      Specified by:
        `engineGetParameters` in class `javax.crypto.CipherSpi`

    - #### createParametersInstance

          protected final java.security.AlgorithmParameters createParametersInstance​(java.lang.String algorithm)
                                                                              throws java.security.NoSuchAlgorithmException,
                                                                                     java.security.NoSuchProviderException

      Throws:
        `java.security.NoSuchAlgorithmException`
        `java.security.NoSuchProviderException`

    - #### engineSetMode

          protected void engineSetMode​(java.lang.String mode)
                                throws java.security.NoSuchAlgorithmException

      Specified by:
        `engineSetMode` in class `javax.crypto.CipherSpi`
      Throws:
        `java.security.NoSuchAlgorithmException`

    - #### engineSetPadding

          protected void engineSetPadding​(java.lang.String padding)
                                   throws javax.crypto.NoSuchPaddingException

      Specified by:
        `engineSetPadding` in class `javax.crypto.CipherSpi`
      Throws:
        `javax.crypto.NoSuchPaddingException`

    - #### engineInit

          protected void engineInit​(int opmode,
                                    java.security.Key key,
                                    java.security.spec.AlgorithmParameterSpec params,
                                    java.security.SecureRandom random)
                             throws java.security.InvalidKeyException,
                                    java.security.InvalidAlgorithmParameterException

      Specified by:
        `engineInit` in class `javax.crypto.CipherSpi`
      Throws:
        `java.security.InvalidKeyException`
        `java.security.InvalidAlgorithmParameterException`

    - #### engineInit

          protected void engineInit​(int opmode,
                                    java.security.Key key,
                                    java.security.AlgorithmParameters params,
                                    java.security.SecureRandom random)
                             throws java.security.InvalidKeyException,
                                    java.security.InvalidAlgorithmParameterException

      Specified by:
        `engineInit` in class `javax.crypto.CipherSpi`
      Throws:
        `java.security.InvalidKeyException`
        `java.security.InvalidAlgorithmParameterException`

    - #### engineInit

          protected void engineInit​(int opmode,
                                    java.security.Key key,
                                    java.security.SecureRandom random)
                             throws java.security.InvalidKeyException

      Specified by:
        `engineInit` in class `javax.crypto.CipherSpi`
      Throws:
        `java.security.InvalidKeyException`

    - #### engineUpdate

          protected byte[] engineUpdate​(byte[] input,
                                        int inputOffset,
                                        int inputLen)

      Specified by:
        `engineUpdate` in class `javax.crypto.CipherSpi`

    - #### engineUpdate

          protected int engineUpdate​(byte[] input,
                                     int inputOffset,
                                     int inputLen,
                                     byte[] output,
                                     int outputOffset)
                              throws javax.crypto.ShortBufferException

      Specified by:
        `engineUpdate` in class `javax.crypto.CipherSpi`
      Throws:
        `javax.crypto.ShortBufferException`

    - #### engineDoFinal

          protected byte[] engineDoFinal​(byte[] input,
                                         int inputOffset,
                                         int inputLen)
                                  throws javax.crypto.IllegalBlockSizeException,
                                         javax.crypto.BadPaddingException

      Specified by:
        `engineDoFinal` in class `javax.crypto.CipherSpi`
      Throws:
        `javax.crypto.IllegalBlockSizeException`
        `javax.crypto.BadPaddingException`

    - #### engineDoFinal

          protected int engineDoFinal​(byte[] input,
                                      int inputOffset,
                                      int inputLen,
                                      byte[] output,
                                      int outputOffset)
                               throws javax.crypto.IllegalBlockSizeException,
                                      javax.crypto.BadPaddingException,
                                      javax.crypto.ShortBufferException

      Specified by:
        `engineDoFinal` in class `javax.crypto.CipherSpi`
      Throws:
        `javax.crypto.IllegalBlockSizeException`
        `javax.crypto.BadPaddingException`
        `javax.crypto.ShortBufferException`

    - #### engineWrap

          protected byte[] engineWrap​(java.security.Key key)
                               throws javax.crypto.IllegalBlockSizeException,
                                      java.security.InvalidKeyException

      Overrides:
        `engineWrap` in class `javax.crypto.CipherSpi`
      Throws:
        `javax.crypto.IllegalBlockSizeException`
        `java.security.InvalidKeyException`

    - #### engineUnwrap

          protected java.security.Key engineUnwrap​(byte[] wrappedKey,
                                                   java.lang.String wrappedKeyAlgorithm,
                                                   int wrappedKeyType)
                                            throws java.security.InvalidKeyException,
                                                   java.security.NoSuchAlgorithmException

      Overrides:
        `engineUnwrap` in class `javax.crypto.CipherSpi`
      Throws:
        `java.security.InvalidKeyException`
        `java.security.NoSuchAlgorithmException`