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.

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

feat(config): add option to disable custom html functionality #26956

Merged
merged 13 commits into from Mar 22, 2023

Conversation

liamdebeasi
Copy link
Member

@liamdebeasi liamdebeasi commented Mar 14, 2023

Docs PR: ionic-team/ionic-docs#2826

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
    • Some docs updates need to be made in the ionic-docs repo, in a separate PR. See the contributing guide for details.
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue URL: Internal ticket

Developers have requested a way to disable the innerHTML functionality in Ionic for use cases where they are only passing plain text. Accepting user content and passing to innerHTML without properly sanitizing their content poses a security risk. Ionic has a built-in sanitizer for this, but it is not designed to be comprehensive.

What is the new behavior?

  • Added a global innerHTMLTemplatesEnabled config. When false, this will disable any innerHTML functionality inside of Ionic. This avoids the need to user a sanitizer because user-generated content will be interpreted as text instead of custom HTML.

Does this introduce a breaking change?

  • Yes
  • No

Other information

@stackblitz
Copy link

stackblitz bot commented Mar 14, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot added the package: core @ionic/core package label Mar 14, 2023
@liamdebeasi liamdebeasi changed the title feat(config): add option to disable html functionality feat(config): add option to disable custom html functionality Mar 14, 2023
@liamdebeasi liamdebeasi marked this pull request as ready for review March 14, 2023 16:46
@liamdebeasi liamdebeasi requested a review from a team as a code owner March 14, 2023 16:46
Copy link
Contributor

@amandaejohnston amandaejohnston left a comment

Choose a reason for hiding this comment

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

Don't forget to add this to the interface docs: https://ionicframework.com/docs/angular/config#ionicconfig (also for React and Vue)

Copy link
Contributor

@amandaejohnston amandaejohnston left a comment

Choose a reason for hiding this comment

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

Oh wait, that would be in the docs PR, wouldn't it 😆 Nvm, this one looks good.

@liamdebeasi liamdebeasi requested a review from a team March 20, 2023 13:06
@liamdebeasi liamdebeasi merged commit 3b0af7c into feature-6.7 Mar 22, 2023
45 checks passed
@liamdebeasi liamdebeasi deleted the FW-3722 branch March 22, 2023 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: core @ionic/core package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants