WinZipAesEntryExtraField (TrueZIP Driver ZIP 7.4.2 API)

java.lang.Object
- de.schlichtherle.truezip.zip.ExtraField
- - de.schlichtherle.truezip.zip.WinZipAesEntryExtraField

```
@NotThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
final class WinZipAesEntryExtraField
extends ExtraField
```
WinZip AES Extra Field.

Since:

TrueZIP 7.3

Author:

Christian Schlichtherle

See Also:
AES Encryption Information: Encryption Specification AE-1 and AE-2 (WinZip Computing, S.L.), AES Coding Tips for Developers (WinZip Computing, S.L.), RawZipOutputStream.WinZipAesOutputMethod

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`DATA_SIZE`
`private byte`	`encryptionStrength`
`private static AesKeyStrength[]`	`KEY_STRENGTHS`
`private short`	`method`
`private static int`	`VENDOR_ID`
`private short`	`vendorVersion`
`(package private) static int`	`VV_AE_1` Entries of this type do include the standard ZIP CRC-32 value.
`(package private) static int`	`VV_AE_2` Entries of this type do not include the standard ZIP CRC-32 value.

Fields inherited from class de.schlichtherle.truezip.zip.ExtraField
WINZIP_AES_ID, ZIP64_HEADER_ID

Constructor Summary

Constructors
Constructor and Description

WinZipAesEntryExtraField()
Constructs a new WinZip AES Extra Field.

Constructors
Constructor and Description
`WinZipAesEntryExtraField()` Constructs a new WinZip AES Extra Field.

Method Summary

Methods
Modifier and Type	Method and Description
`private static byte`	`encryptionStrength(AesKeyStrength keyStrength)`
`(package private) int`	`getDataSize()` Returns the Data Size of this Extra Field.
`(package private) int`	`getHeaderId()` Returns the Header ID (type) of this Extra Field.
`(package private) AesKeyStrength`	`getKeyStrength()`
`(package private) int`	`getMethod()`
`(package private) int`	`getVendorId()`
`(package private) int`	`getVendorVersion()` Returns the vendor version.
`private static AesKeyStrength`	`keyStrength(int encryptionStrength)`
`(package private) void`	`readFrom(byte[] src, int off, int size)` Initializes this Extra Field by deserializing a Data Block of `size` bytes from the byte array `data` at the zero based offset `off`.
`(package private) void`	`setKeyStrength(AesKeyStrength keyStrength)`
`(package private) void`	`setMethod(int compressionMethod)`
`(package private) void`	`setVendorVersion(int vendorVersion)` Sets the vendor version.
`(package private) void`	`writeTo(byte[] dst, int off)` Serializes a Data Block of `ExtraField.getDataSize()` bytes to the byte array `data` at the zero based offset `off`.

Methods inherited from class de.schlichtherle.truezip.zip.ExtraField
create, getDataBlock, register

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATA_SIZE
```
private static final int DATA_SIZE
```
    See Also:
    Constant Field Values
  - encryptionStrength
```
private byte encryptionStrength
```
  - KEY_STRENGTHS
```
private static final AesKeyStrength[] KEY_STRENGTHS
```
  - method
```
private short method
```
  - VENDOR_ID
```
private static final int VENDOR_ID
```
    See Also:
    Constant Field Values
  - vendorVersion
```
private short vendorVersion
```
  - VV_AE_1
```
static final int VV_AE_1
```
    Entries of this type do include the standard ZIP CRC-32 value. For use with setVendorVersion(int)/getVendorVersion().
    
    See Also:
    Constant Field Values
  - VV_AE_2
```
static final int VV_AE_2
```
    Entries of this type do not include the standard ZIP CRC-32 value. For use with setVendorVersion(int)/getVendorVersion().
    
    See Also:
    Constant Field Values
- Constructor Detail
  - WinZipAesEntryExtraField
```
WinZipAesEntryExtraField()
```
    Constructs a new WinZip AES Extra Field.
- Method Detail
  - encryptionStrength
```
private static byte encryptionStrength(AesKeyStrength keyStrength)
```
  - getDataSize
```
int getDataSize()
```
    Description copied from class: ExtraField
    
    Returns the Data Size of this Extra Field. The Data Size is an unsigned short integer (two bytes) which indicates the length of the Data Block in bytes and does not include its own size in this Extra Field. This property may be initialized by calling ExtraField.readFrom(byte[], int, int).
    
    Specified by:
    
    getDataSize in class ExtraField
    
    Returns:
    The size of the Data Block in bytes or 0 if unknown.
    See Also:
    ExtraField.getDataBlock()
  - getHeaderId
```
int getHeaderId()
```
    Description copied from class: ExtraField
    
    Returns the Header ID (type) of this Extra Field. The Header ID is an unsigned short integer (two bytes) which must be constant during the life cycle of this object.
    
    Specified by:
    
    getHeaderId in class ExtraField
  - getKeyStrength
```
AesKeyStrength getKeyStrength()
```
  - getMethod
```
int getMethod()
```
  - getVendorId
```
int getVendorId()
```
  - getVendorVersion
```
int getVendorVersion()
```
    Returns the vendor version.
    
    See Also:
    VV_AE_1, VV_AE_2
  - keyStrength
```
private static AesKeyStrength keyStrength(int encryptionStrength)
```
  - readFrom
```
void readFrom(byte[] src,
            int off,
            int size)
```
    Description copied from class: ExtraField
    
    Initializes this Extra Field by deserializing a Data Block of size bytes from the byte array data at the zero based offset off. Upon return, this Extra Field shall not access data subsequently and ExtraField.getDataSize() must equal size.
    
    Specified by:
    
    readFrom in class ExtraField
    
    Parameters:
    src - The byte array to read the Data Block from.
    off - The zero based offset in the byte array where the first byte of the Data Block is read from.
    size - The length of the Data Block in bytes.
    See Also:
    ExtraField.getDataSize()
  - setKeyStrength
```
void setKeyStrength(AesKeyStrength keyStrength)
```
  - setMethod
```
void setMethod(int compressionMethod)
```
  - setVendorVersion
```
void setVendorVersion(int vendorVersion)
```
    Sets the vendor version.
    
    Parameters:
    vendorVersion - the vendor version.
    
    Throws:
    
    IllegalArgumentException
    See Also:
    VV_AE_1, VV_AE_2
  - writeTo
```
void writeTo(byte[] dst,
           int off)
```
    Description copied from class: ExtraField
    
    Serializes a Data Block of ExtraField.getDataSize() bytes to the byte array data at the zero based offset off. Upon return, this Extra Field shall not access data subsequently.
    
    Specified by:
    
    writeTo in class ExtraField
    
    Parameters:
    dst - The byte array to write the Data Block to.
    off - The zero based offset in the byte array where the first byte of the Data Block is written to.
    See Also:
    ExtraField.getDataSize()

Class WinZipAesEntryExtraField

Field Summary

Fields inherited from class de.schlichtherle.truezip.zip.ExtraField

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.zip.ExtraField

Methods inherited from class java.lang.Object

Field Detail

DATA_SIZE

encryptionStrength

KEY_STRENGTHS

method

VENDOR_ID

vendorVersion

VV_AE_1

VV_AE_2

Constructor Detail

WinZipAesEntryExtraField

Method Detail

encryptionStrength

getDataSize

getHeaderId

getKeyStrength

getMethod

getVendorId

getVendorVersion

keyStrength

readFrom

setKeyStrength

setMethod

setVendorVersion

writeTo