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: Optional[str] = None, *, comment: Optional[str] = None, formats: Optional[Sequence[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat]] = 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 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: Optional[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: Any, **kwargs: Any)[source]

Bases: marshmallow.

Presentation schema.

class Meta[source]

Bases: object

Presentation schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v2_0.messages.pres.V20Pres

comment

formats

presentations_attach

validate_fields(data, **kwargs): 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: 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

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: Any, **kwargs: Any)[source]

Bases: marshmallow.

Schema for V20PresAck class.

class Meta[source]

Bases: object

V20PresAck schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v2_0.messages.pres_ack.V20PresAck

verification_result

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

property aries: Alias for field number 0

property handler: Alias for field number 1

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

Bases: aries_cloudagent.messaging.models.base.BaseModel

Present-proof protocol message attachment format.

class Format(value)[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>)

property api: str: Admin API specifier.

property aries: str: Accessor for aries identifier.

classmethod get(label: Union[str, aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat.Format])[source]: Get format enum for label.

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

property handler: Type[V20PresFormatHandler]: 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'

property format: str: Return format.

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

Bases: marshmallow.

Present-proof protocol message attachment format schema.

class Meta[source]

Bases: object

Present-proof protocol message attachment format schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat

attach_id

format_

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(value)[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: 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.v2_0.messages.pres_problem_report.V20PresProblemReport

validate_fields(data, **kwargs)

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: Optional[str] = None, *, comment: Optional[str] = None, formats: Optional[Sequence[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat]] = None, proposals_attach: Optional[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: Optional[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: Any, **kwargs: Any)[source]

Bases: marshmallow.

Presentation proposal schema.

class Meta[source]

Bases: object

Presentation proposal schema metadata.

model_class: alias of aries_cloudagent.protocols.present_proof.v2_0.messages.pres_proposal.V20PresProposal

comment

formats

proposals_attach

validate_fields(data, **kwargs): 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: Optional[str] = None, *, comment: Optional[str] = None, will_confirm: Optional[bool] = None, formats: Optional[Sequence[aries_cloudagent.protocols.present_proof.v2_0.messages.pres_format.V20PresFormat]] = None, request_presentations_attach: Optional[Sequence[aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator]] = None, **kwargs)[source]