GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still https://gitweb.torproject.org/ https://git.torproject.org/ and git-rw.torproject.org.

BrowserBundleTests.pm 35.6 KB
Newer Older
1
package TBBTestSuite::TestSuite::BrowserBundleTests;
2 3 4

use warnings;
use strict;
boklm's avatar
boklm committed
5 6 7

use parent 'TBBTestSuite::TestSuite';

8 9 10 11 12 13 14
use English;
use FindBin;
use File::Slurp;
use File::Spec;
use File::Find;
use File::Type;
use File::Copy;
15
use File::Temp;
16 17 18
use JSON;
use Digest::SHA qw(sha256_hex);
use LWP::UserAgent;
boklm's avatar
boklm committed
19
use IO::CaptureOutput qw(capture_exec);
20
use TBBTestSuite::Common qw(exit_error winpath clone_strip_coderef screenshot_thumbnail);
21 22
use TBBTestSuite::Options qw($options);
use TBBTestSuite::Tests::VirusTotal qw(virustotal_run);
23
use TBBTestSuite::Tests::Command qw(command_run);
24
use TBBTestSuite::Tests::TorBootstrap;
boklm's avatar
boklm committed
25
use TBBTestSuite::XServer qw(start_X stop_X set_Xmode);
26

boklm's avatar
boklm committed
27 28 29
sub test_types {
    return {
        tor_bootstrap => \&TBBTestSuite::Tests::TorBootstrap::start_tor,
30
        marionette    => \&marionette_run,
boklm's avatar
boklm committed
31 32 33 34
        virustotal    => \&virustotal_run,
        command       => \&command_run,
    };
}
35

boklm's avatar
boklm committed
36 37 38
sub type {
    'browserbundle';
}
39

boklm's avatar
boklm committed
40 41 42
sub description {
    'Tor Browser Bundle integration tests';
}
43

44
our @tests = (
boklm's avatar
boklm committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
    {
        name         => 'win_DEP_ASLR',
        type         => 'command',
        retry        => 1,
        descr        => 'Check DEP/ASLR',
        files        => \&tbb_binfiles,
        command      => [ "$FindBin::Bin/data/check-windows-dep-aslr.sh" ],
        enable       => sub { $_[0]->{os} eq 'Windows' },
        # ticket 16417
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/_ctypes.pyd
            TorBrowser/Tor/PluggableTransports/_hashlib.pyd
            TorBrowser/Tor/PluggableTransports/_socket.pyd
            TorBrowser/Tor/PluggableTransports/_ssl.pyd
            TorBrowser/Tor/PluggableTransports/bz2.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Cipher._AES.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Hash._SHA256.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Hash._SHA512.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Random.OSRNG.winrandom.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Util._counter.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Util.strxor.pyd
            TorBrowser/Tor/PluggableTransports/flashproxy-client.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-appspot.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-email.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-http.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-url.exe
            TorBrowser/Tor/PluggableTransports/fte.cDFA.pyd
            TorBrowser/Tor/PluggableTransports/fteproxy.exe
            TorBrowser/Tor/PluggableTransports/M2Crypto.__m2crypto.pyd
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser.exe
            TorBrowser/Tor/PluggableTransports/meek-client.exe
            TorBrowser/Tor/PluggableTransports/obfs4proxy.exe
            TorBrowser/Tor/PluggableTransports/obfsproxy.exe
            TorBrowser/Tor/PluggableTransports/pyexpat.pyd
            TorBrowser/Tor/PluggableTransports/python27.dll
            TorBrowser/Tor/PluggableTransports/select.pyd
            TorBrowser/Tor/PluggableTransports/terminateprocess-buffer.exe
            TorBrowser/Tor/PluggableTransports/unicodedata.pyd
            TorBrowser/Tor/PluggableTransports/w9xpopen.exe
            TorBrowser/Tor/PluggableTransports/zope.interface._zope_interface_coptimizations.pyd
            ) ],
    },
87
    {
boklm's avatar
boklm committed
88 89 90 91 92 93 94 95
        name            => 'readelf_RELRO',
        type            => 'command',
        descr           => 'Check if binaries are RELocation Read-Only',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-ld' ],
        check_output    => sub { ( $_[0] =~ m/GNU_RELRO/ )
                                 && ( $_[0] =~ m/BIND_NOW/ ) },
        enable          => sub { $OSNAME eq 'linux' },
boklm's avatar
boklm committed
96 97 98 99 100 101
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
            ) ],
