Skip to content

Commit

Permalink
Add and use definition for "cryptosuite verification result".
Browse files Browse the repository at this point in the history
  • Loading branch information
msporny committed Feb 24, 2024
1 parent a2200a4 commit 923558a
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2477,11 +2477,26 @@ <h2>Cryptographic Suites</h2>
<dt><dfn>verifyProof</dfn></dt>
<dd>
An algorithm that takes a [=secured data document=] ([=map=]
|securedDocument|) as input, and produces a verification result
([=map=]) or an error. The verification result MUST contain a
verification status ([=boolean=] |verified|) value and an [=unsecured data
document=] ([=map=] |verifiedDocument|), and MAY contain information
that is useful for debugging purposes.
|securedDocument|) as input, and produces a <dfn>cryptosuite verification
result</dfn> or an error. The [=cryptosuite verification result=] is a
[=struct=] that contains the following [=struct/items=]:
<dl data-dfn-for="cryptosuite verification result">
<dt><dfn class="lint-ignore">verified</dfn></dt>
<dd>
A [=boolean=] that is `true` if the verification succeeded, or `false`
otherwise.
</dd>
<dt><dfn class="lint-ignore">verifiedDocument</dfn></dt>
<dd>
A [=map=] that represents the [=secured data document=] with the verified
proofs removed if [=cryptosuite verification result/verified=] is `true`, or
<a data-cite="INFRA#nulls">null</a> otherwise.
</dd>
</dl>
The structure MAY contain other implementation-specific information that is
useful for developers, such as debugging information. If an error is produced,
the verification process failed to complete. An error, such as a network error,
does not mean that a future attempt at verification would fail.
</dd>
</dl>
</li>
Expand Down Expand Up @@ -3073,10 +3088,10 @@ <h3>Verify Proof</h3>
This algorithm returns a <dfn>verification result</dfn>, a [=struct=] whose
[=struct/items=] are:
</p>
<dl>
<dl data-dfn-for="verification result">
<dt><dfn data-dfn-for="verification result">verified</dfn></dt>
<dd>`true` or `false`</dd>
<dt><dfn data-dfn-for="verification result">document</dfn></dt>
<dt><dfn data-dfn-for="verification result">verifiedDocument</dfn></dt>
<dd>
<a data-cite="INFRA#nulls">Null</a>, if [=verification result/verified=] is
`false`; otherwise, an [=unsecured data document=]
Expand Down Expand Up @@ -3152,7 +3167,7 @@ <h3>Verify Proof</h3>
<dl data-link-for="verification result">
<dt>[=verified=]</dt>
<dd>|cryptosuiteVerificationResult|.|verified|</dd>
<dt>[=document=]</dt>
<dt>[=verifiedDocument=]</dt>
<dd>|cryptosuiteVerificationResult|.|verifiedDocument|</dd>
<dt>[=media type=]</dt>
<dd>|mediaType|</dd>
Expand Down

0 comments on commit 923558a

Please sign in to comment.