aries_cloudagent.protocols.issue_credential.v2_0.formats.indy package¶
Submodules¶
aries_cloudagent.protocols.issue_credential.v2_0.formats.indy.handler module¶
V2.0 issue-credential indy credential format handler.
-
class
aries_cloudagent.protocols.issue_credential.v2_0.formats.indy.handler.
IndyCredFormatHandler
(profile: aries_cloudagent.core.profile.Profile)[source]¶ Bases:
aries_cloudagent.protocols.issue_credential.v2_0.formats.handler.V20CredFormatHandler
Indy credential format handler.
-
create_offer
(cred_proposal_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposal) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator][source]¶ Create indy credential offer.
-
create_proposal
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, proposal_data: Mapping[str, str]) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator][source]¶ Create indy credential proposal.
-
create_request
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, request_data: Mapping = None) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator][source]¶ Create indy credential request.
-
format
= FormatSpec(aries='hlindy/', detail=<class 'aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndy'>, handler=<aries_cloudagent.utils.classloader.DeferLoad object>)¶
-
get_detail_record
(cred_ex_id: str) → aries_cloudagent.protocols.issue_credential.v2_0.models.detail.indy.V20CredExRecordIndy[source]¶ Retrieve credential exchange detail record by cred_ex_id.
-
get_format_data
(message_type: str, data: dict) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator][source]¶ Get credential format and attachment objects for use in cred ex messages.
Returns a tuple of both credential format and attachment decorator for use in credential exchange messages. It looks up the correct format identifier and encodes the data as a base64 attachment.
Parameters: Returns: Credential format and attachment data objects
Return type: CredFormatAttachment
-
get_format_identifier
(message_type: str) → str[source]¶ Get attachment format identifier for format and message combination.
Parameters: message_type (str) – Message type for which to return the format identifier Returns: Issue credential attachment format identifier Return type: str
-
issue_credential
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, retries: int = 5) → Tuple[aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_format.V20CredFormat, aries_cloudagent.messaging.decorators.attach_decorator.AttachDecorator][source]¶ Issue indy credential.
-
receive_credential
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_issue_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_issue.V20CredIssue) → None[source]¶ Receive indy credential.
Validation is done in the store credential step.
-
receive_offer
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_offer_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_offer.V20CredOffer) → None[source]¶ Receive indy credential offer.
-
receive_proposal
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_proposal_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_proposal.V20CredProposal) → None[source]¶ Receive indy credential proposal.
No custom handling is required for this step.
-
receive_request
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_request_message: aries_cloudagent.protocols.issue_credential.v2_0.messages.cred_request.V20CredRequest) → None[source]¶ Receive indy credential request.
-
store_credential
(cred_ex_record: aries_cloudagent.protocols.issue_credential.v2_0.models.cred_ex_record.V20CredExRecord, cred_id: str = None) → None[source]¶ Store indy credential.
-
classmethod
validate_fields
(message_type: str, attachment_data: Mapping)[source]¶ Validate attachment data for a specific message type.
Uses marshmallow schemas to validate if format specific attachment data is valid for the specified message type. Only does structural and type checks, does not validate if .e.g. the issuer value is valid.
Parameters: - message_type (str) – The message type to validate the attachment data for. Should be one of the message types as defined in message_types.py
- attachment_data (Mapping) – [description] The attachment data to valide
Raises: Exception
– When the data is not valid.
-