102 103
    },
    {
boklm's avatar
boklm committed
104 105 106 107 108 109 110
        name            => 'readelf_stack_canary',
        type            => 'command',
        descr           => 'Check for stack canary support',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-s' ],
        check_output    => sub { $_[0] =~ m/__stack_chk_fail/ },
        enable          => sub { $OSNAME eq 'linux' },
boklm's avatar
boklm committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
        # ticket 13056
        skip_files   => [ qw(
            libmozalloc.so
            libnssckbi.so
            libplc4.so
            libplds4.so
            TorBrowser/Tor/libstdc++.so.6
            TorBrowser/Tor/PluggableTransports/Crypto/Cipher/_ARC4.so
            TorBrowser/Tor/PluggableTransports/Crypto/Cipher/_XOR.so
            TorBrowser/Tor/PluggableTransports/Crypto/Util/_counter.so
            TorBrowser/Tor/PluggableTransports/fte/cDFA.so
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/twisted/python/_initgroups.so
            TorBrowser/Tor/PluggableTransports/twisted/runner/portmap.so
            TorBrowser/Tor/PluggableTransports/twisted/test/raiser.so
            TorBrowser/Tor/PluggableTransports/zope/interface/_zope_interface_coptimizations.so
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/obfs4proxy
            ) ],
130 131
    },
    {
boklm's avatar
boklm committed
132 133 134 135 136 137 138
        name            => 'readelf_NX',
        type            => 'command',
        descr           => 'Check for NX support',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-W', '-l' ],
        check_output    => sub { ! ($_[0] =~ m/GNU_STACK.+RWE/) },
        enable          => sub { $OSNAME eq 'linux' },
139 140
    },
    {
boklm's avatar
boklm committed
141 142 143 144 145 146 147
        name            => 'readelf_PIE',
        type            => 'command',
        descr           => 'Check for PIE support',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-h' ],
        check_output    => sub { $_[0] =~ m/Type:\s+DYN/ },
        enable          => sub { $OSNAME eq 'linux' },
boklm's avatar
boklm committed
148 149 150 151 152
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
            ) ],
153 154
    },
    {
boklm's avatar
boklm committed
155 156 157 158 159 160 161
        name            => 'readelf_no_rpath',
        type            => 'command',
        descr           => 'Check for no rpath',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-d' ],
        check_output    => sub { ! ( $_[0] =~ m/RPATH/ ) },
        enable          => sub { $OSNAME eq 'linux' },
162 163
    },
    {
boklm's avatar
boklm committed
164 165 166 167 168 169 170
        name            => 'readelf_no_runpath',
        type            => 'command',
        descr           => 'Check for no runpath',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-d' ],
        check_output    => sub { ! ( $_[0] =~ m/runpath/ ) },
        enable          => sub { $OSNAME eq 'linux' },
171
    },
boklm's avatar
boklm committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
    {
        name            => 'otool_PIE',
        type            => 'command',
        descr           => 'Check for PIE support',
        files           => \&tbb_osx_executable_files,
        command         => [ 'otool', '-hv' ],
        check_output    => sub {
            my @lines = split("\n", $_[0]);
            my $last_line = pop @lines;
            my ($flags) = $last_line =~ m/^\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+(.*)/;
            my %flags = map { $_ => 1 } split(/\s+/, $flags);
            return $flags{PIE};
        },
        enable          => sub { $OSNAME eq 'darwin' },
        retry           => 1,
boklm's avatar
boklm committed
187 188 189 190 191
        skip_files   => [ qw(
            Contents/MacOS/Tor/PluggableTransports/meek-client
            Contents/MacOS/Tor/PluggableTransports/meek-client-torbrowser
            Contents/MacOS/Tor/PluggableTransports/obfs4proxy
            ) ],
boklm's avatar
boklm committed
192
    },
193
    {
boklm's avatar
boklm committed
194 195 196 197 198
        name            => 'tor_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
199
        run_once        => 1,
200 201
    },
    {
boklm's avatar
boklm committed
202 203 204
        name            => 'tor_bridge',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge',
205
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
206
        run_once        => 1,
207 208
    },
    {
boklm's avatar
boklm committed
209 210 211 212
        name            => 'tor_bridge_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge and an http proxy',
        httpproxy       => 1,
213
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
214
        run_once        => 1,
215 216
    },
    {
boklm's avatar
boklm committed
217 218 219
        name            => 'tor_obfs3',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs3',
220
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
221
        run_once        => 1,
222 223
    },
    {
boklm's avatar
boklm committed
224 225 226 227
        name            => 'tor_obfs3_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs3 and an http proxy',
        httpproxy       => 1,
228
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
229
        run_once        => 1,
230
    },
231
    {
boklm's avatar
boklm committed
232 233 234
        name            => 'tor_obfs4',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4',
235
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
236
        run_once        => 1,
237 238
    },
    {
boklm's avatar
boklm committed
239 240 241 242
        name            => 'tor_obfs4_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4 and an http proxy',
        httpproxy       => 1,
243
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
244
        run_once        => 1,
245
    },
