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 34.1 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
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
boklm's avatar
boklm committed
101
            TorBrowser/Tor/PluggableTransports/zope/interface/_zope_interface_coptimizations.so
102 103
            TorBrowser/Tor/PluggableTransports/snowflake-client
            TorBrowser/ncprop279/ncprop279
boklm's avatar
boklm committed
104
            ) ],
105 106
    },
    {
boklm's avatar
boklm committed
107 108 109 110
        name            => 'readelf_stack_canary',
        type            => 'command',
        descr           => 'Check for stack canary support',
        files           => \&tbb_binfiles,
111
        command         => [ 'readelf', '-s', '--wide' ],
boklm's avatar
boklm committed
112 113
        check_output    => sub { $_[0] =~ m/__stack_chk_fail/ },
        enable          => sub { $OSNAME eq 'linux' },
boklm's avatar
boklm committed
114 115
        # ticket 13056
        skip_files   => [ qw(
116 117
            abicheck
            gtk2/libmozgtk.so
boklm's avatar
boklm committed
118
            libmozalloc.so
119
            libmozgtk.so
boklm's avatar
boklm committed
120 121
            libplc4.so
            libplds4.so
122
            TorBrowser/Tor/libstdc++/libstdc++.so.6
boklm's avatar
boklm committed
123 124 125 126 127 128 129 130 131 132 133
            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
134 135 136 137 138
            TorBrowser/Tor/PluggableTransports/snowflake-client
            TorBrowser/ncprop279/ncprop279
            libgraphitewasm.so
            liboggwasm.so
            libmozwayland.so
boklm's avatar
boklm committed
139
            ) ],
140 141
    },
    {
boklm's avatar
boklm committed
142 143 144 145 146 147 148
        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' },
149 150
    },
    {
boklm's avatar
boklm committed
151 152 153 154 155 156 157
        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
158 159 160 161
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
162
            TorBrowser/Tor/PluggableTransports/snowflake-client
163
            TorBrowser/ncprop279/ncprop279
boklm's avatar
boklm committed
164
            ) ],
165 166
    },
    {
boklm's avatar
boklm committed
167 168 169 170 171 172 173
        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' },
174 175
    },
    {
boklm's avatar
boklm committed
176 177 178 179 180 181 182
        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' },
Alex Catarineu's avatar
Alex Catarineu committed
183 184 185
        skip_files   => [ qw(
            updater
            ) ], # We have tor-browser-build#40092 for investigating this
186
    },
boklm's avatar
boklm committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
    {
        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
202 203 204 205 206
        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
207
    },
