freenet.keys

Class Key

java.lang.Object

freenet.keys.Key

All Implemented Interfaces:

WritableToDataOutputStream, java.lang.Comparable<Key>

Direct Known Subclasses:

NodeCHK, NodeSSK

public abstract class Key
extends java.lang.Object
implements WritableToDataOutputStream, java.lang.Comparable<Key>

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ALGO_AES_CTR_256_SHA256
static byte	ALGO_AES_PCFB_256_SHA256 Code for 256-bit AES with PCFB and SHA-256

Fields inherited from interface freenet.io.WritableToDataOutputStream

VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Key(byte[] routingKey)
protected	Key(Key key)

Method Summary

Modifier and Type	Method and Description
abstract Key	archivalCopy() Get a copy of the key with any unnecessary information stripped, for long-term in-memory storage.
abstract Key	cloneKey()
static freenet.keys.Key.Compressed	compress(Bucket sourceData, boolean dontCompress, short alreadyCompressedCodec, long sourceLength, long MAX_LENGTH_BEFORE_COMPRESSION, int MAX_COMPRESSED_DATA_LENGTH, boolean shortLength, java.lang.String compressordescriptor) Compress data.
static KeyBlock	createBlock(short keyType, byte[] keyBytes, byte[] headersBytes, byte[] dataBytes, byte[] pubkeyBytes)
static ClientKeyBlock	createKeyBlock(ClientKey key, KeyBlock block)
boolean	equals(java.lang.Object o)
abstract byte[]	getFullKey() Get the full key, including any crypto type bytes, everything needed to construct a Key object
byte[]	getKeyBytes()
byte[]	getRoutingKey()
abstract short	getType() Get key type High 8 bit ((type >> 8) & 0xFF) is the base type (NodeCHK.BASE_TYPE or NodeSSK.BASE_TYPE).
int	hashCode()
static boolean	isValidCryptoAlgorithm(byte cryptoAlgorithm)
static Key	read(java.io.DataInput raf) Read a Key from a RandomAccessFile
double	toNormalizedDouble() Convert the key to a double between 0.0 and 1.0.
abstract void	write(java.io.DataOutput _index) Write to disk.

Methods inherited from class java.lang.Object

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

Methods inherited from interface freenet.io.WritableToDataOutputStream

writeToDataOutputStream

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

ALGO_AES_PCFB_256_SHA256

public static final byte ALGO_AES_PCFB_256_SHA256

Code for 256-bit AES with PCFB and SHA-256

See Also:

Constant Field Values

ALGO_AES_CTR_256_SHA256

public static final byte ALGO_AES_CTR_256_SHA256

See Also:

Constant Field Values

Constructor Detail

Key

protected Key(byte[] routingKey)

Key

protected Key(Key key)

Method Detail

cloneKey

public abstract Key cloneKey()

write

public abstract void write(java.io.DataOutput _index)
                    throws java.io.IOException

Write to disk. Take up exactly 22 bytes.

Parameters:

_index -

Throws:

java.io.IOException

read

public static Key read(java.io.DataInput raf)
                throws java.io.IOException

Read a Key from a RandomAccessFile

Parameters:

raf - The file to read from.

Returns:

a Key, or throw an exception, or return null if the key is not parsable.

Throws:

java.io.IOException

createBlock

public static KeyBlock createBlock(short keyType,
                                   byte[] keyBytes,
                                   byte[] headersBytes,
                                   byte[] dataBytes,
                                   byte[] pubkeyBytes)
                            throws KeyVerifyException

Throws:

KeyVerifyException

toNormalizedDouble

public double toNormalizedDouble()

Convert the key to a double between 0.0 and 1.0. Normally we will hash the key first, in order to make chosen-key attacks harder.

getType

public abstract short getType()

Get key type

• High 8 bit ((type >> 8) & 0xFF) is the base type (NodeCHK.BASE_TYPE or NodeSSK.BASE_TYPE).
• Low 8 bit (type & 0xFF) is the crypto algorithm. (Currently only ALGO_AES_PCFB_256_SHA256 is supported).

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compress

public static freenet.keys.Key.Compressed compress(Bucket sourceData,
                                                   boolean dontCompress,
                                                   short alreadyCompressedCodec,
                                                   long sourceLength,
                                                   long MAX_LENGTH_BEFORE_COMPRESSION,
                                                   int MAX_COMPRESSED_DATA_LENGTH,
                                                   boolean shortLength,
                                                   java.lang.String compressordescriptor)
                                            throws KeyEncodeException,
                                                   java.io.IOException,
                                                   InvalidCompressionCodecException

Compress data.

Parameters:

sourceData -

dontCompress -

alreadyCompressedCodec -

sourceLength -

MAX_LENGTH_BEFORE_COMPRESSION -

MAX_COMPRESSED_DATA_LENGTH -

shortLength -

compressordescriptor -

Returns:

Throws:

KeyEncodeException

java.io.IOException

InvalidCompressionCodecException

getRoutingKey

public byte[] getRoutingKey()

getKeyBytes

public byte[] getKeyBytes()

createKeyBlock

public static ClientKeyBlock createKeyBlock(ClientKey key,
                                            KeyBlock block)
                                     throws KeyVerifyException

Throws:

KeyVerifyException

getFullKey

public abstract byte[] getFullKey()

Get the full key, including any crypto type bytes, everything needed to construct a Key object

archivalCopy

public abstract Key archivalCopy()

Get a copy of the key with any unnecessary information stripped, for long-term in-memory storage. E.g. for SSKs, strips the DSAPublicKey. Copies it whether or not we need to copy it because the original might pick up a pubkey after this call. And the returned key will not accidentally pick up extra data.

isValidCryptoAlgorithm

public static boolean isValidCryptoAlgorithm(byte cryptoAlgorithm)