aries_cloudagent.indy.models package¶
Submodules¶
aries_cloudagent.indy.models.cred module¶
Credential artifacts.
-
class
aries_cloudagent.indy.models.cred.
IndyAttrValue
(raw: str = None, encoded: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy attribute value.
-
class
aries_cloudagent.indy.models.cred.
IndyAttrValueSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy attribute value schema.
-
class
Meta
[source]¶ Bases:
object
Indy attribute value schema metadata.
-
model_class
¶ alias of
IndyAttrValue
-
unknown
¶ Used by autodoc_mock_imports.
-
-
encoded
¶ Used by autodoc_mock_imports.
-
raw
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.cred.
IndyCredential
(schema_id: str = None, cred_def_id: str = None, rev_reg_id: str = None, values: Mapping[str, aries_cloudagent.indy.models.cred.IndyAttrValue] = None, signature: Mapping = None, signature_correctness_proof: Mapping = None, rev_reg: Mapping = None, witness: Mapping = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy credential.
-
class
aries_cloudagent.indy.models.cred.
IndyCredentialSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy credential schema.
-
class
Meta
[source]¶ Bases:
object
Indy credential schemametadata.
-
model_class
¶ alias of
IndyCredential
-
unknown
¶ Used by autodoc_mock_imports.
-
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
rev_reg
¶ Used by autodoc_mock_imports.
-
rev_reg_id
¶ Used by autodoc_mock_imports.
-
schema_id
¶ Used by autodoc_mock_imports.
-
signature
¶ Used by autodoc_mock_imports.
-
signature_correctness_proof
¶ Used by autodoc_mock_imports.
-
values
¶ Used by autodoc_mock_imports.
-
witness
¶ Used by autodoc_mock_imports.
-
class
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: str = None, cred_def_id: str = None, nonce: str = None, key_correctness_proof: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy credential abstract.
-
class
aries_cloudagent.indy.models.cred_abstract.
IndyCredAbstractSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy credential abstract schema.
-
class
Meta
[source]¶ Bases:
object
Indy credential abstract schema metadata.
-
model_class
¶ alias of
IndyCredAbstract
-
unknown
¶ Used by autodoc_mock_imports.
-
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
key_correctness_proof
¶ Used by autodoc_mock_imports.
-
nonce
¶ Used by autodoc_mock_imports.
-
schema_id
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.cred_abstract.
IndyKeyCorrectnessProof
(c: str = None, xz_cap: str = None, xr_cap: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy key correctness proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy key correctness proof schema metadata.
-
model_class
¶ alias of
IndyKeyCorrectnessProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
c
¶ Used by autodoc_mock_imports.
-
xr_cap
¶ Used by autodoc_mock_imports.
-
xz_cap
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.indy.models.cred_def module¶
Schema artifacts.
-
class
aries_cloudagent.indy.models.cred_def.
CredDefValuePrimarySchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Cred def value primary schema.
-
n
¶ Used by autodoc_mock_imports.
-
r
¶ Used by autodoc_mock_imports.
-
rctxt
¶ Used by autodoc_mock_imports.
-
s
¶ Used by autodoc_mock_imports.
-
z
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.indy.models.cred_def.
CredDefValueRevocationSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Cred def value revocation schema.
-
g
¶ Used by autodoc_mock_imports.
-
g_dash
¶ Used by autodoc_mock_imports.
-
h
¶ Used by autodoc_mock_imports.
-
h0
¶ Used by autodoc_mock_imports.
-
h1
¶ Used by autodoc_mock_imports.
-
h2
¶ Used by autodoc_mock_imports.
-
h_cap
¶ Used by autodoc_mock_imports.
-
htilde
¶ Used by autodoc_mock_imports.
-
pk
¶ Used by autodoc_mock_imports.
-
u
¶ Used by autodoc_mock_imports.
-
y
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.indy.models.cred_def.
CredDefValueSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Cred def value schema.
-
primary
¶ Used by autodoc_mock_imports.
-
revocation
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.indy.models.cred_def.
CredentialDefinitionSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Marshmallow schema for indy cred def.
-
ident
¶ Used by autodoc_mock_imports.
-
schemaId
¶ Used by autodoc_mock_imports.
-
tag
¶ Used by autodoc_mock_imports.
-
typ
¶ Used by autodoc_mock_imports.
-
value
¶ Used by autodoc_mock_imports.
-
ver
¶ Used by autodoc_mock_imports.
-
aries_cloudagent.indy.models.cred_precis module¶
Admin routes for presentations.
-
class
aries_cloudagent.indy.models.cred_precis.
IndyCredInfo
(referent: str = None, attrs: Mapping = None, schema_id: str = None, cred_def_id: str = None, rev_reg_id: str = None, cred_rev_id: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Schema for indy cred-info.
-
class
Meta
[source]¶ Bases:
object
Schema metadata.
-
model_class
¶ alias of
IndyCredInfo
-
unknown
¶ Used by autodoc_mock_imports.
-
-
attrs
¶ Used by autodoc_mock_imports.
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
cred_rev_id
¶ Used by autodoc_mock_imports.
-
referent
¶ Used by autodoc_mock_imports.
-
rev_reg_id
¶ Used by autodoc_mock_imports.
-
schema_id
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.cred_precis.
IndyCredPrecisSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Schema for precis that indy credential search returns (and aca-py augments).
-
cred_info
¶ Used by autodoc_mock_imports.
-
interval
¶ Used by autodoc_mock_imports.
-
presentation_referents
¶ Used by autodoc_mock_imports.
-
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: str = None, cred_def_id: str = None, blinded_ms: Mapping = None, blinded_ms_correctness_proof: Mapping = None, nonce: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy credential request.
-
class
aries_cloudagent.indy.models.cred_request.
IndyCredRequestSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy credential request schema.
-
class
Meta
[source]¶ Bases:
object
Indy credential request schema metadata.
-
model_class
¶ alias of
IndyCredRequest
-
unknown
¶ Used by autodoc_mock_imports.
-
-
blinded_ms
¶ Used by autodoc_mock_imports.
-
blinded_ms_correctness_proof
¶ Used by autodoc_mock_imports.
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
nonce
¶ Used by autodoc_mock_imports.
-
prover_did
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.indy.models.non_rev_interval module¶
Indy non-revocation interval.
-
class
aries_cloudagent.indy.models.non_rev_interval.
IndyNonRevocationInterval
(fro: int = None, to: 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
-
class
aries_cloudagent.indy.models.non_rev_interval.
IndyNonRevocationIntervalSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Schema to allow serialization/deserialization of non-revocation intervals.
-
class
Meta
[source]¶ Bases:
object
IndyNonRevocationIntervalSchema metadata.
-
model_class
¶ alias of
IndyNonRevocationInterval
-
unknown
¶ Used by autodoc_mock_imports.
-
-
fro
¶ Used by autodoc_mock_imports.
-
to
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.indy.models.predicate module¶
Utilities for dealing with predicates.
-
class
aries_cloudagent.indy.models.predicate.
Predicate
[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>>)¶
-
fortran
¶ Fortran nomenclature.
-
math
¶ Mathematical nomenclature.
-
wql
¶ WQL nomenclature.
-
aries_cloudagent.indy.models.pres_preview module¶
A presentation preview inner object.
-
class
aries_cloudagent.indy.models.pres_preview.
IndyPresAttrSpec
(name: str, cred_def_id: str = None, mime_type: str = None, value: str = None, referent: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing an attibute specification within a presentation preview.
-
class
Posture
[source]¶ Bases:
enum.Enum
Attribute posture: self-attested, revealed claim or unrevealed claim.
-
REVEALED_CLAIM
= 1¶
-
SELF_ATTESTED
= 0¶
-
UNREVEALED_CLAIM
= 2¶
-
-
static
list_plain
(plain: dict, cred_def_id: str, referent: str = None)[source]¶ Return a list of IndyPresAttrSpec on input cred def id.
Parameters: - plain – dict mapping names to values
- cred_def_id – credential definition identifier to specify
- referent – single referent to use, omit for none
Returns: List of IndyPresAttrSpec on input cred def id with no MIME types
-
posture
¶ self-attested, revealed claim, or unrevealed claim.
Type: Attribute posture
-
class
-
class
aries_cloudagent.indy.models.pres_preview.
IndyPresAttrSpecSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Attribute specifiation schema.
-
class
Meta
[source]¶ Bases:
object
Attribute specifiation schema metadata.
-
model_class
¶ alias of
IndyPresAttrSpec
-
unknown
¶ Used by autodoc_mock_imports.
-
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
mime_type
¶ Used by autodoc_mock_imports.
-
name
¶ Used by autodoc_mock_imports.
-
referent
¶ Used by autodoc_mock_imports.
-
value
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.pres_preview.
IndyPresPredSpec
(name: str, *, cred_def_id: str = None, predicate: str, threshold: int, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing a predicate specification within a presentation preview.
-
class
aries_cloudagent.indy.models.pres_preview.
IndyPresPredSpecSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Predicate specifiation schema.
-
class
Meta
[source]¶ Bases:
object
Predicate specifiation schema metadata.
-
model_class
¶ alias of
IndyPresPredSpec
-
unknown
¶ Used by autodoc_mock_imports.
-
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
name
¶ Used by autodoc_mock_imports.
-
predicate
¶ Used by autodoc_mock_imports.
-
threshold
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.pres_preview.
IndyPresPreview
(*, _type: str = None, attributes: Sequence[aries_cloudagent.indy.models.pres_preview.IndyPresAttrSpec] = None, predicates: Sequence[aries_cloudagent.indy.models.pres_preview.IndyPresPredSpec] = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Class representing presentation preview.
-
class
Meta
[source]¶ Bases:
object
Presentation preview metadata.
-
message_type
= 'present-proof/1.0/presentation-preview'¶
-
schema_class
= 'IndyPresPreviewSchema'¶
-
-
has_attr_spec
(cred_def_id: str, name: str, value: str) → bool[source]¶ Return whether preview contains given attribute specification.
Parameters: - cred_def_id – credential definition identifier
- name – attribute name
- value – attribute value
Returns: Whether preview contains matching attribute specification.
-
indy_proof_request
(profile: aries_cloudagent.core.profile.Profile = None, name: str = None, version: str = None, nonce: str = None, non_revoc_intervals: Mapping[str, aries_cloudagent.indy.models.non_rev_interval.IndyNonRevocationInterval] = None) → dict[source]¶ Return indy proof request corresponding to presentation preview.
Typically the verifier turns the proof preview into a proof request.
Parameters: - name – for proof request
- version – version for proof request
- nonce – nonce for proof request
- ledger – ledger with credential definitions, to check for revocation support
- non_revoc_intervals – non-revocation interval to use per cred def id where applicable (default from and to the current time if applicable)
Returns: Indy proof request dict.
-
class
-
class
aries_cloudagent.indy.models.pres_preview.
IndyPresPreviewSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Presentation preview schema.
-
class
Meta
[source]¶ Bases:
object
Presentation preview schema metadata.
-
model_class
¶ alias of
IndyPresPreview
-
unknown
¶ Used by autodoc_mock_imports.
-
-
attributes
¶ Used by autodoc_mock_imports.
-
predicates
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.indy.models.proof module¶
Marshmallow bindings for indy proofs.
-
class
aries_cloudagent.indy.models.proof.
IndyEQProof
(revealed_attrs: Mapping[str, str] = None, a_prime: str = None, e: str = None, v: str = None, m: Mapping[str, str] = None, m2: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy equality proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy equality proof metadata.
-
model_class
¶ alias of
IndyEQProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
a_prime
¶ Used by autodoc_mock_imports.
-
e
¶ Used by autodoc_mock_imports.
-
m
¶ Used by autodoc_mock_imports.
-
m2
¶ Used by autodoc_mock_imports.
-
revealed_attrs
¶ Used by autodoc_mock_imports.
-
v
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyGEProof
(u: Mapping[str, str] = None, r: Mapping[str, str] = None, mj: str = None, alpha: str = None, t: Mapping[str, str] = None, predicate: 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: str = None, p_type: str = None, value: int = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy GE proof predicate.
-
class
aries_cloudagent.indy.models.proof.
IndyGEProofPredSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy GE proof predicate schema.
-
class
Meta
[source]¶ Bases:
object
Indy GE proof predicate metadata.
-
model_class
¶ alias of
IndyGEProofPred
-
unknown
¶ Used by autodoc_mock_imports.
-
-
attr_name
¶ Used by autodoc_mock_imports.
-
p_type
¶ Used by autodoc_mock_imports.
-
value
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyGEProofSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy GE proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy GE proof schema metadata.
-
model_class
¶ alias of
IndyGEProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
alpha
¶ Used by autodoc_mock_imports.
-
mj
¶ Used by autodoc_mock_imports.
-
predicate
¶ Used by autodoc_mock_imports.
-
r
¶ Used by autodoc_mock_imports.
-
t
¶ Used by autodoc_mock_imports.
-
u
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyNonRevocProof
(x_list: Mapping = None, c_list: Mapping = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy non-revocation proof.
-
class
aries_cloudagent.indy.models.proof.
IndyNonRevocProofSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy non-revocation proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy non-revocation proof schema metadata.
-
model_class
¶ alias of
IndyNonRevocProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
c_list
¶ Used by autodoc_mock_imports.
-
x_list
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyPresSpecSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.utils.tracing.AdminAPIMessageTracingSchema
Request schema for indy proof specification to send as presentation.
-
requested_attributes
¶ Used by autodoc_mock_imports.
-
requested_predicates
¶ Used by autodoc_mock_imports.
-
self_attested_attributes
¶ Used by autodoc_mock_imports.
-
trace
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.indy.models.proof.
IndyPrimaryProof
(eq_proof: aries_cloudagent.indy.models.proof.IndyEQProof = None, ge_proofs: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy primary proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy primary proof schema metadata.
-
model_class
¶ alias of
IndyPrimaryProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
eq_proof
¶ Used by autodoc_mock_imports.
-
ge_proofs
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProof
(proof: aries_cloudagent.indy.models.proof.IndyProofProof = None, requested_proof: aries_cloudagent.indy.models.proof.IndyProofRequestedProof = None, identifiers: 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: str = None, cred_def_id: str = None, rev_reg_id: str = None, timestamp: int = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof identifier.
-
class
aries_cloudagent.indy.models.proof.
IndyProofIdentifierSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof identifier schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof identifier schema metadata.
-
model_class
¶ alias of
IndyProofIdentifier
-
unknown
¶ Used by autodoc_mock_imports.
-
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
rev_reg_id
¶ Used by autodoc_mock_imports.
-
schema_id
¶ Used by autodoc_mock_imports.
-
timestamp
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofProof
(proofs: Sequence[aries_cloudagent.indy.models.proof.IndyProofProofProofsProof] = None, aggregated_proof: 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: str = None, c_list: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof.proof aggregated proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof.proof aggregated proof schema metadata.
-
model_class
¶ alias of
IndyProofProofAggregatedProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
c_hash
¶ Used by autodoc_mock_imports.
-
c_list
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofProofProofsProof
(primary_proof: aries_cloudagent.indy.models.proof.IndyPrimaryProof = None, non_revoc_proof: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof.proof.proofs constituent proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof.proof.proofs constituent proof schema metadata.
-
model_class
¶ alias of
IndyProofProofProofsProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
non_revoc_proof
¶ Used by autodoc_mock_imports.
-
primary_proof
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofProofSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof.proof content schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof.proof content schema metadata.
-
model_class
¶ alias of
IndyProofProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
aggregated_proof
¶ Used by autodoc_mock_imports.
-
proofs
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofRequestedProof
(revealed_attrs: Mapping[str, aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttr] = None, revealed_attr_groups: Mapping[str, aries_cloudagent.indy.models.proof.IndyProofRequestedProofRevealedAttrGroup] = None, self_attested_attrs: Mapping = None, unrevealed_attrs: Mapping = None, predicates: 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: int = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof requested proof predicate.
-
class
aries_cloudagent.indy.models.proof.
IndyProofRequestedProofPredicateSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof requested prrof predicate schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof requested proof requested proof predicate schema metadata.
-
model_class
¶ alias of
IndyProofRequestedProofPredicate
-
unknown
¶ Used by autodoc_mock_imports.
-
-
sub_proof_index
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofRequestedProofRevealedAttr
(sub_proof_index: 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: int = None, values: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof requested proof revealed attr group schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof requested proof revealed attr group schema metadata.
-
model_class
¶
-
unknown
¶ Used by autodoc_mock_imports.
-
-
sub_proof_index
¶ Used by autodoc_mock_imports.
-
values
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofRequestedProofRevealedAttrSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.indy.models.proof.RawEncodedSchema
Indy proof requested proof revealed attr schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof requested proof revealed attr schema metadata.
-
model_class
¶ alias of
IndyProofRequestedProofRevealedAttr
-
unknown
¶ Used by autodoc_mock_imports.
-
-
sub_proof_index
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofRequestedProofSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof requested proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof requested proof schema metadata.
-
model_class
¶ alias of
IndyProofRequestedProof
-
unknown
¶ Used by autodoc_mock_imports.
-
-
predicates
¶ Used by autodoc_mock_imports.
-
revealed_attr_groups
¶ Used by autodoc_mock_imports.
-
revealed_attrs
¶ Used by autodoc_mock_imports.
-
self_attested_attrs
¶ Used by autodoc_mock_imports.
-
unrevealed_attrs
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
IndyProofSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy proof schema.
-
class
Meta
[source]¶ Bases:
object
Indy proof schema metadata.
-
unknown
¶ Used by autodoc_mock_imports.
-
-
identifiers
¶ Used by autodoc_mock_imports.
-
proof
¶ Used by autodoc_mock_imports.
-
requested_proof
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.proof.
RawEncoded
(raw: str = None, encoded: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Raw and encoded attribute values.
-
class
aries_cloudagent.indy.models.proof.
RawEncodedSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Raw and encoded attribute values schema.
-
class
Meta
[source]¶ Bases:
object
Raw and encoded attribute values schema metadata.
-
model_class
¶ alias of
RawEncoded
-
unknown
¶ Used by autodoc_mock_imports.
-
-
encoded
¶ Used by autodoc_mock_imports.
-
raw
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.indy.models.proof_request module¶
Utilities to deal with indy.
-
class
aries_cloudagent.indy.models.proof_request.
IndyProofReqAttrSpecSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Schema for attribute specification in indy proof request.
-
name
¶ Used by autodoc_mock_imports.
-
names
¶ Used by autodoc_mock_imports.
-
non_revoked
¶ Used by autodoc_mock_imports.
-
restrictions
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.indy.models.proof_request.
IndyProofReqPredSpecSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Schema for predicate specification in indy proof request.
-
name
¶ Used by autodoc_mock_imports.
-
non_revoked
¶ Used by autodoc_mock_imports.
-
p_type
¶ Used by autodoc_mock_imports.
-
p_value
¶ Used by autodoc_mock_imports.
-
restrictions
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.indy.models.proof_request.
IndyProofRequest
(nonce: str = None, name: str = None, version: str = None, requested_attributes: Mapping = None, requested_predicates: Mapping = None, non_revoked: Mapping = None, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy proof request.
-
class
aries_cloudagent.indy.models.proof_request.
IndyProofRequestSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Schema for indy proof request.
-
class
Meta
[source]¶ Bases:
object
Indy proof request schema metadata.
-
model_class
¶ alias of
IndyProofRequest
-
unknown
¶ Used by autodoc_mock_imports.
-
-
name
¶ Used by autodoc_mock_imports.
-
non_revoked
¶ Used by autodoc_mock_imports.
-
nonce
¶ Used by autodoc_mock_imports.
-
requested_attributes
¶ Used by autodoc_mock_imports.
-
requested_predicates
¶ Used by autodoc_mock_imports.
-
version
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.indy.models.requested_creds module¶
Admin routes for presentations.
-
class
aries_cloudagent.indy.models.requested_creds.
IndyRequestedCredsRequestedAttrSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Schema for requested attributes within indy requested credentials structure.
-
cred_id
¶ Used by autodoc_mock_imports.
-
revealed
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.indy.models.requested_creds.
IndyRequestedCredsRequestedPredSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Schema for requested predicates within indy requested credentials structure.
-
cred_id
¶ Used by autodoc_mock_imports.
-
timestamp
¶ Used by autodoc_mock_imports.
-
aries_cloudagent.indy.models.revocation module¶
Revocation artifacts.
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegDef
(ver: str = None, id_: str = None, revoc_def_type: str = None, tag: str = None, cred_def_id: str = None, value: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy revocation registry definition schema.
-
class
Meta
[source]¶ Bases:
object
Schema metadata.
-
model_class
¶ alias of
IndyRevRegDef
-
unknown
¶ Used by autodoc_mock_imports.
-
-
cred_def_id
¶ Used by autodoc_mock_imports.
-
id_
¶ Used by autodoc_mock_imports.
-
revoc_def_type
¶ Used by autodoc_mock_imports.
-
tag
¶ Used by autodoc_mock_imports.
-
value
¶ Used by autodoc_mock_imports.
-
ver
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegDefValue
(issuance_type: str = None, max_cred_num: int = None, public_keys: aries_cloudagent.indy.models.revocation.IndyRevRegDefValuePublicKeys = None, tails_hash: str = None, tails_location: str = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy revocation registry definition value.
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegDefValuePublicKeys
(accum_key: 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: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy revocation registry definition value public keys accum key schema.
-
class
Meta
[source]¶ Bases:
object
Schema metadata.
-
model_class
¶ alias of
IndyRevRegDefValuePublicKeysAccumKey
-
unknown
¶ Used by autodoc_mock_imports.
-
-
z
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegDefValuePublicKeysSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy revocation registry definition value public keys schema.
-
class
Meta
[source]¶ Bases:
object
Schema metadata.
-
model_class
¶ alias of
IndyRevRegDefValuePublicKeys
-
unknown
¶ Used by autodoc_mock_imports.
-
-
accum_key
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegDefValueSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy revocation registry definition value schema.
-
class
Meta
[source]¶ Bases:
object
Schema metadata.
-
model_class
¶ alias of
IndyRevRegDefValue
-
unknown
¶ Used by autodoc_mock_imports.
-
-
issuance_type
¶ Used by autodoc_mock_imports.
-
max_cred_num
¶ Used by autodoc_mock_imports.
-
public_keys
¶ Used by autodoc_mock_imports.
-
tails_hash
¶ Used by autodoc_mock_imports.
-
tails_location
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegEntry
(ver: str = None, value: 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, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy revocation registry entry schema.
-
class
Meta
[source]¶ Bases:
object
Schema metadata.
-
model_class
¶ alias of
IndyRevRegEntry
-
unknown
¶ Used by autodoc_mock_imports.
-
-
value
¶ Used by autodoc_mock_imports.
-
ver
¶ Used by autodoc_mock_imports.
-
class
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegEntryValue
(prev_accum: str = None, accum: str = None, revoked: Sequence[int] = None)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModel
Indy revocation registry entry value.
-
class
aries_cloudagent.indy.models.revocation.
IndyRevRegEntryValueSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.base.BaseModelSchema
Indy revocation registry entry value schema.
-
class
Meta
[source]¶ Bases:
object
Schema metadata.
-
model_class
= 'IndyRevRegEntryValue'¶
-
unknown
¶ Used by autodoc_mock_imports.
-
-
accum
¶ Used by autodoc_mock_imports.
-
prev_accum
¶ Used by autodoc_mock_imports.
-
revoked
¶ Used by autodoc_mock_imports.
-
class
aries_cloudagent.indy.models.schema module¶
Schema artifacts.
-
class
aries_cloudagent.indy.models.schema.
SchemaSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Marshmallow schema for indy schema.
-
attr_names
¶ Used by autodoc_mock_imports.
-
ident
¶ Used by autodoc_mock_imports.
-
name
¶ Used by autodoc_mock_imports.
-
seqNo
¶ Used by autodoc_mock_imports.
-
ver
¶ Used by autodoc_mock_imports.
-
version
¶ Used by autodoc_mock_imports.
-
aries_cloudagent.indy.models.xform module¶
Utilities to deal with indy.
-
aries_cloudagent.indy.models.xform.
indy_proof_req2non_revoc_intervals
(indy_proof_req: dict)[source]¶ Return non-revocation intervals by requested item referent in proof request.
-
aries_cloudagent.indy.models.xform.
indy_proof_req_preview2indy_requested_creds
(indy_proof_req: dict, preview: aries_cloudagent.indy.models.pres_preview.IndyPresPreview = None, *, holder: aries_cloudagent.indy.holder.IndyHolder)[source]¶ Build indy requested-credentials structure.
Given input proof request and presentation preview, use credentials in holder’s wallet to build indy requested credentials structure for input to proof creation.
Parameters: - indy_proof_req – indy proof request
- pres_preview – preview from presentation proposal, if applicable
- holder – holder injected into current context