net.java.truevfs.driver.zip.raes.crypto

Interface Type0RaesParameters

All Superinterfaces:

RaesParameters

public interface Type0RaesParameters
extends RaesParameters

The parameters of this interface are used with RAES type 0 files. Type 0 RAES files use password based encryption according to the specifications in PKCS #5 V2.0 und PKCS #12 V1.0.

Implementations do not need to be safe for multi-threading.

See Also:

PKCS #5, PKCS #12

Method Summary

Modifier and Type	Method and Description
net.java.truecommons.key.spec.common.AesKeyStrength	getKeyStrength() Returns the key strength to use for writing a RAES type 0 file.
char[]	getPasswordForReading(boolean invalid) Returns the password to use for reading a RAES type 0 file.
char[]	getPasswordForWriting() Returns the password to use for writing a RAES type 0 file.
void	setKeyStrength(net.java.truecommons.key.spec.common.AesKeyStrength keyStrength) Sets the key strength obtained from reading a RAES type 0 file.

Method Detail

getPasswordForWriting

char[] getPasswordForWriting()
                      throws RaesKeyException

Returns the password to use for writing a RAES type 0 file.

Returns:

A clone of the char array holding the password to use for writing a RAES type 0 file.

Throws:

RaesKeyException - If key retrieval has failed for some reason.

getPasswordForReading

char[] getPasswordForReading(boolean invalid)
                      throws RaesKeyException

Returns the password to use for reading a RAES type 0 file. This method is called consecutively until either the returned password is successfully validated or an exception is thrown.

Parameters:

invalid - true iff a previous call to this method returned an invalid password.

Returns:

A clone of the char array holding the password to use for reading a RAES type 0 file.

Throws:

RaesKeyException - If key retrieval has failed for some reason.

getKeyStrength

net.java.truecommons.key.spec.common.AesKeyStrength getKeyStrength()
                                                            throws RaesKeyException

Returns the key strength to use for writing a RAES type 0 file.

Returns:

The key strength to use for writing a RAES type 0 file.

Throws:

RaesKeyException - If key retrieval has failed for some reason.

setKeyStrength

void setKeyStrength(net.java.truecommons.key.spec.common.AesKeyStrength keyStrength)
             throws RaesKeyException

Sets the key strength obtained from reading a RAES type 0 file.

Parameters:

keyStrength - the key strength obtained from reading a RAES type 0 file.

Throws:

RaesKeyException - If key retrieval has failed for some reason.