hera.key

Class AergoKey

java.lang.Object

hera.key.AergoKey

All Implemented Interfaces:

KeyPair, MessageSigner, Signer, TxSigner, WithPrincipal

@ApiAudience.Public
 @ApiStability.Unstable
public class AergoKey
extends java.lang.Object
implements KeyPair, Signer, MessageSigner

Field Summary

Fields

Modifier and Type	Field and Description
protected AccountAddress	address
protected ECDSAKey	ecdsakey
protected org.slf4j.Logger	logger
protected AergoSignVerifier	verifier

Constructor Summary

Constructors

Constructor and Description
AergoKey(ECDSAKey ecdsakey) AergoKey constructor.
AergoKey(EncryptedPrivateKey encryptedPrivateKey, java.lang.String password) AergoKey constructor.
AergoKey(java.lang.String encodedEncryptedPrivateKey, java.lang.String password) AergoKey constructor.

Method Summary

Modifier and Type	Method and Description
EncryptedPrivateKey	export(java.lang.String password) Return encrypted private key.
AccountAddress	getPrincipal() Get principal of a signer.
java.security.PrivateKey	getPrivateKey() Get private key.
java.security.PublicKey	getPublicKey() Get public key.
protected byte[]	getRawPrivateKey()
static AergoKey	of(EncryptedPrivateKey encryptedPrivateKey, java.lang.String password) Create a key pair with encrypted private key and password.
static AergoKey	of(java.lang.String encodedEncryptedPrivateKey, java.lang.String password) Create a key pair with encoded encrypted private key and password.
Transaction	sign(RawTransaction rawTransaction) Sign to raw transaction.
Signature	signMessage(BytesValue message) Sha256 hash to message and sign to it.
java.lang.String	signMessage(java.lang.String message) Sha256 hash to message and sign to it.
java.lang.String	signMessage(java.lang.String message, Encoder encoder) Sha256 hash to message and sign to it.
java.lang.String	toString()
boolean	verify(Transaction transaction) Check if Transaction is valid.
boolean	verifyMessage(BytesValue message, Signature signature) Check if signature is valid for current accountAddress and message.
boolean	verifyMessage(Hash hashedMessage, Signature signature) Check if signature is valid for hash and current address.
boolean	verifyMessage(java.lang.String message, java.lang.String base64EncodedSignature) Check if base64EncodedSignature is valid for current accountAddress and message.
boolean	verifyMessage(java.lang.String message, java.lang.String encodedSignature, Decoder decoder) Check if base64EncodedSignature is valid for current accountAddress and message.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final transient org.slf4j.Logger logger

verifier

protected final AergoSignVerifier verifier

ecdsakey

protected final ECDSAKey ecdsakey

address

protected final AccountAddress address

Constructor Detail

AergoKey

public AergoKey(java.lang.String encodedEncryptedPrivateKey,
                java.lang.String password)

AergoKey constructor.

Parameters:

encodedEncryptedPrivateKey - base58 with checksum encoded encrypted private key

password - password to decrypt

AergoKey

public AergoKey(EncryptedPrivateKey encryptedPrivateKey,
                java.lang.String password)

AergoKey constructor.

Parameters:

encryptedPrivateKey - encrypted private key

password - password to decrypt

AergoKey

public AergoKey(ECDSAKey ecdsakey)

AergoKey constructor.

Parameters:

ecdsakey - keypair

Method Detail

of

public static AergoKey of(java.lang.String encodedEncryptedPrivateKey,
                          java.lang.String password)

Create a key pair with encoded encrypted private key and password.

Parameters:

encodedEncryptedPrivateKey - base58 with checksum encoded encrypted private key

password - password to decrypt

Returns:

key instance

of

public static AergoKey of(EncryptedPrivateKey encryptedPrivateKey,
                          java.lang.String password)

Create a key pair with encrypted private key and password.

Parameters:

encryptedPrivateKey - encrypted private key

password - password to decrypt

Returns:

key instance

getPrivateKey

public java.security.PrivateKey getPrivateKey()

Description copied from interface: KeyPair

Get private key.

Specified by:

getPrivateKey in interface KeyPair

Returns:

private key

getPublicKey

public java.security.PublicKey getPublicKey()

Description copied from interface: KeyPair

Get public key.

Specified by:

getPublicKey in interface KeyPair

Returns:

public key

getPrincipal

public AccountAddress getPrincipal()

Description copied from interface: WithPrincipal

Get principal of a signer.

Specified by:

getPrincipal in interface WithPrincipal

Returns:

a identitprincipal of signer

sign

public Transaction sign(RawTransaction rawTransaction)

Description copied from interface: Signer

Sign to raw transaction.

Specified by:

sign in interface Signer

Specified by:

sign in interface TxSigner

Parameters:

rawTransaction - raw transaction to sign

Returns:

a signed transaction

signMessage

public java.lang.String signMessage(java.lang.String message)

Description copied from interface: MessageSigner

Sha256 hash to message and sign to it.

Specified by:

signMessage in interface MessageSigner

Parameters:

message - a message to sign

Returns:

base64 encoded signature

signMessage

public java.lang.String signMessage(java.lang.String message,
                                    Encoder encoder)

Description copied from interface: MessageSigner

Sha256 hash to message and sign to it.

Specified by:

signMessage in interface MessageSigner

Parameters:

message - a message to sign

encoder - an encoder to encode signed message

Returns:

an encoded signature

signMessage

public Signature signMessage(BytesValue message)

Description copied from interface: MessageSigner

Sha256 hash to message and sign to it.

Specified by:

signMessage in interface MessageSigner

Parameters:

message - a message to sign

Returns:

a signature

verify

public boolean verify(Transaction transaction)

Check if Transaction is valid.

Parameters:

transaction - transaction to verify

Returns:

if valid

verifyMessage

public boolean verifyMessage(java.lang.String message,
                             java.lang.String base64EncodedSignature)

Check if base64EncodedSignature is valid for current accountAddress and message. It hashes message and verify hashed one.

Parameters:

message - a message

base64EncodedSignature - a base64 encoded signature

Returns:

if valid

verifyMessage

public boolean verifyMessage(java.lang.String message,
                             java.lang.String encodedSignature,
                             Decoder decoder)

Check if base64EncodedSignature is valid for current accountAddress and message. It hashes message and verify hashed one.

Parameters:

message - a message

encodedSignature - an encoded signature

decoder - a decoder to decode encoded signature

Returns:

if valid

verifyMessage

public boolean verifyMessage(BytesValue message,
                             Signature signature)

Check if signature is valid for current accountAddress and message. It hashes message and verify hashed one.

Parameters:

message - a message

signature - signature

Returns:

if valid

verifyMessage

public boolean verifyMessage(Hash hashedMessage,
                             Signature signature)

Check if signature is valid for hash and current address.

Parameters:

hashedMessage - a hashed message

signature - signature to verify

Returns:

if valid

export

public EncryptedPrivateKey export(java.lang.String password)

Return encrypted private key.

Parameters:

password - encrypt key

Returns:

encrypted key

getRawPrivateKey

protected byte[] getRawPrivateKey()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object