acapy_agent.askar package

Subpackages

• acapy_agent.askar.didcomm package
  • Submodules
  • acapy_agent.askar.didcomm.v1 module
    • pack_message()
    • unpack_message()
  • acapy_agent.askar.didcomm.v2 module
    • DidcommEnvelopeError
    • ecdh_1pu_decrypt()
    • ecdh_1pu_encrypt()
    • ecdh_es_decrypt()
    • ecdh_es_encrypt()
    • unpack_message()

Submodules

acapy_agent.askar.profile module

acapy_agent.askar.profile_anon module

Manage Aries-Askar profile interaction.

class acapy_agent.askar.profile_anon.AskarAnonCredsProfile(opened: AskarOpenStore, context: InjectionContext | None = None, *, profile_id: str | None = None)

Bases: Profile

Provide access to Aries-Askar profile interaction methods.

BACKEND_NAME: str | None = 'askar-anoncreds'

TEST_PROFILE_NAME = 'test-profile'

bind_providers()

Initialize the profile-level instance providers.

async close()

Close the profile instance.

init_ledger_pool()

Initialize the ledger pool.

property name: str

Accessor for the profile name.

async remove()

Remove the profile.

session(context: InjectionContext | None = None) → AskarAnonCredsProfileSession

Start a new interactive session with no transaction support requested.

property store: aries_askar.Store

Accessor for the opened Store instance.

transaction(context: InjectionContext | None = None) → AskarAnonCredsProfileSession

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 acapy_agent.askar.profile_anon.AskarAnonCredsProfileSession(profile: AskarAnonCredsProfile, is_txn: bool, *, context: InjectionContext | None = None, settings: Mapping[str, Any] = None)

Bases: ProfileSession

An active connection to the profile management backend.

property handle: aries_askar.Session

Accessor for the Session instance.

property is_transaction: bool

Check if the session supports commit and rollback operations.

property store: aries_askar.Store

Accessor for the Store instance.

class acapy_agent.askar.profile_anon.AskarAnonProfileManager

Bases: ProfileManager

Manager for Aries-Askar stores.

async classmethod generate_store_key(seed: str | None = None) → str

Generate a raw store key.

async open(context: InjectionContext, config: Mapping[str, Any] = None) → Profile

Open an instance of an existing profile.

async provision(context: InjectionContext, config: Mapping[str, Any] = None) → Profile

Provision a new instance of a profile.

acapy_agent.askar.store module

Askar store configuration and management.

class acapy_agent.askar.store.AskarOpenStore(config: AskarStoreConfig, created: bool, store: aries_askar.Store)

Bases: object

Handle and metadata for an opened Askar store.

async close()

Close and optionally remove the store.

config: AskarStoreConfig

created: bool

property name: str

Accessor for the store name.

store: aries_askar.Store

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

Bases: object

Helper for handling Askar store configuration.

DEFAULT_KEY = ''

DEFAULT_KEY_DERIVATION = 'kdf:argon2i:mod'

SUPPORTED_STORAGE_TYPES = ('sqlite', 'postgres')

get_uri(create: bool = False, in_memory: bool | None = False) → str

Construct the storage URI.

async open_store(provision: bool = False, in_memory: bool | None = False) → AskarOpenStore

Open or provision the store based on configuration.

async remove_store()

Remove the store if it exists.