signal-desktop/ts/test-node/util/privacy_test.ts

// Copyright 2018 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only

import { assert } from 'chai';

import * as Privacy from '../../util/privacy';
import { APP_ROOT_PATH } from '../../util/privacy';

Privacy.addSensitivePath('sensitive-path');

describe('Privacy', () => {
  describe('redactCardNumbers', () => {
    it('should redact anything that looks like a credit card', () => {
      const text =
        'This is a log line with a card number 1234-1234-1234\n' +
        'and another one 1234 1234 1234 1234 123';

      const actual = Privacy.redactCardNumbers(text);
      const expected =
        'This is a log line with a card number [REDACTED]\n' +
        'and another one [REDACTED]';
      assert.equal(actual, expected);
    });

    it('should redact weird credit card numbers', () => {
      const text =
        '12341234123\n' +
        '123412341234\n' +
        '1234123412341\n' +
        '12341234123412\n' +
        '123412341234123\n' +
        '1234123412341234\n' +
        '12341234123412341\n' +
        '123412341234123412\n' +
        '1234123412341234123\n' +
        '12341234123412341234\n' +
        '1-2-3-4-1-2-3-4-1-2-3\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1-2\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1-2-3\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1-2-3-4\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1-2-3-4-1\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1-2-3-4-1-2\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1-2-3-4-1-2-3\n' +
        '1-2-3-4-1-2-3-4-1-2-3-4-1-2-3-4-1-2-3-4\n' +
        '1 2 3 4 1 2 3 4 1 2 3\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2 3\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 1\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 1 2\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 1 2 3\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4\n' +
        '1 2 3 a 4 1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4\n' +
        '1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 1 a 2 3 4\n' +
        '';

      const actual = Privacy.redactCardNumbers(text);
      const expected =
        '12341234123\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]4\n' +
        '1-2-3-4-1-2-3-4-1-2-3\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]-4\n' +
        '1 2 3 4 1 2 3 4 1 2 3\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED]\n' +
        '[REDACTED] 4\n' +
        '1 2 3 a [REDACTED]\n' +
        '[REDACTED] a 2 3 4\n' +
        '';
      assert.equal(actual, expected);
    });

    it('should not redact things that are close to credit card numbers', () => {
      const text = `
        12--3412341234
        1234123  412341234
        1e23412341234
      `;

      const actual = Privacy.redactCardNumbers(text);
      const expected = `
        12--3412341234
        1234123  412341234
        1e23412341234
      `;
      assert.equal(actual, expected);
    });
  });

  describe('redactPhoneNumbers', () => {
    it('should redact all phone numbers', () => {
      const text =
        'This is a log line with a phone number +12223334455\n' +
        'and another one +13334445566';

      const actual = Privacy.redactPhoneNumbers(text);
      const expected =
        'This is a log line with a phone number +[REDACTED]455\n' +
        'and another one +[REDACTED]566';
      assert.equal(actual, expected);
    });
  });

  describe('redactUuids', () => {
    it('should redact all uuids', () => {
      const text =
        'This is a log line with a uuid 9e420799-acdf-4bf4-8dee-353d7e2096b4\n' +
        'and another one IN ALL UPPERCASE 340727FB-E43A-413B-941B-AADA033B6CA3\n' +
        'and a v7 uuid: 019291b5-fea7-7007-9261-31ca82451a6e\n' +
        'and my story: 00000000-0000-0000-0000-000000000000';

      const actual = Privacy.redactUuids(text);
      const expected =
        'This is a log line with a uuid [REDACTED]6b4\n' +
        'and another one IN ALL UPPERCASE [REDACTED]CA3\n' +
        'and a v7 uuid: [REDACTED]a6e\n' +
        'and my story: [REDACTED]000';
      assert.equal(actual, expected);
    });
  });

  describe('redactGroupIds', () => {
    it('should redact all group IDs', () => {
      const text =
        'This is a log line with two group IDs: group(123456789)\n' +
        'and group(abcdefghij)';

      const actual = Privacy.redactGroupIds(text);
      const expected =
        'This is a log line with two group IDs: group([REDACTED]789)\n' +
        'and group([REDACTED]hij)';
      assert.equal(actual, expected);
    });

    it('should remove newlines from redacted group IDs', () => {
      const text =
        'This is a log line with two group IDs: group(12345678\n9)\n' +
        'and group(abc\ndefghij)';

      const actual = Privacy.redactGroupIds(text);
      const expected =
        'This is a log line with two group IDs: group([REDACTED]789)\n' +
        'and group([REDACTED]hij)';
      assert.equal(actual, expected);
    });

    it('should remove newlines from redacted group V2 IDs', () => {
      const text =
        'This is a log line with three group IDs: groupv2(abcd32341a==)\n' +
        'and groupv2(abcd32341ad=) and and groupv2(abcd32341ade)';

      const actual = Privacy.redactGroupIds(text);
      const expected =
        'This is a log line with three group IDs: groupv2([REDACTED]41a==)\n' +
        'and groupv2([REDACTED]1ad=) and and groupv2([REDACTED]ade)';
      assert.equal(actual, expected);
    });
  });

  describe('redactCallLinkRoomIds', () => {
    it('should redact call link room IDs', () => {
      const text =
        'Log line with call link room ID 7f3d431d4512b30754915a262db43cd789f799d710525a83429d48aee8c2cd4b\n' +
        'and another IN ALL UPPERCASE 7F3D431D4512B30754915A262DB43CD789F799D710525A83429D48AEE8C2CD4B';

      const actual = Privacy.redactCallLinkRoomIds(text);
      const expected =
        'Log line with call link room ID [REDACTED]d4b\n' +
        'and another IN ALL UPPERCASE [REDACTED]D4B';
      assert.equal(actual, expected);
    });
  });

  describe('redactCallLinkRootKeys', () => {
    it('should redact call link root keys', () => {
      const text =
        'Log line with call link https://signal.link/call/#key=hktt-kskq-dhcn-bgkm-hbbg-qqkq-sfbp-czmc\n' +
        'and another IN ALL UPPERCASE HKTT-KSKQ-DHCN-BGKM-HBBG-QQKQ-SFBP-CZMC';

      const actual = Privacy.redactCallLinkRootKeys(text);
      const expected =
        'Log line with call link https://signal.link/call/#key=[REDACTED]hktt\n' +
        'and another IN ALL UPPERCASE [REDACTED]HKTT';
      assert.equal(actual, expected);
    });
  });

  describe('redactAttachmentUrlKeys', () => {
    it('should redact key= values ', () => {
      const text =
        'Log line with url attachment://v2/e6/abcdee64?key=hxKJ9cTfK0v3KEsnzJ2j%2F4Crwe0yu&size=39360&contentType=png ' +
        'and another already partially redacted attachment://v2/e6/[REDACTED]?LOCALKEY=hxKJ9cTfK0v3KEsnzJ2j%2F4Crwe0yu&size=39360&contentType=png';

      const actual = Privacy.redactAttachmentUrlKeys(text);
      const expected =
        'Log line with url attachment://v2/e6/abcdee64?key=[REDACTED] ' +
        'and another already partially redacted attachment://v2/e6/[REDACTED]?LOCALKEY=[REDACTED]';
      assert.equal(actual, expected);
    });
  });

  describe('redactAttachmentUrl', () => {
    it('should remove search params ', () => {
      const url =
        'attachment://v2/e6/abcdee64?key=hxKJ9cTfK0v3KEsnzJ2j%2F4Crwe0yu&size=39360&contentType=png';
      const actual = Privacy.redactAttachmentUrl(url);
      const expected = 'attachment://v2/e6/abcdee64';
      assert.equal(actual, expected);
    });
  });

  describe('redactAll', () => {
    it('should redact all sensitive information', () => {
      const encodedAppRootPath = APP_ROOT_PATH.replace(/ /g, '%20');
      const text =
        'This is a log line with sensitive information:\n' +
        `path1 ${APP_ROOT_PATH}/main.js\n` +
        'phone1 +12223334455 ipsum\n' +
        'group1 group(123456789) doloret\n' +
        `path2 file:///${encodedAppRootPath}/js/background.js.` +
        'phone2 +13334445566 lorem\n' +
        'group2 group(abcdefghij) doloret\n' +
        'path3 sensitive-path/attachment.noindex\n' +
        'cc 1234 1234 1234 1234 and another 1234123412341234\n' +
        'attachment://v2/ab/abcde?key=specialkey\n';

      const actual = Privacy.redactAll(text);
      const expected =
        'This is a log line with sensitive information:\n' +
        'path1 [REDACTED]/main.js\n' +
        'phone1 +[REDACTED]455 ipsum\n' +
        'group1 group([REDACTED]789) doloret\n' +
        'path2 [REDACTED]/js/background.js.' +
        'phone2 +[REDACTED]566 lorem\n' +
        'group2 group([REDACTED]hij) doloret\n' +
        'path3 [REDACTED]/attachment.noindex\n' +
        'cc [REDACTED] and another [REDACTED]\n' +
        'attachment://v2/ab/abcde?key=[REDACTED]\n';
      assert.equal(actual, expected);
    });
  });

  describe('_redactPath', () => {
    it('should redact file paths', () => {
      const testPath = '/Users/meow/Library/Application Support/Signal Beta';
      const text =
        'This is a log line with sensitive information:\n' +
        `path1 ${testPath}/main.js\n` +
        'phone1 +12223334455 ipsum\n';

      const actual = Privacy._redactPath(testPath)(text);
      const expected =
        'This is a log line with sensitive information:\n' +
        'path1 [REDACTED]/main.js\n' +
        'phone1 +12223334455 ipsum\n';
      assert.equal(actual, expected);
    });

    it('should redact URL-encoded paths', () => {
      const testPath = '/Users/meow/Library/Application Support/Signal Beta';
      const encodedTestPath = encodeURI(testPath);
      const text =
        'This is a log line with sensitive information:\n' +
        `path1 ${testPath}/main.js\n` +
        'phone1 +12223334455 ipsum\n' +
        'group1 group(123456789) doloret\n' +
        `path2 file:///${encodedTestPath}/js/background.js.`;

      const actual = Privacy._redactPath(testPath)(text);
      const expected =
        'This is a log line with sensitive information:\n' +
        'path1 [REDACTED]/main.js\n' +
        'phone1 +12223334455 ipsum\n' +
        'group1 group(123456789) doloret\n' +
        'path2 [REDACTED]/js/background.js.';
      assert.equal(actual, expected);
    });

    it('should redact stack traces with both forward and backslashes', () => {
      const testPath =
        'C:/Users/Meow/AppData/Local/Programs/signal-desktop-beta';
      const modifiedTestPath =
        'C:\\Users\\Meow\\AppData\\Local\\Programs\\signal-desktop-beta';
      const text =
        'This is a log line with sensitive information:\n' +
        `path1 ${testPath}\\main.js\n` +
        'phone1 +12223334455 ipsum\n' +
        'group1 group(123456789) doloret\n' +
        `path2 ${modifiedTestPath}\\js\\background.js.`;

      const actual = Privacy._redactPath(testPath)(text);
      const expected =
        'This is a log line with sensitive information:\n' +
        'path1 [REDACTED]\\main.js\n' +
        'phone1 +12223334455 ipsum\n' +
        'group1 group(123456789) doloret\n' +
        'path2 [REDACTED]\\js\\background.js.';
      assert.equal(actual, expected);
    });

    it('should redact stack traces with escaped backslashes', () => {
      const testPath =
        'C:\\Users\\Meow\\AppData\\Local\\Programs\\signal-desktop-beta';
      const modifiedTestPath =
        'C:\\\\Users\\\\Meow\\\\AppData\\\\Local\\\\Programs\\\\signal-desktop-beta';
      const text =
        'This is a log line with sensitive information:\n' +
        `path1 ${testPath}\\main.js\n` +
        'phone1 +12223334455 ipsum\n' +
        'group1 group(123456789) doloret\n' +
        `path2 ${modifiedTestPath}\\js\\background.js.`;

      const actual = Privacy._redactPath(testPath)(text);
      const expected =
        'This is a log line with sensitive information:\n' +
        'path1 [REDACTED]\\main.js\n' +
        'phone1 +12223334455 ipsum\n' +
        'group1 group(123456789) doloret\n' +
        'path2 [REDACTED]\\js\\background.js.';
      assert.equal(actual, expected);
    });
  });
});