Skip to content

docs: document opt-in safeUrlSchemes configuration parameter (CP: 25.1)#5790

Open
mcollovati wants to merge 1 commit into
v25.1from
docs/safeUrlScheme-backport
Open

docs: document opt-in safeUrlSchemes configuration parameter (CP: 25.1)#5790
mcollovati wants to merge 1 commit into
v25.1from
docs/safeUrlScheme-backport

Conversation

@mcollovati

Copy link
Copy Markdown
Contributor

Backport of #5775 to the v25.1 branch, adapted for the Flow 25.1 backport vaadin/flow#24924.

Two differences from the main version:

  • The validation is opt-in (disabled by default). On 25.1 the safeUrlSchemes parameter defaults to *, so every URL scheme is accepted unless the parameter is set. The docs describe how to enable it rather than how to relax an already-enabled default.
  • No com.vaadin.safeUrlSchemes legacy name. The 25.1 backport only recognizes safeUrlSchemes, so the deprecated-alias note is omitted.

Also adds a note that the default flips to enabled in Vaadin 25.2, so users are aware of the behavior change when migrating.

The upgrading/index.adoc change from #5775 is intentionally omitted: it documents a breaking change in 25.2, which doesn't apply to the opt-in 25.1 backport.

Part of vaadin/flow#24924

🤖 Generated with Claude Code

Flow 25.1 adds URL scheme validation for `Anchor.setHref()`,
`IFrame.setSrc()` and `Page.open()`, but the validation is opt-in:
URLs of any scheme are accepted unless the `safeUrlSchemes` parameter
is set.

Document the `safeUrlSchemes` parameter and the Unsafe URL Schemes
security topic, and note that the default flips to enabled in Vaadin
25.2 so users are aware of the change when migrating.

Part of vaadin/flow#24924
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant