AesCipherParameters (TrueZIP Driver ZIP.RAES (TZP) 7.3-rc-1 API)

java.lang.Object
- de.schlichtherle.truezip.crypto.raes.param.AesCipherParameters

All Implemented Interfaces:: SafeKey<AesCipherParameters>, Cloneable

@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class AesCipherParameters
extends Object
implements SafeKey<AesCipherParameters>, Cloneable

A Java bean which holds AES cipher parameters.

Author:: Christian Schlichtherle

Field Summary

Fields
Modifier and Type Field and Description

private Type0RaesParameters.KeyStrength keyStrength

private char[] password

Fields
Modifier and Type	Field and Description
`private Type0RaesParameters.KeyStrength`	`keyStrength`
`private char[]`	`password`

Constructor Summary

Constructors
Constructor and Description

AesCipherParameters()

Constructors
Constructor and Description
`AesCipherParameters()`

Method Summary

Methods
Modifier and Type	Method and Description
`AesCipherParameters`	`clone()` Returns a deep clone of this safe key.
`Type0RaesParameters.KeyStrength`	`getKeyStrength()` Returns the AES cipher key strength, which defaults to `Type0RaesParameters.KeyStrength.BITS_256`.
`char[]`	`getPassword()` Returns a protective copy of the password char array.
`void`	`reset()` Wipes any key data from the heap and resets this safe key to it's initial state.
`void`	`setKeyFileBytes(byte[] bytes)` Decodes the given byte array to a password char array for subsequent use.
`void`	`setKeyStrength(Type0RaesParameters.KeyStrength keyStrength)` Sets the AES cipher key strength.
`void`	`setPassword(char[] newPW)` Copies the given password char array for subsequent use as the AES cipher key.

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

- Field Detail
  - keyStrength
```
private Type0RaesParameters.KeyStrength keyStrength
```
  - password
```
@CheckForNull
private char[] password
```
- Constructor Detail
  - AesCipherParameters
```
public AesCipherParameters()
```
- Method Detail
  - clone
```
public AesCipherParameters clone()
```
    Description copied from interface: SafeKey
    
    Returns a deep clone of this safe key.
    
    Specified by:
    
    clone in interface SafeKey<AesCipherParameters>
    
    Overrides:
    
    clone in class Object
  - reset
```
public void reset()
```
    Description copied from interface: SafeKey
    
    Wipes any key data from the heap and resets this safe key to it's initial state.
    
    Specified by:
    
    reset in interface SafeKey<AesCipherParameters>
  - getPassword
```
@Nullable
public char[] getPassword()
```
    Returns a protective copy of the password char array.
    
    Returns:
    A protective copy of the password char array.
  - setPassword
```
public void setPassword(@CheckForNull
               char[] newPW)
```
    Copies the given password char array for subsequent use as the AES cipher key.
    This method makes a protective copy of the given password char array. It's highly recommended to overwrite this array with any non-password data after calling this method.
    
    Parameters:
    newPW - the password char array to be copied for subsequent use.
  - setKeyFileBytes
```
public void setKeyFileBytes(@CheckForNull
                   byte[] bytes)
```
    Decodes the given byte array to a password char array for subsequent use. This method should be used if a key file is used rather than a password.
    This method makes a protective copy of the given key file byte array. It's highly recommended to overwrite this array with any non-password data after calling this method.
    
    Parameters:
    bytes - the byte array to decode.
  - getKeyStrength
```
public Type0RaesParameters.KeyStrength getKeyStrength()
```
    Returns the AES cipher key strength, which defaults to Type0RaesParameters.KeyStrength.BITS_256.
    
    Returns:
    The AES cipher key strength, which defaults to Type0RaesParameters.KeyStrength.BITS_256.
  - setKeyStrength
```
public void setKeyStrength(Type0RaesParameters.KeyStrength keyStrength)
```
    Sets the AES cipher key strength.
    
    Parameters:
    keyStrength - the AES cipher key strength.

Class AesCipherParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

keyStrength

password

Constructor Detail

AesCipherParameters

Method Detail

clone

reset

getPassword

setPassword

setKeyFileBytes

getKeyStrength

setKeyStrength