aries_cloudagent.vc.ld_proofs.suites package¶
Submodules¶
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020 module¶
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020_base module¶
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_proof_2020 module¶
aries_cloudagent.vc.ld_proofs.suites.ed25519_signature_2018 module¶
aries_cloudagent.vc.ld_proofs.suites.ed25519_signature_2020 module¶
aries_cloudagent.vc.ld_proofs.suites.jws_linked_data_signature module¶
aries_cloudagent.vc.ld_proofs.suites.linked_data_proof module¶
Abstract base class for linked data proofs.
-
class
aries_cloudagent.vc.ld_proofs.suites.linked_data_proof.
DeriveProofResult
(*args, **kwargs)[source]¶ Bases:
sphinx.ext.autodoc.importer._MockObject
Result dict for deriving a proof.
-
class
aries_cloudagent.vc.ld_proofs.suites.linked_data_proof.
LinkedDataProof
(*, signature_type: str, proof: dict = None, supported_derive_proof_types: Optional[List[str]] = None)[source]¶ Bases:
abc.ABC
Base Linked data proof.
-
create_proof
(*, document: dict, purpose: aries_cloudagent.vc.ld_proofs.purposes.proof_purpose.ProofPurpose, document_loader: Callable[[str, dict], dict]) → dict[source]¶ Create proof for document.
Parameters: - document (dict) – The document to create the proof for
- purpose (ProofPurpose) – The proof purpose to include in the proof
- document_loader (DocumentLoader) – Document loader used for resolving
Returns: The proof object
Return type:
-
derive_proof
(*, proof: dict, document: dict, reveal_document: dict, document_loader: Callable[[str, dict], dict], nonce: bytes = None) → aries_cloudagent.vc.ld_proofs.suites.linked_data_proof.DeriveProofResult[source]¶ Derive proof for document, returning derived document and proof.
Parameters: - proof (dict) – The proof to derive from
- document (dict) – The document to derive the proof for
- reveal_document (dict) – The JSON-LD frame the revealed attributes
- document_loader (DocumentLoader) – Document loader used for resolving
- nonce (bytes, optional) – Nonce to use for the proof. Defaults to None.
Returns: The derived document and proof
Return type: DeriveProofResult
-
match_proof
(signature_type: str) → bool[source]¶ Match signature type to signature type of this suite.
-
verify_proof
(*, proof: dict, document: dict, purpose: aries_cloudagent.vc.ld_proofs.purposes.proof_purpose.ProofPurpose, document_loader: Callable[[str, dict], dict]) → aries_cloudagent.vc.ld_proofs.validation_result.ProofResult[source]¶ Verify proof against document and proof purpose.
Parameters: Returns: The results of the proof verification
Return type: ValidationResult
-