matrix-js-sdk/spec/unit/crypto/verification/sas.spec.js

/*
Copyright 2018-2019 New Vector 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.
*/

try {
    global.Olm = require('olm');
} catch (e) {
    console.warn("unable to run device verification tests: libolm not available");
}

import expect from 'expect';

import sdk from '../../../..';

import {verificationMethods} from '../../../../lib/crypto';
import DeviceInfo from '../../../../lib/crypto/deviceinfo';

import SAS from '../../../../lib/crypto/verification/SAS';

const Olm = global.Olm;

const MatrixEvent = sdk.MatrixEvent;

import {makeTestClients} from './util';

describe("SAS verification", function() {
    if (!global.Olm) {
        console.warn('Not running device verification unit tests: libolm not present');
        return;
    }

    beforeEach(async function() {
        await Olm.init();
    });

    it("should error on an unexpected event", async function() {
        const sas = new SAS({}, "@alice:example.com", "ABCDEFG");
        sas.handleEvent(new MatrixEvent({
            sender: "@alice:example.com",
            type: "es.inquisition",
            content: {},
        }));
        const spy = expect.createSpy();
        await sas.verify()
            .catch(spy);
        expect(spy).toHaveBeenCalled();
    });

    it("should verify a key", async function() {
        const [alice, bob] = await makeTestClients(
            [
                {userId: "@alice:example.com", deviceId: "Osborne2"},
                {userId: "@bob:example.com", deviceId: "Dynabook"},
            ],
            {
                verificationMethods: [verificationMethods.SAS],
            },
        );

        alice.setDeviceVerified = expect.createSpy();
        alice.getDeviceEd25519Key = () => {
            return "alice+base64+ed25519+key";
        };
        alice.getStoredDevice = () => {
            return DeviceInfo.fromStorage(
                {
                    keys: {
                        "ed25519:Dynabook": "bob+base64+ed25519+key",
                    },
                },
                "Dynabook",
            );
        };
        alice.downloadKeys = () => {
            return Promise.resolve();
        };

        bob.setDeviceVerified = expect.createSpy();
        bob.getStoredDevice = () => {
            return DeviceInfo.fromStorage(
                {
                    keys: {
                        "ed25519:Osborne2": "alice+base64+ed25519+key",
                    },
                },
                "Osborne2",
            );
        };
        bob.getDeviceEd25519Key = () => {
            return "bob+base64+ed25519+key";
        };
        bob.downloadKeys = () => {
            return Promise.resolve();
        };

        let aliceSasEvent;
        let bobSasEvent;

        const bobPromise = new Promise((resolve, reject) => {
            bob.on("crypto.verification.start", (verifier) => {
                verifier.on("show_sas", (e) => {
                    if (!e.sas.emoji || !e.sas.decimal) {
                        e.cancel();
                    } else if (!aliceSasEvent) {
                        bobSasEvent = e;
                    } else {
                        try {
                            expect(e.sas).toEqual(aliceSasEvent.sas);
                            e.confirm();
                            aliceSasEvent.confirm();
                        } catch (error) {
                            e.mismatch();
                            aliceSasEvent.mismatch();
                        }
                    }
                });
                resolve(verifier);
            });
        });

        const aliceVerifier = alice.beginKeyVerification(
            verificationMethods.SAS, bob.getUserId(), bob.deviceId,
        );
        aliceVerifier.on("show_sas", (e) => {
            if (!e.sas.emoji || !e.sas.decimal) {
                e.cancel();
            } else if (!bobSasEvent) {
                aliceSasEvent = e;
            } else {
                try {
                    expect(e.sas).toEqual(bobSasEvent.sas);
                    e.confirm();
                    bobSasEvent.confirm();
                } catch (error) {
                    e.mismatch();
                    bobSasEvent.mismatch();
                }
            }
        });
        await Promise.all([
            aliceVerifier.verify(),
            bobPromise.then((verifier) => verifier.verify()),
        ]);
        expect(alice.setDeviceVerified)
            .toHaveBeenCalledWith(bob.getUserId(), bob.deviceId);
        expect(bob.setDeviceVerified)
            .toHaveBeenCalledWith(alice.getUserId(), alice.deviceId);
    });

    it("should send a cancellation message on error", async function() {
        const [alice, bob] = await makeTestClients(
            [
                {userId: "@alice:example.com", deviceId: "Osborne2"},
                {userId: "@bob:example.com", deviceId: "Dynabook"},
            ],
            {
                verificationMethods: [verificationMethods.SAS],
            },
        );
        alice.setDeviceVerified = expect.createSpy();
        alice.downloadKeys = () => {
            return Promise.resolve();
        };
        bob.setDeviceVerified = expect.createSpy();
        bob.downloadKeys = () => {
            return Promise.resolve();
        };

        const bobPromise = new Promise((resolve, reject) => {
            bob.on("crypto.verification.start", (verifier) => {
                verifier.on("show_sas", (e) => {
                    e.mismatch();
                });
                resolve(verifier);
            });
        });

        const aliceVerifier = alice.beginKeyVerification(
            verificationMethods.SAS, bob.getUserId(), bob.deviceId,
        );

        const aliceSpy = expect.createSpy();
        const bobSpy = expect.createSpy();
        await Promise.all([
            aliceVerifier.verify().catch(aliceSpy),
            bobPromise.then((verifier) => verifier.verify()).catch(bobSpy),
        ]);
        expect(aliceSpy).toHaveBeenCalled();
        expect(bobSpy).toHaveBeenCalled();
        expect(alice.setDeviceVerified)
            .toNotHaveBeenCalled();
        expect(bob.setDeviceVerified)
            .toNotHaveBeenCalled();
    });
});