208
    {
boklm's avatar
boklm committed
209 210 211 212 213
        name            => 'tor_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
214
        run_once        => 1,
215 216
    },
    {
boklm's avatar
boklm committed
217 218 219
        name            => 'tor_bridge',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge',
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_bridge_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge 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 247 248 249
    {
        name            => 'tor_meek-azure',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-azure',
250
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
251
        run_once        => 1,
252
    },
253
    {
boklm's avatar
boklm committed
254 255 256 257 258
        name            => 'tor_bootstrap',
        type            => 'tor_bootstrap',
        descr           => 'Check that we can bootstrap tor',
        fail_type       => 'fatal',
        no_kill         => 1,
259 260 261
        use_default_config => 1,
    },
    {
boklm's avatar
boklm committed
262
        name            => 'screenshots',
263
        type            => 'marionette',
boklm's avatar
boklm committed
264
        descr           => 'Take some screenshots',
265 266
    },
    {
boklm's avatar
boklm committed
267
        name            => 'check',
268
        type            => 'marionette',
boklm's avatar
boklm committed
269 270
        use_net         => 1,
        descr           => 'Check that http://check.torproject.org/ think we are using tor',
271 272
    },
    {
boklm's avatar
boklm committed
273
        name            => 'https-everywhere-disabled',
274 275
        marionette_test => 'https-everywhere',
        type            => 'marionette',
boklm's avatar
boklm committed
276 277
        descr           => 'Check that https everywhere is not doing anything when disabled',
        use_net         => 1,
278
    },
boklm's avatar
boklm committed
279 280 281 282 283 284
    {
        name            => 'https-everywhere',
        type            => 'marionette',
        use_net         => 1,
        descr           => 'Check that https everywhere is working',
    },
285
    {
boklm's avatar
boklm committed
286
        name            => 'settings',
287
        type            => 'marionette',
boklm's avatar
boklm committed
288
        descr           => 'Check that some important settings are correctly set',
289
    },
boklm's avatar
boklm committed
290
    {
boklm's avatar
boklm committed
291
        name            => 'acid3',
boklm's avatar
boklm committed
292
        type            => 'marionette',
boklm's avatar
boklm committed
293 294
        descr           => 'acid3 tests',
        use_net         => 1,
boklm's avatar
boklm committed
295
        retry           => 4,
boklm's avatar
boklm committed
296 297
        # the acid3 test is disabled for now
        enable          => sub { 0; },
boklm's avatar
boklm committed
298
    },
boklm's avatar
boklm committed
299
    {
boklm's avatar
boklm committed
300
        name            => 'slider_settings_1',
301 302
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
303 304 305 306
        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
307 308
    },
    {
boklm's avatar
boklm committed
309
        name            => 'slider_settings_2',
310 311
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
312 313 314 315
        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
316 317
    },
    {
boklm's avatar
boklm committed
318
        name            => 'slider_settings_4',
319 320
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
321 322 323 324
        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
325
    },
boklm's avatar
boklm committed
326
    {
boklm's avatar
boklm committed
327
        name            => 'dom-objects-enumeration',
328
        type            => 'marionette',
boklm's avatar
boklm committed
329
        descr           => 'Check the list of DOM Objects exposed in the global namespace',
boklm's avatar
boklm committed
330
    },
331 332 333 334 335
    {
        name            => 'dom-objects-enumeration-worker',
        type            => 'marionette',
        descr           => 'Check the list of DOM Objects exposed in a Worker context',
    },
336
    {
boklm's avatar
boklm committed
337
        name            => 'navigation-timing',
338
        type            => 'marionette',
boklm's avatar
boklm committed
339 340
        descr           => 'Check that the Navigation Timing API is really disabled',
        use_net         => 1,
341
    },
342
    {
boklm's avatar
boklm committed
343
        name            => 'resource-timing',
344
        type            => 'marionette',
345
        descr           => 'Check that the Resource Timing API is really disabled',
boklm's avatar
boklm committed
346
        use_net         => 1,
347 348
        # To check that the test fails when resource timing is enabled,
        # uncomment this:
349 350
        #prefs           => {
        #    'dom.enable_resource_timing' => 'true',
351
        #    'privacy.resistFingerprinting' => 'false',
352 353 354 355 356 357 358 359 360 361
        #},
    },
    {
        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           => {
362
        #    'dom.enable_user_timing' => 'true',
boklm's avatar
boklm committed
363
        #    'privacy.resistFingerprinting' => 'false',
364
        #},
365
    },
366 367 368 369 370 371 372 373 374 375 376 377
    {
        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',
378
        #    'privacy.resistFingerprinting' => 'false',
379 380
        #},
    },
381 382 383 384 385 386
    {
        name            => 'performance-observer',
        type            => 'marionette',
        descr           => 'Check that the Performance Observer API is really disabled',
        use_net         => 1,
    },
387
    {
boklm's avatar
boklm committed
388
        name            => 'searchengines',
389
        type            => 'marionette',
boklm's avatar
boklm committed
390
        descr           => 'Check that we have the default search engines set',
391
    },
boklm's avatar
boklm committed
392
    {
boklm's avatar
boklm committed
393
        name            => 'noscript',
394
        type            => 'marionette',
boklm's avatar
boklm committed
395 396 397
        descr           => 'Check that noscript options are working',
        use_net         => 1,
        prefs           => {
398
            'extensions.torbutton.security_slider' => 2,
boklm's avatar
boklm committed
399 400
        },
    },
boklm's avatar
boklm committed
401
    {
boklm's avatar
boklm committed
402
        name            => 'fp_screen_dimensions',
403
        type            => 'marionette',
boklm's avatar
boklm committed
404
        descr           => 'Check that screen dimensions are spoofed correctly',
405 406
    },
    {
boklm's avatar
boklm committed
407
        name            => 'fp_screen_coords',
408
        type            => 'marionette',
boklm's avatar
boklm committed
409
        descr           => 'Check that screenX, screenY, screenLeft, screenTop, mozInnerScreenX, mozInnerScreenY are 0',
410 411
    },
    {
boklm's avatar
boklm committed
412
        name            => 'fp_plugins',
413
        type            => 'marionette',
boklm's avatar
boklm committed
414
        descr           => 'Check that plugins are disabled',
415 416
    },
    {
boklm's avatar
boklm committed
417
        name            => 'fp_useragent',
418
        type            => 'marionette',
boklm's avatar
boklm committed
419
        descr           => 'Check that userAgent is as expected',
420 421
    },
    {
boklm's avatar
boklm committed
422
        name            => 'fp_navigator',
423
        type            => 'marionette',
boklm's avatar
boklm committed
424 425 426 427
        descr           => 'Check that navigator properties are as expected',
    },
    {
        name            => 'play_videos',
428
        type            => 'marionette',
boklm's avatar
boklm committed
429 430
        descr           => 'Play some videos',
        use_net         => 1,
431
        marionette_test => 'page',
Alex Catarineu's avatar
Alex Catarineu committed
432
        remote          => 0,
boklm's avatar
boklm committed
433 434 435 436
        timeout         => 50000,
    },
    {
        name            => 'svg-disable',
boklm's avatar
boklm committed
437
        type            => 'marionette',
boklm's avatar
boklm committed
438
        descr           => 'Check if disabling svg is working',
boklm's avatar
boklm committed
439
        marionette_test => 'svg',
boklm's avatar
boklm committed
440 441
        use_net         => 1,
        prefs           => {
442
            'extensions.torbutton.security_custom' => 'true',
Alex Catarineu's avatar
Alex Catarineu committed
443
            'svg.disabled' => 'true',
444 445 446
        },
    },
    {
boklm's avatar
boklm committed
447
        name            => 'svg-enable',
boklm's avatar
boklm committed
448
        type            => 'marionette',
boklm's avatar
boklm committed
449
        descr           => 'Check if enabling svg is working',
boklm's avatar
boklm committed
450
        marionette_test => 'svg',
boklm's avatar
boklm committed
451 452
        use_net         => 1,
        prefs           => {
453
            'extensions.torbutton.security_custom' => 'true',
Alex Catarineu's avatar
Alex Catarineu committed
454
            'svg.disabled' => 'false',
455 456
        },
    },
457 458 459 460 461 462
    {
        name            => 'download_pdf',
        type            => 'marionette',
        descr           => 'Check if download of PDF is working (#19402)',
        use_net         => 1,
    },
boklm's avatar
boklm committed
463 464 465 466 467 468 469
    {
        name            => 'pinning_now',
        type            => 'marionette',
        descr           => 'Check if static public key pinning is working (#20149)',
        marionette_test => 'pinning',
        use_net         => 1,
    },
boklm's avatar
boklm committed
470 471 472 473
    {
        name            => 'fpcentral',
        type            => 'marionette',
        descr           => 'Check the browser fingerprint using fpcentral',
boklm's avatar
boklm committed
474
        fpcentral_url   => 'https://fpcentral.tbb.torproject.org/fp?automated_test',
boklm's avatar
boklm committed
475
        use_net         => 1,
476 477
        # Bug 30432: temporarily disable test
        enable          => sub { undef },
boklm's avatar
boklm committed
478
    },
479 480 481 482 483 484
    {
        name            => 'onion_security_expectations',
        type            => 'marionette',
        use_net         => 1,
        descr           => 'Check onion security expectations',
    },
485 486
);

487 488 489
sub set_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
490
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
491 492 493
    copy $prefs, "$prefs.backup";
    my $new_prefs = '';
    foreach my $prefname (sort keys %{$t->{prefs}}) {
494
        $new_prefs .= "user_pref(\"$prefname\", $t->{prefs}{$prefname});\n";
495 496 497 498 499 500 501
    }
    write_file($prefs, {append => 1}, $new_prefs);
}

