net.lingala.zip4j.io.inputstream.AesCipherInputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zip4j Show documentation
An open source java library to handle zip files
There is a newer version: 2.11.5
package net.lingala.zip4j.io.inputstream;

import net.lingala.zip4j.crypto.AESDecrypter;
import net.lingala.zip4j.exception.ZipException;
import net.lingala.zip4j.model.AESExtraDataRecord;
import net.lingala.zip4j.model.LocalFileHeader;
import net.lingala.zip4j.model.enums.CompressionMethod;
import net.lingala.zip4j.util.InternalZipConstants;
import net.lingala.zip4j.util.Zip4jUtil;

import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;

import static net.lingala.zip4j.util.InternalZipConstants.AES_AUTH_LENGTH;
import static net.lingala.zip4j.util.Zip4jUtil.readFully;

class AesCipherInputStream extends CipherInputStream {

  private byte[] singleByteBuffer = new byte[1];
  private byte[] aes16ByteBlock = new byte[16];
  private int aes16ByteBlockPointer = 0;
  private int remainingAes16ByteBlockLength = 0;
  private int lengthToRead = 0;
  private int offsetWithAesBlock = 0;
  private int bytesCopiedInThisIteration = 0;
  private int lengthToCopyInThisIteration = 0;
  private int aes16ByteBlockReadLength = 0;

  public AesCipherInputStream(ZipEntryInputStream zipEntryInputStream, LocalFileHeader localFileHeader, char[] password)
      throws IOException {
    super(zipEntryInputStream, localFileHeader, password);
  }

  @Override
  protected AESDecrypter initializeDecrypter(LocalFileHeader localFileHeader, char[] password) throws IOException {
    return new AESDecrypter(localFileHeader.getAesExtraDataRecord(), password, getSalt(localFileHeader), getPasswordVerifier());
  }

  @Override
  public int read() throws IOException {
    int readLen = read(singleByteBuffer);

    if (readLen == -1) {
      return -1;
    }

    return singleByteBuffer[0];
  }

  @Override
  public int read(byte[] b) throws IOException {
    return read(b, 0, b.length);
  }

  @Override
  public int read(byte[] b, int off, int len) throws IOException {
    lengthToRead = len;
    offsetWithAesBlock = off;
    bytesCopiedInThisIteration = 0;

    if (remainingAes16ByteBlockLength != 0) {
      copyBytesFromBuffer(b, offsetWithAesBlock);

      if (bytesCopiedInThisIteration == len) {
        return bytesCopiedInThisIteration;
      }
    }

    if (lengthToRead < 16) {
      aes16ByteBlockReadLength = super.read(aes16ByteBlock, 0, aes16ByteBlock.length);
      aes16ByteBlockPointer = 0;

      if (aes16ByteBlockReadLength == -1) {
        remainingAes16ByteBlockLength = 0;

        if (bytesCopiedInThisIteration > 0) {
          return bytesCopiedInThisIteration;
        }

        return -1;
      }

      remainingAes16ByteBlockLength = aes16ByteBlockReadLength;

      copyBytesFromBuffer(b, offsetWithAesBlock);

      if (bytesCopiedInThisIteration == len) {
        return bytesCopiedInThisIteration;
      }
    }

    int readLen = super.read(b, offsetWithAesBlock, (lengthToRead - lengthToRead %16));

    if (readLen == -1) {
      if (bytesCopiedInThisIteration > 0) {
        return bytesCopiedInThisIteration;
      } else {
        return -1;
      }
    } else {
      return readLen + bytesCopiedInThisIteration;
    }
  }

  private void copyBytesFromBuffer(byte[] b, int off) {
    lengthToCopyInThisIteration = lengthToRead < remainingAes16ByteBlockLength ? lengthToRead : remainingAes16ByteBlockLength;
    System.arraycopy(aes16ByteBlock, aes16ByteBlockPointer, b, off, lengthToCopyInThisIteration);

    incrementAesByteBlockPointer(lengthToCopyInThisIteration);
    decrementRemainingAesBytesLength(lengthToCopyInThisIteration);

    bytesCopiedInThisIteration += lengthToCopyInThisIteration;

    lengthToRead -= lengthToCopyInThisIteration;
    offsetWithAesBlock += lengthToCopyInThisIteration;
  }

  @Override
  protected void endOfEntryReached(InputStream inputStream) throws IOException {
    verifyContent(readStoredMac(inputStream));
  }

  private void verifyContent(byte[] storedMac) throws IOException {
    if (getLocalFileHeader().isDataDescriptorExists()
        && CompressionMethod.DEFLATE.equals(Zip4jUtil.getCompressionMethod(getLocalFileHeader()))) {
      // Skip content verification in case of Deflate compression and if data descriptor exists.
      // In this case, we do not know the exact size of compressed data before hand and it is possible that we read
      // and pass more than required data into inflater, thereby corrupting the aes mac bytes.
      // See usage of PushBackInputStream in the project for how this push back of data is done
      // Unfortunately, in this case we cannot perform a content verification and have to skip
      return;
    }

    byte[] calculatedMac = getDecrypter().getCalculatedAuthenticationBytes();
    byte[] first10BytesOfCalculatedMac = new byte[AES_AUTH_LENGTH];
    System.arraycopy(calculatedMac, 0, first10BytesOfCalculatedMac, 0, InternalZipConstants.AES_AUTH_LENGTH);

    if (!Arrays.equals(storedMac, first10BytesOfCalculatedMac)) {
      throw new IOException("Reached end of data for this entry, but aes verification failed");
    }
  }

  protected byte[] readStoredMac(InputStream inputStream) throws IOException {
    byte[] storedMac = new byte[AES_AUTH_LENGTH];
    int readLen = readFully(inputStream, storedMac);

    if (readLen != AES_AUTH_LENGTH) {
      throw new ZipException("Invalid AES Mac bytes. Could not read sufficient data");
    }

    return storedMac;
  }

  private byte[] getSalt(LocalFileHeader localFileHeader) throws IOException {
    if (localFileHeader.getAesExtraDataRecord() == null) {
      throw new IOException("invalid aes extra data record");
    }

    AESExtraDataRecord aesExtraDataRecord = localFileHeader.getAesExtraDataRecord();
    byte[] saltBytes = new byte[aesExtraDataRecord.getAesKeyStrength().getSaltLength()];
    readRaw(saltBytes);
    return saltBytes;
  }

  private byte[] getPasswordVerifier() throws IOException {
    byte[] pvBytes = new byte[2];
    readRaw(pvBytes);
    return pvBytes;
  }

  private void incrementAesByteBlockPointer(int incrementBy) {
    aes16ByteBlockPointer += incrementBy;

    if (aes16ByteBlockPointer >= 15) {
      aes16ByteBlockPointer = 15;
    }
  }

  private void decrementRemainingAesBytesLength(int decrementBy) {
    remainingAes16ByteBlockLength -= decrementBy;

    if (remainingAes16ByteBlockLength <= 0) {
      remainingAes16ByteBlockLength = 0;
    }
  }
}