aries_cloudagent.messaging package¶

Subpackages¶

Submodules¶

aries_cloudagent.messaging.agent_message module¶

Agent message base class and schema.

class aries_cloudagent.messaging.agent_message.AgentMessage(_id: str = None, _decorators: aries_cloudagent.messaging.decorators.base.BaseDecoratorSet = None)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModel

Agent message base class.

Handler¶

Accessor for the agent message’s handler class.

Returns:	Handler class

class Meta[source]¶

Bases: object

AgentMessage metadata.

handler_class = None¶

message_type = None¶

schema_class = None¶

add_trace_decorator(target: str = 'log', full_thread: bool = True)[source]¶

Create a new trace decorator.

Parameters:	target – The trace target full_thread – Full thread flag

add_trace_report(val: Union[aries_cloudagent.messaging.decorators.trace_decorator.TraceReport, dict])[source]¶

Append a new trace report.

Parameters:	val – The trace target

assign_thread_from(msg: aries_cloudagent.messaging.agent_message.AgentMessage)[source]¶

Copy thread information from a previous message.

Parameters:	msg – The received message containing optional thread information

assign_thread_id(thid: str, pthid: str = None)[source]¶

Assign a specific thread ID.

Parameters:	thid – The thread identifier pthid – The parent thread identifier

assign_trace_decorator(context, trace)[source]¶

Copy trace from a json structure.

Parameters:	trace – string containing trace json stucture

assign_trace_from(msg: aries_cloudagent.messaging.agent_message.AgentMessage)[source]¶

Copy trace information from a previous message.

Parameters:	msg – The received message containing optional trace information

get_signature(field_name: str) → aries_cloudagent.messaging.decorators.signature_decorator.SignatureDecorator[source]¶

Get the signature for a named field.

Parameters:	field_name – Field name to get the signature for
Returns:	A SignatureDecorator for the requested field name

set_signature(field_name: str, signature: aries_cloudagent.messaging.decorators.signature_decorator.SignatureDecorator)[source]¶

Add or replace the signature for a named field.

Parameters:	field_name – Field to set signature on signature – Signature for the field

sign_field(field_name: str, signer_verkey: str, wallet: aries_cloudagent.wallet.base.BaseWallet, timestamp=None) → aries_cloudagent.messaging.decorators.signature_decorator.SignatureDecorator[source]¶

Create and store a signature for a named field.

Parameters:	field_name – Field to sign signer_verkey – Verkey of signer wallet – Wallet to use for signature timestamp – Optional timestamp for signature
Returns:	A SignatureDecorator for newly created signature
Raises:	`ValueError` – If field_name doesn’t exist on this message

verify_signatures(wallet: aries_cloudagent.wallet.base.BaseWallet) → bool[source]¶

Verify all associated field signatures.

Parameters:	wallet – Wallet to use in verification
Returns:	True if all signatures verify, else false

verify_signed_field(field_name: str, wallet: aries_cloudagent.wallet.base.BaseWallet, signer_verkey: str = None) → str[source]¶

Verify a specific field signature.

Parameters:	field_name – The field name to verify wallet – Wallet to use for the verification signer_verkey – Verkey of signer to use
Returns:	The verkey of the signer
Raises:	`ValueError` – If field_name does not exist on this message `ValueError` – If the verification fails `ValueError` – If the verkey of the signature does not match the provided verkey