sub reset_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
502
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
503 504 505
    move "$prefs.backup", $prefs;
}

boklm's avatar
boklm committed
506 507
sub set_slider_mode {
    my ($tbbinfos, $t) = @_;
508
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
boklm's avatar
boklm committed
509 510
    copy $prefs, "$prefs.slider_backup";
    write_file($prefs, {append => 1},
511 512
      'user_pref("extensions.torbutton.security_custom", false);' . "\n" .
      "user_pref(\"extensions.torbutton.security_slider\", $t->{slider_mode});\n");
boklm's avatar
boklm committed
513 514 515 516
}

sub reset_slider_mode {
    my ($tbbinfos, $t) = @_;
517
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
boklm's avatar
boklm committed
518 519 520
    move "$prefs.slider_backup", $prefs;
}

521 522 523
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
524
    my %binfiles;
525 526 527 528
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
529 530 531
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
532
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
533 534 535
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
536 537 538 539 540
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{binfiles} = [ keys %binfiles ];
}

boklm's avatar
boklm committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
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 ];
}

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
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);
595 596 597 598 599
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
600
        $tbbinfos->{tbbdir} .= '/Browser';
601 602 603 604
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
605
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
606 607 608 609 610
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser") if -d "$tmpdir/\$_OUTDIR";
        if (-d "$tmpdir/Browser") {
            mkdir "$tmpdir/torbrowser";
            move("$tmpdir/Browser", "$tmpdir/torbrowser/Browser");
        }
611
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
612
        system('chmod', '-R', '+rx', $tmpdir) if $OSNAME eq 'cygwin';
boklm's avatar
boklm committed
613 614 615 616 617 618
    } 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";
619 620 621 622 623 624 625 626 627 628 629 630 631
    }
}

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) = @_;
632 633 634 635 636 637
    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
638 639 640 641
    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'}
    }
642 643 644 645
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
646
    $test->{clean_strace} //= !%bad_connections;
647
    $test->{results}{bad_connections} = \%bad_connections;
648 649 650 651
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
652
    my @bad_modified_files = @{$test->{results}{modified_files}};
653 654 655 656
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
657
    $test->{clean_strace} //= !@bad_modified_files;
658 659 660
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

661 662
sub clean_strace {
    my ($tbbinfos, $test) = @_;
663
    return unless $test->{clean_strace};
664 665
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
666
    unlink "$logfile.tmp";
667 668
}

669 670 671
sub parse_strace {
    my ($tbbinfos, $test) = @_;
    my %ignore_files = map { $_ => 1 } qw(/dev/null /dev/tty);
672
    my @ignore_re = ( qr/^\/dev\/(dri)|(shm)/ );
673
    push @ignore_re, qr/^$test->{workspace}/ if $test->{workspace};
674 675 676 677 678
    my %files;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    $test->{results}{connections} = {};
    my %modified_files;
    my %removed_files;
679 680 681 682 683
    if (-f "$logfile.tmp") {
        my $txt = read_file("$logfile.tmp");
        write_file($logfile, { append => 1 }, $txt);
        unlink "$logfile.tmp";
    }
684
    my @lines = read_file($logfile) if -f $logfile;
685
    LINE: foreach my $line (@lines) {
686 687 688 689 690
        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};
691 692 693
            if ($ENV{'MOZMILL_SCREENSHOTS'}) {
                next if $1 =~ m/^$ENV{'MOZMILL_SCREENSHOTS'}/;
            }
694 695 696
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
697 698 699 700
            $modified_files{$1}++;
        }
        if ($line =~ m/^\d+ unlink\("((?:[^"\\]++|\\.)*+)"/) {
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
701 702 703 704
            next if $ignore_files{$1};
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
705 706 707
            $removed_files{$1}++;
            delete $modified_files{$1} unless -f $1;
        }
