freenet.keys

Class ClientCHKBlock

java.lang.Object

freenet.keys.ClientCHKBlock

All Implemented Interfaces:

ClientKeyBlock

public class ClientCHKBlock
extends java.lang.Object
implements ClientKeyBlock

Constructor Summary

Constructors

Constructor and Description
ClientCHKBlock(byte[] data, byte[] header, ClientCHK key2, boolean verify) Construct from data retrieved, and a key.
ClientCHKBlock(CHKBlock block, ClientCHK key2) Construct from a CHKBlock and a key.

Method Summary

Modifier and Type	Method and Description
Bucket	decode(BucketFactory bf, int maxLength, boolean dontCompress) Decode the CHK and recover the original data
Bucket	decodeNew(BucketFactory bf, int maxLength, boolean dontCompress) Decode the CHK and recover the original data
Bucket	decodeNewNoJCA(BucketFactory bf, int maxLength, boolean dontCompress) Decode using Freenet's built in crypto.
Bucket	decodeOld(BucketFactory bf, int maxLength, boolean dontCompress) Decode the CHK and recover the original data
static ClientCHKBlock	encode(Bucket sourceData, boolean asMetadata, boolean dontCompress, short alreadyCompressedCodec, long sourceLength, java.lang.String compressorDescriptor, byte[] cryptoKey, byte cryptoAlgorithm) Encode a Bucket of data to a CHKBlock.
static ClientCHKBlock	encode(byte[] sourceData, boolean asMetadata, boolean dontCompress, short alreadyCompressedCodec, int sourceLength, java.lang.String compressorDescriptor) Encode a block of data to a CHKBlock.
static ClientCHKBlock	encodeNew(byte[] data, int dataLength, java.security.MessageDigest md256, byte[] encKey, boolean asMetadata, short compressionAlgorithm, byte cryptoAlgorithm, int blockHashAlgorithm) Format: [0-1]: Block hash algorithm [2-34]: HMAC (with cryptokey) of data + length bytes.
static ClientCHKBlock	encodeNewNoJCA(byte[] data, int dataLength, java.security.MessageDigest md256, byte[] encKey, boolean asMetadata, short compressionAlgorithm, byte cryptoAlgorithm, int blockHashAlgorithm) Encode using Freenet's built in crypto.
static ClientCHKBlock	encodeSplitfileBlock(byte[] data, byte[] cryptoKey, byte cryptoAlgorithm) Encode a splitfile block.
boolean	equals(java.lang.Object o) This is why ClientKeyBlock isn't instanceof KeyBlock: Two ClientKeyBlock's with the same content but different keys are not equals(), therefore a ClientKeyBlock and its KeyBlock have to be !equals too.
CHKBlock	getBlock()
ClientCHK	getClientKey()
Key	getKey()
int	hashCode() Please be consistent with equals()
static ClientCHKBlock	innerEncode(byte[] data, int dataLength, java.security.MessageDigest md256, byte[] encKey, boolean asMetadata, short compressionAlgorithm, byte cryptoAlgorithm)
boolean	isMetadata() Does the block contain metadata? If not, it contains real data.
byte[]	memoryDecode() Decode into RAM, if short.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientCHKBlock

public ClientCHKBlock(byte[] data,
                      byte[] header,
                      ClientCHK key2,
                      boolean verify)
               throws CHKVerifyException

Construct from data retrieved, and a key. Do not do full decode. Verify what can be verified without doing a full decode.

Parameters:

key2 - The client key.

header - The header.

data - The data.

Throws:

CHKVerifyException

ClientCHKBlock

public ClientCHKBlock(CHKBlock block,
                      ClientCHK key2)
               throws CHKVerifyException

Construct from a CHKBlock and a key.

Throws:

CHKVerifyException

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

memoryDecode

public byte[] memoryDecode()
                    throws CHKDecodeException

Decode into RAM, if short.

Specified by:

memoryDecode in interface ClientKeyBlock

Throws:

CHKDecodeException

decode

public Bucket decode(BucketFactory bf,
                     int maxLength,
                     boolean dontCompress)
              throws CHKDecodeException,
                     java.io.IOException

Decode the CHK and recover the original data

Specified by:

decode in interface ClientKeyBlock

Parameters:

bf - The BucketFactory to use to create the Bucket to return the data in.

maxLength - The maximum size of the returned data in bytes.

Returns:

the original data

Throws:

java.io.IOException - If there is a bucket error.

CHKDecodeException

decodeOld

public Bucket decodeOld(BucketFactory bf,
                        int maxLength,
                        boolean dontCompress)
                 throws CHKDecodeException,
                        java.io.IOException

Decode the CHK and recover the original data

Returns:

the original data

Throws:

java.io.IOException - If there is a bucket error.

CHKDecodeException

decodeNew

public Bucket decodeNew(BucketFactory bf,
                        int maxLength,
                        boolean dontCompress)
                 throws CHKDecodeException,
                        java.io.IOException

Decode the CHK and recover the original data

Returns:

the original data

Throws:

java.io.IOException - If there is a bucket error.

CHKDecodeException

decodeNewNoJCA

public Bucket decodeNewNoJCA(BucketFactory bf,
                             int maxLength,
                             boolean dontCompress)
                      throws CHKDecodeException,
                             java.io.IOException

Decode using Freenet's built in crypto. FIXME remove once Java 1.7 is mandatory. Note that we assume that HMAC SHA256 is available; the problem is AES is limited to 128 bits.

Returns:

the original data

Throws:

java.io.IOException - If there is a bucket error.

CHKDecodeException

encodeSplitfileBlock