246
    {
boklm's avatar
boklm committed
247 248 249
        name            => 'tor_fte',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using fteproxy',
250
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
251
        run_once        => 1,
252 253
    },
    {
boklm's avatar
boklm committed
254 255 256 257
        name            => 'tor_fte_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using fteproxy and an http proxy',
        httpproxy       => 1,
258
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
259
        run_once        => 1,
260
    },
261 262 263 264
    {
        name            => 'tor_scramblesuit',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using scramblesuit',
265
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
266
        run_once        => 1,
267 268 269 270 271 272
    },
    {
        name            => 'tor_scramblesuit_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using scramblesuit and an http proxy',
        httpproxy       => 1,
273
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
274
        run_once        => 1,
275
    },
276 277 278 279
    {
        name            => 'tor_meek-amazon',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-amazon',
280
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
281
        run_once        => 1,
282 283 284 285 286
    },
    {
        name            => 'tor_meek-azure',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-azure',
287
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
288
        run_once        => 1,
289
    },
290
    {
boklm's avatar
boklm committed
291 292 293 294 295
        name            => 'tor_bootstrap',
        type            => 'tor_bootstrap',
        descr           => 'Check that we can bootstrap tor',
        fail_type       => 'fatal',
        no_kill         => 1,
296 297 298
        use_default_config => 1,
    },
    {
boklm's avatar
boklm committed
299
        name            => 'screenshots',
300
        type            => 'marionette',
boklm's avatar
boklm committed
301
        descr           => 'Take some screenshots',
302 303
    },
    {
boklm's avatar
boklm committed
304
        name            => 'check',
305
        type            => 'marionette',
boklm's avatar
boklm committed
306 307
        use_net         => 1,
        descr           => 'Check that http://check.torproject.org/ think we are using tor',
308 309
    },
    {
boklm's avatar
boklm committed
310
        name            => 'https-everywhere',
311
        type            => 'marionette',
boklm's avatar
boklm committed
312 313
        use_net         => 1,
        descr           => 'Check that https everywhere is enabled and working',
314 315
    },
    {
boklm's avatar
boklm committed
316
        name            => 'https-everywhere-disabled',
317 318
        marionette_test => 'https-everywhere',
        type            => 'marionette',
boklm's avatar
boklm committed
319 320
        descr           => 'Check that https everywhere is not doing anything when disabled',
        use_net         => 1,
boklm's avatar
boklm committed
321 322 323
        prefs           => {
            'extensions.https_everywhere.globalEnabled' => 'false',
        },
324 325
    },
    {
boklm's avatar
boklm committed
326
        name            => 'settings',
327
        type            => 'marionette',
boklm's avatar
boklm committed
328
        descr           => 'Check that some important settings are correctly set',
329
    },
boklm's avatar
boklm committed
330
    {
boklm's avatar
boklm committed
331
        name            => 'acid3',
boklm's avatar
boklm committed
332
        type            => 'marionette',
boklm's avatar
boklm committed
333 334
        descr           => 'acid3 tests',
        use_net         => 1,
boklm's avatar
boklm committed
335
        retry           => 4,
boklm's avatar
boklm committed
336 337
        # the acid3 test is disabled for now
        enable          => sub { 0; },
boklm's avatar
boklm committed
338
    },
boklm's avatar
boklm committed
339
    {
boklm's avatar
boklm committed
340
        name            => 'slider_settings_1',
341 342
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
343 344 345 346
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 1,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
347 348
    },
    {
boklm's avatar
boklm committed
349
        name            => 'slider_settings_2',
350 351
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
352 353 354 355
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 2,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
356 357
    },
    {
boklm's avatar
boklm committed
358
        name            => 'slider_settings_3',
359 360
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
361 362
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 3,
363
        enable          => sub { $_[0]->{version} =~ m/^6.0/ },
boklm's avatar
boklm committed
364 365
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
366 367
    },
    {
boklm's avatar
boklm committed
368
        name            => 'slider_settings_4',
369 370
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
371 372 373 374
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 4,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
375
    },
boklm's avatar
boklm committed
376
    {
boklm's avatar
boklm committed
377
        name            => 'dom-objects-enumeration',
378
        type            => 'marionette',
boklm's avatar
boklm committed
379
        descr           => 'Check the list of DOM Objects exposed in the global namespace',
boklm's avatar
boklm committed
380
    },
381 382 383 384 385
    {
        name            => 'dom-objects-enumeration-worker',
        type            => 'marionette',
        descr           => 'Check the list of DOM Objects exposed in a Worker context',
    },
386
    {
boklm's avatar
boklm committed
387
        name            => 'navigation-timing',
388
        type            => 'marionette',
boklm's avatar
boklm committed
389 390
        descr           => 'Check that the Navigation Timing API is really disabled',
        use_net         => 1,
391
    },
