Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Allow webviews to be set as trusted viewers #5592

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
jridgewell merged 5 commits into from
Oct 14, 2016
Merged

Allow webviews to be set as trusted viewers #5592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4558da2
Allow webviews to be set as trusted viewers
jridgewell Oct 13, 2016
0c4d255
Add tests
jridgewell Oct 13, 2016
9ee3004
Do not trust "webviews" that are really bad actor iframes
jridgewell Oct 13, 2016
479470f
Test for '1' explicitly
jridgewell Oct 13, 2016
c2851f7
Fix test
jridgewell Oct 14, 2016
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
11 changes: 9 additions & 2 deletions src/service/viewer-impl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,12 +240,19 @@ export class Viewer {
this.performanceTracking_ = this.params_['csi'] === '1';
dev().fine(TAG_, '- performanceTracking:', this.performanceTracking_);

/**
* Whether the AMP document is embedded in a webview.
* @private @const {boolean}
*/
this.isWebviewEmbedded_ = !this.isIframed_ &&
this.params_['webview'] == '1';

/**
* Whether the AMP document is embedded in a viewer, such as an iframe or
* a web view.
* @private @const {boolean}
*/
this.isEmbedded_ = (this.isIframed_ || this.params_['webview'] === '1') &&
this.isEmbedded_ = (this.isIframed_ || this.isWebviewEmbedded_) &&
!this.win.AMP_TEST_IFRAME;

/** @private {boolean} */
Expand Down Expand Up @@ -293,7 +300,7 @@ export class Viewer {
// Not embedded in IFrame - can't trust the viewer.
trustedViewerResolved = false;
trustedViewerPromise = Promise.resolve(false);
} else if (this.win.location.ancestorOrigins) {
} else if (this.win.location.ancestorOrigins && !this.isWebviewEmbedded_) {

@dvoytenko dvoytenko Oct 13, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could we also check that the document is NOT currently iframed?

@jridgewell jridgewell Oct 13, 2016

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That's a great case. I've added this to the #isWebviewEmbeded boolean, and added tests.

// Ancestors when available take precedence. This is the main API used
// for this determination. Fallback is only done when this API is not
// supported by the browser.
Expand Down
117 changes: 117 additions & 0 deletions test/functional/test-viewer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -838,6 +838,123 @@ describe('Viewer', () => {
});
});

describe('when in webview', () => {
it('should decide trusted on connection with origin', () => {
windowApi.parent = windowApi;
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = [];
const viewer = new Viewer(ampdoc);
viewer.setMessageDeliverer(() => {}, 'https://google.com');
return viewer.isTrustedViewer().then(res => {
expect(res).to.be.true;
});
});

it('should NOT allow channel without origin', () => {
windowApi.parent = windowApi;
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = [];
const viewer = new Viewer(ampdoc);
expect(() => {
viewer.setMessageDeliverer(() => {});
}).to.throw(/message channel must have an origin/);
});

it('should decide non-trusted on connection with wrong origin', () => {
windowApi.parent = windowApi;
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = [];
const viewer = new Viewer(ampdoc);
viewer.setMessageDeliverer(() => {}, 'https://untrusted.com');
return viewer.isTrustedViewer().then(res => {
expect(res).to.be.false;
});
});

it('should NOT give precedence to ancestor', () => {
windowApi.parent = windowApi;
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = ['https://google.com'];
const viewer = new Viewer(ampdoc);
viewer.setMessageDeliverer(() => {}, 'https://untrusted.com');
return viewer.isTrustedViewer().then(res => {
expect(res).to.be.false;
});
});
});

describe('when in a fake webview (a bad actor iframe)', () => {
it('should consider trusted by ancestor', () => {
windowApi.parent = {};
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = ['https://google.com'];
return new Viewer(ampdoc).isTrustedViewer().then(res => {
expect(res).to.be.true;
});
});

it('should consider non-trusted without ancestor', () => {
windowApi.parent = {};
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = [];
return new Viewer(ampdoc).isTrustedViewer().then(res => {
expect(res).to.be.false;
});
});

it('should consider non-trusted with wrong ancestor', () => {
windowApi.parent = {};
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = ['https://untrusted.com'];
return new Viewer(ampdoc).isTrustedViewer().then(res => {
expect(res).to.be.false;
});
});

it('should decide trusted on connection with origin', () => {
windowApi.parent = {};
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = null;
const viewer = new Viewer(ampdoc);
viewer.setMessageDeliverer(() => {}, 'https://google.com');
return viewer.isTrustedViewer().then(res => {
expect(res).to.be.true;
});
});

it('should NOT allow channel without origin', () => {
windowApi.parent = {};
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = null;
const viewer = new Viewer(ampdoc);
expect(() => {
viewer.setMessageDeliverer(() => {});
}).to.throw(/message channel must have an origin/);
});

it('should decide non-trusted on connection with wrong origin', () => {
windowApi.parent = {};
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = null;
const viewer = new Viewer(ampdoc);
viewer.setMessageDeliverer(() => {}, 'https://untrusted.com');
return viewer.isTrustedViewer().then(res => {
expect(res).to.be.false;
});
});

it('should give precedence to ancestor', () => {
windowApi.parent = {};
windowApi.location.hash = '#webview=1';
windowApi.location.ancestorOrigins = ['https://google.com'];
const viewer = new Viewer(ampdoc);
viewer.setMessageDeliverer(() => {}, 'https://untrusted.com');
return viewer.isTrustedViewer().then(res => {
expect(res).to.be.true;
});
});
});

it('should trust domain variations', () => {
test('https://google.com', true);
test('https://www.google.com', true);
Expand Down