[Webapp Refactor] Group authentications fields into remoting.CredentialsProvider.

remoting/webapp/crd/js/session_connector_impl.js

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * @fileoverview
  * Connect set-up state machine for Me2Me and IT2Me
  */
 
 'use strict';
@@ skipping 99 matching lines @@
   // Initialize/declare per-connection state.
   this.reset();
 };
 
 /**
  * Reset the per-connection state so that the object can be re-used for a
  * second connection. Note the none of the shared WCS state is reset.
  */
 remoting.SessionConnectorImpl.prototype.reset = function() {
   /**
-   * For paired connections, the client id of this device, issued by the host.
-   *
-   * @type {string}
-   * @private
-   */
-  this.clientPairingId_ = '';
-
-  /**
-   * For paired connections, the paired secret for this device, issued by the
-   * host.
-   *
-   * @type {string}
-   * @private
-   */
-  this.clientPairedSecret_ = '';
-
-  /**
-   * String used to authenticate to the host on connection. For IT2Me, this is
-   * the access code; for Me2Me it is the PIN.
-   *
-   * @type {string}
-   * @private
-   */
-  this.passPhrase_ = '';
-
-  /**
    * @type {remoting.Host}
    * @private
    */
   this.host_ = null;
 
   /**
    * @type {boolean}
    * @private
    */
   this.logHostOfflineErrors_ = false;
 
   /**
    * @type {remoting.ClientSession}
    * @private
    */
   this.clientSession_ = null;
 
   /**
    * @type {XMLHttpRequest}
    * @private
    */
   this.pendingXhr_ = null;
 
   /**
-   * Function to interactively obtain the PIN from the user.
-   * @type {function(boolean, function(string):void):void}
+   * @type {remoting.CredentialsProvider}
    * @private
    */
-  this.fetchPin_ = function(onPinFetched) {};
-
-  /**
-   * @type {function(string, string, string,
-   *                 function(string, string):void): void}
-   * @private
-   */
-  this.fetchThirdPartyToken_ = function(
-      tokenUrl, hostPublicKey, scope, onThirdPartyTokenFetched) {};
+  this.credentials_ = null;
 };
 
 /**
  * Initiate a Me2Me connection.
  *
  * This doesn't report host-offline errors because the connection will
  * be retried and retryConnectMe2Me is responsible for reporting these errors.
  *
  * @param {remoting.Host} host The Me2Me host to which to connect.
  * @param {function(boolean, function(string):void):void} fetchPin Function to
  *     interactively obtain the PIN from the user.
- * @param {function(string, string, string,
- *                  function(string, string): void): void}
- *     fetchThirdPartyToken Function to obtain a token from a third party
- *     authentication server.
  * @param {string} clientPairingId The client id issued by the host when
  *     this device was paired, if it is already paired.
  * @param {string} clientPairedSecret The shared secret issued by the host when
  *     this device was paired, if it is already paired.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.connectMe2Me =
     function(host, fetchPin, fetchThirdPartyToken,
              clientPairingId, clientPairedSecret) {
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.ME2ME;
   this.logHostOfflineErrors_ = false;
-  this.connectMe2MeInternal_(host, fetchPin, fetchThirdPartyToken,
-                             clientPairingId, clientPairedSecret);
+  var credentials = new remoting.CredentialsProvider({
+    fetchPin: fetchPin,
+    pairingInfo: { id: clientPairingId, secret: clientPairedSecret },
+    fetchThirdPartyToken: fetchThirdPartyToken
+  });
+  this.connectInternal_(host, credentials);
 };
 
 /**
  * Retry connecting to a Me2Me host after a connection failure.
  *
  * This is the same as connectMe2Me except that is will log errors if the
  * host is offline.
  *
  * @param {remoting.Host} host The Me2Me host to refresh.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.retryConnectMe2Me = function(host) {
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.ME2ME;
   this.logHostOfflineErrors_ = true;
-  this.connectMe2MeInternal_(host, this.fetchPin_, this.fetchThirdPartyToken_,
-                             this.clientPairingId_, this.clientPairedSecret_);
+  this.connectInternal_(host, this.credentials_);
 };
 
 /**
  * Initiate a Me2App connection.
  *
  * @param {remoting.Host} host The Me2Me host to which to connect.
  * @param {function(string, string, string,
  *                  function(string, string): void): void}
  *     fetchThirdPartyToken Function to obtain a token from a third party
  *     authenticaiton server.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.connectMe2App =
     function(host, fetchThirdPartyToken) {
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.APP_REMOTING;
   this.logHostOfflineErrors_ = true;
-  this.connectMe2MeInternal_(host, function() {}, fetchThirdPartyToken, '', '');
+  var credentials = new remoting.CredentialsProvider({
+    fetchThirdPartyToken : fetchThirdPartyToken
+  });
+  this.connectInternal_(host, credentials);
 };
 
 /**
  * Update the pairing info so that the reconnect function will work correctly.
  *
  * @param {string} clientId The paired client id.
  * @param {string} sharedSecret The shared secret.
  */
 remoting.SessionConnectorImpl.prototype.updatePairingInfo =
     function(clientId, sharedSecret) {
-  this.clientPairingId_ = clientId;
-  this.clientPairedSecret_ = sharedSecret;
+  var pairingInfo = this.credentials_.getPairingInfo();
+  pairingInfo.id = clientId;
+  pairingInfo.secret = sharedSecret;
 };
 
 /**
  * Initiate a Me2Me connection.
  *
  * @param {remoting.Host} host the Host to connect to.
- * @param {function(boolean, function(string):void):void} fetchPin Function to
- *     interactively obtain the PIN from the user.
- * @param {function(string, string, string,
- *                  function(string, string): void): void}
- *     fetchThirdPartyToken Function to obtain a token from a third party
- *     authentication server.
- * @param {string} clientPairingId The client id issued by the host when
- *     this device was paired, if it is already paired.
- * @param {string} clientPairedSecret The shared secret issued by the host when
- *     this device was paired, if it is already paired.
+ * @param {remoting.CredentialsProvider} credentials Credentials.
  * @return {void} Nothing.
  * @private
  */
