Cross-document messaging

HTML
HTML and HTML5 Dynamic HTML XHTML XHTML Mobile Profile and C-HTML Canvas element Character encodings Document Object Model Font family HTML editor HTML element HTML Frames HTML5 video HTML scripting Web browser engine Quirks mode Style sheets Unicode and HTML W3C and WHATWG Web colors Web Storage Comparison of document markup languages web browsers layout engines for HTML HTML5 HTML5 Canvas HTML5 Media Non-standard HTML XHTML (1.1)
This box: view · talk · edit

Cross-document messaging, or web messaging, is an API introduced in the WHATWG HTML5 draft specification, allowing documents to communicate with one another across different origins, or source domains.^[1] Prior to HTML5, web browsers disallowed cross-site scripting, to protect against security attacks. This practice barred communication between non-hostile pages as well, making document interaction of any kind difficult.^[1][2] Cross-Document messaging allows scripts to interact across these boundaries, while providing a rudimentary level of security.

Requirements and Attributes

Using the Messaging API's postMessage method, plain text messages can be sent from one domain to another.^[3] This requires that the author first obtain the Window object of the receiving document. As a result, messages can be posted to the following:^[2]

• other frames or iframes within the sender document's window
• windows the sender document explicitly opens through Javascript calls
• the parent window of the sender document
• the window which opened the sender document

The message event being received has the following attributes:

• data - The data, or actual content, of the incoming message.
• origin - The origin of the sender document. This typically includes the scheme, hostname and port. It does not include the path or fragment identifier.^[1]
• source - the WindowProxy of where the document came from (the source window).

Example

Consider we want document A to communicate with document B, which is contained within an iframe or popup window.^[1] The Javascript for document A will look as follows:

var o = document.getElementsByTagName('iframe')[0];
o.contentWindow.postMessage('Hello B', 'http://documentB.com/');

The origin of our contentWindow object is passed to postMessage. It must match the origin of the document we wish to communicate with (in this case, document B). Otherwise, a security error will be thrown and the script will stop.^[3] The Javascript for document B will look as follows:

window.addEventListener('message', receiver, false);
function receiver(event) {
        if (event.origin == 'http://documentA.com') {
                if (event.data == 'Hello B') {
                        event.source.postMessage('Hello A, how are you?', event.origin);
                }
                else {
                        alert (event.data);
                }
        }
}

An event listener is set up to receive messages from document A. Using the origin property, it then checks that the domain of the sender is the expected domain. Document B then looks at the message, either displaying it to the user, or responding in turn with a message of its own for document A.^[1]

Security

Poor origin checking can pose a risk for applications which employ cross-document messaging.^[4] To safeguard against malicious code from foreign domains, authors should check the origin attribute to ensure messages are accepted from domains they expect to receive messages from. The format of incoming data should also be checked that it matches the expected format.^[1]

Support

Support for cross-document messaging exists in current versions of Internet Explorer, Mozilla Firefox, Safari, Google Chrome, Opera, Opera Mini, Opera Mobile, and Android web browser.^[5] Support for the API exists in the Trident, Gecko, WebKit and Presto layout engines.^[6]

See Also

• Cross-site scripting
• Cross-site request forgery
• Same origin policy

External Links

• HTML5 Web Messaging specification
• Cross-Document Messaging – HTML Draft Standard, WHATWG, http://www.whatwg.org/specs/web-apps/current-work/multipage/comms.html#web-messaging 
• WebKit DOM Programming Topics - Cross Document Messaging, Apple Developer Library, http://developer.apple.com/library/mac/#documentation/AppleApplications/Conceptual/SafariJSProgTopics/Articles/Cross-documentmessaging.html 
• Eng, Chris (2010-05-17), HTML5 Security in a Nutshell, Veracode, http://www.veracode.com/blog/2010/05/html5-security-in-a-nutshell/ 
• When can I use Cross-Document Messaging?, CanIUse, http://caniuse.com/x-doc-messaging 
• A Selection of Supported Features in HTML5, http://molly.com/html5/html5-0709.html 

References

1. ^ ^{a b c d e f} Cross-Document Messaging – HTML Draft Standard
2. ^ ^{a b} WebKit DOM Programming Topics - Cross Document Messaging
3. ^ ^{a b} Remy, Sharp, Messages, Workers, and Sockets, Introducing HTML5, New Riders, 2011, p. 197-199
4. ^ HTML5 Security in a Nutshell
5. ^ When can I use Cross-Document Messaging?
6. ^ A Selection of Supported Features in HTML5