Update Readme file with recent refactor
Change-Id: Ic9095f9db2273bc5b3293a29ea6a6d554471885c
Signed-off-by: Mate Toth-Pal <mate.toth-pal@arm.com>
diff --git a/iat-verifier/iatverifier/attest_token_verifier.py b/iat-verifier/iatverifier/attest_token_verifier.py
index bd93441..3bd82ac 100644
--- a/iat-verifier/iatverifier/attest_token_verifier.py
+++ b/iat-verifier/iatverifier/attest_token_verifier.py
@@ -228,6 +228,15 @@
a value representing this claim is a dictionary. This claim contains further
claims which represent the possible key-value pairs in the value for this
claim.
+
+ It is possible that there are requirement that the claims in this claim must
+ satisfy, but this can't be checked in the `verify` function of a claim.
+
+ For example the composite claim can contain a claim type `A`, and a claim
+ type `B`, exactly one of the two can be present.
+
+ In this case a method must be passed in the `cross_claim_requirement_checker`
+ parameter of the `__init__` function, that does this check.
"""
def __init__(self,
@@ -261,6 +270,8 @@
def verify(self, value):
+ # No actual verification is done here. The `verify` function of the contained claims
+ # is called during traversing of the token tree.
self.verify_count += 1
def _parse_token_dict(self, *, entry_number, token, verify, check_p_header, lower_case_key):