aries_cloudagent.protocols.out_of_band.v1_0.messages package

Submodules

aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation module

An invitation content message.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.HSProto

Bases: enum.Enum

Handshake protocol enum for invitation message.

RFC160 = HSProtoSpec(rfc=160, name='connections/1.0', aka={'connection', '160', 'connections', 'conns', 'conn', 'rfc160', 'old'})

RFC23 = HSProtoSpec(rfc=23, name='didexchange/1.0', aka={'rfc23', 'didexchange', 'didx', '23', 'new', 'didex'})

aka

Accessor for also-known-as.

get = <bound method HSProto.get of <enum 'HSProto'>>

rfc

Accessor for RFC.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.HSProtoSpec(rfc, name, aka)

Bases: tuple

aka

Alias for field number 2

name

Alias for field number 1

rfc

Alias for field number 0

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage(*, comment: str = None, label: str = None, handshake_protocols: Sequence[str] = None, requests_attach: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator] = None, services: Sequence[Union[aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service, str]] = None, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing an out of band invitation message.

class Meta

Bases: object

InvitationMessage metadata.

message_type = 'out-of-band/1.0/invitation'

schema_class = 'InvitationMessageSchema'

classmethod from_url(url: str) → aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage

Parse a URL-encoded invitation into an InvitationMessage instance.

Parameters:url – Url to decode Returns:An InvitationMessage object.

to_url(base_url: str = None) → str

Convert an invitation message to URL format for sharing.

Returns:An invite url

classmethod wrap_message(message: dict) → aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator

Convert an aries message to an attachment decorator.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessageSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

InvitationMessage schema.

class Meta

Bases: object

InvitationMessage schema metadata.

model_class

alias of InvitationMessage

unknown = 'exclude'

handshake_protocols = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>

label = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>

post_dump(data, **kwargs)

Post dump hook.

requests_attach = <fields.Nested(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'type': 'Invalid type.'})>

services = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>

validate_fields(data, **kwargs)

Validate schema fields.

Parameters:data – The data to validate Raises:ValidationError – If any of the fields do not validate

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.ServiceOrDIDField(*, default: Any = <marshmallow.missing>, missing: Any = <marshmallow.missing>, data_key: str = None, attribute: str = None, validate: Union[Callable[[Any], Any], Iterable[Callable[[Any], Any]]] = None, required: bool = False, allow_none: bool = None, load_only: bool = False, dump_only: bool = False, error_messages: Dict[str, str] = None, **metadata)

Bases: marshmallow.fields.Field

DIDComm Service object or DID string field for Marshmallow.

aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report module

Represents an OOB connection reuse problem report message.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.OOBProblemReport(*args, **kwargs)

Bases: aries_cloudagent.protocols.problem_report.v1_0.message.ProblemReport

Base class representing an OOB connection reuse problem report message.

class Meta

Bases: object

OOB connection reuse problem report metadata.

handler_class = 'aries_cloudagent.protocols.out_of_band.v1_0.handlers.problem_report_handler.OOBProblemReportMessageHandler'

message_type = 'out-of-band/1.0/problem_report'

schema_class = 'OOBProblemReportSchema'

class aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.OOBProblemReportSchema(*args, **kwargs)

Bases: aries_cloudagent.protocols.problem_report.v1_0.message.ProblemReportSchema

Schema for ProblemReport base class.

class Meta

Bases: object

Metadata for problem report schema.

model_class

alias of OOBProblemReport

unknown = 'exclude'

check_thread_deco(obj, **kwargs)

Thread decorator, and its thid and pthid, are mandatory.

validate_fields(data, **kwargs)

Validate schema fields.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.ProblemReportReason

Bases: enum.Enum

Supported reason codes.

EXISTING_CONNECTION_NOT_ACTIVE = 'existing_connection_not_active'

NO_EXISTING_CONNECTION = 'no_existing_connection'

aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse module

Represents a Handshake Reuse message under RFC 0434.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse.HandshakeReuse(**kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a Handshake Reuse message.

class Meta

Bases: object

Metadata for Handshake Reuse message.

handler_class = 'aries_cloudagent.protocols.out_of_band.v1_0.handlers.reuse_handler.HandshakeReuseMessageHandler'

message_type = 'out-of-band/1.0/handshake-reuse'

schema_class = 'HandshakeReuseSchema'

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse.HandshakeReuseSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Handshake Reuse schema class.

class Meta

Bases: object

Handshake Reuse schema metadata.

model_class

alias of HandshakeReuse

unknown = 'exclude'

check_thread_deco(obj, **kwargs)

Thread decorator, and its thid and pthid, are mandatory.

aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept module

Represents a Handshake Reuse Accept message under RFC 0434.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept.HandshakeReuseAccept(**kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a Handshake Reuse Accept message.

class Meta

Bases: object

Metadata for Handshake Reuse Accept message.

handler_class = 'aries_cloudagent.protocols.out_of_band.v1_0.handlers.reuse_accept_handler.HandshakeReuseAcceptMessageHandler'

message_type = 'out-of-band/1.0/handshake-reuse-accepted'

schema_class = 'HandshakeReuseAcceptSchema'

class aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept.HandshakeReuseAcceptSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Handshake Reuse Accept schema class.

class Meta

Bases: object

Handshake Reuse Accept schema metadata.

model_class

alias of HandshakeReuseAccept

unknown = 'exclude'

check_thread_deco(obj, **kwargs)

Thread decorator, and its thid and pthid, are mandatory.

aries_cloudagent.protocols.out_of_band.v1_0.messages.service module

Record used to represent a service block of an out of band invitation.

class aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service(*, _id: str = None, _type: str = None, did: str = None, recipient_keys: Sequence[str] = None, routing_keys: Sequence[str] = None, service_endpoint: str = None)

Bases: aries_cloudagent.messaging.models.base.BaseModel

Record used to represent a service block of an out of band invitation.

class Meta

Bases: object

Service metadata.

schema_class = 'ServiceSchema'

class aries_cloudagent.protocols.out_of_band.v1_0.messages.service.ServiceSchema(*args, **kwargs)

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

Service schema.

class Meta

Bases: object

ServiceSchema metadata.

model_class

alias of Service

unknown = 'exclude'

did = <fields.String(default=<marshmallow.missing>, attribute=None, validate=<aries_cloudagent.messaging.valid.IndyDID object>, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>

post_dump(data, **kwargs)

Post dump hook.

recipient_keys = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>

routing_keys = <fields.List(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid list.'})>

service_endpoint = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>