Skip to content

Improve explanation of danger with the linkHandler API #4310

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

Merged
Tyriar merged 1 commit into from
Dec 14, 2022
Merged

Improve explanation of danger with the linkHandler API #4310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/browser/OscLinkProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export class OscLinkProvider implements ILinkProvider {
}

function defaultActivate(e: MouseEvent, uri: string): void {
const answer = confirm(`Do you want to navigate to ${uri}?`);
const answer = confirm(`Do you want to navigate to ${uri}?\n\nWARNING: This link could potentially be dangerous`);
if (answer) {
const newWindow = window.open();
if (newWindow) {
Expand Down
11 changes: 8 additions & 3 deletions typings/xterm.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,14 @@ declare module 'xterm' {

/**
* The handler for OSC 8 hyperlinks. Links will use the `confirm` browser
* API if no link handler is set. Consider the security of users when using
* this, there should be some tooltip or prompt when hovering or activating
* the link.
* API with a strongly worded warning if no link handler is set.
*
* When setting this, consider the security of users opening these links,
* at a minimum there should be a tooltip or a prompt when hovering or
* activating the link respectively. An example of what might be possible is
* a terminal app writing link in the form `javascript:...` that runs some
* javascript, a safe approach to prevent that is to validate the link
* starts with http(s)://.
*/
linkHandler?: ILinkHandler | null;

Expand Down