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[V20PresFormat]] = None, presentations_attach: Optional[Sequence[AttachDecorator]] = None, **kwargs)[source]

Bases: 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[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: AgentMessageSchema

Presentation schema.

class Meta[source]

Bases: object

Presentation schema metadata.

model_class

alias of V20Pres

formats

alias of V20PresFormatSchema

presentations_attach

alias of AttachDecoratorSchema

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: 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: V10AckSchema

Schema for V20PresAck class.

class Meta[source]

Bases: object

V20PresAck schema metadata.

model_class

alias of V20PresAck

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: Optional[str] = None, format_: Optional[str] = None)[source]

Bases: BaseModel

Present-proof protocol message attachment format.

class Format(value)[source]

Bases: 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>)

To make the switch from indy to anoncreds replace the above with the following INDY = FormatSpec(

“hlindy/”, DeferLoad(

“aries_cloudagent.protocols.present_proof.v2_0” “.formats.anoncreds.handler.AnonCredsPresExchangeHandler”

),

)

property api: str

Admin API specifier.

property aries: str

Accessor for aries identifier.

classmethod get(label: Union[str, Format])[source]

Get format enum for label.

get_attachment_data(formats: Sequence[V20PresFormat], attachments: Sequence[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: 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

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

Supported reason codes.

ABANDONED = 'abandoned'
class aries_cloudagent.protocols.present_proof.v2_0.messages.pres_problem_report.V20PresProblemReport(*args, **kwargs)[source]

Bases: 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: ProblemReportSchema

Problem report schema.

class Meta[source]

Bases: object

Schema metadata.

model_class

alias of 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[V20PresFormat]] = None, proposals_attach: Optional[Sequence[AttachDecorator]] = None, **kwargs)[source]

Bases: 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[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: AgentMessageSchema

Presentation proposal schema.

class Meta[source]

Bases: object

Presentation proposal schema metadata.

model_class

alias of V20PresProposal

formats

alias of V20PresFormatSchema

proposals_attach

alias of AttachDecoratorSchema

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[V20PresFormat]] = None, request_presentations_attach: Optional[Sequence[AttachDecorator]] = None, **kwargs)[source]

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

Bases: AgentMessageSchema

Presentation request schema.

class Meta[source]

Bases: object

V20PresRequest schema metadata.

model_class

alias of V20PresRequest

formats

alias of V20PresFormatSchema

request_presentations_attach

alias of AttachDecoratorSchema

validate_fields(data, **kwargs)

Validate proposal attachment per format.

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.