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

Manage Aries-Askar profile interaction.

class aries_cloudagent.askar.profile.AskarProfile(opened: aries_cloudagent.askar.store.AskarOpenStore, context: aries_cloudagent.config.injection_context.InjectionContext = None, *, profile_id: str = None)

Bases: aries_cloudagent.core.profile.Profile

Provide access to Aries-Askar profile interaction methods.

BACKEND_NAME = 'askar'

bind_providers()

Initialize the profile-level instance providers.

close()

Close the profile instance.

init_ledger_pool()

Initialize the ledger pool.

name

Accessor for the profile name.

remove()

Remove the profile.

session(context: aries_cloudagent.config.injection_context.InjectionContext = None) → aries_cloudagent.core.profile.ProfileSession

Start a new interactive session with no transaction support requested.

store

Accessor for the opened Store instance.

transaction(context: aries_cloudagent.config.injection_context.InjectionContext = None) → aries_cloudagent.core.profile.ProfileSession

Start a new interactive session with commit and rollback support.

If the current backend does not support transactions, then commit and rollback operations of the session will not have any effect.

class aries_cloudagent.askar.profile.AskarProfileManager

Bases: aries_cloudagent.core.profile.ProfileManager

Manager for Aries-Askar stores.

classmethod generate_store_key(seed: str = None) → str

Generate a raw store key.

open(context: aries_cloudagent.config.injection_context.InjectionContext, config: Mapping[str, Any] = None) → aries_cloudagent.core.profile.Profile

Open an instance of an existing profile.

provision(context: aries_cloudagent.config.injection_context.InjectionContext, config: Mapping[str, Any] = None) → aries_cloudagent.core.profile.Profile

Provision a new instance of a profile.

class aries_cloudagent.askar.profile.AskarProfileSession(profile: aries_cloudagent.askar.profile.AskarProfile, is_txn: bool, *, context: aries_cloudagent.config.injection_context.InjectionContext = None, settings: Mapping[str, Any] = None)

Bases: aries_cloudagent.core.profile.ProfileSession

An active connection to the profile management backend.

handle

Accessor for the Session instance.

is_transaction

Check if the session supports commit and rollback operations.

store

Accessor for the Store instance.

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 0x7fc04646feb0>)

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