aries_cloudagent.askar.didcomm package

Submodules

aries_cloudagent.askar.didcomm.v1 module

DIDComm v1 envelope handling via Askar backend.

aries_cloudagent.askar.didcomm.v1.pack_message(to_verkeys: Sequence[str], from_key: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f2100aad490>], message: bytes) → bytes[source]

Encode a message using the DIDComm v1 ‘pack’ algorithm.

aries_cloudagent.askar.didcomm.v1.unpack_message(session: <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100aad5e0>, enc_message: bytes) → Tuple[str, str, str][source]

Decode a message using the DIDComm v1 ‘unpack’ algorithm.

aries_cloudagent.askar.didcomm.v2 module

DIDComm v2 envelope handling via Askar backend.

exception aries_cloudagent.askar.didcomm.v2.DidcommEnvelopeError(*args, error_code: str = None, **kwargs)[source]

Bases: aries_cloudagent.wallet.error.WalletError

A base error class for DIDComm envelope wrapping and unwrapping operations.

aries_cloudagent.askar.didcomm.v2.ecdh_1pu_decrypt(wrapper: aries_cloudagent.utils.jwe.JweEnvelope, recip_kid: str, recip_key: <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100a6ca30>, sender_key: <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100a6ca30>) → Tuple[str, str, str][source]

Decode a message with DIDComm v2 authenticated encryption.

aries_cloudagent.askar.didcomm.v2.ecdh_1pu_encrypt(to_verkeys: Mapping[str, <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100a6ca30>], sender_kid: str, sender_key: <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100a6ca30>, message: bytes) → bytes[source]

Encode a message using DIDComm v2 authenticated encryption.

aries_cloudagent.askar.didcomm.v2.ecdh_es_decrypt(wrapper: aries_cloudagent.utils.jwe.JweEnvelope, recip_kid: str, recip_key: <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100a6ca30>) → bytes[source]

Decode a message with DIDComm v2 anonymous encryption.

aries_cloudagent.askar.didcomm.v2.ecdh_es_encrypt(to_verkeys: Mapping[str, <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100a6ca30>], message: bytes) → bytes[source]

Encode a message using DIDComm v2 anonymous encryption.

aries_cloudagent.askar.didcomm.v2.unpack_message(session: <sphinx.ext.autodoc.importer._MockObject object at 0x7f2100a6c8b0>, enc_message: Union[bytes, str]) → Tuple[str, str, str][source]

Decode a message using DIDComm v2 encryption.