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(value)

Bases: enum.Enum

Handshake protocol enum for invitation message.

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

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

property aka: int

Accessor for also-known-as.

classmethod get(label: Union[str, aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.HSProto]) → aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.HSProto

Get handshake protocol enum for label.

property rfc: int

Accessor for RFC.

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

Bases: tuple

property aka

Alias for field number 2

property name

Alias for field number 1

property rfc

Alias for field number 0

class aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage(*, comment: Optional[str] = None, label: Optional[str] = None, image_url: Optional[str] = None, handshake_protocols: Optional[Sequence[str]] = None, requests_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, services: Optional[Sequence[Union[aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service, str]]] = None, accept: Optional[Sequence[str]] = None, version: str = '1.1', msg_type: Optional[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.1/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: Optional[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: Any, **kwargs: Any)

Bases: marshmallow.

InvitationMessage schema.

class Meta

Bases: object

InvitationMessage schema metadata.

model_class

alias of aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.InvitationMessage

post_dump(data, **kwargs)

Post dump hook.

requests_attach

alias of aries_cloudagent.messaging.decorators.attach_decorator.AttachDecoratorSchema

services

DIDComm Service object or DID string field for Marshmallow.

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(*args: Any, **kwargs: Any)

Bases: marshmallow.fields.

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(version: str = '1.1', msg_type: Optional[str] = None, *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.1/problem_report'

schema_class = 'OOBProblemReportSchema'

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

Bases: marshmallow.

Schema for ProblemReport base class.

class Meta

Bases: object

Metadata for problem report schema.

model_class

alias of aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.OOBProblemReport

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(value)

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(version: str = '1.1', msg_type: Optional[str] = None, **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.1/handshake-reuse'

schema_class = 'HandshakeReuseSchema'

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

Bases: marshmallow.

Handshake Reuse schema class.

class Meta

Bases: object

Handshake Reuse schema metadata.

model_class

alias of aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse.HandshakeReuse

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(version: str = '1.1', msg_type: Optional[str] = None, **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.1/handshake-reuse-accepted'

schema_class = 'HandshakeReuseAcceptSchema'

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

Bases: marshmallow.

Handshake Reuse Accept schema class.

class Meta

Bases: object

Handshake Reuse Accept schema metadata.

model_class

alias of aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept.HandshakeReuseAccept

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: Optional[str] = None, _type: Optional[str] = None, did: Optional[str] = None, recipient_keys: Optional[Sequence[str]] = None, routing_keys: Optional[Sequence[str]] = None, service_endpoint: Optional[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: Any, **kwargs: Any)

Bases: marshmallow.

Service schema.

class Meta

Bases: object

ServiceSchema metadata.

model_class

alias of aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service

post_dump(data, **kwargs)

Post dump hook.