Skip to content

Block disallowed URL schemes before opening external links - #56

Closed
elirangoshen wants to merge 1 commit into
mainfrom
eliran/external-link-scheme-allowlist
Closed

elirangoshen wants to merge 1 commit into
mainfrom
eliran/external-link-scheme-allowlist

Conversation

@elirangoshen

Copy link
Copy Markdown

Explanation of Change

Adds a scheme allowlist that blocks disallowed URL schemes before they reach Linking.openURL, preventing scheme injection (e.g. javascript:, data:, file:, custom app schemes like intent:) from server- or user-controlled URLs.

  • New CONST.ALLOWED_EXTERNAL_LINK_SCHEMES (http:, https:, mailto:, tel:).
  • New isExternalLinkSchemeAllowed(url) helper in src/libs/Url.ts. Schemeless values (relative/anchor paths) pass through since they are handled by navigation, not external opens.
  • Guards added before Linking.openURL in AnchorForCommentsOnly (native), Header, PDFView (native), and both asyncOpenURL implementations (native + web). Blocked attempts are logged via Log.warn.

Fixed Issues

$ N/A — internal security hardening on the callstack-internal fork; no linked GitHub issue.
PROPOSAL: N/A — straightforward defensive guard, no design proposal required.

Tests

  1. Open the app and navigate to a chat.
  2. Send a message containing a normal link (e.g. https://example.com) and tap it — verify it opens as before.
  3. Verify mailto: and tel: links still open their respective handlers.
  4. Confirm a disallowed scheme (e.g. a javascript: link) does not open anything and a Log.warn is emitted.
  5. Run the unit tests: npm run test -- tests/unit/UrlTest.ts and verify the isExternalLinkSchemeAllowed suite passes.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests — the scheme guard runs entirely client-side and behaves identically offline.

QA Steps

Same as Tests.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Add an allowlist (http/https/mailto/tel) enforced via isExternalLinkSchemeAllowed
at the asyncOpenURL chokepoint (native + web) and on dynamic direct Linking.openURL
callers (Header, AnchorForCommentsOnly, PDFView). Prevents javascript:/data:/custom
scheme injection from server- or user-controlled URLs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4e02f709-2590-45b8-aa43-b5f5ffcacae9

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch eliran/external-link-scheme-allowlist

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant