Package org.drasyl.identity

Class Identity

java.lang.Object

java.net.SocketAddress

org.drasyl.identity.Identity

All Implemented Interfaces:

Serializable

@UnstableApi
public abstract class Identity
extends SocketAddress

Represents the private identity of a peer (includes the proof of work, the public and private key). Should be kept secret!

This is an immutable object.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	POW_DIFFICULTY

Constructor Summary

Constructors

Constructor	Description
Identity()

Method Summary

Modifier and Type	Method	Description
static Identity	generateIdentity()	Generates a new random identity.
DrasylAddress	getAddress()	Returns the address for this identity.
abstract KeyPair<IdentityPublicKey,IdentitySecretKey>	getIdentityKeyPair()
IdentityPublicKey	getIdentityPublicKey()
IdentitySecretKey	getIdentitySecretKey()
abstract KeyPair<KeyAgreementPublicKey,KeyAgreementSecretKey>	getKeyAgreementKeyPair()
KeyAgreementPublicKey	getKeyAgreementPublicKey()
KeyAgreementSecretKey	getKeyAgreementSecretKey()
abstract ProofOfWork	getProofOfWork()
boolean	isValid()	Validates the identity by checking whether the proof of work matches the public key.
static Identity	of(int proofOfWork, String identitySecretKey)
static Identity	of(int proofOfWork, String identityPublicKey, String identitySecretKey)
static Identity	of(int proofOfWork, IdentitySecretKey identitySecretKey)
static Identity	of(int proofOfWork, KeyPair<IdentityPublicKey,IdentitySecretKey> identityKeyPair, KeyPair<KeyAgreementPublicKey,KeyAgreementSecretKey> keyAgreementKeyPair)
static Identity	of(ProofOfWork proofOfWork, String identityPublicKey, String identitySecretKey)
static Identity	of(ProofOfWork proofOfWork, IdentityPublicKey identityPublicKey, IdentitySecretKey identitySecretKey)
static Identity	of(ProofOfWork proofOfWork, IdentitySecretKey identitySecretKey)
static Identity	of(ProofOfWork proofOfWork, KeyPair<IdentityPublicKey,IdentitySecretKey> identityKeyPair)
static Identity	of(ProofOfWork proofOfWork, KeyPair<IdentityPublicKey,IdentitySecretKey> identityKeyPair, KeyPair<KeyAgreementPublicKey,KeyAgreementSecretKey> keyAgreementKeyPair)
String	toUnmaskedString()	Unlike Object.toString(), this method returns the identity with the unmasked secret keys.

Methods inherited from class java.lang.Object

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

Field Details

POW_DIFFICULTY

public static final byte POW_DIFFICULTY

Constructor Details

Identity

public Identity()

Method Details

getProofOfWork

public abstract ProofOfWork getProofOfWork()

getIdentityKeyPair

public abstract KeyPair<IdentityPublicKey,IdentitySecretKey> getIdentityKeyPair()

getKeyAgreementKeyPair

public abstract KeyPair<KeyAgreementPublicKey,KeyAgreementSecretKey> getKeyAgreementKeyPair()

getIdentityPublicKey

public IdentityPublicKey getIdentityPublicKey()

getIdentitySecretKey

public IdentitySecretKey getIdentitySecretKey()

toUnmaskedString

public String toUnmaskedString()

Unlike Object.toString(), this method returns the identity with the unmasked secret keys.

Returns:

identity with unmasked secret keys

getAddress

public DrasylAddress getAddress()

Returns the address for this identity.

Returns:

returns the address for this identity.

getKeyAgreementPublicKey

public KeyAgreementPublicKey getKeyAgreementPublicKey()

getKeyAgreementSecretKey

public KeyAgreementSecretKey getKeyAgreementSecretKey()

isValid

public boolean isValid()

Validates the identity by checking whether the proof of work matches the public key.

Returns:

true if this identity is valid. Otherwise false

of

public static Identity of(ProofOfWork proofOfWork,
 KeyPair<IdentityPublicKey,IdentitySecretKey> identityKeyPair,
 KeyPair<KeyAgreementPublicKey,KeyAgreementSecretKey> keyAgreementKeyPair)

Throws:

NullPointerException - if proofOfWork, identityKeyPair or keyAgreementKeyPair is null.

of

public static Identity of(ProofOfWork proofOfWork,
 IdentityPublicKey identityPublicKey,
 IdentitySecretKey identitySecretKey)

Throws:

NullPointerException - if proofOfWork, identityPublicKey or identitySecretKey is null.

IllegalArgumentException - if identityPublicKey and identitySecretKey can not be converted to a key agreement key pair.

of

public static Identity of(ProofOfWork proofOfWork,
 KeyPair<IdentityPublicKey,IdentitySecretKey> identityKeyPair)

Throws:

IllegalArgumentException - if identityKeyPair can not be converted to a key agreement key pair.

NullPointerException - if proofOfWork, identityKeyPair or a key within the pair is null

of

public static Identity of(ProofOfWork proofOfWork,
 String identityPublicKey,
 String identitySecretKey)

of

public static Identity of(int proofOfWork,
 String identityPublicKey,
 String identitySecretKey)

of

public static Identity of(int proofOfWork,
 KeyPair<IdentityPublicKey,IdentitySecretKey> identityKeyPair,
 KeyPair<KeyAgreementPublicKey,KeyAgreementSecretKey> keyAgreementKeyPair)

Throws:

NullPointerException - if identityKeyPair or keyAgreementKeyPair is null.

of

public static Identity of(int proofOfWork,
 IdentitySecretKey identitySecretKey)

Throws:

NullPointerException - if identitySecretKey is null.

of

public static Identity of(ProofOfWork proofOfWork,
 IdentitySecretKey identitySecretKey)

Throws:

NullPointerException - if proofOfWork or identitySecretKey is null.

of

public static Identity of(int proofOfWork,
 String identitySecretKey)

Throws:

IllegalArgumentException - if identitySecretKey is not a valid secret key.

generateIdentity

public static Identity generateIdentity()
                                 throws IOException

Generates a new random identity.

Returns:

the generated identity

Throws:

IOException - if an identity could not be generated