Class PublicKey

A public part of a key pair involved in ECDSA, the digital signature algorithm on which the Libplanet is based. It can be used to verify signatures created with the corresponding PrivateKey and to encrypt messages for someone possessing the corresponding PrivateKey. This can be distributed publicly, hence the name.

Note that it uses secp256k1 as the parameters of the elliptic curve, which is same to Bitcoin and Ethereum. It means public keys generated for Bitcoin/Ethereum can be used by Libplanet-backed games/apps too.

Inheritance

Object

PublicKey

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Libplanet.Crypto

Assembly: Libplanet.dll

Syntax

public class PublicKey

Remarks

Every PublicKey object is immutable.

Constructors

PublicKey(IReadOnlyList<Byte>)

Creates a PublicKey instance from the given Byte array (i.e., publicKey), which encodes a valid ECDSA public key.

Declaration

public PublicKey(IReadOnlyList<byte> publicKey)

Parameters

Type	Name	Description
IReadOnlyList<Byte>	publicKey	A valid Byte array that encodes an ECDSA public key. It can be either compressed or not.

Remarks

A valid Byte array for a PublicKey can be encoded using Format(Boolean) method.

See Also

Format(Boolean)

Methods

Encrypt(ImmutableArray<Byte>)

Encrypts a plaintext message to a ciphertext, which can be decrypted with the corresponding PrivateKey.

Declaration

public ImmutableArray<byte> Encrypt(ImmutableArray<byte> message)

Parameters

Type	Name	Description
ImmutableArray<Byte>	message	A binary data to encrypt.

Returns

Type	Description
ImmutableArray<Byte>	A ciphertext that was encrypted from the original message. This can be decrypted with the corresponding PrivateKey.

Remarks

Although the word “ciphertext” has the word “text”, a returned ciphertext is not a Unicode String, but a mutable Byte array.

See Also

Decrypt(ImmutableArray<Byte>)

Encrypt(Byte[])

Encrypts a plaintext message to a ciphertext, which can be decrypted with the corresponding PrivateKey.

Declaration

public byte[] Encrypt(byte[] message)

Parameters

Type	Name	Description
Byte[]	message	A binary data to encrypt.

Returns

Type	Description
Byte[]	A ciphertext that was encrypted from the original message. This can be decrypted with the corresponding PrivateKey.

Remarks

Although the word “ciphertext” has the word “text”, a returned ciphertext is not a Unicode String, but a mutable Byte array.

See Also

Decrypt(Byte[])

Format(Boolean)

Encodes this public key into a mutable Byte array representation.

To get an immutable one, use ToImmutableArray(Boolean) method instead.

Declaration

[Pure]
public byte[] Format(bool compress)

Parameters

Type	Name	Description
Boolean	compress	Returns a short length representation if it is true. This option does not lose any information.

Returns

Type	Description
Byte[]	An encoded mutable Byte array representation. It can be recovered to a PublicKey instance again using PublicKey(IReadOnlyList<Byte>) constructor whether it is compressed or not.

See Also

ToImmutableArray(Boolean)

PublicKey(IReadOnlyList<Byte>)

ToImmutableArray(Boolean)

Encodes this public key into a immutable Byte array representation.

To get an mutable one, use Format(Boolean) method instead.

Declaration

[Pure]
public ImmutableArray<byte> ToImmutableArray(bool compress)

Parameters

Type	Name	Description
Boolean	compress	Returns a short length representation if it is true. This option does not lose any information.

Returns

Type	Description
ImmutableArray<Byte>	An encoded immutable Byte array representation. It can be recovered to a PublicKey instance again using PublicKey(IReadOnlyList<Byte>) constructor whether it is compressed or not.

See Also

Format(Boolean)

PublicKey(IReadOnlyList<Byte>)

ToString()

Gets the public key's hexadecimal representation in compressed form.

Declaration

public override string ToString()

Returns

Type	Description
String	The hexadecimal string of the public key's compressed bytes.

Overrides

Object.ToString()

Verify(IReadOnlyList<Byte>, IReadOnlyList<Byte>)

Verifies whether a signature proves authenticity of message with the corresponding PrivateKey.

Declaration

[Pure]
public bool Verify(IReadOnlyList<byte> message, IReadOnlyList<byte> signature)

Parameters

Type	Name	Description
IReadOnlyList<Byte>	message	A original plaintext message that the signature tries to prove its authenticity. I.e., an argument data passed to Sign(Byte[]) or Sign(ImmutableArray<Byte>) methods.
IReadOnlyList<Byte>	signature	A signature which tries to authenticity of message. I.e., a data that Sign(Byte[]) or Sign(ImmutableArray<Byte>) methods returned.

Returns

Type	Description
Boolean	true if the signature proves authenticity of the message with the corresponding PrivateKey. Otherwise false.

Operators

Equality(PublicKey, PublicKey)

Declaration

public static bool operator ==(PublicKey left, PublicKey right)

Parameters

Type	Name	Description
PublicKey	left
PublicKey	right

Returns

Type	Description
Boolean

Inequality(PublicKey, PublicKey)

Declaration

public static bool operator !=(PublicKey left, PublicKey right)

Parameters

Type	Name	Description
PublicKey	left
PublicKey	right

Returns

Type	Description
Boolean

Extension Methods

AddressExtensions.ToAddress(PublicKey)

See Also

PrivateKey

Address