aries_cloudagent.indy.models package
Submodules
aries_cloudagent.indy.models.cred module
Credential artifacts.
- class aries_cloudagent.indy.models.cred.IndyAttrValue(raw: Optional[str] = None, encoded: Optional[str] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy attribute value.
- class aries_cloudagent.indy.models.cred.IndyAttrValueSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy attribute value schema.
- encoded
- raw
- class aries_cloudagent.indy.models.cred.IndyCredential(schema_id: Optional[str] = None, cred_def_id: Optional[str] = None, rev_reg_id: Optional[str] = None, values: Optional[Mapping[str, aries_cloudagent.indy.models.cred.IndyAttrValue]] = None, signature: Optional[Mapping] = None, signature_correctness_proof: Optional[Mapping] = None, rev_reg: Optional[Mapping] = None, witness: Optional[Mapping] = None)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy credential.
- class aries_cloudagent.indy.models.cred.IndyCredentialSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy credential schema.
- cred_def_id
- rev_reg
- rev_reg_id
- schema_id
- signature
- signature_correctness_proof
- values
- witness
aries_cloudagent.indy.models.cred_abstract module
Cred abstract artifacts to attach to RFC 453 messages.
- class aries_cloudagent.indy.models.cred_abstract.IndyCredAbstract(schema_id: Optional[str] = None, cred_def_id: Optional[str] = None, nonce: Optional[str] = None, key_correctness_proof: Optional[str] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy credential abstract.
- class aries_cloudagent.indy.models.cred_abstract.IndyCredAbstractSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy credential abstract schema.
- class Meta[source]
Bases:
object
Indy credential abstract schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.cred_abstract.IndyCredAbstract
- cred_def_id
- key_correctness_proof
- nonce
- schema_id
- class aries_cloudagent.indy.models.cred_abstract.IndyKeyCorrectnessProof(c: Optional[str] = None, xz_cap: Optional[str] = None, xr_cap: Optional[Sequence[Sequence[str]]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy key correctness proof.
- class aries_cloudagent.indy.models.cred_abstract.IndyKeyCorrectnessProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy key correctness proof schema.
- class Meta[source]
Bases:
object
Indy key correctness proof schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.cred_abstract.IndyKeyCorrectnessProof
- c
- xr_cap
- xz_cap
aries_cloudagent.indy.models.cred_def module
Schema artifacts.
- class aries_cloudagent.indy.models.cred_def.CredDefValuePrimarySchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Cred def value primary schema.
- n
- r
- rctxt
- s
- z
- class aries_cloudagent.indy.models.cred_def.CredDefValueRevocationSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Cred def value revocation schema.
- g
- g_dash
- h
- h0
- h1
- h2
- h_cap
- htilde
- pk
- u
- y
aries_cloudagent.indy.models.cred_precis module
Admin routes for presentations.
- class aries_cloudagent.indy.models.cred_precis.IndyCredInfo(referent: Optional[str] = None, attrs: Optional[Mapping] = None, schema_id: Optional[str] = None, cred_def_id: Optional[str] = None, rev_reg_id: Optional[str] = None, cred_rev_id: Optional[str] = None)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy cred info, as holder gets via indy-sdk.
- class aries_cloudagent.indy.models.cred_precis.IndyCredInfoSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Schema for indy cred-info.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.cred_precis.IndyCredInfo
- attrs
- cred_def_id
- cred_rev_id
- referent
- rev_reg_id
- schema_id
aries_cloudagent.indy.models.cred_request module
Cred request artifacts to attach to RFC 453 messages.
- class aries_cloudagent.indy.models.cred_request.IndyCredRequest(prover_did: Optional[str] = None, cred_def_id: Optional[str] = None, blinded_ms: Optional[Mapping] = None, blinded_ms_correctness_proof: Optional[Mapping] = None, nonce: Optional[str] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy credential request.
- class aries_cloudagent.indy.models.cred_request.IndyCredRequestSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy credential request schema.
- class Meta[source]
Bases:
object
Indy credential request schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.cred_request.IndyCredRequest
- blinded_ms
- blinded_ms_correctness_proof
- cred_def_id
- nonce
- prover_did
aries_cloudagent.indy.models.non_rev_interval module
Indy non-revocation interval.
- class aries_cloudagent.indy.models.non_rev_interval.IndyNonRevocationInterval(fro: Optional[int] = None, to: Optional[int] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy non-revocation interval.
- class Meta[source]
Bases:
object
NonRevocationInterval metadata.
- schema_class = 'IndyNonRevocationIntervalSchema'
- class aries_cloudagent.indy.models.non_rev_interval.IndyNonRevocationIntervalSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Schema to allow serialization/deserialization of non-revocation intervals.
- class Meta[source]
Bases:
object
IndyNonRevocationIntervalSchema metadata.
- model_class
alias of
aries_cloudagent.indy.models.non_rev_interval.IndyNonRevocationInterval
- fro
- to
aries_cloudagent.indy.models.predicate module
Utilities for dealing with predicates.
- class aries_cloudagent.indy.models.predicate.Predicate(value)[source]
Bases:
enum.Enum
Enum for predicate types that indy-sdk supports.
- GE = Relation(fortran='GE', wql='$gte', math='>=', yes=<function Predicate.<lambda>>, no=<function Predicate.<lambda>>)
- GT = Relation(fortran='GT', wql='$gt', math='>', yes=<function Predicate.<lambda>>, no=<function Predicate.<lambda>>)
- LE = Relation(fortran='LE', wql='$lte', math='<=', yes=<function Predicate.<lambda>>, no=<function Predicate.<lambda>>)
- LT = Relation(fortran='LT', wql='$lt', math='<', yes=<function Predicate.<lambda>>, no=<function Predicate.<lambda>>)
- static get(relation: str) aries_cloudagent.indy.models.predicate.Predicate [source]
Return enum instance corresponding to input relation string.
aries_cloudagent.indy.models.pres_preview module
aries_cloudagent.indy.models.proof module
Marshmallow bindings for indy proofs.
- class aries_cloudagent.indy.models.proof.IndyEQProof(revealed_attrs: Optional[Mapping[str, str]] = None, a_prime: Optional[str] = None, e: Optional[str] = None, v: Optional[str] = None, m: Optional[Mapping[str, str]] = None, m2: Optional[str] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Equality proof for indy primary proof.
- class aries_cloudagent.indy.models.proof.IndyEQProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy equality proof schema.
- a_prime
- e
- m
- m2
- revealed_attrs
- v
- class aries_cloudagent.indy.models.proof.IndyGEProof(u: Optional[Mapping[str, str]] = None, r: Optional[Mapping[str, str]] = None, mj: Optional[str] = None, alpha: Optional[str] = None, t: Optional[Mapping[str, str]] = None, predicate: Optional[aries_cloudagent.indy.models.proof.IndyGEProofPred] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Greater-than-or-equal-to proof for indy primary proof.
- class aries_cloudagent.indy.models.proof.IndyGEProofPred(attr_name: Optional[str] = None, p_type: Optional[str] = None, value: Optional[int] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy GE proof predicate.
- class aries_cloudagent.indy.models.proof.IndyGEProofPredSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy GE proof predicate schema.
- attr_name
- p_type
- value
- class aries_cloudagent.indy.models.proof.IndyGEProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy GE proof schema.
- alpha
- mj
- predicate
- r
- t
- u
- class aries_cloudagent.indy.models.proof.IndyNonRevocProof(x_list: Optional[Mapping] = None, c_list: Optional[Mapping] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy non-revocation proof.
- class aries_cloudagent.indy.models.proof.IndyNonRevocProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy non-revocation proof schema.
- class Meta[source]
Bases:
object
Indy non-revocation proof schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyNonRevocProof
- c_list
- x_list
- class aries_cloudagent.indy.models.proof.IndyPresSpecSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Request schema for indy proof specification to send as presentation.
- requested_attributes
- requested_predicates
- self_attested_attributes
- trace
- class aries_cloudagent.indy.models.proof.IndyPrimaryProof(eq_proof: Optional[aries_cloudagent.indy.models.proof.IndyEQProof] = None, ge_proofs: Optional[Sequence[aries_cloudagent.indy.models.proof.IndyGEProof]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy primary proof.
- class aries_cloudagent.indy.models.proof.IndyPrimaryProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy primary proof schema.
- class Meta[source]
Bases:
object
Indy primary proof schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyPrimaryProof
- eq_proof
- ge_proofs
- class aries_cloudagent.indy.models.proof.IndyProof(proof: Optional[aries_cloudagent.indy.models.proof.IndyProofProof] = None, requested_proof: Optional[aries_cloudagent.indy.models.proof.IndyProofRequestedProof] = None, identifiers: Optional[Sequence[aries_cloudagent.indy.models.proof.IndyProofIdentifier]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof.
- class aries_cloudagent.indy.models.proof.IndyProofIdentifier(schema_id: Optional[str] = None, cred_def_id: Optional[str] = None, rev_reg_id: Optional[str] = None, timestamp: Optional[int] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof identifier.
- class aries_cloudagent.indy.models.proof.IndyProofIdentifierSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof identifier schema.
- class Meta[source]
Bases:
object
Indy proof identifier schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyProofIdentifier
- cred_def_id
- rev_reg_id
- schema_id
- timestamp
- class aries_cloudagent.indy.models.proof.IndyProofProof(proofs: Optional[Sequence[aries_cloudagent.indy.models.proof.IndyProofProofProofsProof]] = None, aggregated_proof: Optional[aries_cloudagent.indy.models.proof.IndyProofProofAggregatedProof] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof.proof content.
- class aries_cloudagent.indy.models.proof.IndyProofProofAggregatedProof(c_hash: Optional[str] = None, c_list: Optional[Sequence[Sequence[int]]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof.proof aggregated proof.
- class aries_cloudagent.indy.models.proof.IndyProofProofAggregatedProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof.proof aggregated proof schema.
- class Meta[source]
Bases:
object
Indy proof.proof aggregated proof schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyProofProofAggregatedProof
- c_hash
- c_list
- class aries_cloudagent.indy.models.proof.IndyProofProofProofsProof(primary_proof: Optional[aries_cloudagent.indy.models.proof.IndyPrimaryProof] = None, non_revoc_proof: Optional[aries_cloudagent.indy.models.proof.IndyNonRevocProof] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof.proof.proofs constituent proof.
- class aries_cloudagent.indy.models.proof.IndyProofProofProofsProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof.proof.proofs constituent proof schema.
- class Meta[source]
Bases:
object
Indy proof.proof.proofs constituent proof schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyProofProofProofsProof
- non_revoc_proof
- primary_proof
- class aries_cloudagent.indy.models.proof.IndyProofProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof.proof content schema.
- aggregated_proof
- proofs
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProof(revealed_attrs: Optional[Mapping[str, aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttr]] = None, revealed_attr_groups: Optional[Mapping[str, aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttrGroup]] = None, self_attested_attrs: Optional[Mapping] = None, unrevealed_attrs: Optional[Mapping] = None, predicates: Optional[Mapping[str, aries_cloudagent.indy.models.proof.IndyProofRequestedProofPredicate]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof.requested_proof content.
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProofPredicate(sub_proof_index: Optional[int] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof requested proof predicate.
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProofPredicateSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof requested prrof predicate schema.
- class Meta[source]
Bases:
object
Indy proof requested proof requested proof predicate schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyProofRequestedProofPredicate
- sub_proof_index
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttr(sub_proof_index: Optional[int] = None, **kwargs)[source]
Bases:
aries_cloudagent.indy.models.proof.RawEncoded
Indy proof requested proof revealed attr.
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttrGroup(sub_proof_index: Optional[int] = None, values: Optional[Mapping[str, aries_cloudagent.indy.models.proof.RawEncoded]] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof requested proof revealed attr group.
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttrGroupSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof requested proof revealed attr group schema.
- class Meta[source]
Bases:
object
Indy proof requested proof revealed attr group schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttrGroup
- sub_proof_index
- values
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttrSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof requested proof revealed attr schema.
- class Meta[source]
Bases:
object
Indy proof requested proof revealed attr schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttr
- sub_proof_index
- class aries_cloudagent.indy.models.proof.IndyProofRequestedProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof requested proof schema.
- class Meta[source]
Bases:
object
Indy proof requested proof schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof.IndyProofRequestedProof
- predicates
- revealed_attr_groups
- revealed_attrs
- self_attested_attrs
- unrevealed_attrs
- class aries_cloudagent.indy.models.proof.IndyProofSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy proof schema.
- identifiers
- proof
- requested_proof
- class aries_cloudagent.indy.models.proof.RawEncoded(raw: Optional[str] = None, encoded: Optional[str] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Raw and encoded attribute values.
aries_cloudagent.indy.models.proof_request module
Utilities to deal with indy.
- class aries_cloudagent.indy.models.proof_request.IndyProofReqAttrSpecSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Schema for attribute specification in indy proof request.
- name
- names
- non_revoked
- restrictions
- validate_fields(data, **kwargs)
Validate schema fields.
Data must have exactly one of name or names; if names then restrictions are mandatory.
- Parameters
data – The data to validate
- Raises
ValidationError – if data has both or neither of name and names
- class aries_cloudagent.indy.models.proof_request.IndyProofReqPredSpecSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Schema for predicate specification in indy proof request.
- name
- non_revoked
- p_type
- p_value
- restrictions
- class aries_cloudagent.indy.models.proof_request.IndyProofRequest(nonce: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, requested_attributes: Optional[Mapping] = None, requested_predicates: Optional[Mapping] = None, non_revoked: Optional[Mapping] = None, **kwargs)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof request.
- class aries_cloudagent.indy.models.proof_request.IndyProofRequestSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Schema for indy proof request.
- class Meta[source]
Bases:
object
Indy proof request schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.proof_request.IndyProofRequest
- name
- non_revoked
- nonce
- requested_attributes
- requested_predicates
- version
aries_cloudagent.indy.models.requested_creds module
Admin routes for presentations.
aries_cloudagent.indy.models.revocation module
Revocation artifacts.
- class aries_cloudagent.indy.models.revocation.IndyRevRegDef(ver: Optional[str] = None, id_: Optional[str] = None, revoc_def_type: Optional[str] = None, tag: Optional[str] = None, cred_def_id: Optional[str] = None, value: Optional[aries_cloudagent.indy.models.revocation.IndyRevRegDefValue] = None)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy revocation registry definition.
- class aries_cloudagent.indy.models.revocation.IndyRevRegDefSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy revocation registry definition schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.revocation.IndyRevRegDef
- cred_def_id
- id_
- revoc_def_type
- tag
- value
- ver
- class aries_cloudagent.indy.models.revocation.IndyRevRegDefValue(issuance_type: Optional[str] = None, max_cred_num: Optional[int] = None, public_keys: Optional[aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeys] = None, tails_hash: Optional[str] = None, tails_location: Optional[str] = None)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy revocation registry definition value.
- class aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeys(accum_key: Optional[aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeysAccumKey] = None)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy revocation registry definition value public keys.
- class aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeysAccumKey(z: Optional[str] = None)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy revocation registry definition value public keys accum key.
- class aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeysAccumKeySchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy revocation registry definition value public keys accum key schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeysAccumKey
- z
- class aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeysSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy revocation registry definition value public keys schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeys
- accum_key
- class aries_cloudagent.indy.models.revocation.IndyRevRegDefValueSchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy revocation registry definition value schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.revocation.IndyRevRegDefValue
- issuance_type
- max_cred_num
- public_keys
- tails_hash
- tails_location
- class aries_cloudagent.indy.models.revocation.IndyRevRegEntry(ver: Optional[str] = None, value: Optional[aries_cloudagent.indy.models.revocation.IndyRevRegEntryValue] = None)[source]
Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy revocation registry entry.
- class aries_cloudagent.indy.models.revocation.IndyRevRegEntrySchema(*args: Any, **kwargs: Any)[source]
Bases:
marshmallow.
Indy revocation registry entry schema.
- class Meta[source]
Bases:
object
Schema metadata.
- model_class
alias of
aries_cloudagent.indy.models.revocation.IndyRevRegEntry
- value
- ver
aries_cloudagent.indy.models.schema module
Schema artifacts.