summaryrefslogtreecommitdiffstats
path: root/remoting/webapp/base/js/xmpp_login_handler.js
blob: 60199e729d9ae544910bb08b56184d1264c9567a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
// Copyright 2014 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.

'use strict';

/** @suppress {duplicate} */
var remoting = remoting || {};

/**
 * XmppLoginHandler handles authentication handshake for XmppConnection. It
 * receives incoming data using onDataReceived(), calls |sendMessageCallback|
 * to send outgoing messages and calls |onHandshakeDoneCallback| after
 * authentication is finished successfully or |onErrorCallback| on error.
 *
 * See RFC3920 for description of XMPP and authentication handshake.
 *
 * @param {string} server Domain name of the server we are connecting to.
 * @param {string} username Username.
 * @param {string} authToken OAuth2 token.
 * @param {boolean} needHandshakeBeforeTls Set to true when <starttls> handshake
 *     is required before starting TLS. Otherwise TLS can be started right away.
 * @param {function(string):void} sendMessageCallback Callback to call to send
 *     a message.
 * @param {function():void} startTlsCallback Callback to call to start TLS on
 *     the underlying socket.
 * @param {function(string, remoting.XmppStreamParser):void}
 *     onHandshakeDoneCallback Callback to call after authentication is
 *     completed successfully
 * @param {function(!remoting.Error, string):void} onErrorCallback Callback to
 *     call on error. Can be called at any point during lifetime of connection.
 * @constructor
 */
remoting.XmppLoginHandler = function(server,
                                     username,
                                     authToken,
                                     needHandshakeBeforeTls,
                                     sendMessageCallback,
                                     startTlsCallback,
                                     onHandshakeDoneCallback,
                                     onErrorCallback) {
  /** @private */
  this.server_ = server;
  /** @private */
  this.username_ = username;
  /** @private */
  this.authToken_ = authToken;
  /** @private */
  this.needHandshakeBeforeTls_ = needHandshakeBeforeTls;
  /** @private */
  this.sendMessageCallback_ = sendMessageCallback;
  /** @private */
  this.startTlsCallback_ = startTlsCallback;
  /** @private */
  this.onHandshakeDoneCallback_ = onHandshakeDoneCallback;
  /** @private */
  this.onErrorCallback_ = onErrorCallback;

  /** @private */
  this.state_ = remoting.XmppLoginHandler.State.INIT;
  /** @private */
  this.jid_ = '';

  /** @private {remoting.XmppStreamParser} */
  this.streamParser_ = null;
}

/** @return {function(string, remoting.XmppStreamParser):void} */
remoting.XmppLoginHandler.prototype.getHandshakeDoneCallbackForTesting =
    function() {
  return this.onHandshakeDoneCallback_;
};

/**
 * States the handshake goes through. States are iterated from INIT to DONE
 * sequentially, except for ERROR state which may be accepted at any point.
 *
 * Following messages are sent/received in each state:
 *    INIT
 *      client -> server: Stream header
 *      client -> server: <starttls>
 *    WAIT_STREAM_HEADER
 *      client <- server: Stream header with list of supported features which
 *          should include starttls.
 *    WAIT_STARTTLS_RESPONSE
 *      client <- server: <proceed>
 *    STARTING_TLS
 *      TLS handshake
 *      client -> server: Stream header
 *      client -> server: <auth> message with the OAuth2 token.
 *    WAIT_STREAM_HEADER_AFTER_TLS
 *      client <- server: Stream header with list of supported authentication
 *          methods which is expected to include X-OAUTH2
 *    WAIT_AUTH_RESULT
 *      client <- server: <success> or <failure>
 *      client -> server: Stream header
 *      client -> server: <bind>
 *      client -> server: <iq><session/></iq> to start the session
 *    WAIT_STREAM_HEADER_AFTER_AUTH
 *      client <- server: Stream header with list of features that should
 *         include <bind>.
 *    WAIT_BIND_RESULT
 *      client <- server: <bind> result with JID.
 *    WAIT_SESSION_IQ_RESULT
 *      client <- server: result for <iq><session/></iq>
 *    DONE
 *
 * @enum {number}
 */
