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
[source]¶ Bases:
enum.Enum
Handshake protocol enum for invitation message.
-
RFC160
= HSProtoSpec(rfc=160, name='connections/1.0', aka={'old', 'rfc160', 'connection', 'conn', '160', 'connections', 'conns'})¶
-
RFC23
= HSProtoSpec(rfc=23, name='didexchange/1.0', aka={'didexchange', 'new', 'didex', 'rfc23', 'didx', '23'})¶
-
aka
¶ Accessor for also-known-as.
-
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, request_attach: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator] = None, service: Sequence[Union[aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service, str]] = None, service_blocks: Sequence[aries_cloudagent.protocols.out_of_band.v1_0.messages.service.Service] = None, service_dids: Sequence[str] = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Class representing an out of band invitation message.
-
class
Meta
[source]¶ 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[source]¶ Parse a URL-encoded invitation into an InvitationMessage instance.
Parameters: url – Url to decode Returns: An InvitationMessage object.
-
class
-
class
aries_cloudagent.protocols.out_of_band.v1_0.messages.invitation.
InvitationMessageSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
InvitationMessage schema.
-
class
Meta
[source]¶ 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.'})>¶
-
request_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.'})>¶
-
service_blocks
= <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.'})>¶
-
service_dids
= <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.'})>¶
-
class
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.
ProblemReport
(*, problem_code: str = None, explain: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Base class representing an OOB connection reuse problem report message.
-
class
aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.
ProblemReportReason
[source]¶ -
Supported reason codes.
-
EXISTING_CONNECTION_DOES_NOT_EXISTS
= 'existing_connection_does_not_exists'¶
-
EXISTING_CONNECTION_NOT_ACTIVE
= 'existing_connection_not_active'¶
-
-
class
aries_cloudagent.protocols.out_of_band.v1_0.messages.problem_report.
ProblemReportSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
Schema for ProblemReport base class.
-
class
Meta
[source]¶ Bases:
object
Metadata for problem report schema.
-
model_class
¶ alias of
ProblemReport
-
unknown
= 'exclude'¶
-
-
explain
= <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.'})>¶
-
problem_code
= <fields.String(default=<marshmallow.missing>, attribute=None, validate=<OneOf(choices=['existing_connection_does_not_exists', 'existing_connection_not_active'], labels=[], error='Value {input} must be one of {choices}.')>, 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.'})>¶
-
class
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)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Class representing a Handshake Reuse message.
-
class
aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse.
HandshakeReuseSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
Handshake Reuse schema class.
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)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessage
Class representing a Handshake Reuse Accept message.
-
class
Meta
[source]¶ 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
-
class
aries_cloudagent.protocols.out_of_band.v1_0.messages.reuse_accept.
HandshakeReuseAcceptSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.agent_message.AgentMessageSchema
Handshake Reuse Accept schema class.
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)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Record used to represent a service block of an out of band invitation.
-
class
aries_cloudagent.protocols.out_of_band.v1_0.messages.service.
ServiceSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Service schema.
-
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.'})>¶
-
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.'})>¶
-