freenet.keys

Class NodeSSK

java.lang.Object

freenet.keys.Key

freenet.keys.NodeSSK

All Implemented Interfaces:

WritableToDataOutputStream, java.lang.Comparable<Key>

public class NodeSSK
extends Key

An SSK is a Signed Subspace Key. { pubkey, cryptokey, filename } -> document, basically. To insert you need the private key corresponding to pubkey. KSKs are implemented via SSKs. This is just the key, so we have the hash of the pubkey, the entire cryptokey, and the entire filename.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	BASE_TYPE
static int	E_H_DOCNAME_SIZE
static int	FULL_KEY_LENGTH
static int	PUBKEY_HASH_SIZE
static int	ROUTING_KEY_LENGTH
static int	SSK_VERSION

Fields inherited from class freenet.keys.Key

ALGO_AES_CTR_256_SHA256, ALGO_AES_PCFB_256_SHA256

Fields inherited from interface freenet.io.WritableToDataOutputStream

VERSION

Constructor Summary

Constructors

Constructor and Description
NodeSSK(byte[] pkHash, byte[] ehDocname, byte cryptoAlgorithm)
NodeSSK(byte[] pkHash, byte[] ehDocname, DSAPublicKey pubKey, byte cryptoAlgorithm)

Method Summary

Modifier and Type	Method and Description
Key	archivalCopy() Get a copy of the key with any unnecessary information stripped, for long-term in-memory storage.
Key	cloneKey()
int	compareTo(Key arg0)
static NodeSSK	construct(byte[] buf)
boolean	equals(java.lang.Object o)
byte[]	getFullKey() Get the full key, including any crypto type bytes, everything needed to construct a Key object
byte[]	getKeyBytes()
DSAPublicKey	getPubKey()
byte[]	getPubKeyHash()
short	getType() Get key type High 8 bit ((type >> 8) & 0xFF) is the base type (NodeCHK.BASE_TYPE or BASE_TYPE).
boolean	grabPubkey(GetPubkey pubkeyCache, boolean canReadClientCache, boolean forULPR, BlockMetadata meta)
int	hashCode()
boolean	hasPubKey()
static Key	readSSK(java.io.DataInput raf, byte cryptoAlgorithm)
static byte[]	routingKeyFromFullKey(byte[] keyBuf)
void	setPubKey(DSAPublicKey pubKey2)
java.lang.String	toString()
void	write(java.io.DataOutput _index) Write to disk.
void	writeToDataOutputStream(java.io.DataOutputStream stream)

Methods inherited from class freenet.keys.Key

compress, createBlock, createKeyBlock, getRoutingKey, isValidCryptoAlgorithm, read, toNormalizedDouble

Methods inherited from class java.lang.Object

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

Field Detail

SSK_VERSION

public static final int SSK_VERSION

See Also:

Constant Field Values

PUBKEY_HASH_SIZE

public static final int PUBKEY_HASH_SIZE

See Also:

Constant Field Values

E_H_DOCNAME_SIZE

public static final int E_H_DOCNAME_SIZE

See Also:

Constant Field Values

BASE_TYPE

public static final byte BASE_TYPE

See Also:

Constant Field Values

FULL_KEY_LENGTH

public static final int FULL_KEY_LENGTH

See Also:

Constant Field Values

ROUTING_KEY_LENGTH

public static final int ROUTING_KEY_LENGTH

See Also:

Constant Field Values

Constructor Detail

NodeSSK

public NodeSSK(byte[] pkHash,
               byte[] ehDocname,
               byte cryptoAlgorithm)

NodeSSK

public NodeSSK(byte[] pkHash,
               byte[] ehDocname,
               DSAPublicKey pubKey,
               byte cryptoAlgorithm)
        throws SSKVerifyException

Throws:

SSKVerifyException

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

archivalCopy

public Key archivalCopy()

Description copied from class: Key

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.

Specified by:

archivalCopy in class Key

cloneKey

public Key cloneKey()

Specified by:

cloneKey in class Key

write

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

Description copied from class: Key

Write to disk. Take up exactly 22 bytes.

Specified by:

write in class Key

Throws:

java.io.IOException

readSSK

public static Key readSSK(java.io.DataInput raf,
                          byte cryptoAlgorithm)
                   throws java.io.IOException

Throws:

java.io.IOException

getType

public short getType()

Description copied from class: Key

Get key type

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

Specified by:

getType in class Key

writeToDataOutputStream

public void writeToDataOutputStream(java.io.DataOutputStream stream)
                             throws java.io.IOException

Throws:

java.io.IOException

hasPubKey

public boolean hasPubKey()

Returns:

True if we know the pubkey.

getPubKey

public DSAPublicKey getPubKey()

Returns:

The public key, *if* we know it. Otherwise null.

getPubKeyHash

public byte[] getPubKeyHash()

setPubKey

public void setPubKey(DSAPublicKey pubKey2)
               throws SSKVerifyException

Throws:

SSKVerifyException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Key

hashCode

public int hashCode()

Overrides:

hashCode in class Key

getKeyBytes

public byte[] getKeyBytes()

Overrides:

getKeyBytes in class Key

getFullKey

public byte[] getFullKey()

Description copied from class: Key

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

Specified by:

getFullKey in class Key

construct

public static NodeSSK construct(byte[] buf)
                         throws SSKVerifyException

Throws:

SSKVerifyException

grabPubkey

public boolean grabPubkey(GetPubkey pubkeyCache,
                          boolean canReadClientCache,
                          boolean forULPR,
                          BlockMetadata meta)

routingKeyFromFullKey

public static byte[] routingKeyFromFullKey(byte[] keyBuf)

compareTo

public int compareTo(Key arg0)