boklm's avatar
boklm committed
708
        if ($line =~ m/^\d+ connect\(\d+, \{sa_family=AF_INET, sin_port=htons\((\d+)\), sin_addr=inet_addr\("((?:[^"\\]++|\\.)*+)"\)/) {
709
            $test->{results}{connections}{"$2:$1"}++;
710 711
        }
    }
712 713
    $test->{results}{modified_files} = [ keys %modified_files ];
    $test->{results}{removed_files} = [ keys %removed_files ];
714 715 716 717 718 719 720 721 722
}

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
723
export HOME="$tbbinfos->{tbbdir}"
724
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
725 726
export FONTCONFIG_PATH="\${HOME}/TorBrowser/Data/fontconfig"
export FONTCONFIG_FILE="fonts.conf"
727 728 729 730 731 732 733
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

734
sub ff_strace_wrapper {
735 736
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
737
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
738 739
    my $wrapper = <<EOF;
#!/bin/sh
740 741 742 743 744 745
if [ -f $logfile.tmp ]
then
   cat $logfile.tmp >> $logfile
   rm $logfile.tmp
fi
echo \$@ >> /tmp/ff_run.log
746
strace -e trace=file,network -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
747 748 749 750
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
751 752 753 754 755 756 757 758 759 760 761 762
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");
    }
763
    my %t = map { $_ => 1 } qw(marionette);
764
    if ($options->{use_strace} && $t{$test->{type}}) {
boklm's avatar
boklm committed
765 766
        return ff_strace_wrapper($tbbinfos, $test);
    }
boklm's avatar
boklm committed
767
    return $tbbinfos->{ffbin} if $OSNAME eq 'darwin';
768
    return ff_wrapper($tbbinfos, $test);
769 770
}

771 772 773 774 775 776 777 778 779 780 781 782
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;
}

783 784 785 786 787 788 789
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

790 791
    my $options_file = marionette_export_options($tbbinfos, $test);
    $ENV{TESTSUITE_DATA_FILE} = winpath($options_file);
792 793
    my $result_file_html = "$tbbinfos->{'results-dir'}/$test->{name}.html";
    my $result_file_txt = "$tbbinfos->{'results-dir'}/$test->{name}.txt";
794 795
    $test->{workspace} = "$tbbinfos->{'results-dir'}/$test->{name}_ws";
    mkdir $test->{workspace};
796 797
    #--log-unittest  ./res.txt --log-html ./res.html
    my $bin = $OSNAME eq 'cygwin' ? 'Scripts' : 'bin';
798
    my $marionette_test = $test->{marionette_test} // $test->{name};
799
    my $pypath = $ENV{PYTHONPATH};
boklm's avatar
boklm committed
800 801 802 803
    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;
804 805 806
    $test->{screenshots} = [];
    my $screenshots_tmp = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
    $ENV{'MARIONETTE_SCREENSHOTS'} = winpath($screenshots_tmp);
807
    system(xvfb_run($test), "$FindBin::Bin/virtualenv-marionette-5.0.0/$bin/tor-browser-tests",
808 809
        '--log-unittest', winpath($result_file_txt),
        '--log-html', winpath($result_file_html),
810
        '--server-root', winpath("$FindBin::Bin/test-data"),
811 812
        '--binary', ffbin_path($tbbinfos, $test),
        '--profile', winpath($tbbinfos->{ffprofiledir}),
813
        $OSNAME eq 'cygwin' ? () : ('--workspace', $test->{workspace}),
814
        winpath("$FindBin::Bin/marionette/tor_browser_tests/test_${marionette_test}.py"));
815
    $ENV{PYTHONPATH} = $pypath;