exception aries_cloudagent.messaging.agent_message.AgentMessageError(*args, error_code: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelError

Base exception for agent message issues.

class aries_cloudagent.messaging.agent_message.AgentMessageSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

AgentMessage schema.

class Meta[source]¶

Bases: object

AgentMessageSchema metadata.

model_class = None¶

signed_fields = None¶

unknown¶: Used by autodoc_mock_imports.

check_dump_decorators(obj, **kwargs)[source]¶

Pre-dump hook to validate and load the message decorators.

Parameters:	obj – The AgentMessage object
Raises:	`BaseModelError` – If a decorator does not validate

dump_decorators(data, **kwargs)[source]¶

Post-dump hook to write the decorators to the serialized output.

Parameters:	obj – The serialized data
Returns:	The modified data

extract_decorators(data: Mapping[KT, VT_co], **kwargs)[source]¶

Pre-load hook to extract the decorators and check the signed fields.

Parameters:	data – Incoming data to parse
Returns:	Parsed and modified data
Raises:	`ValidationError` – If a field signature does not correlate to a field in the message `ValidationError` – If the message defines both a field signature and a value for the same field `ValidationError` – If there is a missing field signature

populate_decorators(obj, **kwargs)[source]¶

Post-load hook to populate decorators on the message.

Parameters:	obj – The AgentMessage object
Returns:	The AgentMessage object with populated decorators

replace_signatures(data, **kwargs)[source]¶

Post-dump hook to write the signatures to the serialized output.

Parameters:	obj – The serialized data
Returns:	The modified data

aries_cloudagent.messaging.base_handler module¶

A Base handler class for all message handlers.

class aries_cloudagent.messaging.base_handler.BaseHandler[source]¶

Bases: abc.ABC

Abstract base class for handlers.

handle(context: aries_cloudagent.messaging.request_context.RequestContext, responder: aries_cloudagent.messaging.responder.BaseResponder)[source]¶

Abstract method for handler logic.

Parameters:	context – Request context object responder – A responder object

exception aries_cloudagent.messaging.base_handler.HandlerException(*args, error_code: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.core.error.BaseError

Exception base class for generic handler errors.

aries_cloudagent.messaging.error module¶

Messaging-related error classes and codes.

exception aries_cloudagent.messaging.error.MessageParseError(*args, error_code: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.core.error.BaseError

Message parse error.

error_code = 'message_parse_error'¶

exception aries_cloudagent.messaging.error.MessagePrepareError(*args, error_code: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.core.error.BaseError

Message preparation error.

error_code = 'message_prepare_error'¶

aries_cloudagent.messaging.request_context module¶

Request context class.

A request context provides everything required by handlers and other parts of the system to process a message.

class aries_cloudagent.messaging.request_context.RequestContext(profile: aries_cloudagent.core.profile.Profile, *, context: aries_cloudagent.config.injection_context.InjectionContext = None, settings: Mapping[str, object] = None)[source]¶

Bases: object

Context established by the Conductor and passed into message handlers.

connection_ready¶

Accessor for the flag indicating an active connection with the sender.

Returns:	True if the connection is active, else False

connection_record¶: Accessor for the related connection record.

default_endpoint¶

Accessor for the default agent endpoint (from agent config).

Returns:	The default agent endpoint

default_label¶

Accessor for the default agent label (from agent config).

Returns:	The default label

inject(base_cls: Type[Inject], settings: Mapping[str, object] = None, *, required: bool = True) → Optional[Inject][source]¶

Get the provided instance of a given class identifier.

Parameters:	cls – The base class to retrieve an instance of settings – An optional mapping providing configuration to the provider
Returns:	An instance of the base class, or None

injector¶: Accessor for the associated Injector instance.

message¶

Accessor for the deserialized message instance.

Returns:	This context’s agent message

message_receipt¶

Accessor for the message receipt information.

Returns:	This context’s message receipt information

profile¶: Accessor for the associated Profile instance.

session() → aries_cloudagent.core.profile.ProfileSession[source]¶: Start a new interactive session with no transaction support requested.

settings¶: Accessor for the context settings.

classmethod test_context() → aries_cloudagent.messaging.request_context.RequestContext[source]¶: Quickly set up a new request context for tests.

transaction() → aries_cloudagent.core.profile.ProfileSession[source]¶

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.

update_settings(settings: Mapping[str, object])[source]¶: Update the scope with additional settings.

aries_cloudagent.messaging.responder module¶

A message responder.

The responder is provided to message handlers to enable them to send a new message in response to the message being handled.

class aries_cloudagent.messaging.responder.BaseResponder(*, connection_id: str = None, reply_session_id: str = None, reply_to_verkey: str = None)[source]¶

Bases: abc.ABC

Interface for message handlers to send responses.

create_outbound(message: Union[aries_cloudagent.messaging.agent_message.AgentMessage, str, bytes], *, connection_id: str = None, reply_session_id: str = None, reply_thread_id: str = None, reply_to_verkey: str = None, target: aries_cloudagent.connections.models.connection_target.ConnectionTarget = None, target_list: Sequence[aries_cloudagent.connections.models.connection_target.ConnectionTarget] = None, to_session_only: bool = False) → aries_cloudagent.transport.outbound.message.OutboundMessage[source]¶: Create an OutboundMessage from a message payload.

send(message: Union[aries_cloudagent.messaging.agent_message.AgentMessage, str, bytes], **kwargs)[source]¶: Convert a message to an OutboundMessage and send it.

send_outbound(message: aries_cloudagent.transport.outbound.message.OutboundMessage)[source]¶

Send an outbound message.

Parameters:	message – The OutboundMessage to be sent

send_reply(message: Union[aries_cloudagent.messaging.agent_message.AgentMessage, str, bytes], *, connection_id: str = None, target: aries_cloudagent.connections.models.connection_target.ConnectionTarget = None, target_list: Sequence[aries_cloudagent.connections.models.connection_target.ConnectionTarget] = None)[source]¶

Send a reply to an incoming message.

Parameters:	message – the AgentMessage, or pre-packed str or bytes to reply with connection_id – optionally override the target connection ID target – optionally specify a ConnectionTarget to send to
Raises:	`ResponderError` – If there is no active connection

send_webhook(topic: str, payload: dict)[source]¶

Dispatch a webhook.

Parameters:	topic – the webhook topic identifier payload – the webhook payload value

class aries_cloudagent.messaging.responder.MockResponder[source]¶

Bases: aries_cloudagent.messaging.responder.BaseResponder

Mock responder implementation for use by tests.

send(message: Union[aries_cloudagent.messaging.agent_message.AgentMessage, str, bytes], **kwargs)[source]¶: Convert a message to an OutboundMessage and send it.

send_outbound(message: aries_cloudagent.transport.outbound.message.OutboundMessage)[source]¶: Send an outbound message.

send_reply(message: Union[aries_cloudagent.messaging.agent_message.AgentMessage, str, bytes], **kwargs)[source]¶: Send a reply to an incoming message.

send_webhook(topic: str, payload: dict)[source]¶: Send an outbound message.

exception aries_cloudagent.messaging.responder.ResponderError(*args, error_code: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.core.error.BaseError

Responder error.

aries_cloudagent.messaging.util module¶

Utils for messages.

aries_cloudagent.messaging.util.canon(raw_attr_name: str) → str[source]¶

Canonicalize input attribute name for indy proofs and credential offers.

Parameters:	raw_attr_name – raw attribute name
Returns:	canonicalized attribute name

aries_cloudagent.messaging.util.datetime_now() → datetime.datetime[source]¶: Timestamp in UTC.

aries_cloudagent.messaging.util.datetime_to_str(dt: Union[str, datetime.datetime]) → str[source]¶

Convert a datetime object to an indy-standard datetime string.

Parameters:	dt – May be a string or datetime to allow automatic conversion

aries_cloudagent.messaging.util.encode(orig: Any) → str[source]¶

Encode a credential value as an int.

Encode credential attribute value, purely stringifying any int32 and leaving numeric int32 strings alone, but mapping any other input to a stringified 256-bit (but not 32-bit) integer. Predicates in indy-sdk operate on int32 values properly only when their encoded values match their raw values.

Parameters:	orig – original value to encode
Returns:	encoded value

aries_cloudagent.messaging.util.epoch_to_str(epoch: int) → str[source]¶

Convert epoch seconds to indy-standard datetime string.

Parameters:	epoch – epoch seconds

aries_cloudagent.messaging.util.str_to_datetime(dt: Union[str, datetime.datetime]) → datetime.datetime[source]¶

Convert an indy-standard datetime string to a datetime.

Using a fairly lax regex pattern to match slightly different formats. In Python 3.7 datetime.fromisoformat might be used.

Parameters:	dt – May be a string or datetime to allow automatic conversion

aries_cloudagent.messaging.util.str_to_epoch(dt: Union[str, datetime.datetime]) → int[source]¶

Convert an indy-standard datetime string to epoch seconds.

Parameters:	dt – May be a string or datetime to allow automatic conversion

aries_cloudagent.messaging.util.time_now() → str[source]¶: Timestamp in ISO format.