392
    {
boklm's avatar
boklm committed
393
        name            => 'resource-timing',
394
        type            => 'marionette',
395
        descr           => 'Check that the Resource Timing API is really disabled',
boklm's avatar
boklm committed
396
        use_net         => 1,
397 398
        # To check that the test fails when resource timing is enabled,
        # uncomment this:
399 400
        #prefs           => {
        #    'dom.enable_resource_timing' => 'true',
401 402 403 404 405 406 407 408 409 410
        #},
    },
    {
        name            => 'user-timing',
        type            => 'marionette',
        descr           => 'Check that the User Timing API is really disabled',
        use_net         => 1,
        # To check that the test fails when user timing is enabled,
        # uncomment this:
        #prefs           => {
411
        #    'dom.enable_user_timing' => 'true',
412
        #},
413
    },
414 415 416 417 418 419 420 421 422 423 424 425 426 427
    {
        name            => 'user-timing-worker',
        type            => 'marionette',
        marionette_test => 'page',
        remote          => 0,
        timeout         => 500,
        descr           => 'Check that the User Timing API in Worker context is really disabled',
        use_net         => 1,
        # To check that the test fails when user timing is enabled,
        # uncomment this:
        #prefs           => {
        #    'dom.enable_user_timing' => 'true',
        #},
    },
428 429 430 431 432 433 434 435 436 437 438
    {
        name            => 'performance-observer',
        type            => 'marionette',
        descr           => 'Check that the Performance Observer API is really disabled',
        use_net         => 1,
        # To check that the test fails when performance observer is enabled,
        # uncomment this:
        #prefs           => {
        #    'dom.enable_performance_observer' => 'true',
        #},
    },
439
    {
boklm's avatar
boklm committed
440
        name            => 'searchengines',
441
        type            => 'marionette',
boklm's avatar
boklm committed
442
        descr           => 'Check that we have the default search engines set',
443
    },
boklm's avatar
boklm committed
444
    {
boklm's avatar
boklm committed
445
        name            => 'noscript',
446
        type            => 'marionette',
boklm's avatar
boklm committed
447 448 449
        descr           => 'Check that noscript options are working',
        use_net         => 1,
        prefs           => {
450
            'extensions.torbutton.security_slider' => 2,
boklm's avatar
boklm committed
451 452
        },
    },
boklm's avatar
boklm committed
453
    {
boklm's avatar
boklm committed
454
        name            => 'fp_screen_dimensions',
455
        type            => 'marionette',
boklm's avatar
boklm committed
456
        descr           => 'Check that screen dimensions are spoofed correctly',
457 458
    },
    {
boklm's avatar
boklm committed
459
        name            => 'fp_screen_coords',
460
        type            => 'marionette',
boklm's avatar
boklm committed
461
        descr           => 'Check that screenX, screenY, screenLeft, screenTop, mozInnerScreenX, mozInnerScreenY are 0',
462 463
    },
    {
boklm's avatar
boklm committed
464
        name            => 'fp_plugins',
465
        type            => 'marionette',
boklm's avatar
boklm committed
466
        descr           => 'Check that plugins are disabled',
467 468
    },
    {
boklm's avatar
boklm committed
469
        name            => 'fp_useragent',
470
        type            => 'marionette',
boklm's avatar
boklm committed
471
        descr           => 'Check that userAgent is as expected',
472 473
    },
    {
boklm's avatar
boklm committed
474
        name            => 'fp_navigator',
475
        type            => 'marionette',
boklm's avatar
boklm committed
476 477 478 479
        descr           => 'Check that navigator properties are as expected',
    },
    {
        name            => 'play_videos',
480
        type            => 'marionette',
boklm's avatar
boklm committed
481 482
        descr           => 'Play some videos',
        use_net         => 1,
483
        marionette_test => 'page',
boklm's avatar
boklm committed
484 485 486 487 488
        remote          => 1,
        timeout         => 50000,
    },
    {
        name            => 'svg-disable',
boklm's avatar
boklm committed
489
        type            => 'marionette',
boklm's avatar
boklm committed
490
        descr           => 'Check if disabling svg is working',
boklm's avatar
boklm committed
491
        marionette_test => 'svg',
boklm's avatar
boklm committed
492 493
        use_net         => 1,
        prefs           => {
494 495 496
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'false',
        },
boklm's avatar
boklm committed
497
        enable          => sub { $OSNAME eq 'linux' },
498 499
    },
    {
boklm's avatar
boklm committed
500
        name            => 'svg-enable',
boklm's avatar
boklm committed
501
        type            => 'marionette',
boklm's avatar
boklm committed
502
        descr           => 'Check if enabling svg is working',
boklm's avatar
boklm committed
503
        marionette_test => 'svg',
boklm's avatar
boklm committed
504 505
        use_net         => 1,
        prefs           => {
506 507 508
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'true',
        },
boklm's avatar
boklm committed
509
        enable          => sub { $OSNAME eq 'linux' },
510
    },