816
    my @txt_log = -f $result_file_txt ? read_file($result_file_txt) : ('NoFile');
817 818 819
    my $res_line = shift @txt_log;
    $test->{results}{success} = $res_line eq ".\n" || $res_line eq ".\r\n";
    $test->{results}{log} = join '', @txt_log;
820 821 822
    my $i = 0;
    for my $screenshot_file (sort glob "$screenshots_tmp/*.png") {
        move($screenshot_file, "$tbbinfos->{'results-dir'}/$test->{name}-$i.png");
823
        screenshot_thumbnail($tbbinfos->{'results-dir'}, "$test->{name}-$i.png");
824 825 826
        push @{$test->{screenshots}}, "$test->{name}-$i.png";
        $i++;
    }
827 828 829 830
    reset_test_prefs($tbbinfos, $test);
    parse_strace($tbbinfos, $test);
    check_opened_connections($tbbinfos, $test);
    check_modified_files($tbbinfos, $test);
831
    clean_strace($tbbinfos, $test);
832 833
}

834 835
sub set_tbbpaths {
    my ($tbbinfos) = @_;
836 837 838
    $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/firefox";
    $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/TorBrowser/Tor";
    $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/TorBrowser/Data";
boklm's avatar
boklm committed
839 840
    if ($tbbinfos->{os} eq 'MacOSX') {
        $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/Contents/MacOS/firefox";
841 842 843 844 845 846 847 848 849
        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
850
    }
851 852
    $tbbinfos->{torrcdefaults} //= "$tbbinfos->{datadir}/Tor/torrc-defaults";
    $tbbinfos->{torgeoip} //= "$tbbinfos->{datadir}/Tor/geoip";
853
    $tbbinfos->{torbin} = "$tbbinfos->{tordir}/tor";
boklm's avatar
boklm committed
854
    $tbbinfos->{ptdir} = winpath("$tbbinfos->{tordir}/PluggableTransports");
855
    $tbbinfos->{ffprofiledir} //= "$tbbinfos->{datadir}/Browser/profile.default";
856 857
}

boklm's avatar
boklm committed
858 859 860 861
sub new {
    my ($ts, $testsuite) = @_;
    $testsuite->{type} = 'browserbundle';
    $testsuite->{tests} = [ map { { %$_ } } @tests ];
862 863
    return undef unless $testsuite->{os} eq $options->{os};
    return undef unless $testsuite->{arch} eq $options->{arch};
boklm's avatar
boklm committed
864 865 866
    return bless $testsuite, $ts;
}

867 868 869 870 871 872 873 874 875 876
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);
877
    my $prefs_file = "$tbbinfos->{ffprofiledir}/user.js";
878
    open(my $prefs_fh, '>>', $prefs_file);
879
    print $prefs_fh 'user_pref("privacy.spoof_english", 1);', "\n";
880
    close $prefs_fh;
881
    chdir $tbbinfos->{tbbdir} || exit_error "Can't enter directory $tbbinfos->{tbbdir}";
boklm's avatar
boklm committed
882
    copy "$FindBin::Bin/data/cert_override.txt",
boklm's avatar
boklm committed
883
          "$tbbinfos->{ffprofiledir}/cert_override.txt";
884
    $ENV{TOR_SKIP_LAUNCH} = 1;
885 886
    $ENV{TOR_SOCKS_PORT} = $options->{'tor-socks-port'};
    $ENV{TOR_CONTROL_PORT} = $options->{'tor-control-port'};
boklm's avatar
boklm committed
887 888 889
    if ($options->{xdummy}) {
        $tbbinfos->{Xdisplay} = start_X("$tbbinfos->{'results-dir'}/xorg.log");
    }
890 891 892 893 894
}

sub post_tests {
    my ($tbbinfos) = @_;
    TBBTestSuite::Tests::TorBootstrap::stop_tor($tbbinfos);
boklm's avatar
boklm committed
895
    stop_X($tbbinfos->{Xdisplay}) if $options->{xdummy};
896 897 898
}

1;