aries_cloudagent.vc.ld_proofs.suites package
Submodules
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020 module
BbsBlsSignature2020 class.
- class aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020.BbsBlsSignature2020(*, key_pair: aries_cloudagent.vc.ld_proofs.crypto.key_pair.KeyPair, proof: Optional[dict] = None, verification_method: Optional[str] = None, date: Optional[datetime.datetime] = None)[source]
Bases:
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020_base.BbsBlsSignature2020Base
BbsBlsSignature2020 class.
- async 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, return proof.
- async sign(*, verify_data: List[bytes], proof: dict) dict [source]
Sign the data and add it to the proof.
- signature_type = 'BbsBlsSignature2020'
- async 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.
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020_base module
BbsBlsSignature2020Base class.
- class aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020_base.BbsBlsSignature2020Base(*, signature_type: str, proof: Optional[dict] = None, supported_derive_proof_types: Optional[List[str]] = None)[source]
Bases:
aries_cloudagent.vc.ld_proofs.suites.linked_data_proof.LinkedDataProof
Base class for BbsBlsSignature suites.
- BBS_SUPPORTED = False
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_proof_2020 module
BbsBlsSignatureProof2020 class.
- class aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_proof_2020.BbsBlsSignatureProof2020(*, key_pair: aries_cloudagent.vc.ld_proofs.crypto.key_pair.KeyPair)[source]
Bases:
aries_cloudagent.vc.ld_proofs.suites.bbs_bls_signature_2020_base.BbsBlsSignature2020Base
BbsBlsSignatureProof2020 class.
- async derive_proof(*, proof: dict, document: dict, reveal_document: dict, document_loader: Callable[[str, dict], dict], nonce: Optional[bytes] = None)[source]
Derive proof for document, return dict with derived document and proof.
- signature_type = 'BbsBlsSignatureProof2020'
- supported_derive_proof_types = ['BbsBlsSignature2020', 'sec:BbsBlsSignature2020', 'https://w3id.org/security#BbsBlsSignature2020']
- async 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.
aries_cloudagent.vc.ld_proofs.suites.ed25519_signature_2018 module
Ed25519Signature2018 suite.
- class aries_cloudagent.vc.ld_proofs.suites.ed25519_signature_2018.Ed25519Signature2018(*, key_pair: aries_cloudagent.vc.ld_proofs.crypto.key_pair.KeyPair, proof: Optional[dict] = None, verification_method: Optional[str] = None, date: Optional[Union[datetime.datetime, str]] = None)[source]
Bases:
aries_cloudagent.vc.ld_proofs.suites.jws_linked_data_signature.JwsLinkedDataSignature
Ed25519Signature2018 suite.
- signature_type = 'Ed25519Signature2018'
aries_cloudagent.vc.ld_proofs.suites.jws_linked_data_signature module
JWS Linked Data class.
- class aries_cloudagent.vc.ld_proofs.suites.jws_linked_data_signature.JwsLinkedDataSignature(*, signature_type: str, algorithm: str, required_key_type: str, key_pair: aries_cloudagent.vc.ld_proofs.crypto.key_pair.KeyPair, proof: Optional[dict] = None, verification_method: Optional[str] = None, date: Optional[Union[datetime.datetime, str]] = None)[source]
Bases:
aries_cloudagent.vc.ld_proofs.suites.linked_data_signature.LinkedDataSignature
JWS Linked Data class.
- async sign(*, verify_data: bytes, proof: dict) dict [source]
Sign the data and add it to the proof.
Adds a jws to the proof that can be used for multiple signature algorithms.
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: Any, **kwargs: Any)[source]
Bases:
typing_extensions.
Result dict for deriving a proof.
- document
- proof
- class aries_cloudagent.vc.ld_proofs.suites.linked_data_proof.LinkedDataProof(*, signature_type: str, proof: Optional[dict] = None, supported_derive_proof_types: Optional[List[str]] = None)[source]
Bases:
abc.ABC
Base Linked data proof.
- async 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.
- async derive_proof(*, proof: dict, document: dict, reveal_document: dict, document_loader: Callable[[str, dict], dict], nonce: Optional[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
- match_proof(signature_type: str) bool [source]
Match signature type to signature type of this suite.
- async 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
aries_cloudagent.vc.ld_proofs.suites.linked_data_signature module
Linked Data Signature class.
- class aries_cloudagent.vc.ld_proofs.suites.linked_data_signature.LinkedDataSignature(*, signature_type: str, proof: Optional[dict] = None, verification_method: Optional[str] = None, date: Optional[datetime.datetime] = None)[source]
Bases:
aries_cloudagent.vc.ld_proofs.suites.linked_data_proof.LinkedDataProof
Linked Data Signature class.
- async 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, return proof.
- abstract async sign(*, verify_data: bytes, proof: dict) dict [source]
Sign the data and add it to the proof.
- async 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.