511 512 513 514 515 516
    {
        name            => 'download_pdf',
        type            => 'marionette',
        descr           => 'Check if download of PDF is working (#19402)',
        use_net         => 1,
    },
boklm's avatar
boklm committed
517 518 519 520 521 522 523
    {
        name            => 'pinning_now',
        type            => 'marionette',
        descr           => 'Check if static public key pinning is working (#20149)',
        marionette_test => 'pinning',
        use_net         => 1,
    },
524 525
);

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
sub set_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    copy $prefs, "$prefs.backup";
    my $new_prefs = '';
    foreach my $prefname (sort keys %{$t->{prefs}}) {
        $new_prefs .= "pref(\"$prefname\", $t->{prefs}{$prefname});\n";
    }
    write_file($prefs, {append => 1}, $new_prefs);
}

sub reset_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    move "$prefs.backup", $prefs;
}

boklm's avatar
boklm committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
sub set_slider_mode {
    my ($tbbinfos, $t) = @_;
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    copy $prefs, "$prefs.slider_backup";
    write_file($prefs, {append => 1},
      'pref("extensions.torbutton.security_custom", false);' . "\n" .
      "pref(\"extensions.torbutton.security_slider\", $t->{slider_mode});\n");
}

sub reset_slider_mode {
    my ($tbbinfos, $t) = @_;
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    move "$prefs.slider_backup", $prefs;
}

560 561 562
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
563
    my %binfiles;
564 565 566 567
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
568 569 570
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
571
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
572 573 574
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
575 576 577 578 579
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{binfiles} = [ keys %binfiles ];
}

