io.neow3j.crypto

Class NEP2

java.lang.Object

io.neow3j.crypto.NEP2

public class NEP2
extends java.lang.Object

Provides encryption and decryption functionality according to NEP-2 specification.

Field Summary

Fields

Modifier and Type	Field and Description
static ScryptParams	DEFAULT_SCRYPT_PARAMS
static int	DKLEN
static int	N_STANDARD
static byte	NEP2_FLAGBYTE
static byte	NEP2_PREFIX_1
static byte	NEP2_PREFIX_2
static int	NEP2_PRIVATE_KEY_LENGTH
static int	P_STANDARD
static int	R_STANDARD

Constructor Summary

Constructors

Constructor and Description
NEP2()

Method Summary

Modifier and Type	Method and Description
static ECKeyPair	decrypt(java.lang.String password, java.lang.String nep2String) Decrypts the given encrypted private key in NEP-2 format with the given password and standard scrypt parameters.
static ECKeyPair	decrypt(java.lang.String password, java.lang.String nep2String, ScryptParams scryptParams) Decrypts the given encrypted private key in NEP-2 format with the given password and scrypt parameters.
static java.lang.String	encrypt(java.lang.String password, ECKeyPair ecKeyPair) Encrypts the private key of the given key pair with the given password using standard Scrypt parameters.
static java.lang.String	encrypt(java.lang.String password, ECKeyPair ecKeyPair, int n, int p, int r) Encrypts the private key of the given EC key pair following the NEP-2 standard.
static java.lang.String	encrypt(java.lang.String password, ECKeyPair ecKeyPair, ScryptParams scryptParams) Encrypts the private key of the given EC key pair following the NEP-2 standard.
static byte[]	getAddressHash(ECKeyPair ecKeyPair)
static byte[]	performCipherOperation(int mode, byte[] data, byte[] encryptKey)

Methods inherited from class java.lang.Object

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

Field Detail

DKLEN

public static final int DKLEN

See Also:

Constant Field Values

NEP2_PRIVATE_KEY_LENGTH

public static final int NEP2_PRIVATE_KEY_LENGTH

See Also:

Constant Field Values

NEP2_PREFIX_1

public static final byte NEP2_PREFIX_1

See Also:

Constant Field Values

NEP2_PREFIX_2

public static final byte NEP2_PREFIX_2

See Also:

Constant Field Values

NEP2_FLAGBYTE

public static final byte NEP2_FLAGBYTE

See Also:

Constant Field Values

N_STANDARD

public static final int N_STANDARD

See Also:

Constant Field Values

P_STANDARD

public static final int P_STANDARD

See Also:

Constant Field Values

R_STANDARD

public static final int R_STANDARD

See Also:

Constant Field Values

DEFAULT_SCRYPT_PARAMS

public static final ScryptParams DEFAULT_SCRYPT_PARAMS

Constructor Detail

NEP2

public NEP2()

Method Detail

decrypt

public static ECKeyPair decrypt(java.lang.String password,
                                java.lang.String nep2String)
                         throws CipherException,
                                NEP2InvalidFormat,
                                NEP2InvalidPassphrase

Decrypts the given encrypted private key in NEP-2 format with the given password and standard scrypt parameters.

Parameters:

password - The passphrase used for decryption.

nep2String - The NEP-2 ecnrypted private key.

Returns:

an EC key pair constructed form the decrypted private key.

Throws:

NEP2InvalidFormat - throws if the encrypted NEP2 has an invalid format.

CipherException - throws if failed encrypt the created wallet.

NEP2InvalidPassphrase - throws if the passphrase is not valid.

decrypt

public static ECKeyPair decrypt(java.lang.String password,
                                java.lang.String nep2String,
                                ScryptParams scryptParams)
                         throws NEP2InvalidFormat,
                                CipherException,
                                NEP2InvalidPassphrase

Decrypts the given encrypted private key in NEP-2 format with the given password and scrypt parameters.

Parameters:

password - The passphrase used for decryption.

nep2String - The NEP-2 ecnrypted private key.

scryptParams - The scrypt parameters used for encryption.

Returns:

an EC key pair constructed form the decrypted private key.

Throws:

NEP2InvalidFormat - throws if the encrypted NEP2 has an invalid format.

CipherException - throws if failed encrypt the created wallet.

NEP2InvalidPassphrase - throws if the passphrase is not valid.

encrypt

public static java.lang.String encrypt(java.lang.String password,
                                       ECKeyPair ecKeyPair)
                                throws CipherException

Encrypts the private key of the given key pair with the given password using standard Scrypt parameters.

Parameters:

password - The passphrase used for encryption.

ecKeyPair - the ECKeyPair to be encrypted

Returns:

the NEP-2 encrypted private key.

Throws:

CipherException - throws if the key pair cannot be encrypted.

encrypt

public static java.lang.String encrypt(java.lang.String password,
                                       ECKeyPair ecKeyPair,
                                       ScryptParams scryptParams)
                                throws CipherException

Encrypts the private key of the given EC key pair following the NEP-2 standard.

Parameters:

password - the passphrase to be used to encrypt

ecKeyPair - the ECKeyPair to be encrypted

scryptParams - the scrypt parameters used for encryption.

Returns:

the NEP-2 encrypted private key.

Throws:

CipherException - thrown when the AES/ECB/NoPadding cipher operation fails

encrypt

public static java.lang.String encrypt(java.lang.String password,
                                       ECKeyPair ecKeyPair,
                                       int n,
                                       int p,
                                       int r)
                                throws CipherException

Encrypts the private key of the given EC key pair following the NEP-2 standard.

Parameters:

password - the passphrase to be used to encrypt

ecKeyPair - the ECKeyPair to be encrypted

n - the "n" parameter for SCrypt.generate(byte[], byte[], int, int, int, int) method

p - the "p" parameter for SCrypt.generate(byte[], byte[], int, int, int, int) method

r - the "r" parameter for SCrypt.generate(byte[], byte[], int, int, int, int) method

Returns:

the NEP-2 encrypted private key.

Throws:

CipherException - thrown when the AES/ECB/NoPadding cipher operation fails

performCipherOperation

public static byte[] performCipherOperation(int mode,
                                            byte[] data,
                                            byte[] encryptKey)
                                     throws CipherException

Throws:

CipherException

getAddressHash

public static byte[] getAddressHash(ECKeyPair ecKeyPair)