aries_cloudagent.askar package

Subpackages

• aries_cloudagent.askar.didcomm package
  • Submodules
  • aries_cloudagent.askar.didcomm.v1 module
  • aries_cloudagent.askar.didcomm.v2 module

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: <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100cce220>)

Bases: object

Handle and metadata for an opened Askar store.

close()

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

name

Accessor for the store name.

class aries_cloudagent.askar.store.AskarStoreConfig(config: dict = None)

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

Accessor for the storage URI.

open_store(provision: bool = False) → aries_cloudagent.askar.store.AskarOpenStore

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

remove_store()

Remove an existing store.

Raises:

• ProfileNotFoundError – If the wallet could not be found
• ProfileError – If there was another aries_askar error