-remoting.SessionConnectorImpl.prototype.connectMe2MeInternal_ =
-    function(host, fetchPin, fetchThirdPartyToken,
-             clientPairingId, clientPairedSecret) {
+remoting.SessionConnectorImpl.prototype.connectInternal_ =
+    function(host, credentials) {
   // Cancel any existing connect operation.
   this.cancel();
-

[Jamie, 2015/02/26 23:20:14]

Leave this blank line. It was intended to suggest that the comment above refers
only to the call to cancel(). Also below.

[kelvinp, 2015/02/27 01:03:21]

Done.

   this.host_ = host;
-  this.fetchPin_ = fetchPin;
-  this.fetchThirdPartyToken_ = fetchThirdPartyToken;
-  this.updatePairingInfo(clientPairingId, clientPairedSecret);
-
+  this.credentials_ = credentials;
   this.connectSignaling_();
 };
 
 /**
  * Initiate an IT2Me connection.
  *
  * @param {string} accessCode The access code as entered by the user.
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.connectIT2Me = function(accessCode) {
   var kSupportIdLen = 7;
   var kHostSecretLen = 5;
   var kAccessCodeLen = kSupportIdLen + kHostSecretLen;
 
   // Cancel any existing connect operation.
   this.cancel();
 
   var normalizedAccessCode = this.normalizeAccessCode_(accessCode);
   if (normalizedAccessCode.length != kAccessCodeLen) {
     this.onError_(remoting.Error.INVALID_ACCESS_CODE);
     return;
   }
-
   var hostId = normalizedAccessCode.substring(0, kSupportIdLen);
-  this.passPhrase_ = normalizedAccessCode;
+  this.credentials_ = new remoting.CredentialsProvider({
+    accessCode: normalizedAccessCode
+  });
   this.connectionMode_ = remoting.DesktopConnectedView.Mode.IT2ME;
   remoting.identity.getToken().then(
       this.connectIT2MeWithToken_.bind(this, hostId),
       remoting.Error.handler(this.onError_));
 };
 
 /**
  * Reconnect a closed connection.
  *
  * @return {void} Nothing.
  */
 remoting.SessionConnectorImpl.prototype.reconnect = function() {
   if (this.connectionMode_ == remoting.DesktopConnectedView.Mode.IT2ME) {
     console.error('reconnect not supported for IT2Me.');
     return;
   }
   this.logHostOfflineErrors_ = false;
-  this.connectMe2MeInternal_(this.host_, this.fetchPin_,
-                             this.fetchThirdPartyToken_, this.clientPairingId_,
-                             this.clientPairedSecret_);
+  this.connectInternal_(this.host_, this.credentials_);
 };
 
 /**
  * Cancel a connection-in-progress.
  */
 remoting.SessionConnectorImpl.prototype.cancel = function() {
   if (this.clientSession_) {
     this.clientSession_.removePlugin();
     this.clientSession_ = null;
   }
@@ skipping 89 matching lines @@
  * @return {void} Nothing.
  * @private
  */
 remoting.SessionConnectorImpl.prototype.connectIT2MeWithToken_ =
     function(hostId, token) {
   // Resolve the host id to get the host JID.
   this.pendingXhr_ = remoting.xhr.start({
     method: 'GET',
     url: remoting.settings.DIRECTORY_API_BASE_URL + '/support-hosts/' +
         encodeURIComponent(hostId),
-    onDone: this.onIT2MeHostInfo_.bind(this),
+    onDone: this.onIT2MeHostInfo_.bind(this, hostId),
     oauthToken: token
   });
 };
 
 /**
  * Continue an IT2Me connection once the host JID has been looked up.
  *
  * @param {string} hostId
  * @param {XMLHttpRequest} xhr The server response to the support-hosts query.
  * @return {void} Nothing.
@@ skipping 26 matching lines @@
  */
 remoting.SessionConnectorImpl.prototype.createSession_ = function() {
   // In some circumstances, the WCS <iframe> can get reloaded, which results
   // in a new clientJid and a new callback. In this case, remove the old
   // client plugin before instantiating a new one.
   if (this.clientSession_) {
     this.clientSession_.removePlugin();
     this.clientSession_ = null;
   }
 
-  var authenticationMethods =
-     'third_party,spake2_pair,spake2_hmac,spake2_plain';
   this.clientSession_ = new remoting.ClientSession(
-      this.host_, this.signalStrategy_, this.clientContainer_, this.passPhrase_,
-      this.fetchPin_, this.fetchThirdPartyToken_, authenticationMethods,
-      this.connectionMode_, this.clientPairingId_, this.clientPairedSecret_,
-      this.defaultRemapKeys_);
+      this.host_, this.signalStrategy_, this.credentials_,
+      this.clientContainer_, this.connectionMode_, this.defaultRemapKeys_);
   this.clientSession_.logHostOfflineErrors(this.logHostOfflineErrors_);
   this.clientSession_.addEventListener(
       remoting.ClientSession.Events.stateChanged,
       this.bound_.onStateChange);
   this.clientSession_.createPluginAndConnect(this.onExtensionMessage_,
                                              this.requiredCapabilities_);
 };
 
 /**
  * Handle a change in the state of the client session prior to successful
@@ skipping 120 matching lines @@
  */
 remoting.DefaultSessionConnectorFactory.prototype.createConnector =
     function(clientContainer, onConnected, onError, onExtensionMessage,
              onConnectionFailed, requiredCapabilities, defaultRemapKeys) {
   return new remoting.SessionConnectorImpl(clientContainer, onConnected,
                                            onError, onExtensionMessage,
                                            onConnectionFailed,
                                            requiredCapabilities,
                                            defaultRemapKeys);
 };