[go: nahoru, domu]
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

Jump to bottom

Make FencedFrameConfig IDL objects serializable #111

Merged
merged 6 commits into from
Aug 26, 2023
Merged

Make FencedFrameConfig IDL objects serializable #111

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ad1187b
add serialization steps
blu25 Aug 7, 2023
22d2988
formatting
blu25 Aug 7, 2023
52b86ae
Merge branch 'master' into liam-serializable-config
blu25 Aug 17, 2023
f9bebc0
make config serializable
blu25 Aug 18, 2023
0f04118
address review comments
blu25 Aug 22, 2023
4cfb07d
remove reference to variable name
blu25 Aug 24, 2023
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
Prev Previous commit
Next Next commit
make config serializable
  • Loading branch information
@blu25
blu25 committed Aug 18, 2023
commit f9bebc0e1969d0a836c9503d787ec24cbc847f3d
174 changes: 103 additions & 71 deletions spec.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,9 +456,13 @@ The <dfn attribute for=HTMLFencedFrameElement>config</dfn> IDL attribute getter

1. Let |urn uuid| be the given {{FencedFrameConfig}}'s [=fencedframeconfig/urn=].

1. Let |shared storage context| be the given {{FencedFrameConfig}}'s [=fencedframeconfig/
sharedStorageContext=].

1. [=Navigate=] |element|'s [=fenced navigable container/fenced navigable=] to |urn uuid| using
|element|'s [=Node/node document=], with [=historyHandling=] set to "<a for="history handling
behavior">`replace`</a>" , and [=referrerPolicy=] set to <a>"`no-referrer`"</a>.
behavior">`replace`</a>", [=referrerPolicy=] set to <a>"`no-referrer`"</a>, and
sharedStorageContext set to |shared storage context|.
blu25 marked this conversation as resolved.
Show resolved Hide resolved

