Interface ICipher
An interface to define symmetric cipher algorithm.
Namespace: Libplanet.KeyStore.Ciphers
Assembly: Libplanet.dll
Syntax
public interface ICipherMethods
| Improve this Doc View SourceDecrypt(in ImmutableArray<Byte>, in ImmutableArray<Byte>)
Decrypts the given ciphertext using the given key.
Declaration
[Pure]
ImmutableArray<byte> Decrypt(in ImmutableArray<byte> key, in ImmutableArray<byte> ciphertext)Parameters
| Type | Name | Description |
|---|---|---|
| ImmutableArray<Byte> | key | A symmetric key. |
| ImmutableArray<Byte> | ciphertext | An immutable Byte array to decrypt. |
Returns
| Type | Description |
|---|---|
| ImmutableArray<Byte> | The plain text decrypted from the |
Encrypt(in ImmutableArray<Byte>, in ImmutableArray<Byte>)
Encrypts the given plaintext using the given key.
Declaration
[Pure]
ImmutableArray<byte> Encrypt(in ImmutableArray<byte> key, in ImmutableArray<byte> plaintext)Parameters
| Type | Name | Description |
|---|---|---|
| ImmutableArray<Byte> | key | A symmetric key. |
| ImmutableArray<Byte> | plaintext | An immutable Byte array to encrypt. |
Returns
| Type | Description |
|---|---|
| ImmutableArray<Byte> | The ciphertext made from the |
WriteJson(Utf8JsonWriter)
Dumps the cipher parameters as a JSON representation according to Ethereum's Web3 Secret Storage Definition.
Declaration
string WriteJson(Utf8JsonWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| Utf8JsonWriter | writer | A JSON writer which has not begun object nor array. |
Returns
| Type | Description |
|---|---|
| String | A unique identifier of the cipher algorithm. This is going to be the
|