boklm's avatar
boklm committed
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
sub tbb_osx_executable_files {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{osx_executable_files} if $tbbinfos->{osx_executable_files};
    my %exec_files;
    my $wanted = sub {
        return unless -f $File::Find::name;
        $ENV{LC_ALL}= 'C';
        my ($out, $err, $success) = capture_exec('otool', '-hv', $File::Find::name);
        return unless $success;
        my @out_lines = split("\n", $out);
        return if $out_lines[0] =~ m/is not an object file/;
        my $last_line = pop @out_lines;
        my ($type) = $last_line =~ m/^\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+([^\s]+)\s+[^\s]+\s+[^\s]+\s+/;
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $exec_files{$name} = 1 if $type eq 'EXECUTE';
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{osx_executable_files} = [ keys %exec_files ];
}

601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
sub list_tests {
    foreach my $test (@tests) {
        print "$test->{name} ($test->{type})\n   $test->{descr}\n\n";
    }
}

sub get_tbbfile {
    my ($tbbinfos) = @_;
    $tbbinfos->{tbbfile_orig} = $tbbinfos->{tbbfile};
    if ($tbbinfos->{tbbfile} =~ m/^https?:\/\//) {
        my (undef, undef, $file) = File::Spec->splitpath($tbbinfos->{tbbfile});
        my $output = $options->{'download-dir'} ?
                "$options->{'download-dir'}/$file" : "$tbbinfos->{tmpdir}/$file";
        return $output if -f $output;
        print "Downloading $tbbinfos->{tbbfile}\n";
        my $ua = LWP::UserAgent->new;
        my $resp = $ua->get($tbbinfos->{tbbfile}, ':content_file' => $output);
        exit_error "Error downloading $tbbinfos->{tbbfile}:\n" . $resp->status_line
                unless $resp->is_success;
        $tbbinfos->{tbbfile} = $output;
    }
    exit_error "File $tbbinfos->{tbbfile} does not exist"
                unless -f $tbbinfos->{tbbfile};
}

sub extract_tbb {
    my ($tbbinfos) = @_;
    exit_error "Can't open file $tbbinfos->{tbbfile}" unless -f $tbbinfos->{tbbfile};
    my $tbbfile = File::Spec->rel2abs($tbbinfos->{tbbfile});
    my $tmpdir = $tbbinfos->{tmpdir};
    chdir $tmpdir;
    if ($tbbinfos->{os} eq 'Linux') {
        system('tar', 'xf', $tbbfile);
634 635 636 637 638
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
639
        $tbbinfos->{tbbdir} .= '/Browser';
640 641 642 643
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
644
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
645 646 647 648 649
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser") if -d "$tmpdir/\$_OUTDIR";
        if (-d "$tmpdir/Browser") {
            mkdir "$tmpdir/torbrowser";
            move("$tmpdir/Browser", "$tmpdir/torbrowser/Browser");
        }
650
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
651
        system('chmod', '-R', '+rx', $tmpdir) if $OSNAME eq 'cygwin';
boklm's avatar
boklm committed
652 653 654 655 656 657
    } elsif ($tbbinfos->{os} eq 'MacOSX') {
        my $mountpoint = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
        system('hdiutil', 'mount', '-mountpoint', $mountpoint, $tbbfile);
        system('cp', '-a', "$mountpoint/TorBrowser.app", "$tmpdir/TorBrowser.app");
        system('hdiutil', 'unmount', $mountpoint);
        $tbbinfos->{tbbdir} = "$tmpdir/TorBrowser.app";
658 659 660 661 662 663 664 665 666 667 668 669 670
    }
}

sub xvfb_run {
    my ($test) = @_;
    return () unless $options->{xvfb};
    my $resolution = $test->{resolution} ? $test->{resolution}
                                         : $options->{resolution};
    return ('xvfb-run', '--auto-servernum', '-s', "-screen 0 ${resolution}x24");
}

sub check_opened_connections {
    my ($tbbinfos, $test) = @_;
671 672 673 674 675 676
    my %bad_connections =  %{$test->{results}{connections}};
    delete $bad_connections{"127.0.0.1:$options->{'tor-control-port'}"};
    delete $bad_connections{"127.0.0.1:$options->{'tor-socks-port'}"};
    # For some reasons, tor-browser creates two connections to the default
    # socks port even when when TOR_SOCKS_PORT is set
    # https://lists.torproject.org/pipermail/tbb-dev/2014-May/000050.html
boklm's avatar
boklm committed
677 678 679 680
    if (defined $bad_connections{'127.0.0.1:9150'}
        && $bad_connections{'127.0.0.1:9150'} <= 2) {
        delete $bad_connections{'127.0.0.1:9150'}
    }
681 682 683 684
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
685
    $test->{clean_strace} //= !%bad_connections;
686
    $test->{results}{bad_connections} = \%bad_connections;
687 688 689 690
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
691
    my @bad_modified_files = @{$test->{results}{modified_files}};
692 693 694 695
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
696
    $test->{clean_strace} //= !@bad_modified_files;
697 698 699
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

700 701
sub clean_strace {
    my ($tbbinfos, $test) = @_;
702
    return unless $test->{clean_strace};
703 704
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
705
    unlink "$logfile.tmp";
706 707
}

708 709 710
sub parse_strace {
    my ($tbbinfos, $test) = @_;
    my %ignore_files = map { $_ => 1 } qw(/dev/null /dev/tty);
711 712
    my @ignore_re = ( qr/^\/dev\/dri/ );
    push @ignore_re, qr/^$test->{workspace}/ if $test->{workspace};
713 714 715 716 717
    my %files;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    $test->{results}{connections} = {};
    my %modified_files;
    my %removed_files;
718 719 720 721 722
    if (-f "$logfile.tmp") {
        my $txt = read_file("$logfile.tmp");
        write_file($logfile, { append => 1 }, $txt);
        unlink "$logfile.tmp";
    }
723
    my @lines = read_file($logfile) if -f $logfile;
724
    LINE: foreach my $line (@lines) {
725 726 727 728 729
        if ($line =~ m/^\d+ open\("((?:[^"\\]++|\\.)*+)", ([^\)]+)/ ||
            $line =~ m/^\d+ openat\([^,]+, "((?:[^"\\]++|\\.)*+)", ([^\)]+)/) {
            next if $2 =~ m/O_RDONLY/;
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
            next if $ignore_files{$1};
730 731 732
            if ($ENV{'MOZMILL_SCREENSHOTS'}) {
                next if $1 =~ m/^$ENV{'MOZMILL_SCREENSHOTS'}/;
            }
733 734 735
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
736 737 738 739
            $modified_files{$1}++;
        }
        if ($line =~ m/^\d+ unlink\("((?:[^"\\]++|\\.)*+)"/) {
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
740 741 742 743
            next if $ignore_files{$1};
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
744 745 746
            $removed_files{$1}++;
            delete $modified_files{$1} unless -f $1;
        }
boklm's avatar
boklm committed
747
        if ($line =~ m/^\d+ connect\(\d+, \{sa_family=AF_INET, sin_port=htons\((\d+)\), sin_addr=inet_addr\("((?:[^"\\]++|\\.)*+)"\)/) {
748
            $test->{results}{connections}{"$2:$1"}++;
749 750
        }
    }
751 752
    $test->{results}{modified_files} = [ keys %modified_files ];
    $test->{results}{removed_files} = [ keys %removed_files ];
753 754 755 756 757 758 759 760 761
}