remoting.XmppLoginHandler.State = {
  INIT: 0,
  WAIT_STREAM_HEADER: 1,
  WAIT_STARTTLS_RESPONSE: 2,
  STARTING_TLS: 3,
  WAIT_STREAM_HEADER_AFTER_TLS: 4,
  WAIT_AUTH_RESULT: 5,
  WAIT_STREAM_HEADER_AFTER_AUTH: 6,
  WAIT_BIND_RESULT: 7,
  WAIT_SESSION_IQ_RESULT: 8,
  DONE: 9,
  ERROR: 10
};

remoting.XmppLoginHandler.prototype.start = function() {
  if (this.needHandshakeBeforeTls_) {
    this.state_ = remoting.XmppLoginHandler.State.WAIT_STREAM_HEADER;
    this.startStream_('<starttls xmlns="urn:ietf:params:xml:ns:xmpp-tls"/>');
  } else {
    // If <starttls> handshake is not required then start TLS right away.
    this.state_ = remoting.XmppLoginHandler.State.STARTING_TLS;
    this.startTlsCallback_();
  }
}

/** @param {ArrayBuffer} data */
remoting.XmppLoginHandler.prototype.onDataReceived = function(data) {
  base.debug.assert(this.state_ != remoting.XmppLoginHandler.State.INIT &&
                    this.state_ != remoting.XmppLoginHandler.State.DONE &&
                    this.state_ != remoting.XmppLoginHandler.State.ERROR);

  this.streamParser_.appendData(data);
}

/**
 * @param {Element} stanza
 * @private
 */
remoting.XmppLoginHandler.prototype.onStanza_ = function(stanza) {
  switch (this.state_) {
    case remoting.XmppLoginHandler.State.WAIT_STREAM_HEADER:
      if (stanza.querySelector('features>starttls')) {
        this.state_ = remoting.XmppLoginHandler.State.WAIT_STARTTLS_RESPONSE;
      } else {
        this.onError_(
            remoting.Error.unexpected(),
            "Server doesn't support TLS.");
      }
      break;

    case remoting.XmppLoginHandler.State.WAIT_STARTTLS_RESPONSE:
      if (stanza.localName == "proceed") {
        this.state_ = remoting.XmppLoginHandler.State.STARTING_TLS;
        this.startTlsCallback_();
      } else {
        this.onError_(remoting.Error.unexpected(),
                      "Failed to start TLS: " +
                          (new XMLSerializer().serializeToString(stanza)));
      }
      break;

    case remoting.XmppLoginHandler.State.WAIT_STREAM_HEADER_AFTER_TLS:
      var mechanisms = Array.prototype.map.call(
          stanza.querySelectorAll('features>mechanisms>mechanism'),
          /** @param {Element} m */
          function(m) { return m.textContent; });
      if (mechanisms.indexOf("X-OAUTH2")) {
        this.onError_(remoting.Error.unexpected(),
                      "OAuth2 is not supported by the server.");
        return;
      }

      this.state_ = remoting.XmppLoginHandler.State.WAIT_AUTH_RESULT;

      break;

    case remoting.XmppLoginHandler.State.WAIT_AUTH_RESULT:
      if (stanza.localName == 'success') {
        this.state_ =
            remoting.XmppLoginHandler.State.WAIT_STREAM_HEADER_AFTER_AUTH;
        this.startStream_(
            '<iq type="set" id="0">' +
              '<bind xmlns="urn:ietf:params:xml:ns:xmpp-bind">' +
                '<resource>chromoting</resource>'+
              '</bind>' +
            '</iq>' +
            '<iq type="set" id="1">' +
              '<session xmlns="urn:ietf:params:xml:ns:xmpp-session"/>' +
            '</iq>');
      } else {
        this.onError_(
            new remoting.Error(remoting.Error.Tag.AUTHENTICATION_FAILED),
            'Failed to authenticate: ' +
              (new XMLSerializer().serializeToString(stanza)));
      }
      break;

    case remoting.XmppLoginHandler.State.WAIT_STREAM_HEADER_AFTER_AUTH:
      if (stanza.querySelector('features>bind')) {
        this.state_ = remoting.XmppLoginHandler.State.WAIT_BIND_RESULT;
      } else {
        this.onError_(remoting.Error.unexpected(),
                      "Server doesn't support bind after authentication.");
      }
      break;

    case remoting.XmppLoginHandler.State.WAIT_BIND_RESULT:
      var jidElement = stanza.querySelector('iq>bind>jid');
      if (stanza.getAttribute('id') != '0' ||
          stanza.getAttribute('type') != 'result' || !jidElement) {
        this.onError_(remoting.Error.unexpected(),
                      'Received unexpected response to bind: ' +
                          (new XMLSerializer().serializeToString(stanza)));
        return;
      }
      this.jid_ = jidElement.textContent;
      this.state_ = remoting.XmppLoginHandler.State.WAIT_SESSION_IQ_RESULT;
      break;

    case remoting.XmppLoginHandler.State.WAIT_SESSION_IQ_RESULT:
      if (stanza.getAttribute('id') != '1' ||
          stanza.getAttribute('type') != 'result') {
        this.onError_(remoting.Error.unexpected(),
                      'Failed to start session: ' +
                          (new XMLSerializer().serializeToString(stanza)));
        return;
      }
      this.state_ = remoting.XmppLoginHandler.State.DONE;
      this.onHandshakeDoneCallback_(this.jid_, this.streamParser_);
      break;

    default:
      base.debug.assert(false);
      break;
  }
}

