aries_cloudagent.protocols.present_proof.v2_0.messages package¶

Submodules¶

aries_cloudagent.protocols.present_proof.v2_0.messages.pres module¶

A (proof) presentation content message.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres.V20Pres(_id: str = None, *, comment: str = None, formats: Sequence[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat] = None, presentations_attach: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator] = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a presentation.

class Meta[source]¶

Bases: object

Presentation metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v2_0.handlers.pres_handler.V20PresHandler'¶

message_type = 'present-proof/2.0/presentation'¶

schema_class = 'V20PresSchema'¶

attachment(fmt: aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat.Format = None) → dict[source]¶

Return attached presentation item.

Parameters:	fmt – format of attachment in list to decode and return

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres.V20PresSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Presentation schema.

class Meta[source]¶

Bases: object

Presentation schema metadata.

model_class¶: alias of V20Pres

unknown¶: Used by autodoc_mock_imports.

comment¶: Used by autodoc_mock_imports.

formats¶: Used by autodoc_mock_imports.

presentations_attach¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶: Validate presentation attachment per format.

aries_cloudagent.protocols.present_proof.v2_0.messages.pres_ack module¶

Represents an explicit RFC 15 ack message, adopted into present-proof protocol.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_ack.V20PresAck(status: str = None, verification_result: str = None, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.notification.v1_0.messages.ack.V10Ack

Base class representing an explicit ack message for present-proof protocol.

class Meta[source]¶

Bases: object

V20PresAck metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v2_0.handlers.pres_ack_handler.V20PresAckHandler'¶

message_type = 'present-proof/2.0/ack'¶

schema_class = 'V20PresAckSchema'¶

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_ack.V20PresAckSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.protocols.notification.v1_0.messages.ack.V10AckSchema

Schema for V20PresAck class.

class Meta[source]¶

Bases: object

V20PresAck schema metadata.

model_class¶: alias of V20PresAck

unknown¶: Used by autodoc_mock_imports.

verification_result¶: Used by autodoc_mock_imports.

aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format module¶

Credential format inner object.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.FormatSpec(aries, handler)¶

Bases: tuple

aries¶: Alias for field number 0

handler¶: Alias for field number 1

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat(*, attach_id: str = None, format_: str = None)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModel

Present-proof protocol message attachment format.

class Format[source]¶

Bases: enum.Enum

Attachment format.

DIF = FormatSpec(aries='dif/', handler=<aries_cloudagent.utils.classloader.DeferLoad object>)¶

INDY = FormatSpec(aries='hlindy/', handler=<aries_cloudagent.utils.classloader.DeferLoad object>)¶

api¶: Admin API specifier.

aries¶: Accessor for aries identifier.

get = <bound method V20PresFormat.Format.get of <enum 'Format'>>[source]¶

get_attachment_data(formats: Sequence[V20PresFormat], attachments: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator])[source]¶: Find attachment of current format, decode and return its content.

handler¶: Accessor for presentation exchange format handler.

validate_fields(message_type: str, attachment_data: Mapping)[source]¶: Raise ValidationError for invalid attachment formats.

class Meta[source]¶

Bases: object

Present-proof protocol message attachment format metadata.

schema_class = 'V20PresFormatSchema'¶

format¶: Return format.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormatSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

Present-proof protocol message attachment format schema.

class Meta[source]¶

Bases: object

Present-proof protocol message attachment format schema metadata.

model_class¶: alias of V20PresFormat

unknown¶: Used by autodoc_mock_imports.

attach_id¶: Used by autodoc_mock_imports.

format_¶: Used by autodoc_mock_imports.

aries_cloudagent.protocols.present_proof.v2_0.messages.pres_problem_report module¶

A problem report message.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_problem_report.ProblemReportReason[source]¶

Bases: enum.Enum

Supported reason codes.

ABANDONED = 'abandoned'¶

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_problem_report.V20PresProblemReport(*args, **kwargs)[source]¶

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

Class representing a problem report message.

class Meta[source]¶

Bases: object

Problem report metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v2_0.handlers.pres_problem_report_handler.V20PresProblemReportHandler'¶

message_type = 'present-proof/2.0/problem-report'¶

schema_class = 'V20PresProblemReportSchema'¶

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_problem_report.V20PresProblemReportSchema(*args, **kwargs)[source]¶

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

Problem report schema.

class Meta[source]¶

Bases: object

Schema metadata.

model_class¶: alias of V20PresProblemReport

unknown¶: Used by autodoc_mock_imports.

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

Validate schema fields.

Parameters:	data – The data to validate

aries_cloudagent.protocols.present_proof.v2_0.messages.pres_proposal module¶

A presentation proposal content message.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_proposal.V20PresProposal(_id: str = None, *, comment: str = None, formats: Sequence[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat] = None, proposals_attach: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator] = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a presentation proposal.

class Meta[source]¶

Bases: object

V20PresProposal metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v2_0.handlers.pres_proposal_handler.V20PresProposalHandler'¶

message_type = 'present-proof/2.0/propose-presentation'¶

schema_class = 'V20PresProposalSchema'¶

attachment(fmt: aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat.Format = None) → dict[source]¶

Return attached proposal item.

Parameters:	fmt – format of attachment in list to decode and return

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_proposal.V20PresProposalSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Presentation proposal schema.

class Meta[source]¶

Bases: object

Presentation proposal schema metadata.

model_class¶: alias of V20PresProposal

unknown¶: Used by autodoc_mock_imports.

comment¶: Used by autodoc_mock_imports.

formats¶: Used by autodoc_mock_imports.

proposals_attach¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶: Validate proposal attachment per format.

aries_cloudagent.protocols.present_proof.v2_0.messages.pres_request module¶

A presentation request content message.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_request.V20PresRequest(_id: str = None, *, comment: str = None, will_confirm: bool = None, formats: Sequence[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat] = None, request_presentations_attach: Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator] = None, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a presentation request.

class Meta[source]¶

Bases: object

V20PresRequest metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v2_0.handlers.pres_request_handler.V20PresRequestHandler'¶

message_type = 'present-proof/2.0/request-presentation'¶

schema_class = 'V20PresRequestSchema'¶

attachment(fmt: aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat.Format = None) → dict[source]¶

Return attached presentation request item.

Parameters:	fmt – format of attachment in list to decode and return

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_request.V20PresRequestSchema(*args, **kwargs)[source]¶

Bases: aries_cloudagent.messaging.agent_message.AgentMessageSchema

Presentation request schema.

class Meta[source]¶

Bases: object

V20PresRequest schema metadata.

model_class¶: alias of V20PresRequest

unknown¶: Used by autodoc_mock_imports.

comment¶: Used by autodoc_mock_imports.

formats¶: Used by autodoc_mock_imports.

request_presentations_attach¶: Used by autodoc_mock_imports.

validate_fields(data, **kwargs)[source]¶: Validate proposal attachment per format.

will_confirm¶: Used by autodoc_mock_imports.

aries_cloudagent.protocols.present_proof.v2_0.messages.pres_webhook module¶

v2.0 Presentation exchange record webhook.

class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_webhook.V20PresExRecordWebhook(**kwargs)[source]¶

Bases: object

Class representing a state only Presentation exchange record webhook.