sub ff_wrapper {
    my ($tbbinfos, $test) = @_;
    my $wrapper_file = "$tbbinfos->{tbbdir}/ff_wrapper";
    return $wrapper_file if -f $wrapper_file;
    my $wrapper = <<EOF;
#!/bin/sh
set -e
762
export HOME="$tbbinfos->{tbbdir}"
763
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
764 765
export FONTCONFIG_PATH="\${HOME}/TorBrowser/Data/fontconfig"
export FONTCONFIG_FILE="fonts.conf"
766 767 768 769 770 771 772
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

773
sub ff_strace_wrapper {
774 775
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
776
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
777 778
    my $wrapper = <<EOF;
#!/bin/sh
779 780 781 782 783 784
if [ -f $logfile.tmp ]
then
   cat $logfile.tmp >> $logfile
   rm $logfile.tmp
fi
echo \$@ >> /tmp/ff_run.log
785 786 787 788 789
strace -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
790 791 792 793 794 795 796 797 798 799 800 801
EOF
    my $wrapper_file = "$tbbinfos->{tbbdir}/ff_$test->{name}";
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

sub ffbin_path {
    my ($tbbinfos, $test) = @_;
    if ($OSNAME eq 'cygwin') {
        return winpath("$tbbinfos->{ffbin}.exe");
    }
802
    my %t = map { $_ => 1 } qw(marionette);
803
    if ($options->{use_strace} && $t{$test->{type}}) {
boklm's avatar
boklm committed
804 805
        return ff_strace_wrapper($tbbinfos, $test);
    }
boklm's avatar
boklm committed
806
    return $tbbinfos->{ffbin} if $OSNAME eq 'darwin';
807
    return ff_wrapper($tbbinfos, $test);
808 809
}

810 811 812 813 814 815 816 817 818 819 820 821
sub marionette_export_options {
    my ($tbbinfos, $test) = @_;
    my $options_file = File::Temp->new();
    my $json = {
        options  => clone_strip_coderef($options),
        test     => clone_strip_coderef($test),
        tbbinfos => clone_strip_coderef({ %$tbbinfos, tests => undef }),
    };
    write_file($options_file, encode_json($json));
    return $options_file;
}

822 823 824 825 826 827 828
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

829 830
    my $options_file = marionette_export_options($tbbinfos, $test);
    $ENV{TESTSUITE_DATA_FILE} = winpath($options_file);
831 832
    my $result_file_html = "$tbbinfos->{'results-dir'}/$test->{name}.html";
    my $result_file_txt = "$tbbinfos->{'results-dir'}/$test->{name}.txt";
833 834
    $test->{workspace} = "$tbbinfos->{'results-dir'}/$test->{name}_ws";
    mkdir $test->{workspace};
835 836
    #--log-unittest  ./res.txt --log-html ./res.html
    my $bin = $OSNAME eq 'cygwin' ? 'Scripts' : 'bin';
837
    my $marionette_test = $test->{marionette_test} // $test->{name};
838
    my $pypath = $ENV{PYTHONPATH};
boklm's avatar
boklm committed
839 840 841 842
    my $old_pypath = $ENV{PYTHONPATH};
    $ENV{PYTHONPATH} = winpath("$FindBin::Bin/marionette/tor_browser_tests/lib");
    my $sep = $OSNAME eq 'cygwin' ? ';' : ':';
    $ENV{PYTHONPATH} .= $sep . $old_pypath if $old_pypath;
843 844 845
    $test->{screenshots} = [];
    my $screenshots_tmp = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
    $ENV{'MARIONETTE_SCREENSHOTS'} = winpath($screenshots_tmp);
846 847 848 849 850
    system(xvfb_run($test), "$FindBin::Bin/virtualenv-marionette/$bin/tor-browser-tests",
        '--log-unittest', winpath($result_file_txt),
        '--log-html', winpath($result_file_html),
        '--binary', ffbin_path($tbbinfos, $test),
        '--profile', winpath($tbbinfos->{ffprofiledir}),
851
        $OSNAME eq 'cygwin' ? () : ('--workspace', $test->{workspace}),
852
        winpath("$FindBin::Bin/marionette/tor_browser_tests/test_${marionette_test}.py"));
853
    $ENV{PYTHONPATH} = $pypath;
854
    my @txt_log = -f $result_file_txt ? read_file($result_file_txt) : ('NoFile');
855 856 857
    my $res_line = shift @txt_log;
    $test->{results}{success} = $res_line eq ".\n" || $res_line eq ".\r\n";
    $test->{results}{log} = join '', @txt_log;
858 859 860
    my $i = 0;
    for my $screenshot_file (sort glob "$screenshots_tmp/*.png") {
        move($screenshot_file, "$tbbinfos->{'results-dir'}/$test->{name}-$i.png");
861
        screenshot_thumbnail($tbbinfos->{'results-dir'}, "$test->{name}-$i.png");
862 863 864
        push @{$test->{screenshots}}, "$test->{name}-$i.png";
        $i++;
    }
865 866 867 868
    reset_test_prefs($tbbinfos, $test);
    parse_strace($tbbinfos, $test);
    check_opened_connections($tbbinfos, $test);
    check_modified_files($tbbinfos, $test);
869
    clean_strace($tbbinfos, $test);
870 871
}

872 873
sub set_tbbpaths {
    my ($tbbinfos) = @_;
874 875 876
    $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/firefox";
    $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/TorBrowser/Tor";
    $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/TorBrowser/Data";
boklm's avatar
boklm committed
877 878
    if ($tbbinfos->{os} eq 'MacOSX') {
        $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/Contents/MacOS/firefox";
879 880 881 882 883 884 885 886 887
        unless ($tbbinfos->{version} =~ m/^5./) {
            $tbbinfos->{ffprofiledir} = "$tbbinfos->{tbbdir}/Contents/Resources/distribution";
            $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/Contents/Resources/TorBrowser/Tor";
            $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/../TorBrowser-data";
            $tbbinfos->{torrcdefaults} = "$tbbinfos->{tordir}/torrc-defaults";
            $tbbinfos->{torgeoip} = "$tbbinfos->{tordir}/geoip";
            mkdir $tbbinfos->{datadir} unless -d $tbbinfos->{datadir};
            mkdir "$tbbinfos->{datadir}/Tor" unless -d "$tbbinfos->{datadir}/Tor";
        }
boklm's avatar
boklm committed
888
    }
889 890
    $tbbinfos->{torrcdefaults} //= "$tbbinfos->{datadir}/Tor/torrc-defaults";
    $tbbinfos->{torgeoip} //= "$tbbinfos->{datadir}/Tor/geoip";
891
    $tbbinfos->{torbin} = "$tbbinfos->{tordir}/tor";
boklm's avatar
boklm committed
892
    $tbbinfos->{ptdir} = winpath("$tbbinfos->{tordir}/PluggableTransports");
893
    $tbbinfos->{ffprofiledir} //= "$tbbinfos->{datadir}/Browser/profile.default";
894 895
}

boklm's avatar
boklm committed
896 897 898 899
sub new {
    my ($ts, $testsuite) = @_;
    $testsuite->{type} = 'browserbundle';
    $testsuite->{tests} = [ map { { %$_ } } @tests ];
900 901
    return undef unless $testsuite->{os} eq $options->{os};
    return undef unless $testsuite->{arch} eq $options->{arch};
boklm's avatar
boklm committed
902 903 904
    return bless $testsuite, $ts;
}

905 906 907 908 909 910 911 912 913 914
sub pre_tests {
    my ($tbbinfos) = @_;
    get_tbbfile($tbbinfos);
    if ($tbbinfos->{sha256sum} &&
        $tbbinfos->{sha256sum} ne sha256_hex(read_file($tbbinfos->{tbbfile}))) {
        exit_error "Wrong sha256sum for $tbbinfos->{tbbfile}";
    }
    $tbbinfos->{sha256sum} //= sha256_hex(read_file($tbbinfos->{tbbfile}));
    extract_tbb($tbbinfos);
    set_tbbpaths($tbbinfos);
915 916 917 918
    my $prefs_file = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    open(my $prefs_fh, '>>', $prefs_file);
    print $prefs_fh 'pref("extensions.torbutton.prompted_language", true);', "\n";
    close $prefs_fh;
919
    chdir $tbbinfos->{tbbdir} || exit_error "Can't enter directory $tbbinfos->{tbbdir}";
boklm's avatar
boklm committed
920
    copy "$FindBin::Bin/data/cert_override.txt",
boklm's avatar
boklm committed
921
          "$tbbinfos->{ffprofiledir}/cert_override.txt";
922
    $ENV{TOR_SKIP_LAUNCH} = 1;
923 924
    $ENV{TOR_SOCKS_PORT} = $options->{'tor-socks-port'};
    $ENV{TOR_CONTROL_PORT} = $options->{'tor-control-port'};
boklm's avatar
boklm committed
925 926 927
    if ($options->{xdummy}) {
        $tbbinfos->{Xdisplay} = start_X("$tbbinfos->{'results-dir'}/xorg.log");
    }
928 929 930 931 932
}

sub post_tests {
    my ($tbbinfos) = @_;
    TBBTestSuite::Tests::TorBootstrap::stop_tor($tbbinfos);
boklm's avatar
boklm committed
933
    stop_X($tbbinfos->{Xdisplay}) if $options->{xdummy};
934 935 936
}

1;