Package org.xrpl.xrpl4j.crypto

Interface KeyStoreType

All Known Implementing Classes:

ImmutableDefaultKeyStoreType, KeyStoreType.DefaultKeyStoreType

public interface KeyStoreType

An extensible interface that can be used to identify a type of underlying key-storage, which typically treats key-material as "secret information" whereas the data encrypted by these keys is generally not stored in these platforms.

For example, a database password would not be stored in the key-store. Instead, a private key or symmetric key would be stored in the key-store, and the encrypted database password would be stored in some other system in encrypted form.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	KeyStoreType.DefaultKeyStoreType	For immutables.

Field Summary

Fields

Modifier and Type	Field	Description
static final KeyStoreType	DERIVED_SERVER_SECRET	Private keys are derived from a seed that is derived from a unique identifier and an in-memory server secret.
static final KeyStoreType	GCP_KMS	Private keys and symmetric secrets are stored in Google Cloud Platform KMS.

Method Summary

Modifier and Type	Method	Description
static ImmutableDefaultKeyStoreType.Builder	builder()	Builder for immutables.
static KeyStoreType	fromKeystoreTypeId(String keystoreTypeId)	Helper method to construct a org.xrpl4j.crypto.keystore type from a String.
String	keystoreId()	The unique identifier of this KeyStore type.
static KeyStoreType	of(String keystoreId)	Builder.

Field Details

DERIVED_SERVER_SECRET

static final KeyStoreType DERIVED_SERVER_SECRET

Private keys are derived from a seed that is derived from a unique identifier and an in-memory server secret.

GCP_KMS

static final KeyStoreType GCP_KMS

Private keys and symmetric secrets are stored in Google Cloud Platform KMS.

Method Details

builder

static ImmutableDefaultKeyStoreType.Builder builder()

Builder for immutables.

Returns:

A ImmutableDefaultKeyStoreType.Builder.

of

static KeyStoreType of(String keystoreId)

Builder.

Parameters:

keystoreId - A String identifying the KeyStore.

Returns:

A KeyStoreType.

fromKeystoreTypeId

static KeyStoreType fromKeystoreTypeId(String keystoreTypeId)

Helper method to construct a org.xrpl4j.crypto.keystore type from a String.

Parameters:

keystoreTypeId - A String identifying the KeyStore type to construct.

Returns:

A KeyStoreType.

keystoreId

String keystoreId()

The unique identifier of this KeyStore type.

Returns:

A String