Note: See [[#navigation-changes]] for the <{fencedframe}>-specific changes to the ordinary
navigation flow.
Expand Down Expand Up @@ -524,7 +528,7 @@ to discern when a pending config is finalized, it is important that all visibili
transparent fields do not change from the pending config to the finalized config, given that they
can be inspected through {{FencedFrameConfig}}'s getters. Therefore, a {{FencedFrameConfig}} that
is created and exposed to the web platform is effectively immutable even if its underlying
[=fencedframeconfig/config=] is technically "pending", and will finish resolving completely later.
[=fenced frame config=] is technically "pending", and will finish resolving completely later.
blu25 marked this conversation as resolved.
Show resolved Hide resolved

Each [=fenced frame config mapping=] has a <dfn for="fenced frame config mapping">maximum number of
configs</dfn>, which is implementation-defined. The [=fenced frame config mapping/maximum number of
Expand Down Expand Up @@ -893,7 +897,7 @@ A <dfn export>fenced frame config</dfn> is a [=struct=] with the following [=str
:: a [=URL=]

: <dfn for="mapped url">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

: <dfn>container size</dfn>
:: null, or a [=fencedframetype/size=]
Expand All @@ -904,15 +908,15 @@ A <dfn export>fenced frame config</dfn> is a [=struct=] with the following [=str
:: a [=fencedframetype/size=]

: <dfn for="content size">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

: <dfn>interest group descriptor</dfn>
:: null, or a [=struct=] with the following [=struct/items=]:
: <dfn for="interest group descriptor">value</dfn>
:: an [=fencedframetype/interest group descriptor=]

: <dfn for="interest group descriptor">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

: <dfn>on navigate callback</dfn>
:: null, or a series of steps
Expand All @@ -923,15 +927,15 @@ A <dfn export>fenced frame config</dfn> is a [=struct=] with the following [=str
:: an [=fencedframetype/exhaustive set of sandbox flags=]

: <dfn for="effective sandbox flags">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

: <dfn>effective enabled permissions</dfn>
:: null, or a [=struct=] with the following [=struct/items=]:
: <dfn for="effective enabled permissions">value</dfn>
:: a [=list=] of [=policy-controlled features=]

: <dfn for="effective enabled permissions">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

Note: When non-null, this is a [=list=] of [=policy-controlled features=] that the generator of
this config relies on exclusively being enabled inside the <{fencedframe}> that navigates to
Expand All @@ -951,23 +955,23 @@ A <dfn export>fenced frame config</dfn> is a [=struct=] with the following [=str
:: a [=fencedframetype/fenced frame reporting metadata=]

: <dfn for="fenced frame reporting metadata">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

: <dfn>exfiltration budget metadata</dfn>
:: null, or a [=struct=] with the following [=struct/items=]:
: <dfn for="exfiltration budget metadata">value</dfn>
:: an [=fencedframetype/exfiltration budget metadata=]

: <dfn for="exfiltration budget metadata">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

: <dfn>nested configs</dfn>
:: null, or a [=struct=] with the following [=struct/items=]:
: <dfn for="nested configs">value</dfn>
:: a [=list=] of [=fenced frame configs=]

: <dfn for="nested configs">visibility</dfn>
:: a [=visibility=]
:: a [=fencedframeconfig/visibility=]

: <dfn>embedder shared storage context</dfn>
:: null, or a [=string=]
Expand Down Expand Up @@ -1141,60 +1145,35 @@ element with arbitrary URLs *not* produced by config-generating APIs for develop
Each {{FencedFrameConfig}} has:

* A <dfn for=fencedframeconfig>urn</dfn>, a [=urn uuid=]
* A <dfn for=fencedframeconfig>config</dfn>, a [=fenced frame config=]
* A <dfn for=fencedframeconfig>sharedStorageContext</dfn>, a [=string=]
* A <dfn for=fencedframeconfig>containerWidth</dfn>, a {{FencedFrameConfigSize}} or null
* A <dfn for=fencedframeconfig>containerHeight</dfn>, a {{FencedFrameConfigSize}} or null
* A <dfn for=fencedframeconfig>contentWidth</dfn>, a {{FencedFrameConfigSize}} or null
* A <dfn for=fencedframeconfig>contentHeight</dfn>, a {{FencedFrameConfigSize}} or null

<div algorithm="containerWidth getter">
The {{FencedFrameConfig/containerWidth}} IDL attribute getter steps are:

1. If [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/container size=] is null,
return null.

1. Return [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/container size=]'s
[=size/width=].
The {{FencedFrameConfig/containerWidth}} IDL attribute getter steps are to return [=this=]'s
[=fencedframeconfig/containerWidth=].
</div>

<div algorithm="containerHeight getter">
The {{FencedFrameConfig/containerHeight}} IDL attribute getter steps are:

1. If [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/container size=] is null,
return null.

1. Return [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/container size=]'s
[=size/height=].
The {{FencedFrameConfig/containerHeight}} IDL attribute getter steps are to return [=this=]'s
[=fencedframeconfig/containerHeight=].
</div>

<div algorithm="contentWidth getter">
The {{FencedFrameConfig/contentWidth}} IDL attribute getter steps are:

1. If [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/content size=] is null,
return null.

1. If [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/content size=]'s [=content
size/visibility=] is "<a for=visibility>`transparent`</a>", return the [=fenced frame
config/content size=]'s [=content size/value=]'s [=size/width=].

1. Otherwise, return the `"opaque"` {{OpaqueProperty}}.
The {{FencedFrameConfig/contentWidth}} IDL attribute getter steps are to return [=this=]'s
[=fencedframeconfig/contentWidth=].
</div>

<div algorithm="contentHeight getter">
The {{FencedFrameConfig/contentHeight}} IDL attribute getter steps are:

1. If [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/content size=] is null,
return null.

1. If [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/content size=]'s [=content
size/visibility=] is "<a for=visibility>`transparent`</a>", return the [=fenced frame
config/content size=]'s [=content size/value=]'s [=size/height=].

1. Otherwise, return the `"opaque"` {{OpaqueProperty}}.
The {{FencedFrameConfig/contentHeight}} IDL attribute getter steps are to return [=this=]'s
[=fencedframeconfig/contentHeight=].
</div>

<div algorithm>
The <dfn method for=FencedFrameConfig>setSharedStorageContext(|contextString|)</dfn> method steps
are:

1. Set [=this=]'s [=fencedframeconfig/config=]'s [=fenced frame config/embedder shared storage
context=] to |contextString|.
are to set [=this=]'s [=fencedframeconfig/sharedStorageContext=] to |contextString|.
</div>

<div algorithm="FencedFrameConfig serializer">
Expand All @@ -1203,9 +1182,24 @@ Each {{FencedFrameConfig}} has:

1. If |forStorage| is true, then throw a {{DataCloneError}} {{DOMException}}.

2. Set |serialized|.`[[Urn]]` to the value of |value|'s [=fencedframeconfig/urn=] attribute.
1. Set |serialized|.`[[Urn]]` to the value of |value|'s [=fencedframeconfig/urn=] attribute.
blu25 marked this conversation as resolved.
Show resolved Hide resolved

1. Set |serialized|.`[[SharedStorageContext]]` to the value of |value|'s [=fencedframeconfig/
sharedStorageContext=] attribute.

1. Set |serialized|.`[[ContainerWidth]]` to the value of |value|'s [=fencedframeconfig/
containerWidth=] attribute.

1. Set |serialized|.`[[ContainerHeight]]` to the value of |value|'s [=fencedframeconfig/
containerHeight=] attribute.

1. Set |serialized|.`[[ContentWidth]]` to the value of |value|'s [=fencedframeconfig/
contentWidth=] attribute.

1. Set |serialized|.`[[ContentHeight]]` to the value of |value|'s [=fencedframeconfig/
contentHeight=] attribute.