public static ClientCHKBlock encodeSplitfileBlock(byte[] data,
                                                  byte[] cryptoKey,
                                                  byte cryptoAlgorithm)
                                           throws CHKEncodeException

Encode a splitfile block.

Parameters:

data - The data to encode. Must be exactly DATA_LENGTH bytes.

cryptoKey - The encryption key. Can be null in which case this is equivalent to a normal block encode.

Throws:

CHKEncodeException

encode

public static ClientCHKBlock encode(Bucket sourceData,
                                    boolean asMetadata,
                                    boolean dontCompress,
                                    short alreadyCompressedCodec,
                                    long sourceLength,
                                    java.lang.String compressorDescriptor,
                                    byte[] cryptoKey,
                                    byte cryptoAlgorithm)
                             throws CHKEncodeException,
                                    java.io.IOException

Encode a Bucket of data to a CHKBlock.

Parameters:

sourceData - The bucket of data to encode. Can be arbitrarily large.

asMetadata - Is this a metadata key?

dontCompress - If set, don't even try to compress.

alreadyCompressedCodec - If !dontCompress, and this is >=0, then the data is already compressed, and this is the algorithm.

compressorDescriptor -

cryptoAlgorithm -

cryptoKey -

Throws:

CHKEncodeException

java.io.IOException - If there is an error reading from the Bucket.

InvalidCompressionCodecException

encodeNew

public static ClientCHKBlock encodeNew(byte[] data,
                                       int dataLength,
                                       java.security.MessageDigest md256,
                                       byte[] encKey,
                                       boolean asMetadata,
                                       short compressionAlgorithm,
                                       byte cryptoAlgorithm,
                                       int blockHashAlgorithm)
                                throws CHKEncodeException

Format: [0-1]: Block hash algorithm [2-34]: HMAC (with cryptokey) of data + length bytes. [35-36]: Length bytes. Encryption: CTR with IV = 1st 16 bytes of the hash. (It has to be deterministic as this is a CHK and we need to be able to reinsert them easily): - Data - Length bytes.

Parameters:

data - Data should already have been padded.

dataLength - Length of original data. Between 0 and 32768.

md256 - Convenient reuse of hash object.

encKey - Encryption key for the data, part of the URI.

asMetadata - Whether the final CHK is metadata or not.

compressionAlgorithm - The compression algorithm used.

cryptoAlgorithm - The encryption algorithm used.

Returns:

Throws:

CHKEncodeException

encodeNewNoJCA

public static ClientCHKBlock encodeNewNoJCA(byte[] data,
                                            int dataLength,
                                            java.security.MessageDigest md256,
                                            byte[] encKey,
                                            boolean asMetadata,
                                            short compressionAlgorithm,
                                            byte cryptoAlgorithm,
                                            int blockHashAlgorithm)
                                     throws CHKEncodeException

Encode using Freenet's built in crypto. FIXME remove once Java 1.7 is mandatory. Note that we assume that HMAC SHA256 is available; the problem is AES is limited to 128 bits.

Parameters:

data - Data should already have been padded.

dataLength - Length of original data. Between 0 and 32768.

md256 - Convenient reuse of hash object.

encKey - Encryption key for the data, part of the URI.

asMetadata - Whether the final CHK is metadata or not.

compressionAlgorithm - The compression algorithm used.

cryptoAlgorithm - The encryption algorithm used.

Returns:

Throws:

CHKVerifyException

CHKEncodeException

innerEncode

public static ClientCHKBlock innerEncode(byte[] data,
                                         int dataLength,
                                         java.security.MessageDigest md256,
                                         byte[] encKey,
                                         boolean asMetadata,
                                         short compressionAlgorithm,
                                         byte cryptoAlgorithm)

encode

public static ClientCHKBlock encode(byte[] sourceData,
                                    boolean asMetadata,
                                    boolean dontCompress,
                                    short alreadyCompressedCodec,
                                    int sourceLength,
                                    java.lang.String compressorDescriptor)
                             throws CHKEncodeException,
                                    InvalidCompressionCodecException

Encode a block of data to a CHKBlock.

Parameters:

sourceData - The data to encode.

asMetadata - Is this a metadata key?

dontCompress - If set, don't even try to compress.

alreadyCompressedCodec - If !dontCompress, and this is >=0, then the data is already compressed, and this is the algorithm.

compressorDescriptor - Should be null, or list of compressors to try.

Throws:

InvalidCompressionCodecException

CHKEncodeException

getClientKey

public ClientCHK getClientKey()

Specified by:

getClientKey in interface ClientKeyBlock

Returns:

The ClientKey for this key.

isMetadata

public boolean isMetadata()

Description copied from interface: ClientKeyBlock

Does the block contain metadata? If not, it contains real data.

Specified by:

isMetadata in interface ClientKeyBlock

hashCode

public int hashCode()

Description copied from interface: ClientKeyBlock

Please be consistent with equals()

Specified by:

hashCode in interface ClientKeyBlock

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Description copied from interface: ClientKeyBlock

This is why ClientKeyBlock isn't instanceof KeyBlock: Two ClientKeyBlock's with the same content but different keys are not equals(), therefore a ClientKeyBlock and its KeyBlock have to be !equals too. Hence it's really a different kind of object, so not a child.

Specified by:

equals in interface ClientKeyBlock

Overrides:

equals in class java.lang.Object

getBlock

public CHKBlock getBlock()

Specified by:

getBlock in interface ClientKeyBlock

Returns:

The underlying KeyBlock.

getKey

public Key getKey()

Specified by:

getKey in interface ClientKeyBlock

Returns:

The low-level Key for the block.