Browse files

First xauth checkin for git

  • Loading branch information...
0 parents commit 6670a267985404e6296409654177e6ebae441143 Jian Shen committed Apr 28, 2010
Showing with 2,733 additions and 0 deletions.
  1. +177 −0 LICENSE
  2. +110 −0
  3. +22 −0
  4. +314 −0 release/index.html
  5. +206 −0 release/info/index.html
  6. +2 −0 release/server.html
  7. +453 −0 release/spec/index.html
  8. +1 −0 release/xauth.js
  9. +314 −0 src/index.html
  10. +206 −0 src/info/index.html
  11. +17 −0 src/server.html
  12. +266 −0 src/server.js
  13. +453 −0 src/spec/index.html
  14. +192 −0 src/xauth.js
  15. BIN tools/yuicompressor-2.4.2.jar
@@ -0,0 +1,177 @@
+ Apache License
+ Version 2.0, January 2004
+ 1. Definitions.
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ implied, including, without limitation, any warranties or conditions
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
@@ -0,0 +1,110 @@
+An open platform for extending authenticated user services across the web.
+* The average internet user has more online services than ever (Emails, Social Networks)
+* Many of these services provide APIs (OpenSocial, OpenGraphProtocol) thru delegated authentication (OAuth) to publisher sites (NYTimes, WSJ)
+* Publisher sites don't have an easy way of knowing which services a visitor uses so they present [all available options]( and push the decision to the user
+XAuth provides a more efficient method for publishers to recognize when site visitors are logged in to those online services enabling them to present more meaningful and relevant options.
+### XAuth Usage for Online Service Providers ###
+As an online service provider wanting to publish the presence of an authenticated user, include the xauth.js client library on the landing page after a user is authenticated.
+ <!-- html of -->
+ <script type="text/javascript" src=""></script>
+An XAuth object will be created in the global scope allowing you to extend an XAuth Token. The token that you extend can be anything from a boolean flag indicating the presence of an authenticated user to more sophisticated consumable information such as a revokable delegated auth token that publishers can use to access more functionality. **The example code below is only one possible implementation**
+ <!-- html of -->
+ <script type="text/javascript">
+ XAuth.extend({
+ token: "user_status=online", // Whatever format the extender wants
+ expire: 1272529884557, // Could be however long your Remember Me lasts
+ extend: ["*"],
+ callback: extendSuccessCallback
+ });
+ </script>
+Your token will be saved under the domain name of the page this script executes on. Now Publishers have access to your token.
+### XAuth Usage for Publishers ###
+As a publisher wanting to know the presence of an authenticated user, include the xauth.js client library on any page needing the information.
+ <!-- html of -->
+ <script type="text/javascript" src=""></script>
+An XAuth object will be created in the global scope allowing you to retrieve XAuth Tokens. **The example code below is only one possible implementation**
+ <!-- html of -->
+ <script type="text/javascript">
+ function retrieveCallback(response) {
+ var tokens = response.tokens;
+ for(var domain in tokens) {
+ var token = tokens[domain]['token'];
+ var expiration = tokens[domain]['expire']; // could be useful
+ if(token == 'user_status=online') {
+ // Do something smart for the user for this service!
+ }
+ }
+ }
+ XAuth.retrieve({
+ retrieve: ["", "", ""],
+ callback: retrieveCallback
+ });
+ </script>
+Your callback function will be passed the response object with a hash of tokens keyed by hostname. You can iterate thru the list of tokens available to you at the time and then be able to present more relevant UI to the visitor to your site, such as sorting already logged in social sharing sites first.
+### How does XAuth work? ###
+XAuth relies on three features available only in modern browsers (HTML5) and is 100% front end technology (meaning it could one day just be a feature of the browser ;)
+* [`localStorage`]( - persistent storage mechanism to store the tokens completely client-side
+* [`postMessage`]( - ability to send information between domains and securely determine what domain information is coming from
+* [`JSON`]( - safer methods than eval for serializing and deserializing JSON strings into JavaScript objects when passed via postMessage
+#### When you include the xauth.js script ####
+An `XAuth` object is created in the global scope having three methods: `extend`, `retrieve`, `expire` and one member flag `disabled` to tell you if this browser has the capabilities to support XAuth. The code sets up a listener for postMessage events on the window.
+#### When you call an XAuth method (extend, expire or retrieve) ####
+Your passed in parameters are cleaned and turned into a consumable request object of the form:
+ {
+ cmd: 'xauth::methodname', // based on what you called
+ id: unique_numeric_id, // generated by xauth.js
+ ... other key value parameters specific to this method ...
+ callback: yourCallbackFunctionReference
+ }
+These request objects are cached, serialized into JSON strings and then sent via postMessage to a hidden iframe ( that is created on demand, after the first XAuth method call is made. Any XAuth method calls made prior to the iframe being ready are automatically placed in a queue.
+#### The iframe and security ####
+The iframe code is the enforcer of the rules defined in the XAuth spec, including deciding who has access to tokens in a retrieve request, writing tokens to localStorage in an extend request and deleting expired tokens.
+After setting up a postMessage event listener, any incoming message event is deserialized into a consumable request object (see above) or is otherwise ignored. It is the browser's responsibility to properly implement the window.postMessage security model and include an immutable and unspoofable event.origin property on every incoming postMessage event, telling the iframe exactly where an event originated from. The iframe processes the request on behalf of the retriever identified by event.origin and sends a postMessage back to the calling retriever window with the results.
+### Site performance impacts ###
+We've tried to keep the code brief (unlike this documentation). The xauth.js file that you include on a page is about **1kb**. If you make a call to an XAuth method, an iframe to is created which results in an additional **2kb** of bandwidth. Both of these files are heavily cached and gzip compressed from CDNs. There are no other http requests after both files are loaded. All of the logic behind XAuth lives inside the browser. In the future, it would be great to see this kind of functionality built straight into the browser, thereby decoupling the central domain dependency.
+### More Resources ###
+Discuss XAuth at
+Learn even more at
+Check out code at
@@ -0,0 +1,22 @@
+if [ ! -d "release" ]; then
+ mkdir "release"
+YUI="gij -jar tools/yuicompressor-2.4.2.jar --type js"
+# Compress server and client code
+echo '<!doctype html><script type="text/javascript">' > release/server.html
+$YUI src/server.js >> release/server.html
+echo '</script>' >> release/server.html
+$YUI src/xauth.js > release/xauth.js
+# Copy rest of static files
+cp -R src/info release
+cp -R src/spec release
+cp src/index.html release
+find ./release -name '.svn' -exec rm -r -f {} \;
+find ./release -name '.git' -exec rm -r -f {} \;
Oops, something went wrong.

0 comments on commit 6670a26

Please sign in to comment.