3. Set |serialized|.`[[Config]]` to the value of |value|'s [=fencedframeconfig/config=] attribute.
</div>

<div algorithm="FencedFrameConfig deserializer">
Expand All @@ -1214,7 +1208,20 @@ Each {{FencedFrameConfig}} has:

1. Initialize |value|'s [=fencedframeconfig/urn=] attribute to |serialized|.`[[Urn]]`.
blu25 marked this conversation as resolved.
Show resolved Hide resolved

2. Initialize |value|'s [=fencedframeconfig/config=] attribute to |serialized|.`[[Config]]`.
1. Initialize |value|'s [=fencedframeconfig/sharedStorageContext=] attribute to |serialized|.`
[[SharedStorageContext]]`.

1. Initialize |value|'s [=fencedframeconfig/containerWidth=] attribute to |serialized|.
`[[ContainerWidth]]`.

1. Initialize |value|'s [=fencedframeconfig/containerHeight=] attribute to |serialized|.
`[[ContainerHeight]]`.

1. Initialize |value|'s [=fencedframeconfig/contentWidth=] attribute to |serialized|.
`[[ContentWidth]]`.

1. Initialize |value|'s [=fencedframeconfig/contentHeight=] attribute to |serialized|.
`[[ContentHeight]]`.
</div>

<h3 id=fence-interface>The {{Fence}} interface</h3>
Expand Down Expand Up @@ -1334,8 +1341,28 @@ Several APIs specific to fenced frames are defined on the {{Fence}} interface.
: [=fencedframeconfig/urn=]
:: |urn|

: [=fencedframeconfig/config=]
:: |config|
: [=fencedframeconfig/sharedStorageContext=]
:: |config|'s [=fenced frame config/embedder shared storage context=]

: [=fencedframeconfig/containerWidth=]
:: null if |config|'s [=fenced frame config/container size=] is null, otherwise |config|'s
[=fenced frame config/container size=]'s [=size/width=]

: [=fencedframeconfig/containerHeight=]
:: null if |config|'s [=fenced frame config/container size=] is null, otherwise |config|'s
[=fenced frame config/container size=]'s [=size/height=]

: [=fencedframeconfig/contentWidth=]
:: null if |config|'s [=fenced frame config/content size=] is null, {{OpaqueProperty}} if
blu25 marked this conversation as resolved.
Show resolved Hide resolved
|config|'s [=fenced frame config/content size=]'s [=content size/visibility=] is
[=visibility/opaque=], otherwise |config|'s [=fenced frame config/content size=]'s
[=size/width=]

: [=fencedframeconfig/contentHeight=]
:: null if |config|'s [=fenced frame config/content size=] is null, {{OpaqueProperty}} if
blu25 marked this conversation as resolved.
Show resolved Hide resolved
|config|'s [=fenced frame config/content size=]'s [=content size/visibility=] is
[=visibility/opaque=], otherwise |config|'s [=fenced frame config/content size=]'s
[=size/height=]

1. [=list/Append=] |newConfig| to |results|.

Expand Down Expand Up @@ -2117,6 +2144,9 @@ CORP violation report=] algorithm, as leaving it unfenced may cause a privacy le
</div>

<div algorithm=navigate>
Modify the beginning sentence of [[HTML]]'s [=navigate=] algorithm to include an extra parameter:
blu25 marked this conversation as resolved.
Show resolved Hide resolved
an optional [=string=] |sharedStorageContext| (default null).

Modify step 7 of [[HTML]]'s [=navigate=] algorithm to include the following condition:

* |navigable| is a [=fenced navigable container/fenced navigable=];
Expand All @@ -2142,7 +2172,7 @@ CORP violation report=] algorithm, as leaving it unfenced may cause a privacy le
/fenced-frame/fragment-navigation.https.html
</wpt>

Insert these steps immediately after step 16, the step that goes [=in parallel=], so that what
Insert these steps immediately after step 20, the step that goes [=in parallel=], so that what
follows are the first steps that run [=in parallel=] in the patched algorithm:

1. If |url| is a [=urn uuid=] and |navigable| is a [=fenced navigable container/fenced
Expand All @@ -2158,6 +2188,9 @@ CORP violation report=] algorithm, as leaving it unfenced may cause a privacy le
any subsequent embedder-initiated navigations, <span class=allow-2119>should</span> they
occur, by the usual mechanism that tracks the [=navigable/ongoing navigation=].

1. Set |config|'s [=fenced frame config/embedder shared storage context=] to
|sharedStorageContext|.

1. Set <var ignore>sourceSnapshotParams</var>'s [=source snapshot params/target fenced frame
config=] to |config|.

Expand Down Expand Up @@ -2453,22 +2486,21 @@ directive wouldn't give web sites enough control over their CSP rules. Introduce
*This introductory sub-section is non-normative.*

The [=policy-controlled features=] available to {{Document}}s inside of a <{fencedframe}> are
determined exclusively by the {{FencedFrameConfig}} that the <{fencedframe}> navigates to.
Specifically, the {{FencedFrameConfig}}'s [=fencedframeconfig/config=]'s [=fenced frame
config/effective enabled permissions=] defines the exclusive list of [=policy-controlled features=]
that will be enabled in the {{Document}} (all others will be disabled).

During navigation, the {{FencedFrameConfig}}'s [=fencedframeconfig/config=] [=instantiate a
config|instantiates=] a [=browsing context/fenced frame config instance=] that is stored on the
[=browsing context=] in the [=fenced navigable container/fenced navigable=]. This browsing context's
[=browsing context/fenced frame config instance=]'s [=fenced frame config instance/effective enabled
permissions=] is consulted [=Should navigation response to navigation request be blocked by
Permissions Policy?|during navigation=]. A <{fencedframe}> navigation can only succeed if the
[=Document/permissions policy=] for the navigation's resulting {{Document}} has an [=permissions
policy/inherited policy=] such that the [=inherited policy for a feature|inherited policy value=] is
"`Enabled`" for each feature in the [=fenced frame config/effective enabled permissions=]. Otherwise
the environment the <{fencedframe}> is embedded in is deemed unsuitable for the [=fenced frame
config=], and the navigation is blocked.
determined exclusively by the [=fenced frame config=] that the <{fencedframe}> navigates to.
Specifically, the [=fenced frame config=]'s [=fenced frame config/effective enabled permissions=]
defines the exclusive list of [=policy-controlled features=] that will be enabled in the
{{Document}} (all others will be disabled).

During navigation, the [=fenced frame config=] [=instantiate a config|instantiates=] a [=browsing
context/fenced frame config instance=] that is stored on the [=browsing context=] in the [=fenced
navigable container/fenced navigable=]. This browsing context's [=browsing context/fenced frame
config instance=]'s [=fenced frame config instance/effective enabled permissions=] is consulted
[=Should navigation response to navigation request be blocked by Permissions Policy?|during
navigation=]. A <{fencedframe}> navigation can only succeed if the [=Document/permissions policy=]
for the navigation's resulting {{Document}} has an [=permissions policy/inherited policy=] such that
the [=inherited policy for a feature|inherited policy value=] is "`Enabled`" for each feature in the
[=fenced frame config/effective enabled permissions=]. Otherwise the environment the <{fencedframe}>
is embedded in is deemed unsuitable for the [=fenced frame config=], and the navigation is blocked.

At the same time, to make sure that a <{fencedframe}>'s embedder does not directly influence content
in the frame based on that navigation's [=navigation params/origin=] (since the origin is derived
Expand Down