Package com.goterl.lazysodium.interfaces

Class Ed25519.Ed25519Point

java.lang.Object

com.goterl.lazysodium.interfaces.Ed25519.Ed25519Point

Enclosing interface:

Ed25519

public static final class Ed25519.Ed25519Point
extends Object

Method Summary

Modifier and Type	Method	Description
static Ed25519.Ed25519Point	base(LazySodium ls)	Returns the base point of the Ed25519 group.
String	encode()	Encodes the point using the LazySodium's associated MessageEncoder.
boolean	equals(Object o)
static Ed25519.Ed25519Point	fromBytes(LazySodium ls, byte[] bytes)	Creates a new Ed25519.Ed25519Point from the binary representation.
static Ed25519.Ed25519Point	fromHex(LazySodium ls, String hex)	Creates a new Ed25519.Ed25519Point from the hexadecimal representation.
static Ed25519.Ed25519Point	fromString(LazySodium ls, String encoded)	Creates a new Ed25519.Ed25519Point from the encoded representation, using the LazySodium's associated MessageEncoder.
int	hashCode()
static Ed25519.Ed25519Point	hashToPoint(LazySodium ls, byte[] input)	Maps the input to a Ed25519.Ed25519Point, by calculating the SHA-512 hash and mapping it to the Ed25519 group, using crypto_code_ed25519_from_uniform, i.e.
static Ed25519.Ed25519Point	hashToPoint(LazySodium ls, String encodedInput)	Maps the encoded input to a Ed25519.Ed25519Point, using the LazySodium's associated MessageEncoder.
Ed25519.Ed25519Point	minus(Ed25519.Ed25519Point other)	Subtracts the given point from this point.
Ed25519.Ed25519Point	negate()	Returns the additive inverse of this point.
Ed25519.Ed25519Point	plus(Ed25519.Ed25519Point other)	Adds the given point to this point.
static Ed25519.Ed25519Point	random(LazySodium ls)	Returns a random element of the Ed25519 group.
Ed25519.Ed25519Point	scalarMult(BigInteger n)	Multiplies this point by a given scalar.
Ed25519.Ed25519Point	times(BigInteger n)	Multiplies this point by a given scalar.
byte[]	toBytes()	Returns this point's canonical encoding.
String	toHex()	Returns the hexadecimal notation of this point's canonical encoding.
String	toString()
static Ed25519.Ed25519Point	zero(LazySodium ls)	Returns the zero element (identity element) of the Ed25519 group.

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toHex

public String toHex()

Returns the hexadecimal notation of this point's canonical encoding.

Returns:

the point in hexadecimal notation

toBytes

public byte[] toBytes()

Returns this point's canonical encoding.

Returns:

the point

encode

public String encode()

Encodes the point using the LazySodium's associated MessageEncoder.

Returns:

the encoded point

scalarMult

public Ed25519.Ed25519Point scalarMult(BigInteger n)
                                throws SodiumException

Multiplies this point by a given scalar.

Parameters:

n - the scalar to multiply by

Returns:

the multiplied point

Throws:

SodiumException - if the result is zero

times

public Ed25519.Ed25519Point times(BigInteger n)
                           throws SodiumException

Multiplies this point by a given scalar.

Parameters:

n - the scalar to multiply by

Returns:

the multiplied point

Throws:

SodiumException - if the result is zero

plus

public Ed25519.Ed25519Point plus(Ed25519.Ed25519Point other)
                          throws SodiumException

Adds the given point to this point. Addition is commutative.

Parameters:

other - the point to add

Returns:

the sum of both points

Throws:

SodiumException - when the operation failed

minus

public Ed25519.Ed25519Point minus(Ed25519.Ed25519Point other)
                           throws SodiumException

Subtracts the given point from this point.

Parameters:

other - the point to subtract

Returns:

the difference of both points.

Throws:

SodiumException - when the operation failed

negate

public Ed25519.Ed25519Point negate()
                            throws SodiumException

Returns the additive inverse of this point. This is equivalent to 0 - p where 0 denotes the additive identity.

Returns:

the additive inverse

Throws:

SodiumException - when the operation failed.

zero

public static Ed25519.Ed25519Point zero(LazySodium ls)

Returns the zero element (identity element) of the Ed25519 group.

Parameters:

ls - the LazySodium instance

Returns:

the identity element of Ed25519

random

public static Ed25519.Ed25519Point random(LazySodium ls)

Returns a random element of the Ed25519 group.

Parameters:

ls - the LazySodium instance

Returns:

a random element of Ed25519

base

public static Ed25519.Ed25519Point base(LazySodium ls)
                                 throws SodiumException

Returns the base point of the Ed25519 group.

Parameters:

ls - the LazySodium instance

Returns:

the base point of Ed25519

Throws:

SodiumException

fromHex

public static Ed25519.Ed25519Point fromHex(LazySodium ls,
 String hex)

Creates a new Ed25519.Ed25519Point from the hexadecimal representation. The hexadecimal representation must be a valid canonical encoding.

Parameters:

ls - the LazySodium instance

hex - the Ed25519 canonical encoding in hexadecimal notation

Returns:

the corresponding Ed25519.Ed25519Point

fromString

public static Ed25519.Ed25519Point fromString(LazySodium ls,
 String encoded)

Creates a new Ed25519.Ed25519Point from the encoded representation, using the LazySodium's associated MessageEncoder. The decoded bytes must be a valid canonical encoding.

Parameters:

ls - the LazySodium instance

encoded - the encoded Ed25519 point

Returns:

the corresponding Ed25519.Ed25519Point

fromBytes

public static Ed25519.Ed25519Point fromBytes(LazySodium ls,
 byte[] bytes)

Creates a new Ed25519.Ed25519Point from the binary representation. The binary representation must be a valid canonical encoding.

Parameters:

ls - the LazySodium instance

bytes - the Ed25519 canonical encoding

Returns:

the corresponding Ed25519.Ed25519Point

hashToPoint

public static Ed25519.Ed25519Point hashToPoint(LazySodium ls,
 String encodedInput)
                                        throws SodiumException

Maps the encoded input to a Ed25519.Ed25519Point, using the LazySodium's associated MessageEncoder. The resulting bytes are hashed using SHA-512 and mapped to the Ed25519 group, using crypto_code_ed25519_from_uniform, i.e. the standard hash-to-group algorithm.

Parameters:

ls - the LazySodium instance

encodedInput - the encoded bytes

Returns:

the mapped Ed25519.Ed25519Point

Throws:

SodiumException - if the mapping failed

hashToPoint

public static Ed25519.Ed25519Point hashToPoint(LazySodium ls,
 byte[] input)
                                        throws SodiumException

Maps the input to a Ed25519.Ed25519Point, by calculating the SHA-512 hash and mapping it to the Ed25519 group, using crypto_code_ed25519_from_uniform, i.e. the standard hash-to-group algorithm.

Parameters:

ls - the LazySodium instance

input - the input bytes

Returns:

the mapped Ed25519.Ed25519Point

Throws:

SodiumException - if the mapping failed