🏡 index : quine-global-labs/mirror-cockpit-project-cockpit.git

// SPDX-License-Identifier: LGPL-2.1-or-later
import QUnit from "qunit-tests";

interface ControlMessage {
    command: string;
    problem?: string;
    [key: string]: unknown;
}

function connect(): Promise<WebSocket> {
    const ws = new WebSocket(`ws://${window.location.host}/cockpit/socket`, "cockpit1");
    return new Promise((resolve, reject) => {
        ws.onopen = () => resolve(ws);
        ws.onerror = () => reject(new Error("WebSocket connection failed"));
    });
}

function send_control(ws: WebSocket, message: ControlMessage): void {
    ws.send("\n" + JSON.stringify(message));
}

function read_control(ws: WebSocket): Promise<ControlMessage> {
    return new Promise(resolve => {
        ws.onmessage = event => {
            const message = event.data as string;
            const pos = message.indexOf("\n");
            if (pos < 0)
                throw new Error("invalid message");

            const channel = message.substring(0, pos);
            const data = message.substring(pos + 1);

            if (channel === "") {
                resolve(JSON.parse(data) as ControlMessage);
            }
        };
    });
}

function read_text_data(ws: WebSocket, expected_channel: string): Promise<string> {
    const prefix = expected_channel + "\n";
    return new Promise((resolve, reject) => {
        ws.onmessage = event => {
            if (typeof event.data !== "string")
                return reject(new Error("expected text frame, got binary"));
            if (!event.data.startsWith(prefix))
                return reject(new Error(`expected channel ${expected_channel}, got: ${event.data}`));
            resolve(event.data.substring(prefix.length));
        };
    });
}

function read_binary_data(ws: WebSocket, expected_channel: string): Promise<Uint8Array> {
    const prefix = new TextEncoder().encode(expected_channel + "\n");
    return new Promise((resolve, reject) => {
        ws.onmessage = event => {
            if (!(event.data instanceof ArrayBuffer))
                return reject(new Error("expected binary frame, got text"));
            const frame = new Uint8Array(event.data);
            if (frame.length < prefix.length || !prefix.every((b, i) => frame[i] === b))
                return reject(new Error(`expected channel ${expected_channel}`));
            resolve(frame.subarray(prefix.length));
        };
    });
}

async function init(ws: WebSocket): Promise<string> {
    const message = await read_control(ws);
    if (message.command !== "init")
        throw new Error(`expected init, got ${message.command}`);
    const seed = message["channel-seed"];
    if (typeof seed !== "string")
        throw new Error("missing channel-seed in init message");
    send_control(ws, { command: "init", version: 1 });
    return seed;
}

/* Wait for close, returning the last message received */
async function wait_close(ws: WebSocket): Promise<ControlMessage> {
    const close_promise = new Promise(resolve => {
        ws.onclose = resolve;
    });
    const message = await read_control(ws);
    await close_promise;
    return message;
}

QUnit.test("first message from host is init", async assert => {
    const ws = await connect();

    try {
        const message = await read_control(ws);
        assert.strictEqual(message.command, "init");
        assert.strictEqual(message.version, 1);
        assert.ok("channel-seed" in message);
        assert.ok("host" in message);
        assert.ok("csrf-token" in message);
    } finally {
        ws.close();
    }
});

QUnit.test("host must ensure that init is the first message", async assert => {
    const ws = await connect();
    await read_control(ws); // skip the init

    // send something first that's not "init"
    send_control(ws, { command: "ping" });

    // make sure we get shut down
    const message = await wait_close(ws);
    assert.equal(message.command, "close");
    assert.equal(message.problem, "protocol-error");
});

QUnit.test("host tolerates payload message before init", async assert => {
    const ws = await connect();
    await read_control(ws); // skip the init

    // send payload message before init — the server should reject this
    // with a protocol-error (like it does for control messages before
    // init) but currently it silently ignores it.
    ws.send("somechannel\npayload");

    // connection should still work
    send_control(ws, { command: "init", version: 1 });
    send_control(ws, { command: "ping", still: "alive" });
    const pong = await read_control(ws);
    assert.equal(pong.command, "pong");
    assert.equal(pong.still, "alive");

    ws.close();
});

QUnit.test("server accepts extra init messages", async assert => {
    /* Old versions of the shell used to accidentally forward the init message
     * from each iframe to the webserver, and since a new webserver may be used
     * with old versions of the shell, we need to make sure the webserver
     * continues to accept multiple init messages without error.
     */
    const ws = await connect();

    try {
        // skip the init
        const init = await read_control(ws);
        assert.strictEqual(init.command, "init");

        // we need to send init first
        send_control(ws, { command: "init", version: 1 });

        // but after that additional init is ignored
        send_control(ws, { command: "init", version: 1 });

        // send a ping: if we get the pong then we survived the extra inits
        send_control(ws, { command: "ping", still: "alive" });
        const pong = await read_control(ws);
        assert.equal(pong.command, "pong", "got pong");
        assert.equal(pong.still, "alive", "still alive");
    } finally {
        ws.close();
    }
});

/*
 * cockpit-ws doesn't check the WebSocket frame type on inbound messages: it
 * just forwards them blindly to the bridge.  The information about if a
 * message was binary or text is inherently lost in the cockpit protocol, and
 * the bridge does the correct thing in all cases.
 *
 * The following three tests are meant to document the somewhat-broken status
 * quo.  This was never an intentionally-supported feature and should probably
 * be a hard error.  A testcase used to depend on the ability to send text data
 * to binary channels and has since been fixed.  We have no data on if actual
 * production code is also accidentally relying on this implementation quirk.
 */
