v0.7.4

Otherwise linting will fail if you try to run it

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015"]
+}

.eslintrc.js

@@ -0,0 +1,59 @@
+module.exports = {
+    parserOptions: {
+        ecmaVersion: 6,
+        sourceType: "module",
+        ecmaFeatures: {
+        }
+    },
+    env: {
+        browser: true,
+        node: true,
+    },
+    extends: ["eslint:recommended", "google"],
+    rules: {
+        // rules we've always adhered to
+        "max-len": ["error", {
+            code: 90,
+            ignoreComments: true,
+        }],
+        curly: ["error", "multi-line"],
+
+        // loosen jsdoc requirements a little
+        "require-jsdoc": ["error", {
+            require: {
+                FunctionDeclaration: false,
+            }
+        }],
+        "valid-jsdoc": ["error", {
+            requireParamDescription: false,
+            requireReturn: false,
+            requireReturnDescription: false,
+        }],
+
+        // rules we do not want from eslint-recommended
+        "no-console": ["off"],
+        "no-constant-condition": ["off"],
+        "no-empty": ["error", { "allowEmptyCatch": true }],
+
+        // rules we do not want from the google styleguide
+        "object-curly-spacing": ["off"],
+        "spaced-comment": ["off"],
+
+        // in principle we prefer single quotes, but life is too short
+        quotes: ["off"],
+
+        // rules we'd ideally like to adhere to, but the current
+        // code does not (in most cases because it's still ES5)
+        // we set these to warnings, and assert that the number
+        // of warnings doesn't exceed a given threshold
+        "no-var": ["warn"],
+        "comma-dangle": ["warn"],
+        "brace-style": ["warn"],
+        "prefer-rest-params": ["warn"],
+        "prefer-spread": ["warn"],
+        "one-var": ["warn"],
+        "padded-blocks": ["warn"],
+        "no-extend-native": ["warn"],
+        "camelcase": ["warn"],
+    }
+}

.gitignore

@@ -7,6 +7,7 @@ lib-cov
 out
 reports
 /dist
+/lib
 
 # version file and tarball created by 'npm pack'
 /git-revision.txt

.jshint

@@ -1,11 +0,0 @@
-{
-    "node": true,
-    "jasmine": true,
-
-    "nonew": true,
-    "curly": true,
-    "forin": true,
-    "freeze": false,
-    "undef": true,
-    "unused": "vars"
-}

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+    - node # Latest stable version of nodejs.

CHANGELOG.md

