Skip to main content

PrivateKeyStoreJson class

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

An implementation of AbstractPrivateKeyStore that uses a JSON object to store the private key material needed by KeyManagementSystem.

This class must be initialized with a VeramoJsonStore, which serves as the JSON object storing data in memory as well as providing an update notification callback to persist this data. The JSON object does not have to be shared with other users of VeramoJsonStore, but it can be.

If an AbstractSecretBox is used, then key material is encrypted, even in memory.

This API may change without a BREAKING CHANGE notice.

Signature:

export declare class PrivateKeyStoreJson extends AbstractPrivateKeyStore

Extends: AbstractPrivateKeyStore

Constructors

ConstructorModifiersDescription
(constructor)(jsonStore, secretBox)(BETA) Constructs a new instance of the PrivateKeyStoreJson class

Methods

MethodModifiersDescription
deleteKey({ alias })(BETA)
getKey({ alias })(BETA)
importKey(args)(BETA)
listKeys()(BETA)