Package com.icodici.crypto

Class KeyAddress

java.lang.Object

com.icodici.crypto.KeyAddress

All Implemented Interfaces:

KeyMatcher

public class KeyAddress
extends java.lang.Object
implements KeyMatcher

The address is a short (more or less) representation of any AbstractKey that implements AbstractKey.updateDigestWithKeyComponents(Digest) method. The address contains verification code, key type information and the hash itself. To check that some key matches the address, create KeyAddress instance from a string or packed bytes and call isMatchingKey(AbstractKey) to check it is ok.

It is possible to keep any 4 bits of extra data, getTypeMark(), which will also be protected by the control code.

The inner structure is:

First byte: bits 0x-1..0x08 - key type mask (15 types except code 0), bits 0x10..0x80 - mark byte, [0..15]

bytes [1..48]:Sha3_384 digest of the key in question

bytes [49..53]: Crc32 control code of all previous bytes

Packed to string the long address takes 72 characters, short version only 51.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyAddress.IllegalAddressException

Constructor Summary

Constructors

Constructor	Description
KeyAddress()
KeyAddress(byte[] packedSource)	Unpack an address.
KeyAddress(AbstractKey key, int typeMark, boolean useSha3_384)	Build new KeyAddrAddress for a given key
KeyAddress(java.lang.String packedString)	Unpack the string-encoded key (it actually uses Safe58 to encode).
KeyAddress(net.sergeych.tools.Binder binder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static net.sergeych.biserializer.BiAdapter	getBiAdapter()
byte[]	getPacked()
int	getTypeMark()
int	hashCode()
boolean	isLong()
boolean	isMatchingKey(AbstractKey key)	Check that the key matches this address, e.g.
boolean	isMatchingKeyAddress(KeyAddress other)	Check that the address matches key information.
protected static int	mask(AbstractKey k)	Each supported key has a mask that represents its type.
java.lang.String	toString()	Get the packed string representaion.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyAddress

public KeyAddress()

KeyAddress

public KeyAddress(AbstractKey key,
                  int typeMark,
                  boolean useSha3_384)

Build new KeyAddrAddress for a given key

Parameters:

key - to calculate address from

typeMark - any small number between 0 and 15 inclusive to be stored with address (will also be protected)

useSha3_384 - use longer but more solid hash which is more resistent to wuantum attacks

KeyAddress

public KeyAddress(byte[] packedSource)
           throws KeyAddress.IllegalAddressException

Unpack an address. After construction, use getTypeMark() and isMatchingKey(AbstractKey) methods to retrieve information.

Parameters:

packedSource - binary data holding the address

Throws:

KeyAddress.IllegalAddressException - if the adress is malformed (control code does not match or wrong type code)

KeyAddress

public KeyAddress(java.lang.String packedString)
           throws KeyAddress.IllegalAddressException

Unpack the string-encoded key (it actually uses Safe58 to encode). See KeyAddress(byte[]) for more.

Parameters:

packedString - string with encoded address, use toString() to obtain packed string representation

Throws:

KeyAddress.IllegalAddressException - if the address is malformed (control code is not valid or bad type code)

KeyAddress

public KeyAddress(net.sergeych.tools.Binder binder)

Method Detail

isMatchingKey

public boolean isMatchingKey(AbstractKey key)

Check that the key matches this address, e.g. has of the same type and the digest of its components is the same. The key components digest is calculated by the key self in the AbstractKey.updateDigestWithKeyComponents(Digest)

Specified by:

isMatchingKey in interface KeyMatcher

Parameters:

key - to check

Returns:

true if the key matches (what means, it is the key corresponding to this address)

isMatchingKeyAddress

public boolean isMatchingKeyAddress(KeyAddress other)

Check that the address matches key information. It DOES NOT check the typeMark getTypeMark()! If the type mark is important, check it by hand. If teh address sizes are different always retuen false, in this case it is not possible to perform the real check.

Specified by:

isMatchingKeyAddress in interface KeyMatcher

Parameters:

other -

isLong

public final boolean isLong()

Returns:

true if long version SHA3-384) was used for this address

getPacked

public final byte[] getPacked()

Returns:

packed binary address

getTypeMark

public final int getTypeMark()

Returns:

the type mark (between 0 and 15 inclusive)

toString

public java.lang.String toString()

Get the packed string representaion. Uses Safe58 to encode data provided by the getPacked()

Overrides:

toString in class java.lang.Object

Returns:

mask

protected static int mask(AbstractKey k)

Each supported key has a mask that represents its type. The key that has no known mask can't be processed bt the address.

Parameters:

k - key to calculate mask of.

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getBiAdapter

public static net.sergeych.biserializer.BiAdapter getBiAdapter()