aries_cloudagent.askar package

Subpackages

Submodules

aries_cloudagent.askar.profile module

aries_cloudagent.askar.store module

Aries-Askar backend store configuration.

class aries_cloudagent.askar.store.AskarOpenStore(config: aries_cloudagent.askar.store.AskarStoreConfig, created, store: aries_askar.Store)[source]

Bases: object

Handle and metadata for an opened Askar store.

async close()[source]

Close previously-opened store, removing it if so configured.

property name: str

Accessor for the store name.

class aries_cloudagent.askar.store.AskarStoreConfig(config: Optional[dict] = None)[source]

Bases: object

A helper class for handling Askar store configuration.

DEFAULT_KEY = ''
DEFAULT_KEY_DERIVATION = 'kdf:argon2i:mod'
DEFAULT_STORAGE_TYPE = None
KEY_DERIVATION_ARGON2I_INT = 'kdf:argon2i:int'
KEY_DERIVATION_ARGON2I_MOD = 'kdf:argon2i:mod'
KEY_DERIVATION_RAW = 'RAW'
get_uri(create: bool = False) → str[source]

Accessor for the storage URI.

async open_store(provision: bool = False) → aries_cloudagent.askar.store.AskarOpenStore[source]

Open a store, removing and/or creating it if so configured.

Raises

  • ProfileNotFoundError – If the store is not found

  • ProfileError – If there is another aries_askar error

async remove_store()[source]

Remove an existing store.

Raises

  • ProfileNotFoundError – If the wallet could not be found

  • ProfileError – If there was another aries_askar error