QUnit.test("text frame on binary channel: response is binary", async assert => {
    const ws = await connect();
    ws.binaryType = "arraybuffer";
    const channel = await init(ws) + "1";

    send_control(ws, { command: "open", channel, payload: "echo", binary: "raw" });

    const ready = await read_control(ws);
    assert.equal(ready.command, "ready", "channel ready");

    // send a text frame on a binary channel
    ws.send(`${channel}\nhello`);

    // make sure it comes back as text
    const payload = await read_binary_data(ws, channel);
    assert.equal(new TextDecoder().decode(payload), "hello", "payload survived round-trip");

    ws.close();
});

QUnit.test("binary frame on text channel: response is text", async assert => {
    const ws = await connect();
    ws.binaryType = "arraybuffer";
    const channel = await init(ws) + "1";

    send_control(ws, { command: "open", channel, payload: "echo" });

    const ready = await read_control(ws);
    assert.equal(ready.command, "ready", "channel ready");

    // send a binary frame on a text channel
    ws.send(new TextEncoder().encode(`${channel}\nhello`));

    // make sure it comes back as text
    const payload = await read_text_data(ws, channel);
    assert.equal(payload, "hello", "payload survived round-trip");

    ws.close();
});

QUnit.test("non-utf8 on text channel is rejected by the bridge", async assert => {
    /* The bridge runs a strict UTF-8 decoder on text channels.  Invalid
     * bytes cause a protocol-error channel close — the data never reaches
     * cockpit-ws, which would g_critical() and drop it.
     */
    const ws = await connect();
    ws.binaryType = "arraybuffer";
    const channel = await init(ws) + "1";

    send_control(ws, { command: "open", channel, payload: "echo" });
    const ready = await read_control(ws);
    assert.equal(ready.command, "ready", "channel ready");

    // send invalid UTF-8 bytes via a binary frame on a text channel
    const header = new TextEncoder().encode(channel + "\n");
    const garbage = new Uint8Array([0x80, 0xff, 0xfe, 0xc0, 0xc1]);
    const frame = new Uint8Array(header.length + garbage.length);
    frame.set(header);
    frame.set(garbage, header.length);
    ws.send(frame);

    // the bridge closes the channel with a protocol-error
    const close = await read_control(ws);
    assert.equal(close.command, "close", "channel closed");
    assert.equal(close.channel, channel, "correct channel");
    assert.equal(close.problem, "protocol-error", "protocol-error due to invalid UTF-8");

    ws.close();
});

QUnit.module("tests that need test-server warnings disabled", hooks => {
    /*
     * Some of these tests will trigger cockpit-ws or cockpit-bridge to print out
     * warnings (on protocol errors, for example). Let the test server know that
     * before starting the tests, so it doesn't treat those messages as fatal.
     */

    // hooks wait for the promise to be resolved before continuing
    hooks.before(async () => { await fetch("/mock/expect-warnings") });
    hooks.after(async () => { await fetch("/mock/dont-expect-warnings") });

    QUnit.test("host must return an error when 'channel' is not given in 'open'", async assert => {
        const ws = await connect();
        await read_control(ws); // skip the init

        send_control(ws, { command: "init", version: 1 });

        // this is broken
        send_control(ws, { command: "open", payload: "fsread", path: "/etc/passwd" });

        // wait for the shutdown
        const message = await wait_close(ws);
        assert.equal(message.command, "close");
        assert.equal(message.problem, "protocol-error");
    });

    QUnit.test("host ignores frame without newline", async assert => {
        const ws = await connect();
        await read_control(ws); // skip the init

        send_control(ws, { command: "init", version: 1 });

        // send a frame without a newline — this should be a
        // protocol-error, but currently it's silently ignored.
        ws.send("no newline here");

        // connection should still work - verify with ping/pong
        send_control(ws, { command: "ping", test: "still-alive" });
        const pong = await read_control(ws);
        assert.equal(pong.command, "pong");
        assert.equal(pong.test, "still-alive");

        ws.close();
    });

    QUnit.test("host rejects control message that is not an object (array)", async assert => {
        const ws = await connect();
        await read_control(ws); // skip the init

        send_control(ws, { command: "init", version: 1 });

        // send a control message that's an array, not an object
        ws.send("\n[1, 2, 3]");

        const message = await wait_close(ws);
        assert.equal(message.command, "close");
        assert.equal(message.problem, "protocol-error");
    });

    QUnit.test("host rejects control message that is not an object (null)", async assert => {
        const ws = await connect();
        await read_control(ws); // skip the init

        send_control(ws, { command: "init", version: 1 });

        // send a control message that's null
        ws.send("\nnull");

        const message = await wait_close(ws);
        assert.equal(message.command, "close");
        assert.equal(message.problem, "protocol-error");
    });

    QUnit.test("host rejects control message with invalid JSON", async assert => {
        const ws = await connect();
        await read_control(ws); // skip the init

        send_control(ws, { command: "init", version: 1 });

        // send invalid JSON
        ws.send("\n{not valid json}");

        const message = await wait_close(ws);
        assert.equal(message.command, "close");
        assert.equal(message.problem, "protocol-error");
    });

    QUnit.test("host rejects control message without command", async assert => {
        const ws = await connect();
        await read_control(ws); // skip the init

        send_control(ws, { command: "init", version: 1 });

        // send a control message without "command" field
        ws.send('\n{"channel": "test"}');

        const message = await wait_close(ws);
        assert.equal(message.command, "close");
        assert.equal(message.problem, "protocol-error");
    });

    QUnit.test("host rejects empty control message", async assert => {
        const ws = await connect();
        await read_control(ws); // skip the init

        send_control(ws, { command: "init", version: 1 });

        // send an empty object as a control message
        ws.send("\n{}");

        const message = await wait_close(ws);
        assert.equal(message.command, "close");
        assert.equal(message.problem, "protocol-error");
    });
});

QUnit.start();