Skip to content

Accept (async) iterables in crypto.subtle.digest #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Accept (async) iterables in crypto.subtle.digest #390

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18c9819
Accept async_sequence<BufferSource> in crypto.subtle.digest
twiss Dec 13, 2024
b1a5966
Update spec/Overview.html
twiss Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 173 additions & 26 deletions spec/Overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1271,7 +1271,7 @@ <h2>SubtleCrypto interface</h2>
);
Promise&lt;ArrayBuffer> digest(
AlgorithmIdentifier algorithm,
BufferSource data
(BufferSource or async_sequence&lt;BufferSource>) data
);

Promise&lt;(CryptoKey or CryptoKeyPair)> generateKey(
Expand Down Expand Up @@ -1845,9 +1845,7 @@ <h4>The digest method</h4>
</li>
<li>
<p>
Let |data| be the result of
[= get a copy of the buffer source |
getting a copy of the bytes held by =] the `data` parameter passed to the
Let |data| be the `data` parameter passed to the
{{SubtleCrypto/digest()}} method.
</p>
</li>
Expand All @@ -1865,6 +1863,133 @@ <h4>The digest method</h4>
|normalizedAlgorithm|.
</p>
</li>
<li>
<p>
Let |bytesPromise| be a new Promise.
</p>
</li>
<li>
<dl class="switch">
<dt>If |data| is a {{BufferSource}}:</dt>
<dd>
<ol>
<li>
<p>
Let |bytes| be the result of
[= get a copy of the buffer source |
getting a copy of the bytes held by =] |data|.
</p>
</li>
<li>
<p>
Resolve |bytesPromise| with |bytes|.
</p>
</li>
</dd>
<dt>
Otherwise:
</dt>
<dd>
<div class=note>
<p>
In this case, |data| is an [= async sequence type | async sequence =] of {{BufferSource}}s.
</p>
</div>
<ol>
<li>
<p>
Let |bytes| be an empty [= byte sequence =].
</p>
</li>
<li>
<p>
Let |iterator| be the result of [= open an async sequence | opening =] |data|.
</p>
</li>
<li>
<p>
If an error occurred, reject |bytesPromise| with
|iterator| and terminate these steps.
</p>
</li>
<li>
<p>
Let |getValueSteps| be the following list of steps:
</p>
<ol>
<li>
<p>
Let |next| be the result of [= get an async iterator next value | getting the next value =] of |iterator|.
</p>
</li>
<li>
<p>
[= promise/React =] to |next|:
</p>
<dl class="switch">
<dt>If |next| was rejected with |reason|:</dt>
<dd>
<ol>
<li>
<p>
Reject |bytesPromise| with |reason|.
</p>
</li>
</ol>
</dd>
<dt>If |next| was fulfilled with |value|:</dt>
<dd>
<ol>
<li>
<p>
If |value| is [= end of iteration =],
resolve |bytesPromise| with |bytes|
and terminate these steps.
</p>
</li>
<li>
<p>
Append the result of [= get a copy of the buffer source |
getting a copy of the bytes held by =] |value|
to |bytes|.
</p>
</li>
<li>
<p>
Perform |getValueSteps|.
</p>
</li>
</ol>
</dd>
</dl>
</li>
</ol>
</li>
<li>
<p>
[= Queue a microtask =] to perform |getValueSteps|.
</p>
</li>
</ol>
<div class=note>
<p>
The implementation may wish to compute the hash digest
incrementally, instead of waiting until all data is
available, in order to conserve memory.
</p>
<p>
Additionally, if the |iterator| returned by
[= open an async sequence | opening =] |data|
is the iterator defined by <a data-cite="streams#readablestream">`ReadableStream`</a>,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should work?

Suggested change
is the iterator defined by <a data-cite="streams#readablestream">`ReadableStream`</a>,
is the iterator defined by {{ReadableStream}}</a>,

You'll first have to add streams to the xref config at the top:

- xref: ['html', 'dom', 'webidl', 'infra', 'encoding'],
+ xref: ['html', 'dom', 'webidl', 'infra', 'encoding', 'streams'],

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I had that before, but decided I didn't really want to pull in an xref for a single reference in a side note 😅

the implementation may wish to optimize the steps
above, for example by reading the stream directly,
and/or <a data-cite="streams#rs-transfer">transferring</a>
the stream to the [= in parallel | parallel =] steps below.
</p>
</div>
</dd>
</dl>
</li>
<li>
<p>
Let |realm| be the [= relevant realm =] of [= this =].
Expand Down Expand Up @@ -1892,29 +2017,51 @@ <h4>The digest method</h4>
</li>
<li>
<p>
Let |digest| be the result of performing the digest
operation specified by |normalizedAlgorithm| using
|algorithm|, with |data|
as |message|.
</p>
</li>
<li>
<p>
[= Queue a global task =] on the [= crypto task source =],
given |realm|'s global object, to perform the remaining steps.
</p>
</li>
<li>
<p>
Let |result| be the result of [= ArrayBuffer/create | creating =] an {{ArrayBuffer}}
in |realm|, containing |digest|.
</p>
</li>
<li>
<p>
Resolve |promise| with
|result|.
[= promise/React =] to |bytesPromise|:
</p>
<dl class="switch">
<dt>If |bytesPromise| was rejected with |reason|:</dt>
<dd>
<ol>
<li>
<p>
[= exception/Throw =] |reason|.
</p>
</li>
</ol>
</dd>
<dt>If |bytesPromise| was fulfilled with value |bytes|:</dt>
<dd>
<ol>
<li>
<p>
Let |digest| be the result of performing the digest
operation specified by |normalizedAlgorithm| using
|algorithm|, with |bytes|
as |message|.
</p>
</li>
<li>
<p>
[= Queue a global task =] on the [= crypto task source =],
given |realm|'s global object, to perform the remaining steps.
</p>
</li>
<li>
<p>
Let |result| be the result of [= ArrayBuffer/create | creating =] an {{ArrayBuffer}}
in |realm|, containing |digest|.
</p>
</li>
<li>
<p>
Resolve |promise| with
|result|.
</p>
</li>
</ol>
</dd>
</dl>
</li>
</ol>
</section>
Expand Down