@@ -1,3 +1,113 @@
+Changes in [0.7.4](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.4) (2017-01-16)
+================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.4-rc.1...v0.7.4)
+
+ * Fix non-conference calling
+
+Changes in [0.7.4-rc.1](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.4-rc.1) (2017-01-13)
+==========================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.3...v0.7.4-rc.1)
+
+ * Remove babel-polyfill
+   [\#321](https://github.com/matrix-org/matrix-js-sdk/pull/321)
+ * Update build process for ES6
+   [\#320](https://github.com/matrix-org/matrix-js-sdk/pull/320)
+ * 'babel' is not a babel package anymore
+   [\#319](https://github.com/matrix-org/matrix-js-sdk/pull/319)
+ * Add Babel for ES6 support
+   [\#318](https://github.com/matrix-org/matrix-js-sdk/pull/318)
+ * Move screen sharing check/error
+   [\#317](https://github.com/matrix-org/matrix-js-sdk/pull/317)
+ * release.sh: Bail early if there are uncommitted changes
+   [\#316](https://github.com/matrix-org/matrix-js-sdk/pull/316)
+
+Changes in [0.7.3](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.3) (2017-01-04)
+================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.2...v0.7.3)
+
+ * User presence list feature
+   [\#310](https://github.com/matrix-org/matrix-js-sdk/pull/310)
+ * Allow clients the ability to set a default local timeout
+   [\#313](https://github.com/matrix-org/matrix-js-sdk/pull/313)
+ * Add API to delete threepid
+   [\#312](https://github.com/matrix-org/matrix-js-sdk/pull/312)
+
+Changes in [0.7.2](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.2) (2016-12-15)
+================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.1...v0.7.2)
+
+ * Bump to Olm 2.0
+   [\#309](https://github.com/matrix-org/matrix-js-sdk/pull/309)
+ * Sanity check payload length before encrypting
+   [\#307](https://github.com/matrix-org/matrix-js-sdk/pull/307)
+ * Remove dead _sendPingToDevice function
+   [\#308](https://github.com/matrix-org/matrix-js-sdk/pull/308)
+ * Add setRoomDirectoryVisibilityAppService
+   [\#306](https://github.com/matrix-org/matrix-js-sdk/pull/306)
+ * Update release script to do signed releases
+   [\#305](https://github.com/matrix-org/matrix-js-sdk/pull/305)
+ * e2e: Wait for pending device lists
+   [\#304](https://github.com/matrix-org/matrix-js-sdk/pull/304)
+ * Start a new megolm session when devices are blacklisted
+   [\#303](https://github.com/matrix-org/matrix-js-sdk/pull/303)
+ * E2E: Download our own devicelist on startup
+   [\#302](https://github.com/matrix-org/matrix-js-sdk/pull/302)
+
+Changes in [0.7.1](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.1) (2016-12-09)
+================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.1-rc.1...v0.7.1)
+
+No changes
+
+
+Changes in [0.7.1-rc.1](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.1-rc.1) (2016-12-05)
+==========================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.0...v0.7.1-rc.1)
+
+ * Avoid NPE when no sessionStore is given
+   [\#300](https://github.com/matrix-org/matrix-js-sdk/pull/300)
+ * Improve decryption error messages
+   [\#299](https://github.com/matrix-org/matrix-js-sdk/pull/299)
+ * Revert "Use native Array.isArray when available."
+   [\#283](https://github.com/matrix-org/matrix-js-sdk/pull/283)
+ * Use native Array.isArray when available.
+   [\#282](https://github.com/matrix-org/matrix-js-sdk/pull/282)
+
+Changes in [0.7.0](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.0) (2016-11-18)
+================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.6.4...v0.7.0)
+
+ * Avoid a packetstorm of device queries on startup
+   [\#297](https://github.com/matrix-org/matrix-js-sdk/pull/297)
+ * E2E: Check devices to share keys with on each send
+   [\#295](https://github.com/matrix-org/matrix-js-sdk/pull/295)
+ * Apply unknown-keyshare mitigations
+   [\#296](https://github.com/matrix-org/matrix-js-sdk/pull/296)
+ * distinguish unknown users from deviceless users
+   [\#294](https://github.com/matrix-org/matrix-js-sdk/pull/294)
+ * Allow starting client with initialSyncLimit = 0
+   [\#293](https://github.com/matrix-org/matrix-js-sdk/pull/293)
+ * Make timeline-window _unpaginate public and rename to unpaginate
+   [\#289](https://github.com/matrix-org/matrix-js-sdk/pull/289)
+ * Send a STOPPED sync updated after call to stopClient
+   [\#286](https://github.com/matrix-org/matrix-js-sdk/pull/286)
+ * Fix bug in verifying megolm event senders
+   [\#292](https://github.com/matrix-org/matrix-js-sdk/pull/292)
+ * Handle decryption of events after they arrive
+   [\#288](https://github.com/matrix-org/matrix-js-sdk/pull/288)
+ * Fix examples.
+   [\#287](https://github.com/matrix-org/matrix-js-sdk/pull/287)
+ * Add a travis.yml
+   [\#278](https://github.com/matrix-org/matrix-js-sdk/pull/278)
+ * Encrypt all events, including 'm.call.*'
+   [\#277](https://github.com/matrix-org/matrix-js-sdk/pull/277)
+ * Ignore reshares of known megolm sessions
+   [\#276](https://github.com/matrix-org/matrix-js-sdk/pull/276)
+ * Log to the console on unknown session
+   [\#274](https://github.com/matrix-org/matrix-js-sdk/pull/274)
+ * Make it easier for SDK users to wrap prevailing the 'request' function
+   [\#273](https://github.com/matrix-org/matrix-js-sdk/pull/273)
+
 Changes in [0.6.4](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.6.4) (2016-11-04)
 ================================================================================================
 [Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.6.4-rc.2...v0.6.4)

RELEASING.md

@@ -1,14 +0,0 @@
-There is a script `release.sh` which does the following, but if you need to do
-a release manually, here are the steps:
-
-- `git checkout -b release-v0.x.x`
-- Update `CHANGELOG.md`
-- `npm version 0.x.x`
-- Merge `release-v0.x.x` onto `master`.
-- Push `master`.
-- Push the tag: `git push --tags`
-- `npm publish`
-- Generate documentation: `npm run gendoc` (this outputs HTML to `.jsdoc`)
-- Copy the documentation from `.jsdoc` to the `gh-pages` branch and update `index.html`
-- Merge `master` onto `develop`.
-- Push `develop`.

examples/browser/lib/matrix.js

@@ -1 +1 @@
-../../../dist/browser-matrix-dev.js
+../../../dist/browser-matrix.js

examples/node/app.js

@@ -135,11 +135,15 @@ rl.on('line', function(line) {
 // ==== END User input
 
 // show the room list after syncing.
-matrixClient.on("syncComplete", function() {
-    setRoomList();
-    printRoomList();
-    printHelp();
-    rl.prompt();
+matrixClient.on("sync", function(state, prevState, data) {
+    switch (state) {
+        case "PREPARED":
+          setRoomList();
+          printRoomList();
+          printHelp();
+          rl.prompt();
+        break;
+   }
 });
 
 matrixClient.on("Room", function() {

examples/voip/browserTest.js

@@ -44,7 +44,15 @@ window.onload = function() {
     disableButtons(true, true, true);
 };
 
-client.on("syncComplete", function () {
+matrixClient.on("sync", function(state, prevState, data) {
+    switch (state) {
+        case "PREPARED":
+          syncComplete();
+        break;
+   }
+});
+
+function syncComplete() {
     document.getElementById("result").innerHTML = "<p>Ready for calls.</p>";
     disableButtons(false, true, true);
 
@@ -85,5 +93,5 @@ client.on("syncComplete", function () {
         call = c;
         addListeners(call);
     });
-});
+}
 client.startClient();

examples/voip/lib/matrix.js

@@ -1 +1 @@
-../../../dist/browser-matrix-dev.js
+../../../dist/browser-matrix.js

jenkins.sh

@@ -2,7 +2,7 @@
 
 export NVM_DIR="/home/jenkins/.nvm"
 [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
-nvm use 0.10
+nvm use 4
 npm install
 
 RC=0
@@ -14,13 +14,8 @@ function fail {
 
 npm test || fail "npm test finished with return code $?"
 
-jshint --reporter=checkstyle -c .jshint lib spec > jshint.xml ||
-    fail "jshint finished with return code $?"
-
-gjslint --unix_mode --disable 0131,0211,0200,0222,0212 \
-        --max_line_length 90 \
-        -r lib/ -r spec/ > gjslint.log ||
-    fail "gjslint finished with return code $?"
+npm run -s lint -- -f checkstyle > eslint.xml ||
+    fail "eslint finished with return code $?"
 
 # delete the old tarball, if it exists
 rm -f matrix-js-sdk-*.tgz

lib/crypto/algorithms/megolm.js

@@ -1,527 +0,0 @@
-/*
-Copyright 2015, 2016 OpenMarket Ltd
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-"use strict";
-
-/**
- * Defines m.olm encryption/decryption
- *
- * @module crypto/algorithms/megolm
- */
-
-var q = require("q");
-
-var utils = require("../../utils");
-var olmlib = require("../olmlib");
-var base = require("./base");
-
-/**
- * @private
- * @constructor
- *
- * @param {string} sessionId
- *
- * @property {string} sessionId
- * @property {Number} useCount     number of times this session has been used
- * @property {Number} creationTime when the session was created (ms since the epoch)
- * @property {module:client.Promise?} sharePromise  If a share operation is in progress,
- *    a promise which resolves when it is complete.
- */
-function OutboundSessionInfo(sessionId) {
-    this.sessionId = sessionId;
-    this.useCount = 0;
-    this.creationTime = new Date().getTime();
-    this.sharePromise = null;
-}
-
-
-/**
- * Check if it's time to rotate the session
- *
- * @param {Number} rotationPeriodMsgs
- * @param {Number} rotationPeriodMs
- * @return {Boolean}
- */
-OutboundSessionInfo.prototype.needsRotation = function(
-    rotationPeriodMsgs, rotationPeriodMs
-) {
-    var sessionLifetime = new Date().getTime() - this.creationTime;
-
-    if (this.useCount >= rotationPeriodMsgs ||
-        sessionLifetime >= rotationPeriodMs
-       ) {
-        console.log(
-            "Rotating megolm session after " + this.useCount +
-                " messages, " + sessionLifetime + "ms"
-        );
-        return true;
-    }
-
-    return false;
-};
-
-
-/**
- * Megolm encryption implementation
- *
- * @constructor
- * @extends {module:crypto/algorithms/base.EncryptionAlgorithm}
- *
- * @param {object} params parameters, as per
- *     {@link module:crypto/algorithms/base.EncryptionAlgorithm}
- */
-function MegolmEncryption(params) {
-    base.EncryptionAlgorithm.call(this, params);
-
-    // OutboundSessionInfo. Null if we haven't yet started setting one up. Note
-    // that even if this is non-null, it may not be ready for use (in which
-    // case _outboundSession.sharePromise will be non-null.)
-    this._outboundSession = null;
-
-    // devices which have joined since we last sent a message.
-    // userId -> {deviceId -> true}, or
-    // userId -> true
-    this._devicesPendingKeyShare = {};
-
-    // default rotation periods
-    this._sessionRotationPeriodMsgs = 100;
-    this._sessionRotationPeriodMs = 7 * 24 * 3600 * 1000;
-
-    if (params.config.rotation_period_ms !== undefined) {
-        this._sessionRotationPeriodMs = params.config.rotation_period_ms;
-    }
-
-    if (params.config.rotation_period_msgs !== undefined) {
-        this._sessionRotationPeriodMsgs = params.config.rotation_period_msgs;
-    }
-}
-utils.inherits(MegolmEncryption, base.EncryptionAlgorithm);
-
-/**
- * @private
- *
- * @param {module:models/room} room
- *
- * @return {module:client.Promise} Promise which resolves to the
- *    OutboundSessionInfo when setup is complete.
- */
-MegolmEncryption.prototype._ensureOutboundSession = function(room) {
-    var self = this;
-
-    var session = this._outboundSession;
-
-    // need to make a brand new session?
-    if (!session || session.needsRotation(self._sessionRotationPeriodMsgs,
-                                          self._sessionRotationPeriodMs)
-       ) {
-        this._outboundSession = session = this._prepareNewSession(room);
-    }
-
-    if (session.sharePromise) {
-        // key share already in progress
-        return session.sharePromise;
-    }
-
-    // no share in progress: check for new devices
-    var shareMap = this._devicesPendingKeyShare;
-    this._devicesPendingKeyShare = {};
-
-    // check each user is (still) a member of the room
-    for (var userId in shareMap) {
-        if (!shareMap.hasOwnProperty(userId)) {
-            continue;
-        }
-
-        // XXX what about rooms where invitees can see the content?
-        var member = room.getMember(userId);
-        if (member.membership !== "join") {
-            delete shareMap[userId];
-        }
-    }
-
-    session.sharePromise = this._shareKeyWithDevices(
-        session.sessionId, shareMap
-    ).finally(function() {
-        session.sharePromise = null;
-    }).then(function() {
-        return session;
-    });
-
-    return session.sharePromise;
-};
-
-/**
- * @private
- *
- * @param {module:models/room} room
- *
- * @return {module:crypto/algorithms/megolm.OutboundSessionInfo} session
- */
-MegolmEncryption.prototype._prepareNewSession = function(room) {
-    var session_id = this._olmDevice.createOutboundGroupSession();
-    var key = this._olmDevice.getOutboundGroupSessionKey(session_id);
-
-    this._olmDevice.addInboundGroupSession(
-        this._roomId, this._olmDevice.deviceCurve25519Key, session_id,
-        key.key, {ed25519: this._olmDevice.deviceEd25519Key}
-    );
-
-    // we're going to share the key with all current members of the room,
-    // so we can reset this.
-    this._devicesPendingKeyShare = {};
-
-    var session = new OutboundSessionInfo(session_id);
-
-    var roomMembers = utils.map(room.getJoinedMembers(), function(u) {
-        return u.userId;
-    });
-
-    var shareMap = {};
-    for (var i = 0; i < roomMembers.length; i++) {
-        var userId = roomMembers[i];
-        shareMap[userId] = true;
-    }
-
-    var self = this;
-
-    // TODO: we need to give the user a chance to block any devices or users
-    // before we send them the keys; it's too late to download them here.
-    session.sharePromise = this._crypto.downloadKeys(
-        roomMembers, false
-    ).then(function(res) {
-        return self._shareKeyWithDevices(session_id, shareMap);
-    }).then(function() {
-        return session;
-    }).finally(function() {
-        session.sharePromise = null;
-    });
-
-    return session;
-};
-
-/**
- * @private
- *
- * @param {string} session_id
- *
- * @param {Object<string, Object<string, boolean>|boolean>} shareMap
- *    Map from userid to either: true (meaning this is a new user in the room,
- *    so all of his devices need the keys); or a map from deviceid to true
- *    (meaning this user has one or more new devices, which need the keys).
- *
- * @return {module:client.Promise} Promise which resolves once the key sharing
- *     message has been sent.
- */
-MegolmEncryption.prototype._shareKeyWithDevices = function(session_id, shareMap) {
-    var self = this;
-
-    var key = this._olmDevice.getOutboundGroupSessionKey(session_id);
-    var payload = {
-        type: "m.room_key",
-        content: {
-            algorithm: olmlib.MEGOLM_ALGORITHM,
-            room_id: this._roomId,
-            session_id: session_id,
-            session_key: key.key,
-            chain_index: key.chain_index,
-        }
-    };
-
-    // we downloaded the user's device list when they joined the room, or when
-    // the new device announced itself, so there is no need to do so now.
-
-    return self._crypto.ensureOlmSessionsForUsers(
-        utils.keys(shareMap)
-    ).then(function(devicemap) {
-        var contentMap = {};
-        var haveTargets = false;
-
-        for (var userId in devicemap) {
-            if (!devicemap.hasOwnProperty(userId)) {
-                continue;
-            }
-
-            var devicesToShareWith = shareMap[userId];
-            var sessionResults = devicemap[userId];
-
-            for (var deviceId in sessionResults) {
-                if (!sessionResults.hasOwnProperty(deviceId)) {
-                    continue;
-                }
-
-                if (devicesToShareWith === true) {
-                    // all devices
-                } else if (!devicesToShareWith[deviceId]) {
-                    // not a new device
-                    continue;
-                }
-
-                var sessionResult = sessionResults[deviceId];
-                if (!sessionResult.sessionId) {
-                    // no session with this device, probably because there
-                    // were no one-time keys.
-                    //
-                    // we could send them a to_device message anyway, as a
-                    // signal that they have missed out on the key sharing
-                    // message because of the lack of keys, but there's not
-                    // much point in that really; it will mostly serve to clog
-                    // up to_device inboxes.
-                    //
-                    // ensureOlmSessionsForUsers has already done the logging,
-                    // so just skip it.
-                    continue;
-                }
-
-                console.log(
-                    "sharing keys with device " + userId + ":" + deviceId
-                );
-
-                var deviceInfo = sessionResult.device;
-
-                var encryptedContent = {
-                    algorithm: olmlib.OLM_ALGORITHM,
-                    sender_key: self._olmDevice.deviceCurve25519Key,
-                    ciphertext: {},
-                };
-
-                olmlib.encryptMessageForDevice(
-                    encryptedContent.ciphertext,
-                    self._userId,
-                    self._deviceId,
-                    self._olmDevice,
-                    userId,
-                    deviceInfo,
-                    payload
-                );
-
-                if (!contentMap[userId]) {
-                    contentMap[userId] = {};
-                }
-
-                contentMap[userId][deviceId] = encryptedContent;
-                haveTargets = true;
-            }
-        }
-
-        if (!haveTargets) {
-            return q();
-        }
-
-        // TODO: retries
-        return self._baseApis.sendToDevice("m.room.encrypted", contentMap);
-    });
-};
-
-/**
- * @inheritdoc
- *
- * @param {module:models/room} room
- * @param {string} eventType
- * @param {object} plaintext event content
- *
- * @return {module:client.Promise} Promise which resolves to the new event body
- */
-MegolmEncryption.prototype.encryptMessage = function(room, eventType, content) {
-    var self = this;
-    return this._ensureOutboundSession(room).then(function(session) {
-        var payloadJson = {
-            room_id: self._roomId,
-            type: eventType,
-            content: content
-        };
-
-        var ciphertext = self._olmDevice.encryptGroupMessage(
-            session.sessionId, JSON.stringify(payloadJson)
-        );
-
-        var encryptedContent = {
-            algorithm: olmlib.MEGOLM_ALGORITHM,
-            sender_key: self._olmDevice.deviceCurve25519Key,
-            ciphertext: ciphertext,
-            session_id: session.sessionId,
-             // Include our device ID so that recipients can send us a
-             // m.new_device message if they don't have our session key.
-            device_id: self._deviceId,
-        };
-
-        session.useCount++;
-        return encryptedContent;
-    });
-};
-
-/**
- * @inheritdoc
- *
- * @param {module:models/event.MatrixEvent} event  event causing the change
- * @param {module:models/room-member} member  user whose membership changed
- * @param {string=} oldMembership  previous membership
- */
-MegolmEncryption.prototype.onRoomMembership = function(event, member, oldMembership) {
-    // if we haven't yet made a session, there's nothing to do here.
-    if (!this._outboundSession) {
-        return;
-    }
-
-    var newMembership = member.membership;
-
-    if (newMembership === 'join') {
-        this._onNewRoomMember(member.userId);
-        return;
-    }
-
-    if (newMembership === 'invite' && oldMembership !== 'join') {
-        // we don't (yet) share keys with invited members, so nothing to do yet
-        return;
-    }
-
-    // otherwise we assume the user is leaving, and start a new outbound session.
-    console.log("Discarding outbound megolm session due to change in " +
-                "membership of " + member.userId + " (" + oldMembership +
-                "->" + newMembership + ")");
-
-    // this ensures that we will start a new session on the next message.
-    this._outboundSession = null;
-};
-
-/**
- * handle a new user joining a room
- *
- * @param {string} userId   new member
- */
-MegolmEncryption.prototype._onNewRoomMember = function(userId) {
-    // make sure we have a list of this user's devices. We are happy to use a
-    // cached version here: we assume that if we already have a list of the
-    // user's devices, then we already share an e2e room with them, which means
-    // that they will have announced any new devices via an m.new_device.
-    this._crypto.downloadKeys([userId], false).done();
-
-    // also flag this user up for needing a keyshare.
-    this._devicesPendingKeyShare[userId] = true;
-};
-
-
-/**
- * @inheritdoc
- *
- * @param {string} userId    owner of the device
- * @param {string} deviceId  deviceId of the device
- */
-MegolmEncryption.prototype.onNewDevice = function(userId, deviceId) {
-    var d = this._devicesPendingKeyShare[userId];
-
-    if (d === true) {
-        // we already want to share keys with all devices for this user
-        return;
-    }
-
-    if (!d) {
-        this._devicesPendingKeyShare[userId] = d = {};
-    }
-
-    d[deviceId] = true;
-};
-
-
-/**
- * Megolm decryption implementation
- *
- * @constructor
- * @extends {module:crypto/algorithms/base.DecryptionAlgorithm}
- *
- * @param {object} params parameters, as per
- *     {@link module:crypto/algorithms/base.DecryptionAlgorithm}
- */
-function MegolmDecryption(params) {
-    base.DecryptionAlgorithm.call(this, params);
-}
-utils.inherits(MegolmDecryption, base.DecryptionAlgorithm);
-
-/**
- * @inheritdoc
- *
- * @param {object} event raw event
- *
- * @return {null} The event referred to an unknown megolm session
- * @return {module:crypto.DecryptionResult} decryption result
- *
- * @throws {module:crypto/algorithms/base.DecryptionError} if there is a
- *   problem decrypting the event
- */
-MegolmDecryption.prototype.decryptEvent = function(event) {
-    var content = event.content;
-
-    if (!content.sender_key || !content.session_id ||
-        !content.ciphertext
-       ) {
-        throw new base.DecryptionError("Missing fields in input");
-    }
-
-    var res;
-    try {
-        res = this._olmDevice.decryptGroupMessage(
-            event.room_id, content.sender_key, content.session_id, content.ciphertext
-        );
-    } catch (e) {
-        throw new base.DecryptionError(e);
-    }
-
-    if (res === null) {
-        return null;
-    }
-
-    var payload = JSON.parse(res.result);
-
-    // belt-and-braces check that the room id matches that indicated by the HS
-    // (this is somewhat redundant, since the megolm session is scoped to the
-    // room, so neither the sender nor a MITM can lie about the room_id).
-    if (payload.room_id !== event.room_id) {
-        throw new base.DecryptionError(
-            "Message intended for room " + payload.room_id
-        );
-    }
-
-    return {
-        payload: payload,
-        keysClaimed: res.keysClaimed,
-        keysProved: res.keysProved,
-    };
-};
-
-/**
- * @inheritdoc
- *
- * @param {module:models/event.MatrixEvent} event key event
- */
-MegolmDecryption.prototype.onRoomKeyEvent = function(event) {
-    console.log("Adding key from ", event);
-    var content = event.getContent();
-
-    if (!content.room_id ||
-        !content.session_id ||
-        !content.session_key
-       ) {
-        console.error("key event is missing fields");
-        return;
-    }
-
-    this._olmDevice.addInboundGroupSession(
-        content.room_id, event.getSenderKey(), content.session_id,
-        content.session_key, event.getKeysClaimed()
-    );
-};
-
-base.registerAlgorithm(
-    olmlib.MEGOLM_ALGORITHM, MegolmEncryption, MegolmDecryption
-);

lib/crypto/olmlib.js

@@ -1,102 +0,0 @@
-/*
-Copyright 2016 OpenMarket Ltd
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-/**
- * @module olmlib
- *
- * Utilities common to olm encryption algorithms
- */
-
-var utils = require("../utils");
-
-/**
- * matrix algorithm tag for olm
- */
-module.exports.OLM_ALGORITHM = "m.olm.v1.curve25519-aes-sha2";
-
-/**
- * matrix algorithm tag for megolm
- */
-module.exports.MEGOLM_ALGORITHM = "m.megolm.v1.aes-sha2";
-
-
-/**
- * Encrypt an event payload for an Olm device
- *
- * @param {Object<string, string>} resultsObject  The `ciphertext` property
- *   of the m.room.encrypted event to which to add our result
- *
- * @param {string} ourUserId
- * @param {string} ourDeviceId
- * @param {module:crypto/OlmDevice} olmDevice olm.js wrapper
- * @param {string} recipientUserId
- * @param {module:crypto/deviceinfo} recipientDevice
- * @param {object} payloadFields fields to include in the encrypted payload
- */
-module.exports.encryptMessageForDevice = function(
-    resultsObject,
-    ourUserId, ourDeviceId, olmDevice, recipientUserId, recipientDevice,
-    payloadFields
-) {
-    var deviceKey = recipientDevice.getIdentityKey();
-    var sessionId = olmDevice.getSessionIdForDevice(deviceKey);
-    if (sessionId === null) {
-        // If we don't have a session for a device then
-        // we can't encrypt a message for it.
-        return;
-    }
-
-    console.log(
-        "Using sessionid " + sessionId + " for device " +
-            recipientUserId + ":" + recipientDevice.deviceId
-    );
-
-    var payload = {
-        sender: ourUserId,
-        sender_device: ourDeviceId,
-
-        // Include the Ed25519 key so that the recipient knows what
-        // device this message came from.
-        // We don't need to include the curve25519 key since the
-        // recipient will already know this from the olm headers.
-        // When combined with the device keys retrieved from the
-        // homeserver signed by the ed25519 key this proves that
-        // the curve25519 key and the ed25519 key are owned by
-        // the same device.
-        keys: {
-            "ed25519": olmDevice.deviceEd25519Key,
-        },
-
-        // include the recipient device details in the payload,
-        // to avoid unknown key attacks, per
-        // https://github.com/vector-im/vector-web/issues/2483
-        recipient: recipientUserId,
-        recipient_keys: {
-            "ed25519": recipientDevice.getFingerprint(),
-        },
-    };
-
-    // TODO: technically, a bunch of that stuff only needs to be included for
-    // pre-key messages: after that, both sides know exactly which devices are
-    // involved in the session. If we're looking to reduce data transfer in the
-    // future, we could elide them for subsequent messages.
-
-    utils.extend(payload, payloadFields);
-
-    resultsObject[deviceKey] = olmDevice.encryptMessage(
-        deviceKey, sessionId, JSON.stringify(payload)
-    );
-};

package.json

@@ -1,17 +1,18 @@
 {
   "name": "matrix-js-sdk",
-  "version": "0.6.4",
+  "version": "0.7.4",
   "description": "Matrix Client-Server SDK for Javascript",
   "main": "index.js",
   "scripts": {
     "test": "istanbul cover --report cobertura --config .istanbul.yml -i \"lib/**/*.js\" jasmine-node -- spec --verbose --junitreport --captureExceptions",
     "check": "jasmine-node spec --verbose --junitreport --captureExceptions",
     "gendoc": "jsdoc -r lib -P package.json -R README.md -d .jsdoc",
-    "build": "jshint -c .jshint lib/ && rimraf dist && mkdir dist && browserify --exclude olm browser-index.js -o dist/browser-matrix.js --ignore-missing && uglifyjs -c -m -o dist/browser-matrix.min.js dist/browser-matrix.js",
+    "start": "babel -s -w -d lib src",
+    "build": "babel -s -d lib src && rimraf dist && mkdir dist && browserify --exclude olm browser-index.js -o dist/browser-matrix.js --ignore-missing && uglifyjs -c -m -o dist/browser-matrix.min.js dist/browser-matrix.js",
     "dist": "npm run build",
     "watch": "watchify --exclude olm browser-index.js -o dist/browser-matrix-dev.js -v",
-    "lint": "jshint -c .jshint lib spec && gjslint --unix_mode --disable 0131,0211,0200,0222,0212 --max_line_length 90 -r spec/ -r lib/",
-    "prepublish": "git rev-parse HEAD > git-revision.txt"
+    "lint": "eslint --max-warnings 3480 src spec",
+    "prepublish": "npm run lint && npm run build && git rev-parse HEAD > git-revision.txt"
   },
   "repository": {
     "url": "https://github.com/matrix-org/matrix-js-sdk"
@@ -23,6 +24,8 @@
   "author": "matrix.org",
   "license": "Apache-2.0",
   "files": [
+    ".eslintrc.js",
+    "spec/.eslintrc.js",
     "CHANGELOG.md",
     "CONTRIBUTING.rst",
     "LICENSE",
@@ -37,7 +40,8 @@
     "lib",
     "package.json",
     "release.sh",
-    "spec"
+    "spec",
+    "src"
   ],
   "dependencies": {
     "another-json": "^0.2.0",
@@ -47,15 +51,18 @@
     "request": "^2.53.0"
   },
   "devDependencies": {
+    "babel-cli": "^6.18.0",
+    "babel-preset-es2015": "^6.18.0",
+    "eslint": "^3.13.1",
+    "eslint-config-google": "^0.7.1",
     "istanbul": "^0.3.13",
     "jasmine-node": "^1.14.5",
     "jsdoc": "^3.4.0",
-    "jshint": "^2.8.0",
     "rimraf": "^2.5.4",
     "uglifyjs": "^2.4.10",
     "watchify": "^3.2.1"
   },
   "optionalDependencies": {
-    "olm": "https://matrix.org/packages/npm/olm/olm-1.3.0.tgz"
+    "olm": "https://matrix.org/packages/npm/olm/olm-2.1.0.tgz"
   }
 }

release.sh

@@ -1,17 +1,17 @@
 #!/bin/bash
 #
-# Script to perform a release of matrix-js-sdk. Performs the steps documented
-# in RELEASING.md
+# Script to perform a release of matrix-js-sdk.
 #
 # Requires:
-#   github-changelog-generator; to install, do
+#   github-changelog-generator; install via:
 #     pip install git+https://github.com/matrix-org/github-changelog-generator.git
-#   jq; install from your distibution's package manager (https://stedolan.github.io/jq/)
+#   jq; install from your distribution's package manager (https://stedolan.github.io/jq/)
+#   hub; install via brew (OSX) or source/pre-compiled binaries (debian) (https://github.com/github/hub) - Tested on v2.2.9
 
 set -e
 
-jq --version > /dev/null || (echo "jq is required: please install it"; exit)
-hub --version > /dev/null || (echo "hub is required: please install it"; exit)
+jq --version > /dev/null || (echo "jq is required: please install it"; kill $$)
+hub --version > /dev/null || (echo "hub is required: please install it"; kill $$)
 
 USAGE="$0 [-xz] [-c changelog_file] vX.Y.Z"
 
@@ -32,6 +32,16 @@ if [ "$ret" -eq 0 ]; then
     exit
 fi
 
+if ! git diff-index --quiet --cached HEAD; then
+    echo "this git checkout has staged (uncommitted) changes. Refusing to release."
+    exit
+fi
+
+if ! git diff-files --quiet; then
+    echo "this git checkout has uncommitted changes. Refusing to release."
+    exit
+fi
+
 skip_changelog=
 skip_jsdoc=
 changelog_file="CHANGELOG.md"
@@ -111,19 +121,29 @@ if [ -z "$skip_changelog" ]; then
         git commit "$changelog_file" -m "Prepare changelog for $tag"
     fi
 fi
+latest_changes=`mktemp`
+cat "${changelog_file}" | `dirname $0`/scripts/changelog_head.py > "${latest_changes}"
 
 set -x
 
-# Bump package.json, build the dist, and tag
+# Bump package.json and build the dist
 echo "npm version"
 # npm version will automatically commit its modification
 # and make a release tag. We don't want it to create the tag
-# because github will do that, but we can only turn off both
-# of these behaviours, so we have to manually commit the
-# result.
+# because it can only sign with the default key, but we can
+# only turn off both of these behaviours, so we have to
+# manually commit the result.
 npm version --no-git-tag-version "$release"
 git commit package.json -m "$tag"
 
+
+# figure out if we should be signing this release
+signing_id=
+if [ -f release_config.yaml ]; then
+    signing_id=`cat release_config.yaml | python -c "import yaml; import sys; print yaml.load(sys.stdin)['signing_id']"`
+fi
+
+
 # If there is a 'dist' script in the package.json,
 # run it in a separate checkout of the project, then
 # upload any files in the 'dist' directory as release
@@ -140,14 +160,21 @@ if [ $dodist -eq 0 ]; then
     echo "Building distribution copy in $builddir"
     pushd "$builddir"
     git clone "$projdir" .
-    git co "$rel_branch"
+    git checkout "$rel_branch"
     npm install
     # We haven't tagged yet, so tell the dist script what version
     # it's building
     DIST_VERSION="$tag" npm run dist
+
     popd
+
     for i in "$builddir"/dist/*; do
         assets="$assets -a $i"
+        if [ -n "$signing_id" ]
+        then
+            gpg -u "$signing_id" --armor --output "$i".asc --detach-sig "$i"
+            assets="$assets -a $i.asc"
+        fi
     done
 fi
 
@@ -155,15 +182,33 @@ fi
 # a branch it doesn't have)
 git push origin "$rel_branch"
 
+if [ -n "$signing_id" ]; then
+    # make a signed tag
+    # gnupg seems to fail to get the right tty device unless we set it here
+    GIT_COMMITTER_EMAIL="$signing_id" GPG_TTY=`tty` git tag -u "$signing_id" -F "${latest_changes}" "$tag"
+else
+    git tag -a -F "${latest_changes}" "$tag"
+fi
+
+# push the tag
+git push origin "$tag"
+
 hubflags=''
 if [ $prerelease -eq 1 ]; then
     hubflags='-p'
 fi
-hub release create $hubflags $assets -m "$tag" "$tag"
+
+release_text=`mktemp`
+echo "$tag" > "${release_text}"
+echo >> "${release_text}"
+cat "${latest_changes}" >> "${release_text}"
+hub release create $hubflags $assets -f "${release_text}" "$tag"
 
 if [ $dodist -eq 0 ]; then
     rm -rf "$builddir"
 fi
+rm "${release_text}"
+rm "${latest_changes}"
 
 if [ -z "$skip_jsdoc" ]; then
     echo "generating jsdocs"

scripts/changelog_head.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+
+"""
+Outputs the body of the first entry of changelog file on stdin
+"""
+
+import re
+import sys
+
+found_first_header = False
+for line in sys.stdin:
+    line = line.strip()
+    if re.match(r"^Changes in \[.*\]", line):
+        if found_first_header:
+            break
+        found_first_header = True
+    elif not re.match(r"^=+$", line) and len(line) > 0:
+        print line

spec/.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+    env: {
+        jasmine: true,
+    },
+}

spec/integ/matrix-client-crypto.spec.js

@@ -5,21 +5,6 @@ var HttpBackend = require("../mock-request");
 var utils = require("../../lib/utils");
 var test_utils = require("../test-utils");
 
-function MockStorageApi() {
-    this.data = {};
-}
-MockStorageApi.prototype = {
-    setItem: function(k, v) {
-        this.data[k] = v;
-    },
-    getItem: function(k) {
-        return this.data[k] || null;
-    },
-    removeItem: function(k) {
-        delete this.data[k];
-    }
-};
-
 var aliHttpBackend;
 var bobHttpBackend;
 var aliClient;
@@ -36,7 +21,6 @@ var aliDeviceKeys;
 var bobDeviceKeys;
 var bobDeviceCurve25519Key;
 var bobDeviceEd25519Key;
-var aliLocalStore;
 var aliStorage;
 var bobStorage;
 var aliMessages;
@@ -399,6 +383,15 @@ function recvMessage(httpBackend, client, sender, message) {
 
 function aliStartClient() {
     expectAliKeyUpload().catch(test_utils.failTest);
+
+    // ali will try to query her own keys on start
+    aliHttpBackend.when("POST", "/keys/query").respond(200, function(path, content) {
+        expect(content.device_keys[aliUserId]).toEqual({});
+        var result = {};
+        result[aliUserId] = {};
+        return {device_keys: result};
+    });
+
     startClient(aliHttpBackend, aliClient);
     return aliHttpBackend.flush().then(function() {
         console.log("Ali client started");
@@ -407,6 +400,15 @@ function aliStartClient() {
 
 function bobStartClient() {
     expectBobKeyUpload().catch(test_utils.failTest);
+
+    // bob will try to query his own keys on start
+    bobHttpBackend.when("POST", "/keys/query").respond(200, function(path, content) {
+        expect(content.device_keys[bobUserId]).toEqual({});
+        var result = {};
+        result[bobUserId] = {};
+        return {device_keys: result};
+    });
+
     startClient(bobHttpBackend, bobClient);
     return bobHttpBackend.flush().then(function() {
         console.log("Bob client started");
@@ -461,11 +463,9 @@ describe("MatrixClient crypto", function() {
     }
 
     beforeEach(function() {
-        aliLocalStore = new MockStorageApi();
-        aliStorage = new sdk.WebStorageSessionStore(aliLocalStore);
-        bobStorage = new sdk.WebStorageSessionStore(new MockStorageApi());
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
+        aliStorage = new sdk.WebStorageSessionStore(new test_utils.MockStorageApi());
         aliHttpBackend = new HttpBackend();
         aliClient = sdk.createClient({
             baseUrl: "http://alis.server",
@@ -476,6 +476,7 @@ describe("MatrixClient crypto", function() {
             request: aliHttpBackend.requestFn,
         });
 
+        bobStorage = new sdk.WebStorageSessionStore(new test_utils.MockStorageApi());
         bobHttpBackend = new HttpBackend();
         bobClient = sdk.createClient({
             baseUrl: "http://bobs.server",
@@ -500,6 +501,27 @@ describe("MatrixClient crypto", function() {
         bobClient.stopClient();
     });
 
+    it('Ali knows the difference between a new user and one with no devices',
+        function(done) {
+            aliHttpBackend.when('POST', '/keys/query').respond(200, {
+                device_keys: {
+                    '@bob:id': {},
+                }
+            });
+
+            var p1 = aliClient.downloadKeys(['@bob:id']);
+            var p2 = aliHttpBackend.flush('/keys/query', 1);
+
+            q.all([p1, p2]).then(function() {
+                var devices = aliStorage.getEndToEndDevicesForUser('@bob:id');
+                expect(utils.keys(devices).length).toEqual(0);
+
+                // request again: should be no more requests
+                return aliClient.downloadKeys(['@bob:id']);
+            }).nodeify(done);
+        }
+    );
+
     it("Bob uploads without one-time keys and with one-time keys", function(done) {
         q()
             .then(bobUploadsKeys)
@@ -735,4 +757,31 @@ describe("MatrixClient crypto", function() {
             }).then(aliRecvMessage)
             .catch(test_utils.failTest).done(done);
     });
+
+
+    it("Ali does a key query when she gets a new_device event", function(done) {
+        q()
+            .then(bobUploadsKeys)
+            .then(aliStartClient)
+            .then(function() {
+                var syncData = {
+                    next_batch: '2',
+                    to_device: {
+                        events: [
+                            test_utils.mkEvent({
+                                content: {
+                                    device_id: 'TEST_DEVICE',
+                                    rooms: [],
+                                },
+                                sender: bobUserId,
+                                type: 'm.new_device',
+                            }),
+                        ],
+                    },
+                };
+                aliHttpBackend.when('GET', '/sync').respond(200, syncData);
+                return aliHttpBackend.flush('/sync', 1);
+            }).then(expectAliQueryKeys)
+            .nodeify(done);
+    });
 });

spec/integ/matrix-client-event-emitter.spec.js

@@ -10,7 +10,7 @@ describe("MatrixClient events", function() {
     var selfAccessToken = "aseukfgwef";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/matrix-client-event-timeline.spec.js

@@ -100,7 +100,7 @@ describe("getEventTimeline support", function() {
     var client;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
     });
@@ -221,7 +221,7 @@ describe("MatrixClient event timelines", function() {
     var client, httpBackend;
 
     beforeEach(function(done) {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
 
@@ -415,7 +415,7 @@ describe("MatrixClient event timelines", function() {
                     };
                 });
 
-            var tl0, tl2, tl3;
+            var tl0, tl3;
             client.getEventTimeline(timelineSet, EVENTS[0].event_id
             ).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);
@@ -423,7 +423,6 @@ describe("MatrixClient event timelines", function() {
                 return client.getEventTimeline(timelineSet, EVENTS[2].event_id);
             }).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);
-                tl2 = tl;
                 return client.getEventTimeline(timelineSet, EVENTS[3].event_id);
             }).then(function(tl) {
                 expect(tl.getEvents().length).toEqual(1);

spec/integ/matrix-client-methods.spec.js

@@ -15,7 +15,7 @@ describe("MatrixClient", function() {
     var accessToken = "aseukfgwef";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         store = new MatrixInMemoryStore();
 
@@ -363,7 +363,7 @@ describe("MatrixClient", function() {
 
                 assertObjectContains(res.chaz.dev2, {
                     verified: 0, // DeviceVerification.UNVERIFIED
-                    keys: { "ed25519:dev2" : ed25519key },
+                    keys: { "ed25519:dev2": ed25519key },
                     algorithms: ["2"],
                     unsigned: { "ghi": "def" },
                 });
@@ -371,21 +371,6 @@ describe("MatrixClient", function() {
 
             httpBackend.flush();
         });
-
-        it("should return a rejected promise if the request fails", function(done) {
-            httpBackend.when("POST", "/keys/query").respond(400);
-
-            var exceptionThrown;
-            client.downloadKeys(["bottom"]).then(function() {
-                fail("download didn't fail");
-            }, function(err) {
-                exceptionThrown = err;
-            }).then(function() {
-                expect(exceptionThrown).toBeTruthy();
-            }).catch(utils.failTest).done(done);
-
-            httpBackend.flush();
-        });
     });
 
     describe("deleteDevice", function() {

spec/integ/matrix-client-opts.spec.js

@@ -53,7 +53,7 @@ describe("MatrixClient opts", function() {
     };
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
     });
 

spec/integ/matrix-client-retrying.spec.js

@@ -14,7 +14,7 @@ describe("MatrixClient retrying", function() {
     var room;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         scheduler = new sdk.MatrixScheduler();

spec/integ/matrix-client-room-timeline.spec.js

@@ -101,7 +101,7 @@ describe("MatrixClient room timelines", function() {
     }
 
     beforeEach(function(done) {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/matrix-client-syncing.spec.js

@@ -18,7 +18,7 @@ describe("MatrixClient syncing", function() {
     var roomTwo = "!bar:localhost";
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         httpBackend = new HttpBackend();
         sdk.request(httpBackend.requestFn);
         client = sdk.createClient({

spec/integ/megolm.spec.js

@@ -0,0 +1,899 @@
+/*
+Copyright 2016 OpenMarket Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+"use strict";
+
+
+try {
+    var Olm = require('olm');
+} catch (e) {}
+
+var anotherjson = require('another-json');
+var q = require('q');
+
+var sdk = require('../..');
+var utils = require('../../lib/utils');
+var test_utils = require('../test-utils');
+var MockHttpBackend = require('../mock-request');
+
+var ROOM_ID = "!room:id";
+
+/**
+ * Wrapper for a MockStorageApi, MockHttpBackend and MatrixClient
+ *
+ * @constructor
+ * @param {string} userId
+ * @param {string} deviceId
+ * @param {string} accessToken
+ */
+function TestClient(userId, deviceId, accessToken) {
+    this.userId = userId;
+    this.deviceId = deviceId;
+
+    this.storage = new sdk.WebStorageSessionStore(new test_utils.MockStorageApi());
+    this.httpBackend = new MockHttpBackend();
+    this.client = sdk.createClient({
+        baseUrl: "http://test.server",
+        userId: userId,
+        accessToken: accessToken,
+        deviceId: deviceId,
+        sessionStore: this.storage,
+        request: this.httpBackend.requestFn,
+    });
+
+    this.deviceKeys = null;
+    this.oneTimeKeys = [];
+}
+
+/**
+ * start the client, and wait for it to initialise.
+ *
+ * @param {object?} existingDevices  the list of our existing devices to return from
+ *    the /query request. Defaults to empty device list
+ * @return {Promise}
+ */
+TestClient.prototype.start = function(existingDevices) {
+    var self = this;
+
+    this.httpBackend.when("GET", "/pushrules").respond(200, {});
+    this.httpBackend.when("POST", "/filter").respond(200, { filter_id: "fid" });
+
+    this.httpBackend.when('POST', '/keys/query').respond(200, function(path, content) {
+        expect(content.device_keys[self.userId]).toEqual({});
+        var res = existingDevices;
+        if (!res) {
+            res = { device_keys: {} };
+            res.device_keys[self.userId] = {};
+        }
+        return res;
+    });
+    this.httpBackend.when("POST", "/keys/upload").respond(200, function(path, content) {
+        expect(content.one_time_keys).not.toBeDefined();
+        expect(content.device_keys).toBeDefined();
+        self.deviceKeys = content.device_keys;
+        return {one_time_key_counts: {signed_curve25519: 0}};
+    });
+    this.httpBackend.when("POST", "/keys/upload").respond(200, function(path, content) {
+        expect(content.device_keys).not.toBeDefined();
+        expect(content.one_time_keys).toBeDefined();
+        expect(content.one_time_keys).not.toEqual({});
+        self.oneTimeKeys = content.one_time_keys;
+        return {one_time_key_counts: {
+            signed_curve25519: utils.keys(self.oneTimeKeys).length
+        }};
+    });
+
+    this.client.startClient();
+
+    return this.httpBackend.flush();
+};
+
+/**
+ * stop the client
+ */
+TestClient.prototype.stop = function() {
+    this.client.stopClient();
+};
+
+/**
+ * get the uploaded curve25519 device key
+ *
+ * @return {string} base64 device key
+ */
+TestClient.prototype.getDeviceKey = function() {
+    var key_id = 'curve25519:' + this.deviceId;
+    return this.deviceKeys.keys[key_id];
+};
+
+
+/**
+ * get the uploaded ed25519 device key
+ *
+ * @return {string} base64 device key
+ */
+TestClient.prototype.getSigningKey = function() {
+    var key_id = 'ed25519:' + this.deviceId;
+    return this.deviceKeys.keys[key_id];
+};
+
+/**
+ * start an Olm session with a given recipient
+ *
+ * @param {Olm.Account} olmAccount
+ * @param {TestClient} recipientTestClient
+ * @return {Olm.Session}
+ */
+function createOlmSession(olmAccount, recipientTestClient) {
+    var otk_id = utils.keys(recipientTestClient.oneTimeKeys)[0];
+    var otk = recipientTestClient.oneTimeKeys[otk_id];
+
+    var session = new Olm.Session();
+    session.create_outbound(
+        olmAccount, recipientTestClient.getDeviceKey(), otk.key
+    );
+    return session;
+}
+
+/**
+ * encrypt an event with olm
+ *
+ * @param {object} opts
+ * @param {string=} opts.sender
+ * @param {string} opts.senderKey
+ * @param {Olm.Session} opts.p2pSession
+ * @param {TestClient} opts.recipient
+ * @param {object=} opts.plaincontent
+ * @param {string=} opts.plaintype
+ *
+ * @return {object} event
+ */
+function encryptOlmEvent(opts) {
+    expect(opts.senderKey).toBeDefined();
+    expect(opts.p2pSession).toBeDefined();
+    expect(opts.recipient).toBeDefined();
+
+    var plaintext = {
+        content: opts.plaincontent || {},
+        recipient: opts.recipient.userId,
+        recipient_keys: {
+            ed25519: opts.recipient.getSigningKey(),
+        },
+        sender: opts.sender || '@bob:xyz',
+        type: opts.plaintype || 'm.test',
+    };
+
+    var event = {
+        content: {
+            algorithm: 'm.olm.v1.curve25519-aes-sha2',
+            ciphertext: {},
+            sender_key: opts.senderKey,
+        },
+        sender: opts.sender || '@bob:xyz',
+        type: 'm.room.encrypted',
+    };
+    event.content.ciphertext[opts.recipient.getDeviceKey()] =
+        opts.p2pSession.encrypt(JSON.stringify(plaintext));
+    return event;
+}
+
+/**
+ * encrypt an event with megolm
+ *
+ * @param {object} opts
+ * @param {string} opts.senderKey
+ * @param {Olm.OutboundGroupSession} opts.groupSession
+ * @param {object=} opts.plaintext
+ * @param {string=} opts.room_id
+ *
+ * @return {object} event
+ */
+function encryptMegolmEvent(opts) {
+    expect(opts.senderKey).toBeDefined();
+    expect(opts.groupSession).toBeDefined();
+
+    var plaintext = opts.plaintext || {};
+    if (!plaintext.content) {
+        plaintext.content = {
+            body: '42',
+            msgtype: "m.text",
+        };
+    }
+    if (!plaintext.type) {
+        plaintext.type = "m.room.message";
+    }
+    if (!plaintext.room_id) {
+        expect(opts.room_id).toBeDefined();
+        plaintext.room_id = opts.room_id;
+    }
+
+    return {
+        content: {
+            algorithm: "m.megolm.v1.aes-sha2",
+            ciphertext: opts.groupSession.encrypt(JSON.stringify(plaintext)),
+            device_id: "testDevice",
+            sender_key: opts.senderKey,
+            session_id: opts.groupSession.session_id(),
+        },
+        type: "m.room.encrypted",
+    };
+}
+
+/**
+ * build an encrypted room_key event to share a group session
+ *
+ * @param {object} opts
+ * @param {string} opts.senderKey
+ * @param {TestClient} opts.recipient
+ * @param {Olm.Session} opts.p2pSession
+ * @param {Olm.OutboundGroupSession} opts.groupSession
+ * @param {string=} opts.room_id
+ *
+ * @return {object} event
+ */
+function encryptGroupSessionKey(opts) {
+    return encryptOlmEvent({
+        senderKey: opts.senderKey,
+        recipient: opts.recipient,
+        p2pSession: opts.p2pSession,
+        plaincontent: {
+            algorithm: 'm.megolm.v1.aes-sha2',
+            room_id: opts.room_id,
+            session_id: opts.groupSession.session_id(),
+            session_key: opts.groupSession.session_key(),
+        },
+        plaintype: 'm.room_key',
+    });
+}
+
+/**
+ * get a /sync response which contains a single room (ROOM_ID),
+ * with the members given
+ *
+ * @param {string[]} roomMembers
+ *
+ * @return {object} event
+ */
+function getSyncResponse(roomMembers) {
+    var roomResponse = {
+        state: {
+            events: [
+                test_utils.mkEvent({
+                    type: 'm.room.encryption',
+                    skey: '',
+                    content: {
+                        algorithm: 'm.megolm.v1.aes-sha2',
+                    },
+                }),
+            ],
+        }
+    };
+
+    for (var i = 0; i < roomMembers.length; i++) {
+        roomResponse.state.events.push(
+            test_utils.mkMembership({
+                mship: 'join',
+                sender: roomMembers[i],
+            })
+        );
+    }
+
+    var syncResponse = {
+        next_batch: 1,
+        rooms: {
+            join: {},
+        },
+    };
+    syncResponse.rooms.join[ROOM_ID] = roomResponse;
+    return syncResponse;
+}
+
+
+describe("megolm", function() {
+    if (!sdk.CRYPTO_ENABLED) {
+        return;
+    }
+
+    var testOlmAccount;
+    var testSenderKey;
+    var aliceTestClient;
+
+    /**
+     * Get the device keys for testOlmAccount in a format suitable for a
+     * response to /keys/query
+     *
+     * @param {string} userId The user ID to query for
+     * @returns {Object} The fake query response
+     */
+    function getTestKeysQueryResponse(userId) {
+        var testE2eKeys = JSON.parse(testOlmAccount.identity_keys());
+        var testDeviceKeys = {
+            algorithms: ['m.olm.v1.curve25519-aes-sha2', 'm.megolm.v1.aes-sha2'],
+            device_id: 'DEVICE_ID',
+            keys: {
+                'curve25519:DEVICE_ID': testE2eKeys.curve25519,
+                'ed25519:DEVICE_ID': testE2eKeys.ed25519,
+            },
+            user_id: userId,
+        };
+        var j = anotherjson.stringify(testDeviceKeys);
+        var sig = testOlmAccount.sign(j);
+        testDeviceKeys.signatures = {};
+        testDeviceKeys.signatures[userId] = {
+            'ed25519:DEVICE_ID': sig,
+        };
+
+        var queryResponse = {
+            device_keys: {},
+        };
+
+        queryResponse.device_keys[userId] = {
+            'DEVICE_ID': testDeviceKeys,
+        };
+
+        return queryResponse;
+    }
+
+    /**
+     * Get a one-time key for testOlmAccount in a format suitable for a
+     * response to /keys/claim
+
+     * @param {string} userId The user ID to query for
+     * @returns {Object} The fake key claim response
+     */
+    function getTestKeysClaimResponse(userId) {
+        testOlmAccount.generate_one_time_keys(1);
+        var testOneTimeKeys = JSON.parse(testOlmAccount.one_time_keys());
+        testOlmAccount.mark_keys_as_published();
+
+        var keyId = utils.keys(testOneTimeKeys.curve25519)[0];
+        var oneTimeKey = testOneTimeKeys.curve25519[keyId];
+        var keyResult = {
+            'key': oneTimeKey,
+        };
+        var j = anotherjson.stringify(keyResult);
+        var sig = testOlmAccount.sign(j);
+        keyResult.signatures = {};
+        keyResult.signatures[userId] = {
+            'ed25519:DEVICE_ID': sig,
+        };
+
+        var claimResponse = {one_time_keys: {}};
+        claimResponse.one_time_keys[userId] = {
+            'DEVICE_ID': {},
+        };
+        claimResponse.one_time_keys[userId].DEVICE_ID['signed_curve25519:' + keyId] =
+            keyResult;
+        return claimResponse;
+    }
+
+    beforeEach(function() {
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
+
+        aliceTestClient = new TestClient(
+            "@alice:localhost", "xzcvb", "akjgkrgjs"
+        );
+
+        testOlmAccount = new Olm.Account();
+        testOlmAccount.create();
+        var testE2eKeys = JSON.parse(testOlmAccount.identity_keys());
+        testSenderKey = testE2eKeys.curve25519;
+    });
+
+    afterEach(function() {
+        aliceTestClient.stop();
+    });
+
+    it("Alice receives a megolm message", function(done) {
+        return aliceTestClient.start().then(function() {
+            var p2pSession = createOlmSession(testOlmAccount, aliceTestClient);
+
+            var groupSession = new Olm.OutboundGroupSession();
+            groupSession.create();
+
+            // make the room_key event
+            var roomKeyEncrypted = encryptGroupSessionKey({
+                senderKey: testSenderKey,
+                recipient: aliceTestClient,
+                p2pSession: p2pSession,
+                groupSession: groupSession,
+                room_id: ROOM_ID,
+            });
+
+            // encrypt a message with the group session
+            var messageEncrypted = encryptMegolmEvent({
+                senderKey: testSenderKey,
+                groupSession: groupSession,
+                room_id: ROOM_ID,
+            });
+
+            // Alice gets both the events in a single sync
+            var syncResponse = {
+                next_batch: 1,
+                to_device: {
+                    events: [roomKeyEncrypted],
+                },
+                rooms: {
+                    join: {},
+                },
+            };
+            syncResponse.rooms.join[ROOM_ID] = {
+                timeline: {
+                    events: [messageEncrypted],
+                },
+            };
+
+            aliceTestClient.httpBackend.when("GET", "/sync").respond(200, syncResponse);
+            return aliceTestClient.httpBackend.flush("/sync", 1);
+        }).then(function() {
+            var room = aliceTestClient.client.getRoom(ROOM_ID);
+            var event = room.getLiveTimeline().getEvents()[0];
+            expect(event.getContent().body).toEqual('42');
+        }).nodeify(done);
+    });
+
+    it("Alice gets a second room_key message", function(done) {
+        return aliceTestClient.start().then(function() {
+            var p2pSession = createOlmSession(testOlmAccount, aliceTestClient);
+
+            var groupSession = new Olm.OutboundGroupSession();
+            groupSession.create();
+
+            // make the room_key event
+            var roomKeyEncrypted1 = encryptGroupSessionKey({
+                senderKey: testSenderKey,
+                recipient: aliceTestClient,
+                p2pSession: p2pSession,
+                groupSession: groupSession,
+                room_id: ROOM_ID,
+            });
+
+            // encrypt a message with the group session
+            var messageEncrypted = encryptMegolmEvent({
+                senderKey: testSenderKey,
+                groupSession: groupSession,
+                room_id: ROOM_ID,
+            });
+
+            // make a second room_key event now that we have advanced the group
+            // session.
+            var roomKeyEncrypted2 = encryptGroupSessionKey({
+                senderKey: testSenderKey,
+                recipient: aliceTestClient,
+                p2pSession: p2pSession,
+                groupSession: groupSession,
+                room_id: ROOM_ID,
+            });
+
+            // on the first sync, send the best room key
+            aliceTestClient.httpBackend.when("GET", "/sync").respond(200, {
+                next_batch: 1,
+                to_device: {
+                    events: [roomKeyEncrypted1],
+                },
+            });
+
+            // on the second sync, send the advanced room key, along with the
+            // message.  This simulates the situation where Alice has been sent a
+            // later copy of the room key and is reloading the client.
+            var syncResponse2 = {
+                next_batch: 2,
+                to_device: {
+                    events: [roomKeyEncrypted2],
+                },
+                rooms: {
+                    join: {},
+                },
+            };
+            syncResponse2.rooms.join[ROOM_ID] = {
+                timeline: {
+                    events: [messageEncrypted],
+                },
+            };
+            aliceTestClient.httpBackend.when("GET", "/sync").respond(200, syncResponse2);
+
+            return aliceTestClient.httpBackend.flush("/sync", 2);
+        }).then(function() {
+            var room = aliceTestClient.client.getRoom(ROOM_ID);
+            var event = room.getLiveTimeline().getEvents()[0];
+            expect(event.getContent().body).toEqual('42');
+        }).nodeify(done);
+    });
+
+    it('Alice sends a megolm message', function(done) {
+        var p2pSession;
+
+        return aliceTestClient.start().then(function() {
+            var syncResponse = getSyncResponse(['@bob:xyz']);
+
+            // establish an olm session with alice
+            p2pSession = createOlmSession(testOlmAccount, aliceTestClient);
+
+            var olmEvent = encryptOlmEvent({
+                senderKey: testSenderKey,
+                recipient: aliceTestClient,
+                p2pSession: p2pSession,
+            });
+
+            syncResponse.to_device = { events: [olmEvent] };
+
+            aliceTestClient.httpBackend.when('GET', '/sync').respond(200, syncResponse);
+            return aliceTestClient.httpBackend.flush('/sync', 1);
+        }).then(function() {
+            var inboundGroupSession;
+            aliceTestClient.httpBackend.when('POST', '/keys/query').respond(
+                200, getTestKeysQueryResponse('@bob:xyz')
+            );
+
+            aliceTestClient.httpBackend.when(
+                'PUT', '/sendToDevice/m.room.encrypted/'
+            ).respond(200, function(path, content) {
+                var m = content.messages['@bob:xyz'].DEVICE_ID;
+                var ct = m.ciphertext[testSenderKey];
+                var decrypted = JSON.parse(p2pSession.decrypt(ct.type, ct.body));
+
+                expect(decrypted.type).toEqual('m.room_key');
+                inboundGroupSession = new Olm.InboundGroupSession();
+                inboundGroupSession.create(decrypted.content.session_key);
+                return {};
+            });
+
+            aliceTestClient.httpBackend.when(
+                'PUT', '/send/'
+            ).respond(200, function(path, content) {
+                var ct = content.ciphertext;
+                var r = inboundGroupSession.decrypt(ct);
+                console.log('Decrypted received megolm message', r);
+
+                expect(r.message_index).toEqual(0);
+                var decrypted = JSON.parse(r.plaintext);
+                expect(decrypted.type).toEqual('m.room.message');
+                expect(decrypted.content.body).toEqual('test');
+
+                return {
+                    event_id: '$event_id',
+                };
+            });
+
+            return q.all([
+                aliceTestClient.client.sendTextMessage(ROOM_ID, 'test'),
+                aliceTestClient.httpBackend.flush(),
+            ]);
+        }).nodeify(done);
+    });
+
+    it("Alice shouldn't do a second /query for non-e2e-capable devices", function(done) {
+        return aliceTestClient.start().then(function() {
+            var syncResponse = getSyncResponse(['@bob:xyz']);
+            aliceTestClient.httpBackend.when('GET', '/sync').respond(200, syncResponse);
+
+            return aliceTestClient.httpBackend.flush('/sync', 1);
+        }).then(function() {
+            console.log("Forcing alice to download our device keys");
+
+            aliceTestClient.httpBackend.when('POST', '/keys/query').respond(200, {
+                device_keys: {
+                    '@bob:xyz': {},
+                }
+            });
+
+            return q.all([
+                aliceTestClient.client.downloadKeys(['@bob:xyz']),
+                aliceTestClient.httpBackend.flush('/keys/query', 1),
+            ]);
+        }).then(function() {
+            console.log("Telling alice to send a megolm message");
+
+            aliceTestClient.httpBackend.when(
+                'PUT', '/send/'
+            ).respond(200, {
+                    event_id: '$event_id',
+            });
+
+            return q.all([
+                aliceTestClient.client.sendTextMessage(ROOM_ID, 'test'),
+                aliceTestClient.httpBackend.flush(),
+            ]);
+        }).nodeify(done);
+    });
+
+
+    it("We shouldn't attempt to send to blocked devices", function(done) {
+        return aliceTestClient.start().then(function() {
+            var syncResponse = getSyncResponse(['@bob:xyz']);
+
+            // establish an olm session with alice
+            var p2pSession = createOlmSession(testOlmAccount, aliceTestClient);
+
+            var olmEvent = encryptOlmEvent({
+                senderKey: testSenderKey,
+                recipient: aliceTestClient,
+                p2pSession: p2pSession,
+            });
+
+            syncResponse.to_device = { events: [olmEvent] };
+            aliceTestClient.httpBackend.when('GET', '/sync').respond(200, syncResponse);
+
+            return aliceTestClient.httpBackend.flush('/sync', 1);
+        }).then(function() {
+            console.log('Forcing alice to download our device keys');
+
+            aliceTestClient.httpBackend.when('POST', '/keys/query').respond(
+                200, getTestKeysQueryResponse('@bob:xyz')
+            );
+
+            return q.all([
+                aliceTestClient.client.downloadKeys(['@bob:xyz']),
+                aliceTestClient.httpBackend.flush('/keys/query', 1),
+            ]);
+        }).then(function() {
+            console.log('Telling alice to block our device');
+            aliceTestClient.client.setDeviceBlocked('@bob:xyz', 'DEVICE_ID');
+
+            console.log('Telling alice to send a megolm message');
+            aliceTestClient.httpBackend.when(
+                'PUT', '/send/'
+            ).respond(200, {
+                event_id: '$event_id',
+            });
+
+            return q.all([
+                aliceTestClient.client.sendTextMessage(ROOM_ID, 'test'),
+                aliceTestClient.httpBackend.flush(),
+            ]);
+        }).nodeify(done);
+    });
+
+    it("We should start a new megolm session when a device is blocked", function(done) {
+        var p2pSession;
+        var megolmSessionId;
+
+        return aliceTestClient.start().then(function() {
+            var syncResponse = getSyncResponse(['@bob:xyz']);
+
+            // establish an olm session with alice
+            p2pSession = createOlmSession(testOlmAccount, aliceTestClient);
+
+            var olmEvent = encryptOlmEvent({
+                senderKey: testSenderKey,
+                recipient: aliceTestClient,
+                p2pSession: p2pSession,
+            });
+
+            syncResponse.to_device = { events: [olmEvent] };
+            aliceTestClient.httpBackend.when('GET', '/sync').respond(200, syncResponse);
+
+            return aliceTestClient.httpBackend.flush('/sync', 1);
+        }).then(function() {
+            console.log('Telling alice to send a megolm message');
+
+            aliceTestClient.httpBackend.when('POST', '/keys/query').respond(
+                200, getTestKeysQueryResponse('@bob:xyz')
+            );
+
+            aliceTestClient.httpBackend.when(
+                'PUT', '/sendToDevice/m.room.encrypted/'
+            ).respond(200, function(path, content) {
+                console.log('sendToDevice: ', content);
+                var m = content.messages['@bob:xyz'].DEVICE_ID;
+                var ct = m.ciphertext[testSenderKey];
+                expect(ct.type).toEqual(1); // normal message
+                var decrypted = JSON.parse(p2pSession.decrypt(ct.type, ct.body));
+                console.log('decrypted sendToDevice:', decrypted);
+                expect(decrypted.type).toEqual('m.room_key');
+                megolmSessionId = decrypted.content.session_id;
+                return {};
+            });
+
+            aliceTestClient.httpBackend.when(
+                'PUT', '/send/'
+            ).respond(200, function(path, content) {
+                console.log('/send:', content);
+                expect(content.session_id).toEqual(megolmSessionId);
+                return {
+                    event_id: '$event_id',
+                };
+            });
+
+            return q.all([
+                aliceTestClient.client.sendTextMessage(ROOM_ID, 'test'),
+                aliceTestClient.httpBackend.flush(),
+            ]);
+        }).then(function() {
+            console.log('Telling alice to block our device');
+            aliceTestClient.client.setDeviceBlocked('@bob:xyz', 'DEVICE_ID');
+
+            console.log('Telling alice to send another megolm message');
+            aliceTestClient.httpBackend.when(
+                'PUT', '/send/'
+            ).respond(200, function(path, content) {
+                console.log('/send:', content);
+                expect(content.session_id).not.toEqual(megolmSessionId);
+                return {
+                    event_id: '$event_id',
+                };
+            });
+
+            return q.all([
+                aliceTestClient.client.sendTextMessage(ROOM_ID, 'test2'),
+                aliceTestClient.httpBackend.flush(),
+            ]);
+        }).nodeify(done);
+    });
+
+    // https://github.com/vector-im/riot-web/issues/2676
+    it("Alice should send to her other devices", function(done) {
+        // for this test, we make the testOlmAccount be another of Alice's devices.
+        // it ought to get include in messages Alice sends.
+
+        var p2pSession;
+        var inboundGroupSession;
+        var decrypted;
+
+        return aliceTestClient.start(
+            getTestKeysQueryResponse(aliceTestClient.userId)
+        ).then(function() {
+            // an encrypted room with just alice
+            var syncResponse = {
+                next_batch: 1,
+                rooms: {
+                    join: {},
+                },
+            };
+            syncResponse.rooms.join[ROOM_ID] = {
+                state: {
+                    events: [
+                        test_utils.mkEvent({
+                            type: 'm.room.encryption',
+                            skey: '',
+                            content: {
+                                algorithm: 'm.megolm.v1.aes-sha2',
+                            },
+                        }),
+                        test_utils.mkMembership({
+                            mship: 'join',
+                            sender: aliceTestClient.userId,
+                        }),
+                    ],
+                },
+            };
+            aliceTestClient.httpBackend.when('GET', '/sync').respond(200, syncResponse);
+
+            return aliceTestClient.httpBackend.flush();
+        }).then(function() {
+            aliceTestClient.httpBackend.when('POST', '/keys/claim').respond(
+                200, function(path, content)
+            {
+                expect(content.one_time_keys[aliceTestClient.userId].DEVICE_ID)
+                    .toEqual("signed_curve25519");
+                return getTestKeysClaimResponse(aliceTestClient.userId);
+            });
+
+            aliceTestClient.httpBackend.when(
+                'PUT', '/sendToDevice/m.room.encrypted/'
+            ).respond(200, function(path, content) {
+                console.log("sendToDevice: ", content);
+                var m = content.messages[aliceTestClient.userId].DEVICE_ID;
+                var ct = m.ciphertext[testSenderKey];
+                expect(ct.type).toEqual(0); // pre-key message
+
+                p2pSession = new Olm.Session();
+                p2pSession.create_inbound(testOlmAccount, ct.body);
+                var decrypted = JSON.parse(p2pSession.decrypt(ct.type, ct.body));
+
+                expect(decrypted.type).toEqual('m.room_key');
+                inboundGroupSession = new Olm.InboundGroupSession();
+                inboundGroupSession.create(decrypted.content.session_key);
+                return {};
+            });
+
+            aliceTestClient.httpBackend.when(
+                'PUT', '/send/'
+            ).respond(200, function(path, content) {
+                var ct = content.ciphertext;
+                var r = inboundGroupSession.decrypt(ct);
+                console.log('Decrypted received megolm message', r);
+                decrypted = JSON.parse(r.plaintext);
+
+                return {
+                    event_id: '$event_id',
+                };
+            });
+
+            return q.all([
+                aliceTestClient.client.sendTextMessage(ROOM_ID, 'test'),
+                aliceTestClient.httpBackend.flush(),
+            ]);
+        }).then(function() {
+            expect(decrypted.type).toEqual('m.room.message');
+            expect(decrypted.content.body).toEqual('test');
+        }).nodeify(done);
+    });
+
+
+    it('Alice should wait for device list to complete when sending a megolm message',
+    function(done) {
+        var p2pSession;
+        var inboundGroupSession;
+
+        var downloadPromise;
+        var sendPromise;
+
+        aliceTestClient.httpBackend.when(
+            'PUT', '/sendToDevice/m.room.encrypted/'
+        ).respond(200, function(path, content) {
+            var m = content.messages['@bob:xyz'].DEVICE_ID;
+            var ct = m.ciphertext[testSenderKey];
+            var decrypted = JSON.parse(p2pSession.decrypt(ct.type, ct.body));
+
+            expect(decrypted.type).toEqual('m.room_key');
+            inboundGroupSession = new Olm.InboundGroupSession();
+            inboundGroupSession.create(decrypted.content.session_key);
+            return {};
+        });
+
+        aliceTestClient.httpBackend.when(
+            'PUT', '/send/'
+        ).respond(200, function(path, content) {
+            var ct = content.ciphertext;
+            var r = inboundGroupSession.decrypt(ct);
+            console.log('Decrypted received megolm message', r);
+
+            expect(r.message_index).toEqual(0);
+            var decrypted = JSON.parse(r.plaintext);
+            expect(decrypted.type).toEqual('m.room.message');
+            expect(decrypted.content.body).toEqual('test');
+
+            return {
+                event_id: '$event_id',
+            };
+        });
+
+        return aliceTestClient.start().then(function() {
+            var syncResponse = getSyncResponse(['@bob:xyz']);
+
+            // establish an olm session with alice
+            p2pSession = createOlmSession(testOlmAccount, aliceTestClient);
+
+            var olmEvent = encryptOlmEvent({
+                senderKey: testSenderKey,
+                recipient: aliceTestClient,
+                p2pSession: p2pSession,
+            });
+
+            syncResponse.to_device = { events: [olmEvent] };
+
+            aliceTestClient.httpBackend.when('GET', '/sync').respond(200, syncResponse);
+            return aliceTestClient.httpBackend.flush('/sync', 1);
+        }).then(function() {
+            console.log('Forcing alice to download our device keys');
+
+            // this will block
+            downloadPromise = aliceTestClient.client.downloadKeys(['@bob:xyz']);
+        }).then(function() {
+
+            // so will this.
+            sendPromise = aliceTestClient.client.sendTextMessage(ROOM_ID, 'test');
+        }).then(function() {
+            aliceTestClient.httpBackend.when('POST', '/keys/query').respond(
+                200, getTestKeysQueryResponse('@bob:xyz')
+            );
+
+            return aliceTestClient.httpBackend.flush();
+        }).then(function() {
+            return q.all([downloadPromise, sendPromise]);
+        }).nodeify(done);
+    });
+});

spec/test-utils.js

@@ -28,7 +28,7 @@ module.exports.mock = function(constr, name) {
     result.jasmineToString = function() {
         return "mock" + (name ? " of " + name : "");
     };
-    for (var key in constr.prototype) { // jshint ignore:line
+    for (var key in constr.prototype) { // eslint-disable-line guard-for-in
         try {
             if (constr.prototype[key] instanceof Function) {
                 result[key] = jasmine.createSpy((name || "mock") + '.' + key);
@@ -65,7 +65,7 @@ module.exports.mkEvent = function(opts) {
         content: opts.content,
         event_id: "$" + Math.random() + "-" + Math.random()
     };
-    if (opts.skey) {
+    if (opts.skey !== undefined) {
         event.state_key = opts.skey;
     }
     else if (["m.room.name", "m.room.topic", "m.room.create", "m.room.join_rules",
@@ -159,7 +159,16 @@ module.exports.mkMessage = function(opts) {
  * <p>This is useful for use with integration tests which use asyncronous
  * methods: it can be added as a 'catch' handler in a promise chain.
  *
- * @param {Error} error   exception to be reported
+ * @param {Error} err   exception to be reported
+ *
+ * @deprecated
+ * It turns out there are easier ways of doing this. Just use nodeify():
+ *
+ * it("should not throw", function(done) {
+ *    asynchronousMethod().then(function() {
+ *       // some tests
+ *    }).nodeify(done);
+ * });
  *
  * @example
  * it("should not throw", function(done) {
@@ -168,6 +177,27 @@ module.exports.mkMessage = function(opts) {
  *    }).catch(utils.failTest).done(done);
  * });
  */
-module.exports.failTest = function(error) {
-    expect(error.stack).toBe(null);
+module.exports.failTest = function(err) {
+    expect(true).toBe(false, "Testfunc threw: " + err.stack);
+};
+
+
+/**
+ * A mock implementation of webstorage
+ *
+ * @constructor
+ */
+module.exports.MockStorageApi = function() {
+    this.data = {};
+};
+module.exports.MockStorageApi.prototype = {
+    setItem: function(k, v) {
+        this.data[k] = v;
+    },
+    getItem: function(k) {
+        return this.data[k] || null;
+    },
+    removeItem: function(k) {
+        delete this.data[k];
+    }
 };

spec/unit/content-repo.spec.js

@@ -6,7 +6,7 @@ describe("ContentRepo", function() {
     var baseUrl = "https://my.home.server";
 
     beforeEach(function() {
-        testUtils.beforeEach(this);
+        testUtils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("getHttpUriForMxc", function() {

spec/unit/crypto.spec.js

@@ -9,6 +9,6 @@ describe("Crypto", function() {
     }
 
     it("Crypto exposes the correct olm library version", function() {
-        expect(Crypto.getOlmVersion()).toEqual([1, 3, 0]);
+        expect(Crypto.getOlmVersion()[0]).toEqual(2);
     });
 });

spec/unit/event-timeline.spec.js

@@ -15,7 +15,7 @@ describe("EventTimeline", function() {
     var timeline;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
 
         // XXX: this is a horrid hack; should use sinon or something instead to mock
         var timelineSet = { room: { roomId: roomId }};

spec/unit/filter.spec.js

@@ -9,7 +9,7 @@ describe("Filter", function() {
     var filter;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         filter = new Filter(userId);
     });
 

spec/unit/interactive-auth.spec.js

@@ -24,7 +24,7 @@ var MatrixError = sdk.MatrixError;
 
 describe("InteractiveAuth", function() {
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     it("should start an auth stage and complete it", function(done) {

spec/unit/matrix-client.spec.js

@@ -117,7 +117,7 @@ describe("MatrixClient", function() {
     }
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         jasmine.Clock.useMock();
         scheduler = jasmine.createSpyObj("scheduler", [
             "getQueueForEvent", "queueEvent", "removeEventFromQueue",

spec/unit/realtime-callbacks.spec.js

@@ -14,7 +14,7 @@ describe("realtime-callbacks", function() {
     }
 
     beforeEach(function() {
-        test_utils.beforeEach(this);
+        test_utils.beforeEach(this); // eslint-disable-line no-invalid-this
         clock.useMock();
         fakeDate = Date.now();
         callbacks.setNow(function() { return fakeDate; });
@@ -54,8 +54,8 @@ describe("realtime-callbacks", function() {
         it("should set 'this' to the global object", function() {
             var callback = jasmine.createSpy();
             callback.andCallFake(function() {
-                expect(this).toBe(global);
-                expect(this.console).toBeDefined();
+                expect(this).toBe(global); // eslint-disable-line no-invalid-this
+                expect(this.console).toBeDefined(); // eslint-disable-line no-invalid-this
             });
             callbacks.setTimeout(callback);
             tick(0);

spec/unit/room-member.spec.js

@@ -11,7 +11,7 @@ describe("RoomMember", function() {
     var member;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         member = new RoomMember(roomId, userA);
     });
 

spec/unit/room-state.spec.js

@@ -11,7 +11,7 @@ describe("RoomState", function() {
     var state;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         state = new RoomState(roomId);
         state.setStateEvents([
             utils.mkMembership({  // userA joined

spec/unit/room.spec.js

@@ -16,7 +16,7 @@ describe("Room", function() {
     var room;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         room = new Room(roomId);
         // mock RoomStates
         room.oldState = room.getLiveTimeline()._startState =
@@ -1110,7 +1110,7 @@ describe("Room", function() {
     describe("tags", function() {
 
         function mkTags(roomId, tags) {
-            var content = { "tags" : tags };
+            var content = { "tags": tags };
             return new MatrixEvent({
                 content: content,
                 room_id: roomId,

spec/unit/scheduler.spec.js

@@ -1,4 +1,6 @@
-"use strict";
+// This file had a function whose name is all caps, which displeases eslint
+/* eslint new-cap: "off" */
+
 var q = require("q");
 var sdk = require("../..");
 var MatrixScheduler = sdk.MatrixScheduler;
@@ -18,7 +20,7 @@ describe("MatrixScheduler", function() {
     });
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         jasmine.Clock.useMock();
         scheduler = new MatrixScheduler(function(ev, attempts, err) {
             if (retryFn) {

spec/unit/timeline-window.spec.js

@@ -60,7 +60,7 @@ function createLinkedTimelines() {
 
 describe("TimelineIndex", function() {
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("minIndex", function() {
@@ -153,7 +153,7 @@ describe("TimelineWindow", function() {
     }
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("load", function() {

spec/unit/user.spec.js

@@ -8,7 +8,7 @@ describe("User", function() {
     var user;
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         user = new User(userId);
     });
 

spec/unit/utils.spec.js

@@ -4,7 +4,7 @@ var testUtils = require("../test-utils");
 
 describe("utils", function() {
     beforeEach(function() {
-        testUtils.beforeEach(this);
+        testUtils.beforeEach(this); // eslint-disable-line no-invalid-this
     });
 
     describe("encodeParams", function() {

spec/unit/webstorage.spec.js

@@ -33,7 +33,7 @@ describe("WebStorageStore", function() {
     );
 
     beforeEach(function() {
-        utils.beforeEach(this);
+        utils.beforeEach(this); // eslint-disable-line no-invalid-this
         mockStorageApi = new MockStorageApi();
         store = new WebStorageStore(mockStorageApi, batchNum);
         room = new Room(roomId);

src/base-apis.js

@@ -45,6 +45,10 @@ var utils = require("./utils");
  *
  * @param {string} opts.accessToken The access_token for this user.
  *
+ * @param {Number=} opts.localTimeoutMs Optional. The default maximum amount of
+ * time to wait before timing out HTTP requests. If not specified, there is no
+ * timeout.
+ *
  * @param {Object} opts.queryParams Optional. Extra query parameters to append
  * to all requests with this client. Useful for application services which require
  * <code>?user_id=</code>.
@@ -63,7 +67,8 @@ function MatrixBaseApis(opts) {
         request: opts.request,
         prefix: httpApi.PREFIX_R0,
         onlyData: true,
-        extraParams: opts.queryParams
+        extraParams: opts.queryParams,
+        localTimeoutMs: opts.localTimeoutMs
     };
     this._http = new httpApi.MatrixHttpApi(this, httpOpts);
 
@@ -434,6 +439,7 @@ MatrixBaseApis.prototype.roomInitialSync = function(roomId, limit, callback) {
 // =========================
 
 /**
+ * @param {Object} options Options for this request
  * @param {string} options.server The remote server to query for the room list.
  *                                Optional. If unspecified, get the local home
  *                                server's public room list.
@@ -570,6 +576,30 @@ MatrixBaseApis.prototype.setRoomDirectoryVisibility =
     );
 };
 
+/**
+ * Set the visbility of a room bridged to a 3rd party network in
+ * the current HS's room directory.
+ * @param {string} networkId the network ID of the 3rd party
+ *                 instance under which this room is published under.
+ * @param {string} roomId
+ * @param {string} visibility "public" to make the room visible
+ *                 in the public directory, or "private" to make
+ *                 it invisible.
+ * @param {module:client.callback} callback Optional.
+ * @return {module:client.Promise} Resolves: result object
+ * @return {module:http-api.MatrixError} Rejects: with an error response.
+ */
+MatrixBaseApis.prototype.setRoomDirectoryVisibilityAppService =
+                                function(networkId, roomId, visibility, callback) {
+    var path = utils.encodeUri("/directory/list/appservice/$networkId/$roomId", {
+        $networkId: networkId,
+        $roomId: roomId
+    });
+    return this._http.authedRequest(
+        callback, "PUT", path, undefined, { "visibility": visibility }
+    );
+};
+
 
 // Media operations
 // ================
@@ -688,6 +718,25 @@ MatrixBaseApis.prototype.addThreePid = function(creds, bind, callback) {
     );
 };
 
+/**
+ * @param {string} medium The threepid medium (eg. 'email')
+ * @param {string} address The threepid address (eg. 'bob@example.com')
+ *        this must be as returned by getThreePids.
+ * @return {module:client.Promise} Resolves: The server response on success
+ *     (generally the empty JSON object)
+ * @return {module:http-api.MatrixError} Rejects: with an error response.
+ */
+MatrixBaseApis.prototype.deleteThreePid = function(medium, address) {
+    var path = "/account/3pid/delete";
+    var data = {
+        'medium': medium,
+        'address': address
+    };
+    return this._http.authedRequestWithPrefix(
+        undefined, "POST", path, null, data, httpApi.PREFIX_UNSTABLE
+    );
+};
+
 /**
  * Make a request to change your password.
  * @param {Object} authDict
@@ -974,7 +1023,7 @@ MatrixBaseApis.prototype.downloadKeysForUsers = function(userIds, callback) {
 /**
  * Claim one-time keys
  *
- * @param {string[][]} devices  a list of [userId, deviceId] pairs
+ * @param {string[]} devices  a list of [userId, deviceId] pairs
  *
  * @param {string} [key_algorithm = signed_curve25519]  desired key type
  *

src/client.js

@@ -94,6 +94,9 @@ try {
  * to all requests with this client. Useful for application services which require
  * <code>?user_id=</code>.
  *
+ * @param {Number=} opts.localTimeoutMs Optional. The default maximum amount of
+ * time to wait before timing out HTTP requests. If not specified, there is no timeout.
+ *
  * @param {boolean} [opts.timelineSupport = false] Set to true to enable
  * improved timeline support ({@link
  * module:client~MatrixClient#getEventTimeline getEventTimeline}). It is
@@ -149,7 +152,7 @@ function MatrixClient(opts) {
     this._notifTimelineSet = null;
 
     this._crypto = null;
-    if (CRYPTO_ENABLED && opts.sessionStore !== null &&
+    if (CRYPTO_ENABLED && Boolean(opts.sessionStore) &&
             userId !== null && this.deviceId !== null) {
         this._crypto = new Crypto(
             this, this,
@@ -351,11 +354,9 @@ MatrixClient.prototype.getStoredDevicesForUser = function(userId) {
     if (this._crypto === null) {
         throw new Error("End-to-end encryption disabled");
     }
-    return this._crypto.getStoredDevicesForUser(userId);
+    return this._crypto.getStoredDevicesForUser(userId) || [];
 };
 
-
-
 /**
  * Mark the given device as verified
  *
@@ -374,7 +375,6 @@ MatrixClient.prototype.setDeviceVerified = function(userId, deviceId, verified)
     _setDeviceVerification(this, userId, deviceId, verified, null);
 };
 
-
 /**
  * Mark the given device as blocked/unblocked
  *
@@ -463,38 +463,31 @@ MatrixClient.prototype.isRoomEncrypted = function(roomId) {
  * Decrypt a received event according to the algorithm specified in the event.
  *
  * @param {MatrixClient} client
- * @param {object} raw event
- *
- * @return {MatrixEvent}
+ * @param {MatrixEvent} event
  */
 function _decryptEvent(client, event) {
     if (!client._crypto) {
-        return _badEncryptedMessage(event, "**Encryption not enabled**");
+        _badEncryptedMessage(event, "Encryption not enabled");
+        return;
     }
 
-    var decryptionResult;
     try {
-        decryptionResult = client._crypto.decryptEvent(event);
+        client._crypto.decryptEvent(event);
     } catch (e) {
         if (!(e instanceof Crypto.DecryptionError)) {
             throw e;
         }
-        return _badEncryptedMessage(event, "**" + e.message + "**");
+        _badEncryptedMessage(event, e.message);
+        return;
     }
-    return new MatrixEvent(
-        event, decryptionResult.payload,
-        decryptionResult.keysProved,
-        decryptionResult.keysClaimed
-    );
 }
 
 function _badEncryptedMessage(event, reason) {
-    return new MatrixEvent(event, {
+    event.setClearData({
         type: "m.room.message",
         content: {
             msgtype: "m.bad.encrypted",
-            body: reason,
-            content: event.content,
+            body: "** Unable to decrypt: " + reason + " **",
         },
     });
 }
@@ -546,7 +539,7 @@ MatrixClient.prototype.getUsers = function() {
 /**
  * Set account data event for the current user.
  * @param {string} eventType The event type
- * @param {Object} content the contents object for the event
+ * @param {Object} contents the contents object for the event
  * @param {module:client.callback} callback Optional.
  * @return {module:client.Promise} Resolves: TODO
  * @return {module:http-api.MatrixError} Rejects: with an error response.
@@ -1479,6 +1472,47 @@ MatrixClient.prototype.setPresence = function(opts, callback) {
     );
 };
 
+function _presenceList(callback, client, opts, method) {
+  var path = utils.encodeUri("/presence/list/$userId", {
+      $userId: client.credentials.userId
+  });
+  return client._http.authedRequest(callback, method, path, undefined, opts);
+}
+
+/**
+* Retrieve current user presence list.
+* @param {module:client.callback} callback Optional.
+* @return {module:client.Promise} Resolves: TODO
+* @return {module:http-api.MatrixError} Rejects: with an error response.
+*/
+MatrixClient.prototype.getPresenceList = function(callback) {
+  return _presenceList(callback, this, undefined, "GET");
+};
+
+/**
+* Add users to the current user presence list.
+* @param {module:client.callback} callback Optional.
+* @param {string[]} userIds
+* @return {module:client.Promise} Resolves: TODO
+* @return {module:http-api.MatrixError} Rejects: with an error response.
+*/
+MatrixClient.prototype.inviteToPresenceList = function(callback, userIds) {
+  var opts = {"invite": userIds};
+  return _presenceList(callback, this, opts, "POST");
+};
+
+/**
+* Drop users from the current user presence list.
+* @param {module:client.callback} callback Optional.
+* @param {string[]} userIds
+* @return {module:client.Promise} Resolves: TODO
+* @return {module:http-api.MatrixError} Rejects: with an error response.
+**/
+MatrixClient.prototype.dropFromPresenceList = function(callback, userIds) {
+  var opts = {"drop": userIds};
+  return _presenceList(callback, this, opts, "POST");
+};
+
 /**
  * Retrieve older messages from the given room and put them in the timeline.
  *
@@ -2829,10 +2863,11 @@ function _resolve(callback, defer, res) {
 
 function _PojoToMatrixEventMapper(client) {
     function mapper(plainOldJsObject) {
-        if (plainOldJsObject.type === "m.room.encrypted") {
-            return _decryptEvent(client, plainOldJsObject);
+        var event = new MatrixEvent(plainOldJsObject);
+        if (event.isEncrypted()) {
+            _decryptEvent(client, event);
         }
-        return new MatrixEvent(plainOldJsObject);
+        return event;
     }
     return mapper;
 }
@@ -2872,6 +2907,10 @@ module.exports.CRYPTO_ENABLED = CRYPTO_ENABLED;
 
 /**
  * Fires whenever the SDK receives a new event.
+ * <p>
+ * This is only fired for live events received via /sync - it is not fired for
+ * events received over context, search, or pagination APIs.
+ *
  * @event module:client~MatrixClient#"event"
  * @param {MatrixEvent} event The matrix event which caused this event to fire.
  * @example

src/crypto/OlmDevice.js

@@ -20,10 +20,33 @@ limitations under the License.
  *
  * @module crypto/OlmDevice
  */
-
 var Olm = require("olm");
 var utils = require("../utils");
 
+
+// The maximum size of an event is 65K, and we base64 the content, so this is a
+// reasonable approximation to the biggest plaintext we can encrypt.
+var MAX_PLAINTEXT_LENGTH = 65536 * 3 / 4;
+
+function checkPayloadLength(payloadString) {
+    if (payloadString === undefined) {
+        throw new Error("payloadString undefined");
+    }
+
+    if (payloadString.length > MAX_PLAINTEXT_LENGTH) {
+        // might as well fail early here rather than letting the olm library throw
+        // a cryptic memory allocation error.
+        //
+        // Note that even if we manage to do the encryption, the message send may fail,
+        // because by the time we've wrapped the ciphertext in the event object, it may
+        // exceed 65K. But at least we won't just fail with "abort()" in that case.
+        throw new Error("Message too long (" + payloadString.length + " bytes). " +
+                        "The maximum for an encrypted message is " +
+                        MAX_PLAINTEXT_LENGTH + " bytes.");
+    }
+}
+
+
 /**
  * Manages the olm cryptography functions. Each OlmDevice has a single
  * OlmAccount and a number of OlmSessions.
@@ -386,9 +409,7 @@ OlmDevice.prototype.encryptMessage = function(
 ) {
     var self = this;
 
-    if (payloadString === undefined) {
-        throw new Error("payloadString undefined");
-    }
+    checkPayloadLength(payloadString);
 
     return this._getSession(theirDeviceIdentityKey, sessionId, function(session) {
         var res = session.encrypt(payloadString);
@@ -446,7 +467,6 @@ OlmDevice.prototype.matchesSession = function(
 };
 
 
-
 // Outbound group session
 // ======================
 
@@ -515,6 +535,8 @@ OlmDevice.prototype.createOutboundGroupSession = function() {
 OlmDevice.prototype.encryptGroupMessage = function(sessionId, payloadString) {
     var self = this;
 
+    checkPayloadLength(payloadString);
+
     return this._getOutboundGroupSession(sessionId, function(session) {
         var res = session.encrypt(payloadString);
         self._saveOutboundGroupSession(session);
@@ -627,6 +649,24 @@ OlmDevice.prototype.addInboundGroupSession = function(
     roomId, senderKey, sessionId, sessionKey, keysClaimed
 ) {
     var self = this;
+
+    /* if we already have this session, consider updating it */
+    function updateSession(session) {
+        console.log("Update for megolm session " + senderKey + "/" + sessionId);
+        // for now we just ignore updates. TODO: implement something here
+
+        return true;
+    }
+
+    var r = this._getInboundGroupSession(
+        roomId, senderKey, sessionId, updateSession
+    );
+
+    if (r !== null) {
+        return;
+    }
+
+    // new session.
     var session = new Olm.InboundGroupSession();
     try {
         session.create(sessionKey);

src/crypto/algorithms/base.js

@@ -88,15 +88,6 @@ EncryptionAlgorithm.prototype.onRoomMembership = function(
     event, member, oldMembership
 ) {};
 
-/**
- * Called when a new device announces itself in the room
- *
- * @param {string} userId    owner of the device
- * @param {string} deviceId  deviceId of the device
- */
-EncryptionAlgorithm.prototype.onNewDevice = function(userId, deviceId) {};
-
-
 /**
  * base type for decryption implementations
  *
@@ -105,11 +96,16 @@ EncryptionAlgorithm.prototype.onNewDevice = function(userId, deviceId) {};
  *
  * @param {object} params parameters
  * @param {string} params.userId  The UserID for the local user
+ * @param {module:crypto} params.crypto crypto core
  * @param {module:crypto/OlmDevice} params.olmDevice olm.js wrapper
+ * @param {string=} params.roomId The ID of the room we will be receiving
+ *     from. Null for to-device events.
  */
 var DecryptionAlgorithm = function(params) {
     this._userId = params.userId;
+    this._crypto = params.crypto;
     this._olmDevice = params.olmDevice;
+    this._roomId = params.roomId;
 };
 /** */
 module.exports.DecryptionAlgorithm = DecryptionAlgorithm;
@@ -134,7 +130,7 @@ module.exports.DecryptionAlgorithm = DecryptionAlgorithm;
  *
  * @method module:crypto/algorithms/base.DecryptionAlgorithm#onRoomKeyEvent
  *
- * @param {module:models/event.MatrixEvent} event key event
+ * @param {module:models/event.MatrixEvent} params event key event
  */
 DecryptionAlgorithm.prototype.onRoomKeyEvent = function(params) {
     // ignore by default

src/crypto/algorithms/megolm.js

@@ -0,0 +1,583 @@
+/*
+Copyright 2015, 2016 OpenMarket Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+"use strict";
+
+/**
+ * Defines m.olm encryption/decryption
+ *
+ * @module crypto/algorithms/megolm
+ */
+
+var q = require("q");
+
+var utils = require("../../utils");
+var olmlib = require("../olmlib");
+var base = require("./base");
+
+/**
+ * @private
+ * @constructor
+ *
+ * @param {string} sessionId
+ *
+ * @property {string} sessionId
+ * @property {Number} useCount     number of times this session has been used
+ * @property {Number} creationTime when the session was created (ms since the epoch)
+ *
+ * @property {object} sharedWithDevices
+ *    devices with which we have shared the session key
+ *        userId -> {deviceId -> msgindex}
+ */
+function OutboundSessionInfo(sessionId) {
+    this.sessionId = sessionId;
+    this.useCount = 0;
+    this.creationTime = new Date().getTime();
+    this.sharedWithDevices = {};
+}
+
+
+/**
+ * Check if it's time to rotate the session
+ *
+ * @param {Number} rotationPeriodMsgs
+ * @param {Number} rotationPeriodMs
+ * @return {Boolean}
+ */
+OutboundSessionInfo.prototype.needsRotation = function(
+    rotationPeriodMsgs, rotationPeriodMs
+) {
+    var sessionLifetime = new Date().getTime() - this.creationTime;
+
+    if (this.useCount >= rotationPeriodMsgs ||
+        sessionLifetime >= rotationPeriodMs
+       ) {
+        console.log(
+            "Rotating megolm session after " + this.useCount +
+                " messages, " + sessionLifetime + "ms"
+        );
+        return true;
+    }
+
+    return false;
+};
+
+
+/**
+ * Determine if this session has been shared with devices which it shouldn't
+ * have been.
+ *
+ * @param {Object} devicesInRoom userId -> {deviceId -> object}
+ *   devices we should shared the session with.
+ *
+ * @return {Boolean} true if we have shared the session with devices which aren't
+ * in devicesInRoom.
+ */
+OutboundSessionInfo.prototype.sharedWithTooManyDevices = function(
+    devicesInRoom
+) {
+
+    for (var userId in this.sharedWithDevices) {
+        if (!this.sharedWithDevices.hasOwnProperty(userId)) { continue; }
+
+        if (!devicesInRoom.hasOwnProperty(userId)) {
+            console.log("Starting new session because we shared with " + userId);
+            return true;
+        }
+
+        for (var deviceId in this.sharedWithDevices[userId]) {
+            if (!this.sharedWithDevices[userId].hasOwnProperty(deviceId)) {
+                continue;
+            }
+
+            if (!devicesInRoom[userId].hasOwnProperty(deviceId)) {
+                console.log(
+                    "Starting new session because we shared with " +
+                        userId + ":" + deviceId
+                );
+                return true;
+            }
+        }
+    }
+};
+
+
+/**
+ * Megolm encryption implementation
+ *
+ * @constructor
+ * @extends {module:crypto/algorithms/base.EncryptionAlgorithm}
+ *
+ * @param {object} params parameters, as per
+ *     {@link module:crypto/algorithms/base.EncryptionAlgorithm}
+ */
+function MegolmEncryption(params) {
+    base.EncryptionAlgorithm.call(this, params);
+
+    // the most recent attempt to set up a session. This is used to serialise
+    // the session setups, so that we have a race-free view of which session we
+    // are using, and which devices we have shared the keys with. It resolves
+    // with an OutboundSessionInfo (or undefined, for the first message in the
+    // room).
+    this._setupPromise = q();
+
+    // default rotation periods
+    this._sessionRotationPeriodMsgs = 100;
+    this._sessionRotationPeriodMs = 7 * 24 * 3600 * 1000;
+
+    if (params.config.rotation_period_ms !== undefined) {
+        this._sessionRotationPeriodMs = params.config.rotation_period_ms;
+    }
+
+    if (params.config.rotation_period_msgs !== undefined) {
+        this._sessionRotationPeriodMsgs = params.config.rotation_period_msgs;
+    }
+}
+utils.inherits(MegolmEncryption, base.EncryptionAlgorithm);
+
+/**
+ * @private
+ *
+ * @param {Object} devicesInRoom The devices in this room, indexed by user ID
+ *
+ * @return {module:client.Promise} Promise which resolves to the
+ *    OutboundSessionInfo when setup is complete.
+ */
+MegolmEncryption.prototype._ensureOutboundSession = function(devicesInRoom) {
+    var self = this;
+
+    var session;
+
+    // takes the previous OutboundSessionInfo, and considers whether to create
+    // a new one. Also shares the key with any (new) devices in the room.
+    // Updates `session` to hold the final OutboundSessionInfo.
+    //
+    // returns a promise which resolves once the keyshare is successful.
+    function prepareSession(oldSession) {
+        session = oldSession;
+
+        // need to make a brand new session?
+        if (session && session.needsRotation(self._sessionRotationPeriodMsgs,
+                                             self._sessionRotationPeriodMs)
+           ) {
+            console.log("Starting new megolm session because we need to rotate.");
+            session = null;
+        }
+
+        // determine if we have shared with anyone we shouldn't have
+        if (session && session.sharedWithTooManyDevices(devicesInRoom)) {
+            session = null;
+        }
+
+        if (!session) {
+            session = self._prepareNewSession();
+        }
+
+        // now check if we need to share with any devices
+        var shareMap = {};
+
+        for (var userId in devicesInRoom) {
+            if (!devicesInRoom.hasOwnProperty(userId)) {
+                continue;
+            }
+
+            var userDevices = devicesInRoom[userId];
+
+            for (var deviceId in userDevices) {
+                if (!userDevices.hasOwnProperty(deviceId)) {
+                    continue;
+                }
+
+                var deviceInfo = userDevices[deviceId];
+
+                var key = deviceInfo.getIdentityKey();
+                if (key == self._olmDevice.deviceCurve25519Key) {
+                    // don't bother sending to ourself
+                    continue;
+                }
+
+                if (
+                    !session.sharedWithDevices[userId] ||
+                        session.sharedWithDevices[userId][deviceId] === undefined
+                ) {
+                    shareMap[userId] = shareMap[userId] || [];
+                    shareMap[userId].push(deviceInfo);
+                }
+            }
+        }
+
+        return self._shareKeyWithDevices(
+            session, shareMap
+        );
+    }
+
+    // helper which returns the session prepared by prepareSession
+    function returnSession() { return session; }
+
+    // first wait for the previous share to complete
+    var prom = this._setupPromise.then(prepareSession);
+
+    // _setupPromise resolves to `session` whether or not the share succeeds
+    this._setupPromise = prom.then(returnSession, returnSession);
+
+    // but we return a promise which only resolves if the share was successful.
+    return prom.then(returnSession);
+};
+
+/**
+ * @private
+ *
+ * @return {module:crypto/algorithms/megolm.OutboundSessionInfo} session
+ */
+MegolmEncryption.prototype._prepareNewSession = function() {
+    var session_id = this._olmDevice.createOutboundGroupSession();
+    var key = this._olmDevice.getOutboundGroupSessionKey(session_id);
+
+    this._olmDevice.addInboundGroupSession(
+        this._roomId, this._olmDevice.deviceCurve25519Key, session_id,
+        key.key, {ed25519: this._olmDevice.deviceEd25519Key}
+    );
+
+    return new OutboundSessionInfo(session_id);
+};
+
+/**
+ * @private
+ *
+ * @param {module:crypto/algorithms/megolm.OutboundSessionInfo} session
+ *
+ * @param {object<string, module:crypto/deviceinfo[]>} devicesByUser
+ *    map from userid to list of devices
+ *
+ * @return {module:client.Promise} Promise which resolves once the key sharing
+ *     message has been sent.
+ */
+MegolmEncryption.prototype._shareKeyWithDevices = function(session, devicesByUser) {
+    var self = this;
+
+    var key = this._olmDevice.getOutboundGroupSessionKey(session.sessionId);
+    var payload = {
+        type: "m.room_key",
+        content: {
+            algorithm: olmlib.MEGOLM_ALGORITHM,
+            room_id: this._roomId,
+            session_id: session.sessionId,
+            session_key: key.key,
+            chain_index: key.chain_index,
+        }
+    };
+
+    var contentMap = {};
+
+    return olmlib.ensureOlmSessionsForDevices(
+        this._olmDevice, this._baseApis, devicesByUser
+    ).then(function(devicemap) {
+        var haveTargets = false;
+
+        for (var userId in devicesByUser) {
+            if (!devicesByUser.hasOwnProperty(userId)) {
+                continue;
+            }
+
+            var devicesToShareWith = devicesByUser[userId];
+            var sessionResults = devicemap[userId];
+
+            for (var i = 0; i < devicesToShareWith.length; i++) {
+                var deviceInfo = devicesToShareWith[i];
+                var deviceId = deviceInfo.deviceId;
+
+                var sessionResult = sessionResults[deviceId];
+                if (!sessionResult.sessionId) {
+                    // no session with this device, probably because there
+                    // were no one-time keys.
+                    //
+                    // we could send them a to_device message anyway, as a
+                    // signal that they have missed out on the key sharing
+                    // message because of the lack of keys, but there's not
+                    // much point in that really; it will mostly serve to clog
+                    // up to_device inboxes.
+                    //
+                    // ensureOlmSessionsForUsers has already done the logging,
+                    // so just skip it.
+                    continue;
+                }
+
+                console.log(
+                    "sharing keys with device " + userId + ":" + deviceId
+                );
+
+                var encryptedContent = {
+                    algorithm: olmlib.OLM_ALGORITHM,
+                    sender_key: self._olmDevice.deviceCurve25519Key,
+                    ciphertext: {},
+                };
+
+                olmlib.encryptMessageForDevice(
+                    encryptedContent.ciphertext,
+                    self._userId,
+                    self._deviceId,
+                    self._olmDevice,
+                    userId,
+                    deviceInfo,
+                    payload
+                );
+
+                if (!contentMap[userId]) {
+                    contentMap[userId] = {};
+                }
+
+                contentMap[userId][deviceId] = encryptedContent;
+                haveTargets = true;
+            }
+        }
+
+        if (!haveTargets) {
+            return q();
+        }
+
+        // TODO: retries
+        return self._baseApis.sendToDevice("m.room.encrypted", contentMap);
+    }).then(function() {
+        // Add the devices we have shared with to session.sharedWithDevices.
+        //
+        // we deliberately iterate over devicesByUser (ie, the devices we
+        // attempted to share with) rather than the contentMap (those we did
+        // share with), because we don't want to try to claim a one-time-key
+        // for dead devices on every message.
+        for (var userId in devicesByUser) {
+            if (!devicesByUser.hasOwnProperty(userId)) {
+                continue;
+            }
+            if (!session.sharedWithDevices[userId]) {
+                session.sharedWithDevices[userId] = {};
+            }
+            var devicesToShareWith = devicesByUser[userId];
+            for (var i = 0; i < devicesToShareWith.length; i++) {
+                var deviceInfo = devicesToShareWith[i];
+                session.sharedWithDevices[userId][deviceInfo.deviceId] =
+                    key.chain_index;
+            }
+        }
+    });
+};
+
+/**
+ * @inheritdoc
+ *
+ * @param {module:models/room} room
+ * @param {string} eventType
+ * @param {object} content plaintext event content
+ *
+ * @return {module:client.Promise} Promise which resolves to the new event body
+ */
+MegolmEncryption.prototype.encryptMessage = function(room, eventType, content) {
+    var self = this;
+    return this._getDevicesInRoom(room).then(function(devicesInRoom) {
+        return self._ensureOutboundSession(devicesInRoom);
+    }).then(function(session) {
+        var payloadJson = {
+            room_id: self._roomId,
+            type: eventType,
+            content: content
+        };
+
+        var ciphertext = self._olmDevice.encryptGroupMessage(
+            session.sessionId, JSON.stringify(payloadJson)
+        );
+
+        var encryptedContent = {
+            algorithm: olmlib.MEGOLM_ALGORITHM,
+            sender_key: self._olmDevice.deviceCurve25519Key,
+            ciphertext: ciphertext,
+            session_id: session.sessionId,
+             // Include our device ID so that recipients can send us a
+             // m.new_device message if they don't have our session key.
+            device_id: self._deviceId,
+        };
+
+        session.useCount++;
+        return encryptedContent;
+    });
+};
+
+/**
+ * Get the list of unblocked devices for all users in the room
+ *
+ * @param {module:models/room} room
+ *
+ * @return {module:client.Promise} Promise which resolves to a map
+ *     from userId to deviceId to deviceInfo
+ */
+MegolmEncryption.prototype._getDevicesInRoom = function(room) {
+    // XXX what about rooms where invitees can see the content?
+    var roomMembers = utils.map(room.getJoinedMembers(), function(u) {
+        return u.userId;
+    });
+
+    // We are happy to use a cached version here: we assume that if we already
+    // have a list of the user's devices, then we already share an e2e room
+    // with them, which means that they will have announced any new devices via
+    // an m.new_device.
+    return this._crypto.downloadKeys(roomMembers, false).then(function(devices) {
+        // remove any blocked devices
+        for (var userId in devices) {
+            if (!devices.hasOwnProperty(userId)) {
+                continue;
+            }
+
+            var userDevices = devices[userId];
+            for (var deviceId in userDevices) {
+                if (!userDevices.hasOwnProperty(deviceId)) {
+                    continue;
+                }
+                if (userDevices[deviceId].isBlocked()) {
+                    delete userDevices[deviceId];
+                }
+            }
+        }
+
+        return devices;
+    });
+};
+
+/**
+ * Megolm decryption implementation
+ *
+ * @constructor
+ * @extends {module:crypto/algorithms/base.DecryptionAlgorithm}
+ *
+ * @param {object} params parameters, as per
+ *     {@link module:crypto/algorithms/base.DecryptionAlgorithm}
+ */
+function MegolmDecryption(params) {
+    base.DecryptionAlgorithm.call(this, params);
+
+    // events which we couldn't decrypt due to unknown sessions / indexes: map from
+    // senderKey|sessionId to list of MatrixEvents
+    this._pendingEvents = {};
+}
+utils.inherits(MegolmDecryption, base.DecryptionAlgorithm);
+
+/**
+ * @inheritdoc
+ *
+ * @param {MatrixEvent} event
+ *
+ * @throws {module:crypto/algorithms/base.DecryptionError} if there is a
+ *   problem decrypting the event
+ */
+MegolmDecryption.prototype.decryptEvent = function(event) {
+    var content = event.getWireContent();
+
+    if (!content.sender_key || !content.session_id ||
+        !content.ciphertext
+       ) {
+        throw new base.DecryptionError("Missing fields in input");
+    }
+
+    var res;
+    try {
+        res = this._olmDevice.decryptGroupMessage(
+            event.getRoomId(), content.sender_key, content.session_id, content.ciphertext
+        );
+    } catch (e) {
+        if (e.message === 'OLM.UNKNOWN_MESSAGE_INDEX') {
+            this._addEventToPendingList(event);
+        }
+        throw new base.DecryptionError(e);
+    }
+
+    if (res === null) {
+        // We've got a message for a session we don't have.
+        this._addEventToPendingList(event);
+        throw new base.DecryptionError(
+            "The sender's device has not sent us the keys for this message."
+        );
+    }
+
+    var payload = JSON.parse(res.result);
+
+    // belt-and-braces check that the room id matches that indicated by the HS
+    // (this is somewhat redundant, since the megolm session is scoped to the
+    // room, so neither the sender nor a MITM can lie about the room_id).
+    if (payload.room_id !== event.getRoomId()) {
+        throw new base.DecryptionError(
+            "Message intended for room " + payload.room_id
+        );
+    }
+
+    event.setClearData(payload, res.keysProved, res.keysClaimed);
+};
+
+
+/**
+ * Add an event to the list of those we couldn't decrypt the first time we
+ * saw them.
+ *
+ * @private
+ *
+ * @param {module:models/event.MatrixEvent} event
+ */
+MegolmDecryption.prototype._addEventToPendingList = function(event) {
+    var content = event.getWireContent();
+    var k = content.sender_key + "|" + content.session_id;
+    if (!this._pendingEvents[k]) {
+        this._pendingEvents[k] = [];
+    }
+    this._pendingEvents[k].push(event);
+};
+
+/**
+ * @inheritdoc
+ *
+ * @param {module:models/event.MatrixEvent} event key event
+ */
+MegolmDecryption.prototype.onRoomKeyEvent = function(event) {
+    console.log("Adding key from ", event);
+    var content = event.getContent();
+
+    if (!content.room_id ||
+        !content.session_id ||
+        !content.session_key
+       ) {
+        console.error("key event is missing fields");
+        return;
+    }
+
+    this._olmDevice.addInboundGroupSession(
+        content.room_id, event.getSenderKey(), content.session_id,
+        content.session_key, event.getKeysClaimed()
+    );
+
+    var k = event.getSenderKey() + "|" + content.session_id;
+    var pending = this._pendingEvents[k];
+    if (pending) {
+        // have another go at decrypting events sent with this session.
+        delete this._pendingEvents[k];
+
+        for (var i = 0; i < pending.length; i++) {
+            try {
+                this.decryptEvent(pending[i]);
+                console.log("successful re-decryption of", pending[i]);
+            } catch (e) {
+                console.log("Still can't decrypt", pending[i], e.stack || e);
+            }
+        }
+    }
+};
+
+base.registerAlgorithm(
+    olmlib.MEGOLM_ALGORITHM, MegolmEncryption, MegolmDecryption
+);

src/crypto/algorithms/olm.js

@@ -79,7 +79,7 @@ OlmEncryption.prototype._ensureSession = function(roomMembers) {
  *
  * @param {module:models/room} room
  * @param {string} eventType
- * @param {object} plaintext event content
+ * @param {object} content plaintext event content
  *
  * @return {module:client.Promise} Promise which resolves to the new event body
  */
@@ -151,15 +151,13 @@ utils.inherits(OlmDecryption, base.DecryptionAlgorithm);
 /**
  * @inheritdoc
  *
- * @param {object} event raw event
- *
- * @return {module:crypto.DecryptionResult} decryption result
+ * @param {MatrixEvent} event
  *
  * @throws {module:crypto/algorithms/base.DecryptionError} if there is a
  *   problem decrypting the event
  */
 OlmDecryption.prototype.decryptEvent = function(event) {
-    var content = event.content;
+    var content = event.getWireContent();
     var deviceKey = content.sender_key;
     var ciphertext = content.ciphertext;
 
@@ -178,7 +176,7 @@ OlmDecryption.prototype.decryptEvent = function(event) {
     } catch (e) {
         console.warn(
             "Failed to decrypt Olm event (id=" +
-                event.event_id + ") from " + deviceKey +
+                event.getId() + ") from " + deviceKey +
                 ": " + e.message
         );
         throw new base.DecryptionError("Bad Encrypted Message");
@@ -188,15 +186,9 @@ OlmDecryption.prototype.decryptEvent = function(event) {
 
     // check that we were the intended recipient, to avoid unknown-key attack
     // https://github.com/vector-im/vector-web/issues/2483
-    if (payload.recipient === undefined) {
-        // older versions of riot did not set this field, so we cannot make
-        // this check. TODO: kill this off once our users have updated
+    if (payload.recipient != this._userId) {
         console.warn(
-            "Olm event (id=" + event.event_id + ") contains no 'recipient' " +
-             "property; cannot prevent unknown-key attack");
-    } else if (payload.recipient != this._userId) {
-        console.warn(
-            "Event " + event.event_id + ": Intended recipient " +
+            "Event " + event.getId() + ": Intended recipient " +
             payload.recipient + " does not match our id " + this._userId
         );
         throw new base.DecryptionError(
@@ -204,15 +196,10 @@ OlmDecryption.prototype.decryptEvent = function(event) {
         );
     }
 
-    if (payload.recipient_keys === undefined) {
-        // ditto
-        console.warn(
-            "Olm event (id=" + event.event_id + ") contains no " +
-            "'recipient_keys' property; cannot prevent unknown-key attack");
-    } else if (payload.recipient_keys.ed25519 !=
+    if (payload.recipient_keys.ed25519 !=
                this._olmDevice.deviceEd25519Key) {
         console.warn(
-            "Event " + event.event_id + ": Intended recipient ed25519 key " +
+            "Event " + event.getId() + ": Intended recipient ed25519 key " +
             payload.recipient_keys.ed25519 + " did not match ours"
         );
         throw new base.DecryptionError("Message not intended for this device");
@@ -222,15 +209,10 @@ OlmDecryption.prototype.decryptEvent = function(event) {
     // avoid people masquerading as others.
     // (this check is also provided via the sender's embedded ed25519 key,
     // which is checked elsewhere).
-    if (payload.sender === undefined) {
-        // ditto
+    if (payload.sender != event.getSender()) {
         console.warn(
-            "Olm event (id=" + event.event_id + ") contains no " +
-            "'sender' property; cannot prevent unknown-key attack");
-    } else if (payload.sender != event.sender) {
-        console.warn(
-            "Event " + event.event_id + ": original sender " + payload.sender +
-            " does not match reported sender " + event.sender
+            "Event " + event.getId() + ": original sender " + payload.sender +
+            " does not match reported sender " + event.getSender()
         );
         throw new base.DecryptionError(
             "Message forwarded from " + payload.sender
@@ -238,9 +220,9 @@ OlmDecryption.prototype.decryptEvent = function(event) {
     }
 
     // Olm events intended for a room have a room_id.
-    if (payload.room_id !== event.room_id) {
+    if (payload.room_id !== event.getRoomId()) {
         console.warn(
-            "Event " + event.event_id + ": original room " + payload.room_id +
+            "Event " + event.getId() + ": original room " + payload.room_id +
             " does not match reported room " + event.room_id
         );
         throw new base.DecryptionError(
@@ -248,12 +230,7 @@ OlmDecryption.prototype.decryptEvent = function(event) {
         );
     }
 
-    return {
-        payload: payload,
-        sessionExists: true,
-        keysProved: {curve25519: deviceKey},
-        keysClaimed: payload.keys || {}
-    };
+    event.setClearData(payload, {curve25519: deviceKey}, payload.keys || {});
 };
 
 

src/crypto/index.js

@@ -54,10 +54,19 @@ function Crypto(baseApis, eventEmitter, sessionStore, userId, deviceId) {
     this._userId = userId;
     this._deviceId = deviceId;
 
+    this._initialSyncCompleted = false;
+    // userId -> true
+    this._pendingUsersWithNewDevices = {};
+    // userId -> [promise, ...]
+    this._keyDownloadsInProgressByUser = {};
+
     this._olmDevice = new OlmDevice(sessionStore);
 
     // EncryptionAlgorithm instance for each room
-    this._roomAlgorithms = {};
+    this._roomEncryptors = {};
+
+    // map from algorithm to DecryptionAlgorithm instance, for each room
+    this._roomDecryptors = {};
 
     this._supportedAlgorithms = utils.keys(
         algorithms.DECRYPTION_CLASSES
@@ -70,24 +79,32 @@ function Crypto(baseApis, eventEmitter, sessionStore, userId, deviceId) {
     this._deviceKeys["curve25519:" + this._deviceId] =
         this._olmDevice.deviceCurve25519Key;
 
-    // add our own deviceinfo to the sessionstore
-    var deviceInfo = {
-        keys: this._deviceKeys,
-        algorithms: this._supportedAlgorithms,
-        verified: DeviceVerification.VERIFIED,
-    };
     var myDevices = this._sessionStore.getEndToEndDevicesForUser(
         this._userId
-    ) || {};
-    myDevices[this._deviceId] = deviceInfo;
-    this._sessionStore.storeEndToEndDevicesForUser(
-        this._userId, myDevices
     );
 
-    _registerEventHandlers(this, eventEmitter);
+    if (!myDevices) {
+        // we don't yet have a list of our own devices; make sure we
+        // get one when we flush the pendingUsersWithNewDevices.
+        this._pendingUsersWithNewDevices[this._userId] = true;
+        myDevices = {};
+    }
 
-    // map from userId -> deviceId -> roomId -> timestamp
-    this._lastNewDeviceMessageTsByUserDeviceRoom = {};
+    if (!myDevices[this._deviceId]) {
+        // add our own deviceinfo to the sessionstore
+        var deviceInfo = {
+            keys: this._deviceKeys,
+            algorithms: this._supportedAlgorithms,
+            verified: DeviceVerification.VERIFIED,
+        };
+
+        myDevices[this._deviceId] = deviceInfo;
+        this._sessionStore.storeEndToEndDevicesForUser(
+            this._userId, myDevices
+        );
+    }
+
+    _registerEventHandlers(this, eventEmitter);
 }
 
 function _registerEventHandlers(crypto, eventEmitter) {
@@ -267,53 +284,138 @@ function _uploadOneTimeKeys(crypto) {
 Crypto.prototype.downloadKeys = function(userIds, forceDownload) {
     var self = this;
 
-    // map from userid -> deviceid -> DeviceInfo
-    var stored = {};
+    // promises we need to wait for while the download happens
+    var promises = [];
 
     // list of userids we need to download keys for
     var downloadUsers = [];
 
-    for (var i = 0; i < userIds.length; ++i) {
-        var userId = userIds[i];
-        stored[userId] = {};
+    function perUserCatch(u) {
+        return function(e) {
+            console.warn('Error downloading keys for user ' + u + ':', e);
+        };
+    }
 
-        var devices = this.getStoredDevicesForUser(userId);
-        for (var j = 0; j < devices.length; ++j) {
-            var dev = devices[j];
-            stored[userId][dev.deviceId] = dev;
-        }
+    if (forceDownload) {
+        downloadUsers = userIds;
+    } else {
+        for (var i = 0; i < userIds.length; ++i) {
+            var u = userIds[i];
 
-        if (devices.length === 0 || forceDownload) {
-            downloadUsers.push(userId);
+            var inprogress = this._keyDownloadsInProgressByUser[u];
+            if (inprogress) {
+                // wait for the download to complete
+                promises.push(q.any(inprogress).catch(perUserCatch(u)));
+            } else if (!this.getStoredDevicesForUser(u)) {
+                downloadUsers.push(u);
+            }
         }
     }
 
-    if (downloadUsers.length === 0) {
-        return q(stored);
+    if (downloadUsers.length > 0) {
+        var r = this._doKeyDownloadForUsers(downloadUsers);
+        downloadUsers.map(function(u) {
+            promises.push(r[u].catch(perUserCatch(u)));
+        });
     }
 
-    return this._baseApis.downloadKeysForUsers(
+    return q.all(promises).then(function() {
+        return self._getDevicesFromStore(userIds);
+    });
+};
+
+
+/**
+ * Get the stored device keys for a list of user ids
+ *
+ * @param {string[]} userIds the list of users to list keys for.
+ *
+ * @return {Object} userId->deviceId->{@link module:crypto/deviceinfo|DeviceInfo}.
+ */
+Crypto.prototype._getDevicesFromStore = function(userIds) {
+    var stored = {};
+    var self = this;
+    userIds.map(function(u) {
+        stored[u] = {};
+        var devices = self.getStoredDevicesForUser(u) || [];
+        devices.map(function(dev) {
+            stored[u][dev.deviceId] = dev;
+        });
+    });
+    return stored;
+};
+
+/**
+ * @param {string[]} downloadUsers list of userIds
+ *
+ * @return {Object} a map from userId to a promise for a result for that user
+ */
+Crypto.prototype._doKeyDownloadForUsers = function(downloadUsers) {
+    var self = this;
+
+    console.log('Starting key download for ' + downloadUsers);
+
+    var deferMap = {};
+    var promiseMap = {};
+
+    downloadUsers.map(function(u) {
+        var deferred = q.defer();
+        var promise = deferred.promise.finally(function() {
+            var inProgress = self._keyDownloadsInProgressByUser[u];
+            utils.removeElement(inProgress, function(e) { return e === promise; });
+            if (inProgress.length === 0) {
+                // no more downloads for this user; remove the element
+                delete self._keyDownloadsInProgressByUser[u];
+            }
+        });
+
+        if (!self._keyDownloadsInProgressByUser[u]) {
+            self._keyDownloadsInProgressByUser[u] = [];
+        }
+        self._keyDownloadsInProgressByUser[u].push(promise);
+
+        deferMap[u] = deferred;
+        promiseMap[u] = promise;
+    });
+
+    this._baseApis.downloadKeysForUsers(
         downloadUsers
-    ).then(function(res) {
-        for (var userId in res.device_keys) {
-            if (!stored.hasOwnProperty(userId)) {
-                // spurious result
+    ).done(function(res) {
+        var dk = res.device_keys || {};
+
+        for (var i = 0; i < downloadUsers.length; ++i) {
+            var userId = downloadUsers[i];
+            var deviceId;
+
+            console.log('got keys for ' + userId + ':', dk[userId]);
+
+            if (!dk[userId]) {
+                // no result for this user
+                var err = 'Unknown';
+                // TODO: do something with res.failures
+                deferMap[userId].reject(err);
                 continue;
             }
 
             // map from deviceid -> deviceinfo for this user
-            var userStore = stored[userId];
-            var updated = _updateStoredDeviceKeysForUser(
-                self._olmDevice, userId, userStore, res.device_keys[userId]
-            );
-
-            if (!updated) {
-                continue;
+            var userStore = {};
+            var devs = self._sessionStore.getEndToEndDevicesForUser(userId);
+            if (devs) {
+                for (deviceId in devs) {
+                    if (devs.hasOwnProperty(deviceId)) {
+                        var d = DeviceInfo.fromStorage(devs[deviceId], deviceId);
+                        userStore[deviceId] = d;
+                    }
+                }
             }
 
+            _updateStoredDeviceKeysForUser(
+                self._olmDevice, userId, userStore, dk[userId]
+            );
+
             // update the session store
             var storage = {};
-            for (var deviceId in userStore) {
+            for (deviceId in userStore) {
                 if (!userStore.hasOwnProperty(deviceId)) {
                     continue;
                 }
@@ -323,9 +425,16 @@ Crypto.prototype.downloadKeys = function(userIds, forceDownload) {
             self._sessionStore.storeEndToEndDevicesForUser(
                 userId, storage
             );
+
+            deferMap[userId].resolve();
         }
-        return stored;
+    }, function(err) {
+        downloadUsers.map(function(u) {
+            deferMap[u].reject(err);
+        });
     });
+
+    return promiseMap;
 };
 
 function _updateStoredDeviceKeysForUser(_olmDevice, userId, userStore,
@@ -399,7 +508,7 @@ function _storeDeviceKeys(_olmDevice, userStore, deviceResult) {
     var unsigned = deviceResult.unsigned || {};
 
     try {
-        _verifySignature(_olmDevice, deviceResult, userId, deviceId, signKey);
+        olmlib.verifySignature(_olmDevice, deviceResult, userId, deviceId, signKey);
     } catch (e) {
         console.log("Unable to verify signature on device " +
                     userId + ":" + deviceId + ":", e);
@@ -437,12 +546,13 @@ function _storeDeviceKeys(_olmDevice, userStore, deviceResult) {
  *
  * @param {string} userId the user to list keys for.
  *
- * @return {module:crypto/deviceinfo[]} list of devices
+ * @return {module:crypto/deviceinfo[]|null} list of devices, or null if we haven't
+ * managed to get a list of devices for this user yet.
  */
 Crypto.prototype.getStoredDevicesForUser = function(userId) {
     var devs = this._sessionStore.getEndToEndDevicesForUser(userId);
     if (!devs) {
-        return [];
+        return null;
     }
     var res = [];
     for (var deviceId in devs) {
@@ -453,6 +563,22 @@ Crypto.prototype.getStoredDevicesForUser = function(userId) {
     return res;
 };
 
+/**
+ * Get the stored keys for a single device
+ *
+ * @param {string} userId
+ * @param {string} deviceId
+ *
+ * @return {module:crypto/deviceinfo?} list of devices, or undefined
+ * if we don't know about this device
+ */
+Crypto.prototype.getStoredDevice = function(userId, deviceId) {
+    var devs = this._sessionStore.getEndToEndDevicesForUser(userId);
+    if (!devs || !devs[deviceId]) {
+        return undefined;
+    }
+    return DeviceInfo.fromStorage(devs[deviceId], deviceId);
+};
 
 /**
  * List the stored device keys for a user id
@@ -465,7 +591,7 @@ Crypto.prototype.getStoredDevicesForUser = function(userId) {
  *    "key", and "display_name" parameters.
  */
 Crypto.prototype.listDeviceKeys = function(userId) {
-    var devices = this.getStoredDevicesForUser(userId);
+    var devices = this.getStoredDevicesForUser(userId) || [];
 
     var result = [];
 
@@ -597,7 +723,7 @@ Crypto.prototype.setDeviceVerification = function(userId, deviceId, verified, bl
  * @return {Object.<string, {deviceIdKey: string, sessions: object[]}>}
  */
 Crypto.prototype.getOlmSessionsForUser = function(userId) {
-    var devices = this.getStoredDevicesForUser(userId);
+    var devices = this.getStoredDevicesForUser(userId) || [];
     var result = {};
     for (var j = 0; j < devices.length; ++j) {
         var device = devices[j];
@@ -705,7 +831,7 @@ Crypto.prototype.setRoomEncryption = function(roomId, config) {
         roomId: roomId,
         config: config,
     });
-    this._roomAlgorithms[roomId] = alg;
+    this._roomEncryptors[roomId] = alg;
 };
 
 
@@ -717,7 +843,8 @@ Crypto.prototype.setRoomEncryption = function(roomId, config) {
  */
 
 /**
- * Try to make sure we have established olm sessions for the given users.
+ * Try to make sure we have established olm sessions for all known devices for
+ * the given users.
  *
  * @param {string[]} users list of user ids
  *
@@ -726,19 +853,15 @@ Crypto.prototype.setRoomEncryption = function(roomId, config) {
  *    {@link module:crypto~OlmSessionResult}
  */
 Crypto.prototype.ensureOlmSessionsForUsers = function(users) {
-    var devicesWithoutSession = [
-        // [userId, deviceId, deviceInfo], ...
-    ];
-    var result = {};
+    var devicesByUser = {};
 
     for (var i = 0; i < users.length; ++i) {
         var userId = users[i];
-        result[userId] = {};
+        devicesByUser[userId] = [];
 
-        var devices = this.getStoredDevicesForUser(userId);
+        var devices = this.getStoredDevicesForUser(userId) || [];
         for (var j = 0; j < devices.length; ++j) {
             var deviceInfo = devices[j];
-            var deviceId = deviceInfo.deviceId;
 
             var key = deviceInfo.getIdentityKey();
             if (key == this._olmDevice.deviceCurve25519Key) {
@@ -750,87 +873,13 @@ Crypto.prototype.ensureOlmSessionsForUsers = function(users) {
                 continue;
             }
 
-            var sessionId = this._olmDevice.getSessionIdForDevice(key);
-            if (sessionId === null) {
-                devicesWithoutSession.push([userId, deviceId, deviceInfo]);
-            }
-            result[userId][deviceId] = {
-                device: deviceInfo,
-                sessionId: sessionId,
-            };
+            devicesByUser[userId].push(deviceInfo);
         }
     }
 
-    if (devicesWithoutSession.length === 0) {
-        return q(result);
-    }
-
-    // TODO: this has a race condition - if we try to send another message
-    // while we are claiming a key, we will end up claiming two and setting up
-    // two sessions.
-    //
-    // That should eventually resolve itself, but it's poor form.
-
-    var self = this;
-    var oneTimeKeyAlgorithm = "signed_curve25519";
-    return this._baseApis.claimOneTimeKeys(
-        devicesWithoutSession, oneTimeKeyAlgorithm
-    ).then(function(res) {
-        for (var i = 0; i < devicesWithoutSession.length; ++i) {
-            var device = devicesWithoutSession[i];
-            var userId = device[0];
-            var deviceId = device[1];
-            var deviceInfo = device[2];
-
-            var userRes = res.one_time_keys[userId] || {};
-            var deviceRes = userRes[deviceId];
-            var oneTimeKey = null;
-            for (var keyId in deviceRes) {
-                if (keyId.indexOf(oneTimeKeyAlgorithm + ":") === 0) {
-                    oneTimeKey = deviceRes[keyId];
-                }
-            }
-
-            if (!oneTimeKey) {
-                console.warn(
-                    "No one-time keys (alg=" + oneTimeKeyAlgorithm +
-                        ") for device " + userId + ":" + deviceId
-                );
-                continue;
-            }
-
-            try {
-                _verifySignature(
-                    self._olmDevice, oneTimeKey, userId, deviceId,
-                    deviceInfo.getFingerprint()
-                );
-            } catch (e) {
-                console.log(
-                    "Unable to verify signature on one-time key for device " +
-                        userId + ":" + deviceId + ":", e
-                );
-                continue;
-            }
-
-            var sid;
-            try {
-                sid = self._olmDevice.createOutboundSession(
-                    deviceInfo.getIdentityKey(), oneTimeKey.key
-                );
-            } catch (e) {
-                // possibly a bad key
-                console.error("Error starting session with device " +
-                              userId + ":" + deviceId + ": " + e);
-                continue;
-            }
-
-            console.log("Started new sessionid " + sid +
-                        " for device " + userId + ":" + deviceId);
-
-            result[userId][deviceId].sessionId = sid;
-        }
-        return result;
-    });
+    return olmlib.ensureOlmSessionsForDevices(
+        this._olmDevice, this._baseApis, devicesByUser
+    );
 };
 
 /**
@@ -839,10 +888,9 @@ Crypto.prototype.ensureOlmSessionsForUsers = function(users) {
  * @return {bool} whether encryption is enabled.
  */
 Crypto.prototype.isRoomEncrypted = function(roomId) {
-    return Boolean(this._roomAlgorithms[roomId]);
+    return Boolean(this._roomEncryptors[roomId]);
 };
 
-
 /**
  * Encrypt an event according to the configuration of the room, if necessary.
  *
@@ -862,18 +910,13 @@ Crypto.prototype.encryptEventIfNeeded = function(event, room) {
         return null;
     }
 
-    if (event.getType() !== "m.room.message") {
-        // we only encrypt m.room.message
-        return null;
-    }
-
     if (!room) {
         throw new Error("Cannot send encrypted messages in unknown rooms");
     }
 
     var roomId = event.getRoomId();
 
-    var alg = this._roomAlgorithms[roomId];
+    var alg = this._roomEncryptors[roomId];
     if (!alg) {
         // not encrypting messages in this room
 
@@ -903,118 +946,17 @@ Crypto.prototype.encryptEventIfNeeded = function(event, room) {
     });
 };
 
-/**
- * @typedef {Object} module:crypto.DecryptionResult
- *
- * @property {Object} payload decrypted payload (with properties 'type',
- *     'content').
- *
- * @property {Object<string, string>} keysClaimed keys that the sender of the
- *     event claims ownership of: map from key type to base64-encoded key
- *
- * @property {Object<string, string>} keysProved keys that the sender of the
- *     event is known to have ownership of: map from key type to base64-encoded
- *     key
- */
-
 /**
  * Decrypt a received event
  *
- * @param {object} event raw event
- *
- * @return {module:crypto.DecryptionResult} decryption result
+ * @param {MatrixEvent} event
  *
  * @raises {algorithms.DecryptionError} if there is a problem decrypting the event
  */
 Crypto.prototype.decryptEvent = function(event) {
-    var content = event.content;
-    var AlgClass = algorithms.DECRYPTION_CLASSES[content.algorithm];
-    if (!AlgClass) {
-        throw new algorithms.DecryptionError("Unable to decrypt " + content.algorithm);
-    }
-    var alg = new AlgClass({
-        userId: this._userId,
-        olmDevice: this._olmDevice,
-    });
-    var r = alg.decryptEvent(event);
-
-    if (r !== null) {
-        return r;
-    } else {
-        // We've got a message for a session we don't have.  Maybe the sender
-        // forgot to tell us about the session.  Remind the sender that we
-        // exist so that they might tell us about the session on their next
-        // send.
-        //
-        // (Alternatively, it might be that we are just looking at
-        // scrollback... at least we rate-limit the m.new_device events :/)
-        //
-        // XXX: this is a band-aid which masks symptoms of other bugs. It would
-        // be nice to get rid of it.
-        if (event.room_id !== undefined && event.sender !== undefined) {
-            var device_id = event.content.device_id;
-            if (device_id === undefined) {
-                // if the sending device didn't tell us its device_id, fall
-                // back to all devices.
-                device_id = null;
-            }
-            this._sendPingToDevice(event.sender, device_id, event.room_id);
-        }
-
-        throw new algorithms.DecryptionError("Unknown inbound session id");
-    }
-};
-
-/**
- * Send a "m.new_device" message to remind it that we exist and are a member
- * of a room.
- *
- * This is rate limited to send a message at most once an hour per desination.
- *
- * @param {string}  userId   The ID of the user to ping.
- * @param {string?} deviceId The ID of the device to ping. If null, all
- *     devices.
- * @param {string}  roomId   The ID of the room we want to remind them about.
- */
-Crypto.prototype._sendPingToDevice = function(userId, deviceId, roomId) {
-    if (deviceId === null) {
-        deviceId = "*";
-    }
-
-    var lastMessageTsMap = this._lastNewDeviceMessageTsByUserDeviceRoom;
-
-    var lastTsByDevice = lastMessageTsMap[userId];
-    if (!lastTsByDevice) {
-        lastTsByDevice = lastMessageTsMap[userId] = {};
-    }
-
-    var lastTsByRoom = lastTsByDevice[deviceId];
-    if (!lastTsByRoom) {
-        lastTsByRoom = lastTsByDevice[deviceId] = {};
-    }
-
-    var lastTs = lastTsByRoom[roomId];
-    var timeNowMs = Date.now();
-    var oneHourMs = 1000 * 60 * 60;
-
-    if (lastTs !== undefined && lastTs + oneHourMs > timeNowMs) {
-        // rate-limiting
-        return;
-    }
-
-    var content = {};
-    content[userId] = {};
-    content[userId][deviceId] = {
-        device_id: this._deviceId,
-        rooms: [roomId],
-    };
-
-    this._baseApis.sendToDevice(
-        "m.new_device", // OH HAI!
-        content
-    ).done();
-
-    lastTsByRoom[roomId] = timeNowMs;
+    var content = event.getWireContent();
+    var alg = this._getRoomDecryptor(event.getRoomId(), content.algorithm);
+    alg.decryptEvent(event);
 };
 
 /**
@@ -1044,6 +986,11 @@ Crypto.prototype._onCryptoEvent = function(event) {
  * @param {module:models/room[]} rooms list of rooms the client knows about
  */
 Crypto.prototype._onInitialSyncCompleted = function(rooms) {
+    this._initialSyncCompleted = true;
+
+    // catch up on any m.new_device events which arrived during the initial sync.
+    this._flushNewDeviceRequests();
+
     if (this._sessionStore.getDeviceAnnounced()) {
         return;
     }
@@ -1056,7 +1003,7 @@ Crypto.prototype._onInitialSyncCompleted = function(rooms) {
         var room = rooms[i];
 
         // check for rooms with encryption enabled
-        var alg = this._roomAlgorithms[room.roomId];
+        var alg = this._roomEncryptors[room.roomId];
         if (!alg) {
             continue;
         }
@@ -1110,16 +1057,13 @@ Crypto.prototype._onInitialSyncCompleted = function(rooms) {
  */
 Crypto.prototype._onRoomKeyEvent = function(event) {
     var content = event.getContent();
-    var AlgClass = algorithms.DECRYPTION_CLASSES[content.algorithm];
-    if (!AlgClass) {
-        throw new algorithms.DecryptionError(
-            "Unable to handle keys for " + content.algorithm
-        );
+
+    if (!content.room_id || !content.algorithm) {
+        console.error("key event is missing fields");
+        return;
     }
-    var alg = new AlgClass({
-        userId: this._userId,
-        olmDevice: this._olmDevice,
-    });
+
+    var alg = this._getRoomDecryptor(content.room_id, content.algorithm);
     alg.onRoomKeyEvent(event);
 };
 
@@ -1143,7 +1087,7 @@ Crypto.prototype._onRoomMembership = function(event, member, oldMembership) {
 
     var roomId = member.roomId;
 
-    var alg = this._roomAlgorithms[roomId];
+    var alg = this._roomEncryptors[roomId];
     if (!alg) {
         // not encrypting in this room
         return;
@@ -1173,26 +1117,107 @@ Crypto.prototype._onNewDeviceEvent = function(event) {
     console.log("m.new_device event from " + userId + ":" + deviceId +
                 " for rooms " + rooms);
 
+    if (this.getStoredDevice(userId, deviceId)) {
+        console.log("Known device; ignoring");
+        return;
+    }
+
+    this._pendingUsersWithNewDevices[userId] = true;
+
+    // we delay handling these until the intialsync has completed, so that we
+    // can do all of them together.
+    if (this._initialSyncCompleted) {
+        this._flushNewDeviceRequests();
+    }
+};
+
+/**
+ * Start device queries for any users who sent us an m.new_device recently
+ */
+Crypto.prototype._flushNewDeviceRequests = function() {
     var self = this;
-    this.downloadKeys(
-        [userId], true
-    ).then(function() {
-        for (var i = 0; i < rooms.length; i++) {
-            var roomId = rooms[i];
-            var alg = self._roomAlgorithms[roomId];
-            if (!alg) {
-                // not encrypting in this room
-                continue;
-            }
-            alg.onNewDevice(userId, deviceId);
+
+    var users = utils.keys(this._pendingUsersWithNewDevices);
+
+    if (users.length === 0) {
+        return;
+    }
+
+    var r = this._doKeyDownloadForUsers(users);
+
+    // we've kicked off requests to these users: remove their
+    // pending flag for now.
+    this._pendingUsersWithNewDevices = {};
+
+    users.map(function(u) {
+        r[u] = r[u].catch(function(e) {
+            console.error(
+                'Error updating device keys for user ' + u + ':', e
+            );
+
+            // reinstate the pending flags on any users which failed; this will
+            // mean that we will do another download in the future, but won't
+            // tight-loop.
+            //
+            self._pendingUsersWithNewDevices[u] = true;
+        });
+    });
+
+    q.all(utils.values(r)).done();
+};
+
+/**
+ * Get a decryptor for a given room and algorithm.
+ *
+ * If we already have a decryptor for the given room and algorithm, return
+ * it. Otherwise try to instantiate it.
+ *
+ * @private
+ *
+ * @param {string?} roomId   room id for decryptor. If undefined, a temporary
+ * decryptor is instantiated.
+ *
+ * @param {string} algorithm  crypto algorithm
+ *
+ * @return {module:crypto.algorithms.base.DecryptionAlgorithm}
+ *
+ * @raises {module:crypto.algorithms.DecryptionError} if the algorithm is
+ * unknown
+ */
+Crypto.prototype._getRoomDecryptor = function(roomId, algorithm) {
+    var decryptors;
+    var alg;
+
+    roomId = roomId || null;
+    if (roomId) {
+        decryptors = this._roomDecryptors[roomId];
+        if (!decryptors) {
+            this._roomDecryptors[roomId] = decryptors = {};
         }
-    }).catch(function(e) {
-        console.error(
-            "Error updating device keys for new device " + userId + ":" +
-                deviceId,
-            e
+
+        alg = decryptors[algorithm];
+        if (alg) {
+            return alg;
+        }
+    }
+
+    var AlgClass = algorithms.DECRYPTION_CLASSES[algorithm];
+    if (!AlgClass) {
+        throw new algorithms.DecryptionError(
+            'Unknown encryption algorithm "' + algorithm + '".'
         );
-    }).done();
+    }
+    alg = new AlgClass({
+        userId: this._userId,
+        crypto: this,
+        olmDevice: this._olmDevice,
+        roomId: roomId,
+    });
+
+    if (decryptors) {
+        decryptors[algorithm] = alg;
+    }
+    return alg;
 };
 
 
@@ -1209,40 +1234,6 @@ Crypto.prototype._signObject = function(obj) {
     obj.signatures = sigs;
 };
 
-/**
- * Verify the signature on an object
- *
- * @param {module:crypto/OlmDevice} olmDevice olm wrapper to use for verify op
- *
- * @param {Object} obj object to check signature on. Note that this will be
- * stripped of its 'signatures' and 'unsigned' properties.
- *
- * @param {string} signingUserId  ID of the user whose signature should be checked
- *
- * @param {string} signingDeviceId  ID of the device whose signature should be checked
- *
- * @param {string} signingKey   base64-ed ed25519 public key
- */
-function _verifySignature(olmDevice, obj, signingUserId, signingDeviceId, signingKey) {
-    var signKeyId = "ed25519:" + signingDeviceId;
-    var signatures = obj.signatures || {};
-    var userSigs = signatures[signingUserId] || {};
-    var signature = userSigs[signKeyId];
-    if (!signature) {
-        throw Error("No signature");
-    }
-
-    // prepare the canonical json: remove unsigned and signatures, and stringify with
-    // anotherjson
-    delete obj.unsigned;
-    delete obj.signatures;
-    var json = anotherjson.stringify(obj);
-
-    olmDevice.verifySignature(
-        signingKey, json, signature
-    );
-}
-
 /**
  * @see module:crypto/algorithms/base.DecryptionError
  */

src/crypto/olmlib.js

@@ -0,0 +1,269 @@
+/*
+Copyright 2016 OpenMarket Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/**
+ * @module olmlib
+ *
+ * Utilities common to olm encryption algorithms
+ */
+
+var q = require('q');
+var anotherjson = require('another-json');
+
+var utils = require("../utils");
+
+/**
+ * matrix algorithm tag for olm
+ */
+module.exports.OLM_ALGORITHM = "m.olm.v1.curve25519-aes-sha2";
+
+/**
+ * matrix algorithm tag for megolm
+ */
+module.exports.MEGOLM_ALGORITHM = "m.megolm.v1.aes-sha2";
+
+
+/**
+ * Encrypt an event payload for an Olm device
+ *
+ * @param {Object<string, string>} resultsObject  The `ciphertext` property
+ *   of the m.room.encrypted event to which to add our result
+ *
+ * @param {string} ourUserId
+ * @param {string} ourDeviceId
+ * @param {module:crypto/OlmDevice} olmDevice olm.js wrapper
+ * @param {string} recipientUserId
+ * @param {module:crypto/deviceinfo} recipientDevice
+ * @param {object} payloadFields fields to include in the encrypted payload
+ */
+module.exports.encryptMessageForDevice = function(
+    resultsObject,
+    ourUserId, ourDeviceId, olmDevice, recipientUserId, recipientDevice,
+    payloadFields
+) {
+    var deviceKey = recipientDevice.getIdentityKey();
+    var sessionId = olmDevice.getSessionIdForDevice(deviceKey);
+    if (sessionId === null) {
+        // If we don't have a session for a device then
+        // we can't encrypt a message for it.
+        return;
+    }
+
+    console.log(
+        "Using sessionid " + sessionId + " for device " +
+            recipientUserId + ":" + recipientDevice.deviceId
+    );
+
+    var payload = {
+        sender: ourUserId,
+        sender_device: ourDeviceId,
+
+        // Include the Ed25519 key so that the recipient knows what
+        // device this message came from.
+        // We don't need to include the curve25519 key since the
+        // recipient will already know this from the olm headers.
+        // When combined with the device keys retrieved from the
+        // homeserver signed by the ed25519 key this proves that
+        // the curve25519 key and the ed25519 key are owned by
+        // the same device.
+        keys: {
+            "ed25519": olmDevice.deviceEd25519Key,
+        },
+
+        // include the recipient device details in the payload,
+        // to avoid unknown key attacks, per
+        // https://github.com/vector-im/vector-web/issues/2483
+        recipient: recipientUserId,
+        recipient_keys: {
+            "ed25519": recipientDevice.getFingerprint(),
+        },
+    };
+
+    // TODO: technically, a bunch of that stuff only needs to be included for
+    // pre-key messages: after that, both sides know exactly which devices are
+    // involved in the session. If we're looking to reduce data transfer in the
+    // future, we could elide them for subsequent messages.
+
+    utils.extend(payload, payloadFields);
+
+    resultsObject[deviceKey] = olmDevice.encryptMessage(
+        deviceKey, sessionId, JSON.stringify(payload)
+    );
+};
+
+/**
+ * Try to make sure we have established olm sessions for the given devices.
+ *
+ * @param {module:crypto/OlmDevice} olmDevice
+ *
+ * @param {module:base-apis~MatrixBaseApis} baseApis
+ *
+ * @param {object<string, module:crypto/deviceinfo[]>} devicesByUser
+ *    map from userid to list of devices
+ *
+ * @return {module:client.Promise} resolves once the sessions are complete, to
+ *    an Object mapping from userId to deviceId to
+ *    {@link module:crypto~OlmSessionResult}
+ */
+module.exports.ensureOlmSessionsForDevices = function(
+    olmDevice, baseApis, devicesByUser
+) {
+    var devicesWithoutSession = [
+        // [userId, deviceId], ...
+    ];
+    var result = {};
+
+    for (var userId in devicesByUser) {
+        if (!devicesByUser.hasOwnProperty(userId)) { continue; }
+        result[userId] = {};
+        var devices = devicesByUser[userId];
+        for (var j = 0; j < devices.length; j++) {
+            var deviceInfo = devices[j];
+            var deviceId = deviceInfo.deviceId;
+            var key = deviceInfo.getIdentityKey();
+            var sessionId = olmDevice.getSessionIdForDevice(key);
+            if (sessionId === null) {
+                devicesWithoutSession.push([userId, deviceId]);
+            }
+            result[userId][deviceId] = {
+                device: deviceInfo,
+                sessionId: sessionId,
+            };
+        }
+    }
+
+    if (devicesWithoutSession.length === 0) {
+        return q(result);
+    }
+
+    // TODO: this has a race condition - if we try to send another message
+    // while we are claiming a key, we will end up claiming two and setting up
+    // two sessions.
+    //
+    // That should eventually resolve itself, but it's poor form.
+
+    var oneTimeKeyAlgorithm = "signed_curve25519";
+    return baseApis.claimOneTimeKeys(
+        devicesWithoutSession, oneTimeKeyAlgorithm
+    ).then(function(res) {
+        var otk_res = res.one_time_keys || {};
+        for (var userId in devicesByUser) {
+            if (!devicesByUser.hasOwnProperty(userId)) { continue; }
+            var userRes = otk_res[userId] || {};
+            var devices = devicesByUser[userId];
+            for (var j = 0; j < devices.length; j++) {
+                var deviceInfo = devices[j];
+                var deviceId = deviceInfo.deviceId;
+                if (result[userId][deviceId].sessionId) {
+                    // we already have a result for this device
+                    continue;
+                }
+
+                var deviceRes = userRes[deviceId] || {};
+                var oneTimeKey = null;
+                for (var keyId in deviceRes) {
+                    if (keyId.indexOf(oneTimeKeyAlgorithm + ":") === 0) {
+                        oneTimeKey = deviceRes[keyId];
+                    }
+                }
+
+                if (!oneTimeKey) {
+                    console.warn(
+                        "No one-time keys (alg=" + oneTimeKeyAlgorithm +
+                            ") for device " + userId + ":" + deviceId
+                    );
+                    continue;
+                }
+
+                var sid = _verifyKeyAndStartSession(
+                    olmDevice, oneTimeKey, userId, deviceInfo
+                );
+                result[userId][deviceId].sessionId = sid;
+            }
+        }
+        return result;
+    });
+};
+
+
+function _verifyKeyAndStartSession(olmDevice, oneTimeKey, userId, deviceInfo) {
+    var deviceId = deviceInfo.deviceId;
+    try {
+        _verifySignature(
+            olmDevice, oneTimeKey, userId, deviceId,
+            deviceInfo.getFingerprint()
+        );
+    } catch (e) {
+        console.error(
+            "Unable to verify signature on one-time key for device " +
+                userId + ":" + deviceId + ":", e
+        );
+        return null;
+    }
+
+    var sid;
+    try {
+        sid = olmDevice.createOutboundSession(
+            deviceInfo.getIdentityKey(), oneTimeKey.key
+        );
+    } catch (e) {
+        // possibly a bad key
+        console.error("Error starting session with device " +
+                      userId + ":" + deviceId + ": " + e);
+        return null;
+    }
+
+    console.log("Started new sessionid " + sid +
+                " for device " + userId + ":" + deviceId);
+    return sid;
+}
+
+
+/**
+ * Verify the signature on an object
+ *
+ * @param {module:crypto/OlmDevice} olmDevice olm wrapper to use for verify op
+ *
+ * @param {Object} obj object to check signature on. Note that this will be
+ * stripped of its 'signatures' and 'unsigned' properties.
+ *
+ * @param {string} signingUserId  ID of the user whose signature should be checked
+ *
+ * @param {string} signingDeviceId  ID of the device whose signature should be checked
+ *
+ * @param {string} signingKey   base64-ed ed25519 public key
+ */
+var _verifySignature = module.exports.verifySignature = function(
+    olmDevice, obj, signingUserId, signingDeviceId, signingKey
+) {
+    var signKeyId = "ed25519:" + signingDeviceId;
+    var signatures = obj.signatures || {};
+    var userSigs = signatures[signingUserId] || {};
+    var signature = userSigs[signKeyId];
+    if (!signature) {
+        throw Error("No signature");
+    }
+
+    // prepare the canonical json: remove unsigned and signatures, and stringify with
+    // anotherjson
+    delete obj.unsigned;
+    delete obj.signatures;
+    var json = anotherjson.stringify(obj);
+
+    olmDevice.verifySignature(
+        signingKey, json, signature
+    );
+};

src/filter-component.js

@@ -44,7 +44,7 @@ function _matches_wildcard(actual_value, filter_value) {
  * 'Filters' are referred to as 'FilterCollections'.
  *
  * @constructor
- * @param {Object} the definition of this filter JSON, e.g. { 'contains_url': true }
+ * @param {Object} filter_json the definition of this filter JSON, e.g. { 'contains_url': true }
  */
 function FilterComponent(filter_json) {
     this.filter_json = filter_json;

src/http-api.js

@@ -70,8 +70,10 @@ module.exports.PREFIX_MEDIA_R0 = "/_matrix/media/r0";
  *
  * @param {string} opts.accessToken The access_token to send with requests. Can be
  * null to not send an access token.
- * @param {Object} opts.extraParams Optional. Extra query parameters to send on
+ * @param {Object=} opts.extraParams Optional. Extra query parameters to send on
  * requests.
+ * @param {Number=} opts.localTimeoutMs The default maximum amount of time to wait
+ * before timing out the request. If not specified, there is no timeout.
  */
 module.exports.MatrixHttpApi = function MatrixHttpApi(event_emitter, opts) {
     utils.checkObjectHasKeys(opts, ["baseUrl", "request", "prefix"]);
@@ -104,7 +106,7 @@ module.exports.MatrixHttpApi.prototype = {
      *
      * @param {object} file The object to upload. On a browser, something that
      *   can be sent to XMLHttpRequest.send (typically a File).  Under node.js,
-     *   a a Buffer, String or ReadStream.
+     *   a Buffer, String or ReadStream.
      *
      * @param {object} opts  options object
      *
@@ -594,7 +596,7 @@ module.exports.MatrixHttpApi.prototype = {
      * @param {object=} opts.headers  extra request headers
      *
      * @param {number=} opts.localTimeoutMs client-side timeout for the
-     *    request. No timeout if undefined.
+     *    request. Default timeout if falsy.
      *
      * @param {function=} opts.bodyParser function to parse the body of the
      *    response before passing it to the promise and callback.
@@ -626,7 +628,7 @@ module.exports.MatrixHttpApi.prototype = {
         var timeoutId;
         var timedOut = false;
         var req;
-        var localTimeoutMs = opts.localTimeoutMs;
+        var localTimeoutMs = opts.localTimeoutMs || this.opts.localTimeoutMs;
         if (localTimeoutMs) {
             timeoutId = callbacks.setTimeout(function() {
                 timedOut = true;

src/interactive-auth.js

@@ -89,8 +89,8 @@ InteractiveAuth.prototype = {
     /**
      * get the server params for a given stage
      *
-     * @param {string}  login type for the stage
-     * @return {object?}  any parameters from the server for this stage
+     * @param {string} loginType login type for the stage
+     * @return {object?} any parameters from the server for this stage
      */
     getStageParams: function(loginType) {
         var params = {};

src/matrix.js

@@ -82,6 +82,27 @@ module.exports.request = function(r) {
     request = r;
 };
 
+/**
+ * Return the currently-set request function.
+ * @return {requestFunction} The current request function.
+ */
+module.exports.getRequest = function() {
+    return request;
+};
+
+/**
+ * Apply wrapping code around the request function. The wrapper function is
+ * installed as the new request handler, and when invoked it is passed the
+ * previous value, along with the options and callback arguments.
+ * @param {requestWrapperFunction} wrapper The wrapping function.
+ */
+module.exports.wrapRequest = function(wrapper) {
+    var origRequest = request;
+    request = function(options, callback) {
+        return wrapper(origRequest, options, callback);
+    };
+};
+
 /**
  * Construct a Matrix Client. Similar to {@link module:client~MatrixClient}
  * except that the 'request', 'store' and 'scheduler' dependencies are satisfied.
@@ -129,6 +150,16 @@ module.exports.createClient = function(opts) {
  * @param {requestCallback} callback The request callback.
  */
 
+/**
+ * A wrapper for the request function interface.
+ * @callback requestWrapperFunction
+ * @param {requestFunction} origRequest The underlying request function being
+ * wrapped
+ * @param {Object} opts The options for this HTTP request, given in the same
+ * form as {@link requestFunction}.
+ * @param {requestCallback} callback The request callback.
+ */
+
  /**
   * The request callback interface for performing HTTP requests. This matches the
   * API for the {@link https://github.com/request/request#requestoptions-callback|

src/models/event-timeline-set.js

@@ -24,11 +24,12 @@ var EventTimeline = require("./event-timeline");
 // var DEBUG = false;
 var DEBUG = true;
 
+var debuglog;
 if (DEBUG) {
     // using bind means that we get to keep useful line numbers in the console
-    var debuglog = console.log.bind(console);
+    debuglog = console.log.bind(console);
 } else {
-    var debuglog = function() {};
+    debuglog = function() {};
 }
 
 /**

src/models/event.js

@@ -21,6 +21,10 @@ limitations under the License.
  * @module models/event
  */
 
+var EventEmitter = require("events").EventEmitter;
+
+var utils = require('../utils.js');
+
 /**
  * Enum for event statuses.
  * @readonly
@@ -51,15 +55,6 @@ module.exports.EventStatus = {
  *
  * @param {Object} event The raw event to be wrapped in this DAO
  *
- * @param {Object=} clearEvent For encrypted events, the plaintext payload for
- * the event (typically containing <tt>type</tt> and <tt>content</tt> fields).
- *
- * @param {Object=} keysProved Keys owned by the sender of this event.
- *    See {@link module:models/event.MatrixEvent#getKeysProved}.
- *
- * @param {Object=} keysClaimed Keys the sender of this event claims.
- *    See {@link module:models/event.MatrixEvent#getKeysClaimed}.
- *
  * @prop {Object} event The raw (possibly encrypted) event. <b>Do not access
  * this property</b> directly unless you absolutely have to. Prefer the getter
  * methods defined on this class. Using the getter methods shields your app
@@ -75,22 +70,25 @@ module.exports.EventStatus = {
  * Default: true. <strong>This property is experimental and may change.</strong>
  */
 module.exports.MatrixEvent = function MatrixEvent(
-    event, clearEvent, keysProved, keysClaimed
+    event
 ) {
     this.event = event || {};
     this.sender = null;
     this.target = null;
     this.status = null;
     this.forwardLooking = true;
-
-    this._clearEvent = clearEvent || {};
     this._pushActions = null;
+    this._date = this.event.origin_server_ts ?
+        new Date(this.event.origin_server_ts) : null;
 
-    this._keysProved = keysProved || {};
-    this._keysClaimed = keysClaimed || {};
+    this._clearEvent = {};
+    this._keysProved = {};
+    this._keysClaimed = {};
 };
+utils.inherits(module.exports.MatrixEvent, EventEmitter);
 
-module.exports.MatrixEvent.prototype = {
+
+utils.extend(module.exports.MatrixEvent.prototype, {
 
     /**
      * Get the event_id for this event.
@@ -146,6 +144,14 @@ module.exports.MatrixEvent.prototype = {
         return this.event.origin_server_ts;
     },
 
+    /**
+     * Get the timestamp of this event, as a Date object.
+     * @return {Date} The event date, e.g. <code>new Date(1433502692297)</code>
+     */
+    getDate: function() {
+        return this._date;
+    },
+
     /**
      * Get the (decrypted, if necessary) event content JSON.
      *
@@ -239,12 +245,37 @@ module.exports.MatrixEvent.prototype = {
         this._keysClaimed = keys;
     },
 
+    /**
+     * Update the cleartext data on this event.
+     *
+     * (This is used after decrypting an event; it should not be used by applications).
+     *
+     * @internal
+     *
+     * @fires module:models/event.MatrixEvent#"Event.decrypted"
+     *
+     * @param {Object} clearEvent The plaintext payload for the event
+     *     (typically containing <tt>type</tt> and <tt>content</tt> fields).
+     *
+     * @param {Object=} keysProved Keys owned by the sender of this event.
+     *    See {@link module:models/event.MatrixEvent#getKeysProved}.
+     *
+     * @param {Object=} keysClaimed Keys the sender of this event claims.
+     *    See {@link module:models/event.MatrixEvent#getKeysClaimed}.
+     */
+    setClearData: function(clearEvent, keysProved, keysClaimed) {
+        this._clearEvent = clearEvent;
+        this._keysProved = keysProved || {};
+        this._keysClaimed = keysClaimed || {};
+        this.emit("Event.decrypted", this);
+    },
+
     /**
      * Check if the event is encrypted.
      * @return {boolean} True if this event is encrypted.
      */
     isEncrypted: function() {
-        return Boolean(this._clearEvent.type);
+        return this.event.type === "m.room.encrypted";
     },
 
     /**
@@ -353,7 +384,18 @@ module.exports.MatrixEvent.prototype = {
      setPushActions: function(pushActions) {
         this._pushActions = pushActions;
      },
-};
+
+     /**
+      * Replace the `event` property and recalculate any properties based on it.
+      * @param {Object} event the object to assign to the `event` property
+      */
+     handleRemoteEcho: function(event) {
+        this.event = event;
+        // successfully sent.
+        this.status = null;
+        this._date = new Date(this.event.origin_server_ts);
+     }
+});
 
 
 /* http://matrix.org/docs/spec/r0.0.1/client_server.html#redactions says:
@@ -394,3 +436,13 @@ var _REDACT_KEEP_CONTENT_MAP = {
                            },
     'm.room.aliases': {'aliases': 1},
 };
+
+
+/**
+ * Fires when an event is decrypted
+ *
+ * @event module:models/event.MatrixEvent#"Event.decrypted"
+ *
+ * @param {module:models/event.MatrixEvent} event
+ *    The matrix event which has been decrypted
+ */

src/models/room-state.js

@@ -253,7 +253,7 @@ RoomState.prototype.maySendMessage = function(userId) {
 /**
  * Returns true if the given user ID has permission to send a normal
  * event of type `eventType` into this room.
- * @param {string} type The type of event to test
+ * @param {string} eventType The type of event to test
  * @param {string} userId The user ID of the user to test permission for
  * @return {boolean} true if the given user ID should be permitted to send
  *                        the given type of event into this room,
@@ -267,8 +267,8 @@ RoomState.prototype.maySendEvent = function(eventType, userId) {
 /**
  * Returns true if the given MatrixClient has permission to send a state
  * event of type `stateEventType` into this room.
- * @param {string} type The type of state events to test
- * @param {MatrixClient}  The client to test permission for
+ * @param {string} stateEventType The type of state events to test
+ * @param {MatrixClient} cli The client to test permission for
  * @return {boolean} true if the given client should be permitted to send
  *                        the given type of state event into this room,
  *                        according to the room's state.
@@ -283,7 +283,7 @@ RoomState.prototype.mayClientSendStateEvent = function(stateEventType, cli) {
 /**
  * Returns true if the given user ID has permission to send a state
  * event of type `stateEventType` into this room.
- * @param {string} type The type of state events to test
+ * @param {string} stateEventType The type of state events to test
  * @param {string} userId The user ID of the user to test permission for
  * @return {boolean} true if the given user ID should be permitted to send
  *                        the given type of state event into this room,
@@ -296,7 +296,7 @@ RoomState.prototype.maySendStateEvent = function(stateEventType, userId) {
 /**
  * Returns true if the given user ID has permission to send a normal or state
  * event of type `eventType` into this room.
- * @param {string} type The type of event to test
+ * @param {string} eventType The type of event to test
  * @param {string} userId The user ID of the user to test permission for
  * @param {boolean} state If true, tests if the user may send a state
                           event of this type. Otherwise tests whether
@@ -314,18 +314,12 @@ RoomState.prototype._maySendEventOfType = function(eventType, userId, state) {
     var power_levels;
     var events_levels = {};
 
-    var default_user_level = 0;
-    var user_levels = [];
-
     var state_default = 0;
     var events_default = 0;
     if (power_levels_event) {
         power_levels = power_levels_event.getContent();
         events_levels = power_levels.events || {};
 
-        default_user_level = parseInt(power_levels.users_default || 0);
-        user_levels = power_levels.users || {};
-
         if (power_levels.state_default !== undefined) {
             state_default = power_levels.state_default;
         } else {

src/models/room.js

@@ -674,10 +674,7 @@ Room.prototype._handleRemoteEcho = function(remoteEvent, localEvent) {
 
     // replace the event source (this will preserve the plaintext payload if
     // any, which is good, because we don't want to try decoding it again).
-    localEvent.event = remoteEvent.event;
-
-    // successfully sent.
-    localEvent.status = null;
+    localEvent.handleRemoteEcho(remoteEvent.event);
 
     for (var i = 0; i < this._timelineSets.length; i++) {
         var timelineSet = this._timelineSets[i];
@@ -909,8 +906,6 @@ Room.prototype.recalculate = function(userId) {
         });
     }
 
-
-
     var oldName = this.name;
     this.name = calculateRoomName(this, userId);
     this.summary = new RoomSummary(this.roomId, {

src/store/session/webstorage.js

@@ -92,7 +92,7 @@ WebStorageSessionStore.prototype = {
      * @param {string} userId The user's ID.
      * @return {object} A map from device ID to keys for the device.
      */
-    getEndToEndDevicesForUser: function(userId)  {
+    getEndToEndDevicesForUser: function(userId) {
         return getJsonItem(this.store, keyEndToEndDevicesForUser(userId));
     },
 

src/sync.js

@@ -60,7 +60,9 @@ function debuglog() {
 function SyncApi(client, opts) {
     this.client = client;
     opts = opts || {};
-    opts.initialSyncLimit = opts.initialSyncLimit || 8;
+    opts.initialSyncLimit = (
+        opts.initialSyncLimit === undefined ? 8 : opts.initialSyncLimit
+    );
     opts.resolveInvitesToProfiles = opts.resolveInvitesToProfiles || false;
     opts.pollTimeout = opts.pollTimeout || (30 * 1000);
     opts.pendingEventOrdering = opts.pendingEventOrdering || "chronological";
@@ -542,6 +544,7 @@ SyncApi.prototype._sync = function(syncOptions) {
                 self._connectionReturnedDefer.reject();
                 self._connectionReturnedDefer = null;
             }
+            self._updateSyncState("STOPPED");
             return;
         }
         console.error("/sync error %s", err);
@@ -1013,7 +1016,7 @@ SyncApi.prototype._resolveInvites = function(room) {
  * @param {Room} room
  * @param {MatrixEvent[]} stateEventList A list of state events. This is the state
  * at the *START* of the timeline list if it is supplied.
- * @param {?MatrixEvent[]} timelineEventList A list of timeline events. Lower index
+ * @param {MatrixEvent[]} [timelineEventList] A list of timeline events. Lower index
  * is earlier in time. Higher index is later.
  */
 SyncApi.prototype._processRoomEvents = function(room, stateEventList,

src/timeline-window.js

@@ -234,7 +234,7 @@ TimelineWindow.prototype.paginate = function(direction, size, makeRequest,
         // remove some events from the other end, if necessary
         var excess = this._eventCount - this._windowLimit;
         if (excess > 0) {
-            this._unpaginate(excess, direction != EventTimeline.BACKWARDS);
+            this.unpaginate(excess, direction != EventTimeline.BACKWARDS);
         }
         return q(true);
     }
@@ -287,15 +287,13 @@ TimelineWindow.prototype.paginate = function(direction, size, makeRequest,
 
 
 /**
- * Trim the window to the windowlimit
+ * Remove `delta` events from the start or end of the timeline.
  *
  * @param {number}  delta           number of events to remove from the timeline
  * @param {boolean} startOfTimeline if events should be removed from the start
  *     of the timeline.
- *
- * @private
  */
-TimelineWindow.prototype._unpaginate = function(delta, startOfTimeline) {
+TimelineWindow.prototype.unpaginate = function(delta, startOfTimeline) {
     var tl = startOfTimeline ? this._start : this._end;
 
     // sanity-check the delta

src/utils.js

@@ -204,7 +204,8 @@ module.exports.isFunction = function(value) {
  * @return {boolean} True if it is an array.
  */
 module.exports.isArray = function(value) {
-    return Boolean(value && value.constructor === Array);
+    return Array.isArray ? Array.isArray(value) :
+        Boolean(value && value.constructor === Array);
 };
 
 /**
@@ -347,16 +348,12 @@ var deepCompare = module.exports.deepCompare = function(x, y) {
  */
 module.exports.extend = function() {
     var target = arguments[0] || {};
-    // disable jshint "The body of a for in should be wrapped in an if
-    // statement"
-    /* jshint -W089 */
     for (var i = 1; i < arguments.length; i++) {
         var source = arguments[i];
-        for (var propName in source) {
+        for (var propName in source) { // eslint-disable-line guard-for-in
             target[propName] = source[propName];
         }
     }
-    /* jshint +W089 */
     return target;
 };
 

src/webrtc/call.js

@@ -153,7 +153,7 @@ MatrixCall.prototype.placeScreenSharingCall =
 /**
  * Play the given HTMLMediaElement, serialising the operation into a chain
  * of promises to avoid racing access to the element
- * @param {Element} HTMLMediaElement element to play
+ * @param {Element} element HTMLMediaElement element to play
  * @param {string} queueId Arbitrary ID to track the chain of promises to be used
  */
 MatrixCall.prototype.playElement = function(element, queueId) {
@@ -183,7 +183,7 @@ MatrixCall.prototype.playElement = function(element, queueId) {
 /**
  * Pause the given HTMLMediaElement, serialising the operation into a chain
  * of promises to avoid racing access to the element
- * @param {Element} HTMLMediaElement element to pause
+ * @param {Element} element HTMLMediaElement element to pause
  * @param {string} queueId Arbitrary ID to track the chain of promises to be used
  */
 MatrixCall.prototype.pauseElement = function(element, queueId) {
@@ -209,7 +209,7 @@ MatrixCall.prototype.pauseElement = function(element, queueId) {
  * Assign the given HTMLMediaElement by setting the .src attribute on it,
  * serialising the operation into a chain of promises to avoid racing access
  * to the element
- * @param {Element} HTMLMediaElement element to pause
+ * @param {Element} element HTMLMediaElement element to pause
  * @param {string} src the src attribute value to assign to the element
  * @param {string} queueId Arbitrary ID to track the chain of promises to be used
  */
@@ -522,17 +522,16 @@ MatrixCall.prototype._gotUserMediaForInvite = function(stream) {
         }, 0);
     }
 
+    if (this.screenSharingStream) {
+        this.screenSharingStream.addTrack(stream.getAudioTracks()[0]);
+        stream = this.screenSharingStream;
+    }
+
     this.localAVStream = stream;
     // why do we enable audio (and only audio) tracks here? -- matthew
     setTracksEnabled(stream.getAudioTracks(), true);
     this.peerConn = _createPeerConnection(this);
     this.peerConn.addStream(stream);
-    if (this.screenSharingStream) {
-        console.log("Adding screen-sharing stream to peer connection");
-        this.peerConn.addStream(this.screenSharingStream);
-        // let's use this for the local preview...
-        this.localAVStream = this.screenSharingStream;
-    }
     this.peerConn.createOffer(
         hookCallback(self, self._gotLocalOffer),
         hookCallback(self, self._getLocalOfferFailed)
@@ -1144,14 +1143,6 @@ var _getChromeScreenSharingConstraints = function(call) {
         ));
         return;
     }
-    // it won't work at all if you're not on HTTPS so whine whine whine
-    if (!global.window || global.window.location.protocol !== "https:") {
-        call.emit("error", callError(
-            MatrixCall.ERR_NO_USER_MEDIA,
-            "You need to be using HTTPS to place a screen-sharing call."
-        ));
-        return;
-    }
 
     return {
         video: {