/*
    * GordianKnot: Security Suite
    * Copyright 2012-2026. Tony Washer
    *
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
    * use this file except in compliance with the License.  You may obtain a copy
    * of the License at
    *
    *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
   * License for the specific language governing permissions and limitations under
   * the License.
   */
  package io.github.tonywasher.joceanus.gordianknot.impl.jca;
  
  import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
  import io.github.tonywasher.joceanus.gordianknot.api.base.GordianKeySpec;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianAEADCipher;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianCipherParameters;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianCipherSpec;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianStreamAEADCipher;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianStreamCipherSpec;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianStreamKeySpec;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianSymAEADCipher;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianSymCipherSpec;
  import io.github.tonywasher.joceanus.gordianknot.api.cipher.GordianSymKeySpec;
  import io.github.tonywasher.joceanus.gordianknot.impl.core.base.GordianBaseFactory;
  import io.github.tonywasher.joceanus.gordianknot.impl.core.cipher.GordianCoreCipher;
  import io.github.tonywasher.joceanus.gordianknot.impl.core.exc.GordianCryptoException;
  import org.bouncycastle.jcajce.spec.AEADParameterSpec;
  
  import javax.crypto.BadPaddingException;
  import javax.crypto.Cipher;
  import javax.crypto.IllegalBlockSizeException;
  import javax.crypto.SecretKey;
  import javax.crypto.ShortBufferException;
  import javax.crypto.spec.IvParameterSpec;
  import java.security.InvalidAlgorithmParameterException;
  import java.security.InvalidKeyException;
  import java.security.spec.AlgorithmParameterSpec;
  import java.util.Arrays;
  
  /**
   * Cipher for JCA BouncyCastle AEAD Ciphers.
   *
   * @param <T> the key Type
   */
  public class JcaAEADCipher<T extends GordianKeySpec>
          extends GordianCoreCipher<T>
          implements GordianAEADCipher {
      /**
       * Cipher.
       */
      private final Cipher theCipher;
  
      /**
       * is the cipher encrypting?
       */
      private boolean isEncrypting;
  
      /**
       * Constructor.
       *
       * @param pFactory    the Security Factory
       * @param pCipherSpec the cipherSpec
       * @param pCipher     the cipher
       */
      JcaAEADCipher(final GordianBaseFactory pFactory,
                    final GordianCipherSpec<T> pCipherSpec,
                    final Cipher pCipher) {
          super(pFactory, pCipherSpec);
          theCipher = pCipher;
      }
  
      @Override
      public JcaKey<T> getKey() {
          return (JcaKey<T>) super.getKey();
      }
  
  
      @Override
      public void init(final boolean pEncrypt,
                       final GordianCipherParameters pParams) throws GordianException {
          /* Process the parameters and access the key */
          processParameters(pParams);
          final JcaKey<T> myJcaKey = JcaKey.accessKey(getKey());
  
          /* Access details */
          final int myMode = pEncrypt
                  ? Cipher.ENCRYPT_MODE
                  : Cipher.DECRYPT_MODE;
          final SecretKey myKey = myJcaKey.getKey();
          final byte[] myAEAD = getInitialAEAD();
  
          /* Protect against exceptions */
          try {
             /* Initialise as required */
             final AlgorithmParameterSpec myParms = myAEAD == null
                     ? new IvParameterSpec(getInitVector())
                     : new AEADParameterSpec(getInitVector(), getAEADMacSize(), myAEAD);
             theCipher.init(myMode, myKey, myParms);
             isEncrypting = pEncrypt;
         } catch (InvalidKeyException
                  | InvalidAlgorithmParameterException e) {
             throw new GordianCryptoException("Failed to initialise cipher", e);
         }
     }
 
     @Override
     public int getOutputLength(final int pLength) {
         return theCipher.getOutputSize(pLength);
     }
 
     @Override
     public int doUpdate(final byte[] pBytes,
                         final int pOffset,
                         final int pLength,
                         final byte[] pOutput,
                         final int pOutOffset) throws GordianException {
         /* Protect against exceptions */
         try {
             /* Process the bytes */
             return theCipher.update(pBytes, pOffset, pLength, pOutput, pOutOffset);
 
             /* Handle exceptions */
         } catch (ShortBufferException e) {
             throw new GordianCryptoException("Failed to process bytes", e);
         }
     }
 
     @Override
     public void updateAAD(final byte[] pBytes,
                           final int pOffset,
                           final int pLength) throws GordianException {
         /* Protect against exceptions */
         try {
             /* Process the bytes */
             theCipher.updateAAD(pBytes, pOffset, pLength);
 
             /* Handle exceptions */
         } catch (IllegalStateException e) {
             throw new GordianCryptoException("Failed to process AAD bytes", e);
         }
     }
 
     @Override
     public int doFinish(final byte[] pOutput,
                         final int pOutOffset) throws GordianException {
         /* Protect against exceptions */
         try {
             /* Finish the operation */
             return theCipher.doFinal(pOutput, pOutOffset);
 
             /* Handle exceptions */
         } catch (ShortBufferException
                  | IllegalBlockSizeException
                  | BadPaddingException e) {
             throw new GordianCryptoException("Failed to finish operation", e);
         }
     }
 
     @Override
     public int getBlockSize() {
         return 0;
     }
 
     /**
      * JcaSymAADCipher.
      */
     public static class JcaSymAEADCipher
             extends JcaAEADCipher<GordianSymKeySpec>
             implements GordianSymAEADCipher {
         /**
          * Constructor.
          *
          * @param pFactory    the Security Factory
          * @param pCipherSpec the cipherSpec
          * @param pCipher     the cipher
          */
         JcaSymAEADCipher(final GordianBaseFactory pFactory,
                          final GordianSymCipherSpec pCipherSpec,
                          final Cipher pCipher) {
             super(pFactory, pCipherSpec, pCipher);
         }
     }
 
     /**
      * JcaStreamAEADCipher.
      */
     public static class JcaStreamAEADCipher
             extends JcaAEADCipher<GordianStreamKeySpec>
             implements GordianStreamAEADCipher {
         /**
          * Constructor.
          *
          * @param pFactory    the Security Factory
          * @param pCipherSpec the cipherSpec
          * @param pCipher     the cipher
          */
         JcaStreamAEADCipher(final GordianBaseFactory pFactory,
                             final GordianStreamCipherSpec pCipherSpec,
                             final Cipher pCipher) {
             super(pFactory, pCipherSpec, pCipher);
         }
     }
 
     @Override
     public boolean equals(final Object pThat) {
         /* Handle trivial cases */
         if (this == pThat) {
             return true;
         }
         if (pThat == null) {
             return false;
         }
 
         /* Make sure that the classes are the same */
         if (!(pThat instanceof JcaAEADCipher)) {
             return false;
         }
         final JcaAEADCipher<?> myThat = (JcaAEADCipher<?>) pThat;
 
         /* Check that the fields are equal */
         return isEncrypting == myThat.isEncrypting
                 && Arrays.equals(getInitialAEAD(), myThat.getInitialAEAD())
                 && super.equals(myThat);
     }
 
     @Override
     public int hashCode() {
         return super.hashCode()
                 + Arrays.hashCode(getInitialAEAD())
                 + (isEncrypting ? 1 : 0);
     }
 }