Skip to content
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

Add Trusted Signals KVv2 support to W3C Spec #1340

Merged
merged 18 commits into from
Dec 19, 2024
Merged

Add Trusted Signals KVv2 support to W3C Spec #1340

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
6d36ce8
Add Trusted Signals KVv2 support to W3C
Nov 18, 2024
3616421
Add Trusted Signals KVv2 support to W3C
Nov 18, 2024
dc669fd
Apply suggestions from code review
xtlsheep Dec 2, 2024
aad57c2
Apply suggestions from code review
Dec 2, 2024
27f6f9f
Apply suggestions from code review
Dec 4, 2024
f1d4796
Add struct for compressiong group and partition
Dec 4, 2024
5527258
Add struct for compressiong group and partition
Dec 4, 2024
6cadf44
Update spec based on comments and suggestions
Dec 12, 2024
89abacc
Add Trusted Signals KVv2 support to W3C Spec
Dec 14, 2024
34b1520
Add Trusted Signals KVv2 support to W3C Spec
Dec 14, 2024
a7067ea
Use map set in proper positions
Dec 16, 2024
0b2a19e
Update spec based on comments and suggestions
Dec 17, 2024
0ad19ad
Update spec based on comments and suggestions
Dec 17, 2024
f1926cf
Update spec based on comments and suggestions
Dec 18, 2024
b1bb686
Update spec based on comments and suggestions
Dec 18, 2024
a742ac1
Update spec based on comments and suggestions
Dec 18, 2024
22fe8ec
Update spec.bs
xtlsheep Dec 18, 2024
d613bc0
Apply suggestions from code review
qingxinwu Dec 19, 2024
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
80 changes: 49 additions & 31 deletions spec.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2728,7 +2728,7 @@ To <dfn>fetch trusted key value signals</dfn> given a [=URL=] |url|, a [=byte se
deserialization method may follow that described in
[Section 2.3.6 of the Protected Audience Key Value Services](https://privacysandbox.github.io/draft-ietf-protected-audience-key-value-service/draft-ietf-protected-audience-key-value-services.html#name-parsing-a-response).
1. Let |signals| be null.
1. Let |dataVersion| be an empty [=ordered map=].
1. Let |dataVersion| be an empty [=ordered map=], whose keys are [=strings=] and values are integers.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Let |perInterestGroupData| be an [=ordered map=].
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. [=Fetch=] |request| with [=fetch/useParallelQueue=] set to true, and
[=fetch/processResponseConsumeBody=] set to the following steps given a [=response=] |response|
Expand Down Expand Up @@ -7571,7 +7571,11 @@ An <dfn export>interest group</dfn> is a [=struct=] with the following [=struct/
:: A {{long}} integer, initially 0. Indicates the maximum trusted bidding signals fetch url length
for the interest group. 0 means no limit.
: <dfn>trusted bidding signals coordinator</dfn>
:: Null or an [=origin=].
:: Null or an [=origin=]. This is used to specify where to obtain the public key used for
encryption and decryption in communication with a trusted bidding signal server running in a
Trust Execution Environment (TEE). When this field is specified, the request will be sent to
a trusted bidding signals server running in a TEE, and the value of
[=interest group/trusted bidding signals url=] is ignored.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
: <dfn>user bidding signals</dfn>
:: Null or a [=string=]. Additional metadata that the owner can use during on-device bidding.
: <dfn>ads</dfn>
Expand Down Expand Up @@ -7732,7 +7736,11 @@ An <dfn export>auction config</dfn> is a [=struct=] with the following [=struct/
:: A {{long}} integer, initially 0. Indicates the maximum trusted scoring signals fetch url length
for the auction config. 0 means no limit.
: <dfn>trusted scoring signals coordinator</dfn>
:: Null or an [=origin=].
:: Null or an [=origin=]. This is used to specify where to obtain the public key used for
encryption and decryption in communication with a trusted scoring signal server running in a
Trust Execution Environment (TEE). When this field is specified, the request will be sent to
a trusted scoring signals server running in a TEE, and the value of
[=auction config/max trusted scoring signals url length=] is ignored.
: <dfn>interest group buyers</dfn>
:: Null or a [=list=] of [=origins=].
Owners of interest groups allowed to participate in the auction. Each [=origin's=]
Expand Down Expand Up @@ -8328,7 +8336,7 @@ To <dfn>batch or fetch trusted bidding signals</dfn> given a [=trusted bidding s
1. If |keyValueInterestGroups| [=map/contain=] |key|, [=set/Append=] |ig| to |keyValueInterestGroups|
[|key|].
1. Otherwise:
1. Let |keyValueInterestGroups|[|key|] be an empty [=set=].
1. Let |keyValueInterestGroups|[|key|] be an empty [=set=], whose values are [=strings=].
1. [=set/Append=] |ig| to |keyValueInterestGroups| [|key|].
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved

</div>
Expand All @@ -8339,22 +8347,23 @@ To <dfn>build trusted key value bidding signals request body</dfn> given a [=set
an {{unsigned short}}-or-null |experimentGroupId|, an [=origin=] |topLevelOrigin|, a [=string=]
|slotSizeQueryParam|, an [=origin=] |coordinator|, and an [=origin=] |owner|:

1. Let |compressionGroups| be an empty [=list=].
1. Let |compressionGroupMap| be an empty [=map=].
1. Let |compressionIdMap| be an empty [=map=].
1. Let |interestGroupIdMap| be an empty [=map=].
1. Let |compressionGroups| be an empty [=list=], whose values are [=maps=].
1. Let |compressionGroupMap| be an empty [=map=], whose keys are integers and values are [=maps=].
1. Let |compressionIdMap| be an empty [=map=], whose keys [=origins=] and values are integers.
1. Let |interestGroupIdMap| be an empty [=map=], whose keys are [=strings=] and values are [=tuples=]
of (interger, integer).
1. Let |slotSizeParams| be the result of [=strictly splitting=] |slotSizeQueryParam| on U+003D (=).
1. Let |nextCompressionGroupId| be 0.
1. [=list/For each=] |group| of |interestGroups|:
1. Set |joiningOrigin| to |group|'s [=interest group/joining origin=].
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Let |compressionGroupId| be an integer.
1. Let |partitionId| be an integer.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. If |compressionIdMap| does not [=map/contain=] |joiningOrigin|:
1. [=map/Set=] |compressionIdMap|[|joiningOrigin|] to |nextCompressionGroupId|.
1. Increment |nextCompressionGroupId| by 1.
1. Set |compressionGroupId| to |compressionIdMap|[|joiningOrigin|].
1. Let |compressionGroupId| be |compressionIdMap|[|joiningOrigin|].
1. If |compressionGroupMap| does not [=map/contain=] |compressionGroupId|:
1. Let |compressionGroupMap|[|compressionGroupId|] be an empty [=map=].
1. Let |compressionGroupMap|[|compressionGroupId|] be an empty [=map=], whose keys are integers
and values are [=maps=].
1. Set |executionMode| to |group|'s [=interest group/execution mode=].
1. If |executionMode| equal to "`group-by-origin`", set |partitionId| to 0.
1. Otherwise:
Expand All @@ -8365,13 +8374,15 @@ an {{unsigned short}}-or-null |experimentGroupId|, an [=origin=] |topLevelOrigin
1. Set |interestGroupIdMap|[|group|'s [=interest group/name=]] to [=tuple=] of |compressionGroupId|
and |partitionId|.
1. If |compressionGroupMap|[|compressionGroupId|] does not [=map/contain=] |partitionId|:
1. Let |partition| be an empty [=map=].
1. Let |partition| be an empty [=map=], whose keys are [=strings=] and values are integers or
[=maps=].
1. Set |partition|["id"] to |partitionId|.
1. Let |namespace| be an empty [=map=].
1. Let |namespace| be an empty [=map=], whose keys are [=strings=] and values are [=strings=] or
[=list=] of [=strings=].
1. Set |namespace|["interest_group_names"] to [|group|'s [=interest group/name=]].
1. Set |namespace|["bidding_keys"] to |group|'s [=interest group/trusted bidding signals keys=].
1. Set |partition|["namespace"] to |namespace|.
1. Let |metadata| be an empty [=map=].
1. Let |metadata| be an empty [=map=], whose keys and values are [=strings=].
1. Set |metadata|["experiment_group_id"] to |experimentGroupId|.
1. Set |metadata|[|slotSizeParams|[0]] to |slotSizeParams|[1].
1. Set |partition|["metadata"] to |metadata|.
Expand All @@ -8382,13 +8393,14 @@ an {{unsigned short}}-or-null |experimentGroupId|, an [=origin=] |topLevelOrigin
1. [=list/Append=] |group|'s [=interest group/trusted bidding signals keys=] into
|compressionGroupMap|[|compressionGroupId|][|partitionId|]["bidding_keys"].
1. [=map/For each=] |id| → |group| in |compressionGroupMap|:
1. Let |compressionGroup| be an empty [=map=].
1. Let |compressionGroup| be an empty [=map=], whose keys are [=strings=] and values are integers or
[=lists=] of [=maps=].
1. Set |compressionGroup|["compression_group_id"] to |id|.
1. Set |compressionGroup|["partitions"] to an empty [=list=].
1. [=list/For each=] |partition| in |group|'s [=map/values=]:
1. [=list/Append=] |partition| to |compressionGroup|["partitions"].
1. [=list/Append=] |compressionGroup| to |compressionGroups|.
1. Let |metadata| be an empty [=map=].
1. Let |metadata| be an empty [=map=], whose keys and values are [=strings=].
1. Let |hostname| be the result of [=string/UTF-8 percent-encoding=] the
[=serialization of an origin|serialized=] |topLevelOrigin| using [=component percent-encode set=].
1. Set |metadata|["hostname"] to |hostname|.
Expand All @@ -8411,8 +8423,8 @@ an [=origin=] |scriptOrigin|, an {{unsigned short}}-or-null |experimentGroupId|,
1. [=map/For each=] (|coordinator|, |owner|) → |interestGroups| of [=trusted bidding signals
batcher/key value interest groups=]:
1. Let « |requestBody|, |interestGroupIdMap|, |context| » be the result of [=building trusted
key value bidding signals request body=] with |signalsUrl|, |interestGroups|,
|experimentGroupId|, |topLevelOrigin|, |slotSizeQueryParam|, |coordinator| and |owner|.
key value bidding signals request body=] with |interestGroups|, |experimentGroupId|,
|topLevelOrigin|, |slotSizeQueryParam|, |coordinator| and |owner|.
1. Let « |partialTrustedBiddingSignals|, |partialPerInterestGroupData|, |dataVersion| » be the
result of [=fetching trusted key value signals=] with |signalsUrl|, |requestBody|, |context|,
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
|scriptOrigin|, |policyContainer|, |interestGroupIdMap| and true.
Expand Down Expand Up @@ -8592,45 +8604,51 @@ To <dfn>build trusted key value scoring signals request body</dfn> given a non-e
[=trusted scoring signals requests=] |entriesToBatch|:

1. Let |firstRequest| be |entriesToBatch|[0].
1. Let |compressionGroupMap| be an empty [=map=].
1. Let |compressionIdMap| be an empty [=map=].
1. Let |renderUrlIdMap| be an empty [=map=].
1. Let |compressionGroups| be an empty [=list=], whose values are [=maps=].
1. Let |compressionGroupMap| be an empty [=map=], whose keys are integers and keys are [=maps=].
1. Let |compressionIdMap| be an empty [=map=], whose keys are [=tuples=] of ([=origin=],
[=origin=]) and values are integers.
1. Let |renderUrlIdMap| be an empty [=map=], whose keys are [=URLs=] and values are [=tuples=]
of (interger, integer).
1. Let |nextCompressionGroupId| be 0.
1. [=map/For each=] |request| of |entriesToBatch|:
1. Let |compressionGroupId| be an integer.
1. Let |partitionId| be an integer.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Set |joiningOrigin| to |group|'s [=interest group/joining origin=].
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Let |ownerOrigin| be |request|'s [=trusted scoring signals request/owner origin=].
1. Let |mapKey| be a tuple of |ownerOrigin| and |joiningOrigin|.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. If |compressionIdMap| does not [=map/contain=] |mapKey|:
1. Set |compressionIdMap|[|mapKey|] to |nextCompressionGroupId|.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Increase |nextCompressionGroupId| by 1.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Set |compressionGroupId| to |compressionIdMap|[|mapKey|].
1. Let |compressionGroupId| be |compressionIdMap|[|mapKey|].
1. If |compressionGroupMap| does not [=map/contain=] |compressionGroupId|:
1. Let |compressionGroupMap|[|compressionGroupId|] be an empty [=map=].
1. Set |partitionId| to [=list/size=] of |compressionGroups|[|compressionGroupId|].
1. Let |compressionGroupMap|[|compressionGroupId|] be an empty [=map=], whose keys are integers
and values are [=maps=].
1. Set |partitionId| to [=list/size=] of |compressionGroupMap|[|compressionGroupId|].
1. Set |renderUrlIdMap|[|request|'s [=trusted scoring signals request/render URL=]] to [=tuple=]
of |compressionGroupId| and |partitionId|.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Let |partition| be an empty [=map=].
1. Let |partition| be an empty [=map=], whose keys are [=strings=] and values are [=strings=] or
[=list=] of [=strings=].
1. Set |partition|["id"] to |partitionId|.
1. Let |namespace| be an empty [=map=].
1. Let |namespace| be an empty [=map=], whose keys are [=strings=] and values are [=strings=] or
[=list=] of [=strings=].
1. Set |namespace|["render_url"] to [|request|'s [=trusted scoring signals request/render URL=]].
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. Set |namespace|["ad_component_render_urls"] to |request|'s [=trusted scoring signals request/ad
component URLs=].
1. Set |partition|["namespace"] to |namespace|.
1. Let |metadata| be an empty [=map=].
1. Let |metadata| be an empty [=map=], whose keys and values are [=strings=].
1. Set |metadata|["experiment_group_id"] to |firstRequest|'s [=trusted scoring signals
request/seller experiment group id=].
1. Set |partition|["metadata"] to |metadata|.
1. Set |compressionGroups|[|compressionGroupId|][|partitionId|] to |partition|.
1. Set |compressionGroupMap|[|compressionGroupId|][|partitionId|] to |partition|.
xtlsheep marked this conversation as resolved.
Show resolved Hide resolved
1. [=map/For each=] |id| → |group| in |compressionGroupMap|:
1. Let |compressionGroup| be an empty [=map=].
1. Let |compressionGroup| be an empty [=map=], whose keys are [=strings=] and values are integers or
[=lists=] of [=maps=].
1. Set |compressionGroup|["compression_group_id"] to |id|.
1. Set |compressionGroup|["partitions"] to an empty [=list=].
1. [=list/For each=] |partition| in |group|'s [=map/values=]:
1. [=list/Append=] |partition| to |compressionGroup|["partitions"].
1. [=list/Append=] |compressionGroup| to |compressionGroups|.
1. Let |metadata| be an empty [=map=].
1. Let |metadata| be an empty [=map=], whose keys and values are [=strings=].
1. Let |hostname| be the result of [=string/UTF-8 percent-encoding=] the
[=serialization of an origin|serialized=] |firstRequest|'s [=trusted scoring signals request/top
level origin=] using [=component percent-encode set=].
Expand Down
Loading