SafePbeParameters (TrueZIP Driver ZIP 7.3.3 API)

java.lang.Object
- de.schlichtherle.truezip.key.pbe.SafePbeParameters<S,P>

All Implemented Interfaces:: SafeKey<P>, Cloneable

Direct Known Subclasses:: AesPbeParameters

@NotThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public abstract class SafePbeParameters<S extends KeyStrength,P extends SafePbeParameters<S,P>>
extends Object
implements SafeKey<P>

A JavaBean which holds parameters for password based encryption.

Sub classes do not need to be thread-safe.

Author:: Christian Schlichtherle

Field Summary

Fields
Modifier and Type Field and Description

private S keyStrength

private char[] password

Fields
Modifier and Type	Field and Description
`private S`	`keyStrength`
`private char[]`	`password`

Constructor Summary

Constructors
Constructor and Description

SafePbeParameters()

Constructors
Constructor and Description
`SafePbeParameters()`

Method Summary

Methods
Modifier and Type	Method and Description
`P`	`clone()` Returns a deep clone of this safe key.
`S`	`getKeyStrength()` Returns the cipher key strength.
`abstract S[]`	`getKeyStrengthValues()` Returns a new non-empty array of all available key strength values.
`char[]`	`getPassword()` Returns a protective copy of the stored 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(S keyStrength)` Sets the cipher key strength.
`void`	`setPassword(char[] newPW)` Copies and stores the given password char array for deriving the cipher key.

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

- Field Detail
  - keyStrength
```
@CheckForNull
private S extends KeyStrength keyStrength
```
  - password
```
@CheckForNull
private char[] password
```
- Constructor Detail
  - SafePbeParameters
```
public SafePbeParameters()
```
- Method Detail
  - clone
```
public P clone()
```
    Description copied from interface: SafeKey
    
    Returns a deep clone of this safe key.
    
    Specified by:
    
    clone in interface SafeKey<P extends SafePbeParameters<S,P>>
    
    Overrides:
    
    clone in class Object
  - getKeyStrength
```
@Nullable
public S getKeyStrength()
```
    Returns the cipher key strength.
    
    Returns:
    The cipher key strength.
  - getKeyStrengthValues
```
public abstract S[] getKeyStrengthValues()
```
    Returns a new non-empty array of all available key strength values. There should be no duplicated elements in this array.
    
    Returns:
    A new non-empty array of all available key strength values.
  - getPassword
```
@Nullable
public char[] getPassword()
```
    Returns a protective copy of the stored password char array.
    
    Returns:
    A protective copy of the stored password char array.
  - 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<P extends SafePbeParameters<S,P>>
  - 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.
  - setKeyStrength
```
public void setKeyStrength(@CheckForNull
                  S keyStrength)
```
    Sets the cipher key strength.
    
    Parameters:
    keyStrength - the cipher key strength.
  - setPassword
```
public void setPassword(@CheckForNull
               char[] newPW)
```
    Copies and stores the given password char array for deriving the cipher key. It's highly recommended to overwrite this array with any non-password data after calling this method.
    
    Parameters:
    newPW - the password char array for deriving the cipher key.

Class SafePbeParameters<S extends KeyStrength,P extends SafePbeParameters<S,P>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

keyStrength

password

Constructor Detail

SafePbeParameters

Method Detail

clone

getKeyStrength

getKeyStrengthValues

getPassword

reset

setKeyFileBytes

setKeyStrength

setPassword