Module mydata_did.patched_protocols.present_proof.v1_0.messages.inner.presentation_preview
A presentation preview inner object.
Expand source code
"""A presentation preview inner object."""
from enum import Enum
from time import time
from typing import Mapping, Sequence
from marshmallow import fields
from aries_cloudagent.ledger.indy import IndyLedger
from aries_cloudagent.messaging.models.base import BaseModel, BaseModelSchema
from aries_cloudagent.messaging.util import canon
from aries_cloudagent.messaging.valid import INDY_CRED_DEF_ID, INDY_PREDICATE
from aries_cloudagent.revocation.models.indy import NonRevocationInterval
from aries_cloudagent.wallet.util import b64_to_str
from aries_cloudagent.indy.util import generate_pr_nonce
from aries_cloudagent.protocols.didcomm_prefix import DIDCommPrefix
from ...message_types import PRESENTATION_PREVIEW
from ...util.predicate import Predicate
class PresPredSpec(BaseModel):
"""Class representing a predicate specification within a presentation preview."""
class Meta:
"""Pred spec metadata."""
schema_class = "PresPredSpecSchema"
def __init__(
self,
name: str,
*,
cred_def_id: str = None,
predicate: str,
threshold: int,
**kwargs,
):
"""
Initialize preview object.
Args:
name: attribute name
cred_def_id: credential definition identifier
predicate: predicate type (e.g., ">=")
threshold: threshold value
"""
super().__init__(**kwargs)
self.name = name
self.cred_def_id = cred_def_id
self.predicate = predicate
self.threshold = threshold
def __eq__(self, other):
"""Equality comparator."""
if canon(self.name) != canon(other.name):
return False # distinct attribute names modulo canonicalization
if self.cred_def_id != other.cred_def_id:
return False
if self.predicate != other.predicate:
return False
return self.threshold == other.threshold
class PresPredSpecSchema(BaseModelSchema):
"""Predicate specifiation schema."""
class Meta:
"""Predicate specifiation schema metadata."""
model_class = PresPredSpec
name = fields.Str(description="Attribute name", required=True, example="high_score")
cred_def_id = fields.Str(
description="Credential definition identifier",
required=False,
**INDY_CRED_DEF_ID,
)
predicate = fields.Str(
description="Predicate type ('<', '<=', '>=', or '>')",
required=True,
**INDY_PREDICATE,
)
threshold = fields.Int(description="Threshold value", required=True)
class PresAttrSpec(BaseModel):
"""Class representing an attibute specification within a presentation preview."""
class Meta:
"""Attr spec metadata."""
schema_class = "PresAttrSpecSchema"
class Posture(Enum):
"""Attribute posture: self-attested, revealed claim or unrevealed claim."""
SELF_ATTESTED = 0
REVEALED_CLAIM = 1
UNREVEALED_CLAIM = 2
def __init__(
self,
name: str,
cred_def_id: str = None,
mime_type: str = None,
value: str = None,
referent: str = None,
**kwargs,
):
"""
Initialize attribute specification object.
Args:
name: attribute name
cred_def_id: credential definition identifier
(None for self-attested attribute)
mime_type: MIME type
value: attribute value as credential stores it
(None for unrevealed attribute)
referent: credential referent
"""
super().__init__(**kwargs)
self.name = name
self.cred_def_id = cred_def_id
self.mime_type = mime_type.lower() if mime_type else None
self.value = value
self.referent = referent
@staticmethod
def list_plain(plain: dict, cred_def_id: str, referent: str = None):
"""
Return a list of `PresAttrSpec` on input cred def id.
Args:
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 PresAttrSpec on input cred def id with no MIME types
"""
return [
PresAttrSpec(
name=k, cred_def_id=cred_def_id, value=plain[k], referent=referent
)
for k in plain
]
@property
def posture(self) -> "PresAttrSpec.Posture":
"""Attribute posture: self-attested, revealed claim, or unrevealed claim."""
if self.cred_def_id:
if self.value:
return PresAttrSpec.Posture.REVEALED_CLAIM
return PresAttrSpec.Posture.UNREVEALED_CLAIM
if self.value:
return PresAttrSpec.Posture.SELF_ATTESTED
return None
def b64_decoded_value(self) -> str:
"""Value, base64-decoded if applicable."""
return b64_to_str(self.value) if self.value and self.mime_type else self.value
def satisfies(self, pred_spec: PresPredSpec):
"""Whether current specified attribute satisfies input specified predicate."""
return bool(
self.value
and not self.mime_type
and canon(self.name) == canon(pred_spec.name)
and not pred_spec.cred_def_id
or (self.cred_def_id == pred_spec.cred_def_id)
and Predicate.get(pred_spec.predicate).value.yes(
self.value, pred_spec.threshold
)
)
def __eq__(self, other):
"""Equality comparator."""
if canon(self.name) != canon(other.name):
return False # distinct attribute names
if self.cred_def_id != other.cred_def_id:
return False # distinct attribute cred def ids
if self.mime_type != other.mime_type:
return False # distinct MIME types
if self.referent != other.referent:
return False # distinct credential referents
return self.b64_decoded_value() == other.b64_decoded_value()
class PresAttrSpecSchema(BaseModelSchema):
"""Attribute specifiation schema."""
class Meta:
"""Attribute specifiation schema metadata."""
model_class = PresAttrSpec
name = fields.Str(
description="Attribute name", required=True, example="favourite_drink"
)
cred_def_id = fields.Str(required=False, **INDY_CRED_DEF_ID)
mime_type = fields.Str(
description="MIME type (default null)",
required=False,
data_key="mime-type",
example="image/jpeg",
)
value = fields.Str(description="Attribute value", required=False, example="martini")
referent = fields.Str(
description="Credential referent", required=False, example="0"
)
class PresentationPreview(BaseModel):
"""Class representing presentation preview."""
class Meta:
"""Presentation preview metadata."""
schema_class = "PresentationPreviewSchema"
message_type = PRESENTATION_PREVIEW
def __init__(
self,
*,
_type: str = None,
attributes: Sequence[PresAttrSpec] = None,
predicates: Sequence[PresPredSpec] = None,
**kwargs,
):
"""
Initialize presentation preview object.
Args:
_type: formalism for Marshmallow model creation: ignored
attributes: list of attribute specifications
predicates: list of predicate specifications
"""
super().__init__(**kwargs)
self.attributes = list(attributes) if attributes else []
self.predicates = list(predicates) if predicates else []
@property
def _type(self):
"""Accessor for message type."""
return DIDCommPrefix.qualify_current(PresentationPreview.Meta.message_type)
def has_attr_spec(self, cred_def_id: str, name: str, value: str) -> bool:
"""
Return whether preview contains given attribute specification.
Args:
cred_def_id: credential definition identifier
name: attribute name
value: attribute value
Returns:
Whether preview contains matching attribute specification.
"""
return any(
canon(a.name) == canon(name)
and a.value in (value, None)
and a.cred_def_id == cred_def_id
for a in self.attributes
)
async def indy_proof_request(
self,
name: str = None,
version: str = None,
nonce: str = None,
ledger: IndyLedger = None,
non_revoc_intervals: Mapping[str, NonRevocationInterval] = None,
) -> dict:
"""
Return indy proof request corresponding to presentation preview.
Typically the verifier turns the proof preview into a proof request.
Args:
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.
"""
def non_revoc(cred_def_id: str) -> NonRevocationInterval:
"""Non-revocation interval to use for input cred def id."""
nonlocal epoch_now
nonlocal non_revoc_intervals
return (non_revoc_intervals or {}).get(
cred_def_id, NonRevocationInterval(epoch_now, epoch_now)
)
epoch_now = int(time())
proof_req = {
"name": name or "proof-request",
"version": version or "1.0",
"nonce": nonce or await generate_pr_nonce(),
"requested_attributes": {},
"requested_predicates": {},
}
attr_specs_names = {}
for attr_spec in self.attributes:
if attr_spec.posture == PresAttrSpec.Posture.SELF_ATTESTED:
proof_req["requested_attributes"][
"self_{}_uuid".format(canon(attr_spec.name))
] = {"name": attr_spec.name}
continue
cd_id = attr_spec.cred_def_id
revoc_support = False
if cd_id:
if ledger:
async with ledger:
revoc_support = (await ledger.get_credential_definition(cd_id))[
"value"
].get("revocation")
interval = non_revoc(cd_id) if revoc_support else None
if attr_spec.referent:
if attr_spec.referent in attr_specs_names:
attr_specs_names[attr_spec.referent]["names"].append(attr_spec.name)
else:
attr_specs_names[attr_spec.referent] = {
"names": [attr_spec.name],
**{
"restrictions": [{"cred_def_id": cd_id}]
for _ in [""]
if cd_id
},
**{
"non_revoked": interval.serialize()
for _ in [""]
if revoc_support
},
}
else:
proof_req["requested_attributes"][
"{}_{}_uuid".format(
len(proof_req["requested_attributes"]),
canon(attr_spec.name),
)
] = {
"name": attr_spec.name,
**{"restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id},
**{
"non_revoked": interval.serialize()
for _ in [""]
if revoc_support
},
}
for (reft, attr_spec) in attr_specs_names.items():
proof_req["requested_attributes"][
"{}_{}_uuid".format(
len(proof_req["requested_attributes"]), canon(attr_spec["names"][0])
)
] = attr_spec
for pred_spec in self.predicates:
cd_id = pred_spec.cred_def_id
revoc_support = False
if cd_id:
if ledger:
async with ledger:
revoc_support = (await ledger.get_credential_definition(cd_id))[
"value"
].get("revocation")
interval = non_revoc(cd_id) if revoc_support else None
proof_req["requested_predicates"][
"{}_{}_{}_uuid".format(
len(proof_req["requested_predicates"]),
canon(pred_spec.name),
Predicate.get(pred_spec.predicate).value.fortran,
)
] = {
"name": pred_spec.name,
"p_type": pred_spec.predicate,
"p_value": pred_spec.threshold,
**{"restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id},
**{"non_revoked": interval.serialize() for _ in [""] if revoc_support},
}
return proof_req
def __eq__(self, other):
"""Equality comparator."""
for part in vars(self):
if getattr(self, part, None) != getattr(other, part, None):
return False
return True
class PresentationPreviewSchema(BaseModelSchema):
"""Presentation preview schema."""
class Meta:
"""Presentation preview schema metadata."""
model_class = PresentationPreview
_type = fields.Str(
description="Message type identifier",
required=False,
example=DIDCommPrefix.qualify_current(PRESENTATION_PREVIEW),
data_key="@type",
)
attributes = fields.Nested(PresAttrSpecSchema, required=True, many=True)
predicates = fields.Nested(PresPredSpecSchema, required=True, many=True)Classes
class PresAttrSpec (name: str, cred_def_id: str = None, mime_type: str = None, value: str = None, referent: str = None, **kwargs)-
Class representing an attibute specification within a presentation preview.
Initialize attribute specification object.
Args
name- attribute name
cred_def_id- credential definition identifier (None for self-attested attribute)
mime_type- MIME type
value- attribute value as credential stores it (None for unrevealed attribute)
referent- credential referent
Expand source code
class PresAttrSpec(BaseModel): """Class representing an attibute specification within a presentation preview.""" class Meta: """Attr spec metadata.""" schema_class = "PresAttrSpecSchema" class Posture(Enum): """Attribute posture: self-attested, revealed claim or unrevealed claim.""" SELF_ATTESTED = 0 REVEALED_CLAIM = 1 UNREVEALED_CLAIM = 2 def __init__( self, name: str, cred_def_id: str = None, mime_type: str = None, value: str = None, referent: str = None, **kwargs, ): """ Initialize attribute specification object. Args: name: attribute name cred_def_id: credential definition identifier (None for self-attested attribute) mime_type: MIME type value: attribute value as credential stores it (None for unrevealed attribute) referent: credential referent """ super().__init__(**kwargs) self.name = name self.cred_def_id = cred_def_id self.mime_type = mime_type.lower() if mime_type else None self.value = value self.referent = referent @staticmethod def list_plain(plain: dict, cred_def_id: str, referent: str = None): """ Return a list of `PresAttrSpec` on input cred def id. Args: 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 PresAttrSpec on input cred def id with no MIME types """ return [ PresAttrSpec( name=k, cred_def_id=cred_def_id, value=plain[k], referent=referent ) for k in plain ] @property def posture(self) -> "PresAttrSpec.Posture": """Attribute posture: self-attested, revealed claim, or unrevealed claim.""" if self.cred_def_id: if self.value: return PresAttrSpec.Posture.REVEALED_CLAIM return PresAttrSpec.Posture.UNREVEALED_CLAIM if self.value: return PresAttrSpec.Posture.SELF_ATTESTED return None def b64_decoded_value(self) -> str: """Value, base64-decoded if applicable.""" return b64_to_str(self.value) if self.value and self.mime_type else self.value def satisfies(self, pred_spec: PresPredSpec): """Whether current specified attribute satisfies input specified predicate.""" return bool( self.value and not self.mime_type and canon(self.name) == canon(pred_spec.name) and not pred_spec.cred_def_id or (self.cred_def_id == pred_spec.cred_def_id) and Predicate.get(pred_spec.predicate).value.yes( self.value, pred_spec.threshold ) ) def __eq__(self, other): """Equality comparator.""" if canon(self.name) != canon(other.name): return False # distinct attribute names if self.cred_def_id != other.cred_def_id: return False # distinct attribute cred def ids if self.mime_type != other.mime_type: return False # distinct MIME types if self.referent != other.referent: return False # distinct credential referents return self.b64_decoded_value() == other.b64_decoded_value()Ancestors
- aries_cloudagent.messaging.models.base.BaseModel
- abc.ABC
Class variables
var Meta-
Attr spec metadata.
var Posture-
Attribute posture: self-attested, revealed claim or unrevealed claim.
Static methods
def list_plain(plain: dict, cred_def_id: str, referent: str = None)-
Return a list of
PresAttrSpecon input cred def id.Args
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 PresAttrSpec on input cred def id with no MIME types
Expand source code
@staticmethod def list_plain(plain: dict, cred_def_id: str, referent: str = None): """ Return a list of `PresAttrSpec` on input cred def id. Args: 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 PresAttrSpec on input cred def id with no MIME types """ return [ PresAttrSpec( name=k, cred_def_id=cred_def_id, value=plain[k], referent=referent ) for k in plain ]
Instance variables
var posture : PresAttrSpec.Posture-
Attribute posture: self-attested, revealed claim, or unrevealed claim.
Expand source code
@property def posture(self) -> "PresAttrSpec.Posture": """Attribute posture: self-attested, revealed claim, or unrevealed claim.""" if self.cred_def_id: if self.value: return PresAttrSpec.Posture.REVEALED_CLAIM return PresAttrSpec.Posture.UNREVEALED_CLAIM if self.value: return PresAttrSpec.Posture.SELF_ATTESTED return None
Methods
def b64_decoded_value(self) ‑> str-
Value, base64-decoded if applicable.
Expand source code
def b64_decoded_value(self) -> str: """Value, base64-decoded if applicable.""" return b64_to_str(self.value) if self.value and self.mime_type else self.value def satisfies(self, pred_spec: PresPredSpec)-
Whether current specified attribute satisfies input specified predicate.
Expand source code
def satisfies(self, pred_spec: PresPredSpec): """Whether current specified attribute satisfies input specified predicate.""" return bool( self.value and not self.mime_type and canon(self.name) == canon(pred_spec.name) and not pred_spec.cred_def_id or (self.cred_def_id == pred_spec.cred_def_id) and Predicate.get(pred_spec.predicate).value.yes( self.value, pred_spec.threshold ) )
class PresAttrSpecSchema (*args, **kwargs)-
Attribute specifiation schema.
Initialize BaseModelSchema.
Raises
TypeError- If model_class is not set on Meta
Expand source code
class PresAttrSpecSchema(BaseModelSchema): """Attribute specifiation schema.""" class Meta: """Attribute specifiation schema metadata.""" model_class = PresAttrSpec name = fields.Str( description="Attribute name", required=True, example="favourite_drink" ) cred_def_id = fields.Str(required=False, **INDY_CRED_DEF_ID) mime_type = fields.Str( description="MIME type (default null)", required=False, data_key="mime-type", example="image/jpeg", ) value = fields.Str(description="Attribute value", required=False, example="martini") referent = fields.Str( description="Credential referent", required=False, example="0" )Ancestors
- aries_cloudagent.messaging.models.base.BaseModelSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
var Meta-
Attribute specifiation schema metadata.
var opts
class PresPredSpec (name: str, *, cred_def_id: str = None, predicate: str, threshold: int, **kwargs)-
Class representing a predicate specification within a presentation preview.
Initialize preview object.
Args
name- attribute name
cred_def_id- credential definition identifier
predicate- predicate type (e.g., ">=")
threshold- threshold value
Expand source code
class PresPredSpec(BaseModel): """Class representing a predicate specification within a presentation preview.""" class Meta: """Pred spec metadata.""" schema_class = "PresPredSpecSchema" def __init__( self, name: str, *, cred_def_id: str = None, predicate: str, threshold: int, **kwargs, ): """ Initialize preview object. Args: name: attribute name cred_def_id: credential definition identifier predicate: predicate type (e.g., ">=") threshold: threshold value """ super().__init__(**kwargs) self.name = name self.cred_def_id = cred_def_id self.predicate = predicate self.threshold = threshold def __eq__(self, other): """Equality comparator.""" if canon(self.name) != canon(other.name): return False # distinct attribute names modulo canonicalization if self.cred_def_id != other.cred_def_id: return False if self.predicate != other.predicate: return False return self.threshold == other.thresholdAncestors
- aries_cloudagent.messaging.models.base.BaseModel
- abc.ABC
Class variables
var Meta-
Pred spec metadata.
class PresPredSpecSchema (*args, **kwargs)-
Predicate specifiation schema.
Initialize BaseModelSchema.
Raises
TypeError- If model_class is not set on Meta
Expand source code
class PresPredSpecSchema(BaseModelSchema): """Predicate specifiation schema.""" class Meta: """Predicate specifiation schema metadata.""" model_class = PresPredSpec name = fields.Str(description="Attribute name", required=True, example="high_score") cred_def_id = fields.Str( description="Credential definition identifier", required=False, **INDY_CRED_DEF_ID, ) predicate = fields.Str( description="Predicate type ('<', '<=', '>=', or '>')", required=True, **INDY_PREDICATE, ) threshold = fields.Int(description="Threshold value", required=True)Ancestors
- aries_cloudagent.messaging.models.base.BaseModelSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
var Meta-
Predicate specifiation schema metadata.
var opts
class PresentationPreview (*, attributes: Sequence[PresAttrSpec] = None, predicates: Sequence[PresPredSpec] = None, **kwargs)-
Class representing presentation preview.
Initialize presentation preview object.
Args
_type- formalism for Marshmallow model creation: ignored
attributes- list of attribute specifications
predicates- list of predicate specifications
Expand source code
class PresentationPreview(BaseModel): """Class representing presentation preview.""" class Meta: """Presentation preview metadata.""" schema_class = "PresentationPreviewSchema" message_type = PRESENTATION_PREVIEW def __init__( self, *, _type: str = None, attributes: Sequence[PresAttrSpec] = None, predicates: Sequence[PresPredSpec] = None, **kwargs, ): """ Initialize presentation preview object. Args: _type: formalism for Marshmallow model creation: ignored attributes: list of attribute specifications predicates: list of predicate specifications """ super().__init__(**kwargs) self.attributes = list(attributes) if attributes else [] self.predicates = list(predicates) if predicates else [] @property def _type(self): """Accessor for message type.""" return DIDCommPrefix.qualify_current(PresentationPreview.Meta.message_type) def has_attr_spec(self, cred_def_id: str, name: str, value: str) -> bool: """ Return whether preview contains given attribute specification. Args: cred_def_id: credential definition identifier name: attribute name value: attribute value Returns: Whether preview contains matching attribute specification. """ return any( canon(a.name) == canon(name) and a.value in (value, None) and a.cred_def_id == cred_def_id for a in self.attributes ) async def indy_proof_request( self, name: str = None, version: str = None, nonce: str = None, ledger: IndyLedger = None, non_revoc_intervals: Mapping[str, NonRevocationInterval] = None, ) -> dict: """ Return indy proof request corresponding to presentation preview. Typically the verifier turns the proof preview into a proof request. Args: 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. """ def non_revoc(cred_def_id: str) -> NonRevocationInterval: """Non-revocation interval to use for input cred def id.""" nonlocal epoch_now nonlocal non_revoc_intervals return (non_revoc_intervals or {}).get( cred_def_id, NonRevocationInterval(epoch_now, epoch_now) ) epoch_now = int(time()) proof_req = { "name": name or "proof-request", "version": version or "1.0", "nonce": nonce or await generate_pr_nonce(), "requested_attributes": {}, "requested_predicates": {}, } attr_specs_names = {} for attr_spec in self.attributes: if attr_spec.posture == PresAttrSpec.Posture.SELF_ATTESTED: proof_req["requested_attributes"][ "self_{}_uuid".format(canon(attr_spec.name)) ] = {"name": attr_spec.name} continue cd_id = attr_spec.cred_def_id revoc_support = False if cd_id: if ledger: async with ledger: revoc_support = (await ledger.get_credential_definition(cd_id))[ "value" ].get("revocation") interval = non_revoc(cd_id) if revoc_support else None if attr_spec.referent: if attr_spec.referent in attr_specs_names: attr_specs_names[attr_spec.referent]["names"].append(attr_spec.name) else: attr_specs_names[attr_spec.referent] = { "names": [attr_spec.name], **{ "restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id }, **{ "non_revoked": interval.serialize() for _ in [""] if revoc_support }, } else: proof_req["requested_attributes"][ "{}_{}_uuid".format( len(proof_req["requested_attributes"]), canon(attr_spec.name), ) ] = { "name": attr_spec.name, **{"restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id}, **{ "non_revoked": interval.serialize() for _ in [""] if revoc_support }, } for (reft, attr_spec) in attr_specs_names.items(): proof_req["requested_attributes"][ "{}_{}_uuid".format( len(proof_req["requested_attributes"]), canon(attr_spec["names"][0]) ) ] = attr_spec for pred_spec in self.predicates: cd_id = pred_spec.cred_def_id revoc_support = False if cd_id: if ledger: async with ledger: revoc_support = (await ledger.get_credential_definition(cd_id))[ "value" ].get("revocation") interval = non_revoc(cd_id) if revoc_support else None proof_req["requested_predicates"][ "{}_{}_{}_uuid".format( len(proof_req["requested_predicates"]), canon(pred_spec.name), Predicate.get(pred_spec.predicate).value.fortran, ) ] = { "name": pred_spec.name, "p_type": pred_spec.predicate, "p_value": pred_spec.threshold, **{"restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id}, **{"non_revoked": interval.serialize() for _ in [""] if revoc_support}, } return proof_req def __eq__(self, other): """Equality comparator.""" for part in vars(self): if getattr(self, part, None) != getattr(other, part, None): return False return TrueAncestors
- aries_cloudagent.messaging.models.base.BaseModel
- abc.ABC
Class variables
var Meta-
Presentation preview metadata.
Methods
def has_attr_spec(self, cred_def_id: str, name: str, value: str) ‑> bool-
Return whether preview contains given attribute specification.
Args
cred_def_id- credential definition identifier
name- attribute name
value- attribute value
Returns
Whether preview contains matching attribute specification.
Expand source code
def has_attr_spec(self, cred_def_id: str, name: str, value: str) -> bool: """ Return whether preview contains given attribute specification. Args: cred_def_id: credential definition identifier name: attribute name value: attribute value Returns: Whether preview contains matching attribute specification. """ return any( canon(a.name) == canon(name) and a.value in (value, None) and a.cred_def_id == cred_def_id for a in self.attributes ) async def indy_proof_request(self, name: str = None, version: str = None, nonce: str = None, ledger: aries_cloudagent.ledger.indy.IndyLedger = None, non_revoc_intervals: Mapping[str, aries_cloudagent.revocation.models.indy.NonRevocationInterval] = None) ‑> dict-
Return indy proof request corresponding to presentation preview.
Typically the verifier turns the proof preview into a proof request.
Args
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.
Expand source code
async def indy_proof_request( self, name: str = None, version: str = None, nonce: str = None, ledger: IndyLedger = None, non_revoc_intervals: Mapping[str, NonRevocationInterval] = None, ) -> dict: """ Return indy proof request corresponding to presentation preview. Typically the verifier turns the proof preview into a proof request. Args: 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. """ def non_revoc(cred_def_id: str) -> NonRevocationInterval: """Non-revocation interval to use for input cred def id.""" nonlocal epoch_now nonlocal non_revoc_intervals return (non_revoc_intervals or {}).get( cred_def_id, NonRevocationInterval(epoch_now, epoch_now) ) epoch_now = int(time()) proof_req = { "name": name or "proof-request", "version": version or "1.0", "nonce": nonce or await generate_pr_nonce(), "requested_attributes": {}, "requested_predicates": {}, } attr_specs_names = {} for attr_spec in self.attributes: if attr_spec.posture == PresAttrSpec.Posture.SELF_ATTESTED: proof_req["requested_attributes"][ "self_{}_uuid".format(canon(attr_spec.name)) ] = {"name": attr_spec.name} continue cd_id = attr_spec.cred_def_id revoc_support = False if cd_id: if ledger: async with ledger: revoc_support = (await ledger.get_credential_definition(cd_id))[ "value" ].get("revocation") interval = non_revoc(cd_id) if revoc_support else None if attr_spec.referent: if attr_spec.referent in attr_specs_names: attr_specs_names[attr_spec.referent]["names"].append(attr_spec.name) else: attr_specs_names[attr_spec.referent] = { "names": [attr_spec.name], **{ "restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id }, **{ "non_revoked": interval.serialize() for _ in [""] if revoc_support }, } else: proof_req["requested_attributes"][ "{}_{}_uuid".format( len(proof_req["requested_attributes"]), canon(attr_spec.name), ) ] = { "name": attr_spec.name, **{"restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id}, **{ "non_revoked": interval.serialize() for _ in [""] if revoc_support }, } for (reft, attr_spec) in attr_specs_names.items(): proof_req["requested_attributes"][ "{}_{}_uuid".format( len(proof_req["requested_attributes"]), canon(attr_spec["names"][0]) ) ] = attr_spec for pred_spec in self.predicates: cd_id = pred_spec.cred_def_id revoc_support = False if cd_id: if ledger: async with ledger: revoc_support = (await ledger.get_credential_definition(cd_id))[ "value" ].get("revocation") interval = non_revoc(cd_id) if revoc_support else None proof_req["requested_predicates"][ "{}_{}_{}_uuid".format( len(proof_req["requested_predicates"]), canon(pred_spec.name), Predicate.get(pred_spec.predicate).value.fortran, ) ] = { "name": pred_spec.name, "p_type": pred_spec.predicate, "p_value": pred_spec.threshold, **{"restrictions": [{"cred_def_id": cd_id}] for _ in [""] if cd_id}, **{"non_revoked": interval.serialize() for _ in [""] if revoc_support}, } return proof_req
class PresentationPreviewSchema (*args, **kwargs)-
Presentation preview schema.
Initialize BaseModelSchema.
Raises
TypeError- If model_class is not set on Meta
Expand source code
class PresentationPreviewSchema(BaseModelSchema): """Presentation preview schema.""" class Meta: """Presentation preview schema metadata.""" model_class = PresentationPreview _type = fields.Str( description="Message type identifier", required=False, example=DIDCommPrefix.qualify_current(PRESENTATION_PREVIEW), data_key="@type", ) attributes = fields.Nested(PresAttrSpecSchema, required=True, many=True) predicates = fields.Nested(PresPredSpecSchema, required=True, many=True)Ancestors
- aries_cloudagent.messaging.models.base.BaseModelSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
var Meta-
Presentation preview schema metadata.
var opts