aries_cloudagent.protocols.present_proof.v1_0.messages package

Submodules

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation module

A (proof) presentation content message.

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation.Presentation(_id: Optional[str] = None, *, comment: Optional[str] = None, presentations_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.agent_message.AgentMessage

Class representing a (proof) presentation.

class Meta[source]

Bases: object

Presentation metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v1_0.handlers.presentation_handler.PresentationHandler'

message_type = 'present-proof/1.0/presentation'

schema_class = 'PresentationSchema'

indy_proof(index: int = 0)[source]

Retrieve and decode indy proof from attachment.

Parameters: index – ordinal in attachment list to decode and return (typically, list has length 1)

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation.PresentationSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

(Proof) presentation schema.

class Meta[source]

Bases: object

Presentation schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v1_0.messages.presentation.Presentation

comment

presentations_attach

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_ack module

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

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_ack.PresentationAck(status: Optional[str] = None, verification_result: Optional[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

PresentationAck metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v1_0.handlers.presentation_ack_handler.PresentationAckHandler'

message_type = 'present-proof/1.0/ack'

schema_class = 'PresentationAckSchema'

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_ack.PresentationAckSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Schema for PresentationAck class.

class Meta[source]

Bases: object

PresentationAck schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_ack.PresentationAck

verification_result

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_problem_report module

A problem report message.

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_problem_report.PresentationProblemReport(*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.v1_0.handlers.presentation_problem_report_handler.PresentationProblemReportHandler'

message_type = 'present-proof/1.0/problem-report'

schema_class = 'PresentationProblemReportSchema'

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_problem_report.PresentationProblemReportSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Problem report schema.

class Meta[source]

Bases: object

Schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_problem_report.PresentationProblemReport

validate_fields(data, **kwargs)

Validate schema fields.

Parameters: data – The data to validate

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_problem_report.ProblemReportReason(value)[source]

Bases: enum.Enum

Supported reason codes.

ABANDONED = 'abandoned'

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_proposal module

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_request module

A presentation request content message.

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_request.PresentationRequest(_id: Optional[str] = None, *, comment: Optional[str] = None, request_presentations_attach: Optional[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

PresentationRequest metadata.

handler_class = 'aries_cloudagent.protocols.present_proof.v1_0.handlers.presentation_request_handler.PresentationRequestHandler'

message_type = 'present-proof/1.0/request-presentation'

schema_class = 'PresentationRequestSchema'

indy_proof_request(index: int = 0)[source]

Retrieve and decode indy proof request from attachment.

Parameters: index – ordinal in attachment list to decode and return (typically, list has length 1)

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_request.PresentationRequestSchema(*args: Any, **kwargs: Any)[source]

Bases: marshmallow.

Presentation request schema.

class Meta[source]

Bases: object

Presentation request schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_request.PresentationRequest

comment

request_presentations_attach

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_webhook module

v1.0 presentation exchange information webhook.

class aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_webhook.V10PresentationExchangeWebhook(**kwargs)[source]

Bases: object

Class representing a state only presentation exchange webhook.