remoting.XmppLoginHandler.prototype.onTlsStarted = function() {
  base.debug.assert(this.state_ ==
                    remoting.XmppLoginHandler.State.STARTING_TLS);
  this.state_ = remoting.XmppLoginHandler.State.WAIT_STREAM_HEADER_AFTER_TLS;
  var cookie = window.btoa("\0" + this.username_ + "\0" + this.authToken_);

  this.startStream_(
      '<auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" ' +
             'mechanism="X-OAUTH2" auth:service="oauth2" ' +
             'auth:allow-generated-jid="true" ' +
             'auth:client-uses-full-bind-result="true" ' +
             'auth:allow-non-google-login="true" ' +
             'xmlns:auth="http://www.google.com/talk/protocol/auth">' +
        cookie +
      '</auth>');
};

/**
 * @param {string} text
 * @private
 */
remoting.XmppLoginHandler.prototype.onParserError_ = function(text) {
  this.onError_(remoting.Error.unexpected(), text);
}

/**
 * @param {string} firstMessage Message to send after stream header.
 * @private
 */
remoting.XmppLoginHandler.prototype.startStream_ = function(firstMessage) {
  this.sendMessageCallback_('<stream:stream to="' + this.server_ +
                            '" version="1.0" xmlns="jabber:client" ' +
                            'xmlns:stream="http://etherx.jabber.org/streams">' +
                            firstMessage);
  this.streamParser_ = new remoting.XmppStreamParser();
  this.streamParser_.setCallbacks(this.onStanza_.bind(this),
                                  this.onParserError_.bind(this));
}

/**
 * @param {!remoting.Error} error
 * @param {string} text
 * @private
 */
remoting.XmppLoginHandler.prototype.onError_ = function(error, text) {
  if (this.state_ != remoting.XmppLoginHandler.State.ERROR) {
    this.onErrorCallback_(error, text);
    this.state_ = remoting.XmppLoginHandler.State.ERROR;
  } else {
    console.error(text);
  }
}