html/cgi-bin/tor.cgi

   1 #!/usr/bin/perl
   2 ###############################################################################
   3 #                                                                             #
   4 # IPFire.org - A linux based firewall                                         #
   5 # Copyright (C) 2007-2021  IPFire Team  <info@ipfire.org>                     #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU General Public License as published by        #
   9 # the Free Software Foundation, either version 3 of the License, or           #
  10 # (at your option) any later version.                                         #
  11 #                                                                             #
  12 # This program is distributed in the hope that it will be useful,             #
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  15 # GNU General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 use strict;
  23
  24 # enable only the following on debugging purpose
  25 #use warnings;
  26 #use CGI::Carp 'fatalsToBrowser';
  27
  28 require '/var/ipfire/general-functions.pl';
  29 require "${General::swroot}/location-functions.pl";
  30 require "${General::swroot}/lang.pl";
  31 require "${General::swroot}/header.pl";
  32
  33 #workaround to suppress a warning when a variable is used only once
  34 my @dummy = ( ${Header::colouryellow} );
  35 undef (@dummy);
  36
  37 my @bandwidth_limits = (
  38         1000 * 1024, # 1 GBit/s
  39          500 * 1024,
  40          200 * 1024,
  41          100 * 1024, # 100 MBit/s
  42           64 * 1024,
  43           50 * 1024,
  44           25 * 1024,
  45           20 * 1024,
  46           16 * 1024,
  47           10 * 1024,
  48            8 * 1024,
  49            4 * 1024,
  50            2 * 1024,
  51                1024  # 1 MBit/s
  52 );
  53 my @accounting_periods = ('daily', 'weekly', 'monthly');
  54
  55 my $TOR_CONTROL_PORT = 9051;
  56
  57 my $string=();
  58 my $memory=();
  59 my @memory=();
  60 my @pid=();
  61 my @tor=();
  62 sub daemonstats
  63 {
  64         $memory = 0;
  65         # for pid and memory
  66         open(FILE, '/usr/local/bin/addonctrl tor status | ');
  67         @tor = <FILE>;
  68         close(FILE);
  69         $string = join("", @tor);
  70         $string =~ s/[a-z_]//gi;
  71         $string =~ s/\[[0-1]\;[0-9]+//gi;
  72         $string =~ s/[\(\)\.]//gi;
  73         $string =~ s/  //gi;
  74         $string =~ s/\e//gi;
  75         @pid = split(/\s/,$string);
  76         if (open(FILE, "/proc/$pid[0]/statm")){
  77                 my $temp = <FILE>;
  78                 @memory = split(/ /,$temp);
  79                 close(FILE);
  80                 }
  81         $memory+=$memory[0];
  82 }
  83 daemonstats();
  84
  85 our %netsettings = ();
  86 &General::readhash("${General::swroot}/ethernet/settings", \%netsettings);
  87
  88 our %color = ();
  89 our %mainsettings = ();
  90 &General::readhash("${General::swroot}/main/settings", \%mainsettings);
  91 &General::readhash("/srv/web/ipfire/html/themes/ipfire/include/colors.txt", \%color);
  92
  93 our %settings = ();
  94
  95 $settings{'TOR_ENABLED'} = 'off';
  96 $settings{'TOR_SOCKS_PORT'} = 9050;
  97 $settings{'TOR_EXIT_COUNTRY'} = '';
  98 $settings{'TOR_USE_EXIT_NODES'} = '';
  99 $settings{'TOR_GUARD_COUNTRY'} = '';
 100 $settings{'TOR_USE_GUARD_NODES'} = '';
 101 $settings{'TOR_ALLOWED_SUBNETS'} = "$netsettings{'GREEN_NETADDRESS'}\/$netsettings{'GREEN_NETMASK'}";
 102 if (&Header::blue_used()) {
 103         $settings{'TOR_ALLOWED_SUBNETS'} .= ",$netsettings{'BLUE_NETADDRESS'}\/$netsettings{'BLUE_NETMASK'}";
 104 }
 105
 106 $settings{'TOR_RELAY_ENABLED'} = 'off';
 107 $settings{'TOR_RELAY_MODE'} = 'relay';
 108 $settings{'TOR_RELAY_ADDRESS'} = '';
 109 $settings{'TOR_RELAY_PORT'} = 9001;
 110 $settings{'TOR_RELAY_DIRPORT'} = 0;
 111 $settings{'TOR_RELAY_NICKNAME'} = '';
 112 $settings{'TOR_RELAY_CONTACT_INFO'} = '';
 113 $settings{'TOR_RELAY_BANDWIDTH_RATE'} = 0;
 114 $settings{'TOR_RELAY_BANDWIDTH_BURST'} = 0;
 115 $settings{'TOR_RELAY_ACCOUNTING_LIMIT'} = 0;
 116 $settings{'TOR_RELAY_ACCOUNTING_PERIOD'} = 'daily';
 117
 118 $settings{'ACTION'} = '';
 119
 120 my $errormessage = '';
 121 my $warnmessage = '';
 122
 123 &Header::showhttpheaders();
 124
 125 # Get GUI values.
 126 &Header::getcgihash(\%settings);
 127
 128 # Create tor command connection.
 129 our $torctrl = &TorConnect();
 130
 131 # Toggle enable/disable field.
 132 if ($settings{'ACTION'} eq $Lang::tr{'save'}) {
 133         if ($settings{'TOR_RELAY_NICKNAME'} ne '') {
 134                 if ($settings{'TOR_RELAY_NICKNAME'} !~ /^[a-zA-Z0-9]+$/) {
 135                         $errormessage = "$Lang::tr{'tor errmsg invalid relay name'}: $settings{'TOR_RELAY_NICKNAME'}";
 136                 }
 137         }
 138
 139         if (!&General::validport($settings{'TOR_SOCKS_PORT'})) {
 140                 $errormessage = "$Lang::tr{'tor errmsg invalid socks port'}: $settings{'TOR_SOCKS_PORT'}";
 141         }
 142
 143         if (!&General::validport($settings{'TOR_RELAY_PORT'})) {
 144                 $errormessage = "$Lang::tr{'tor errmsg invalid relay port'}: $settings{'TOR_RELAY_PORT'}";
 145         }
 146         if ($settings{'TOR_RELAY_DIRPORT'} ne '0') {
 147                 if (!&General::validport($settings{'TOR_RELAY_DIRPORT'})) {
 148                         $errormessage = "$Lang::tr{'tor errmsg invalid directory port'}: $settings{'TOR_RELAY_DIRPORT'}";
 149                 }
 150         }
 151
 152         if ($settings{'TOR_RELAY_ADDRESS'} ne '') {
 153                 if ((!&General::validfqdn($settings{'TOR_RELAY_ADDRESS'})) && (!&General::validip($settings{'TOR_RELAY_ADDRESS'}))) {
 154                         $errormessage = "$Lang::tr{'tor errmsg invalid relay address'}: $settings{'TOR_RELAY_ADDRESS'}";
 155                 }
 156         }
 157
 158         if ($settings{'TOR_RELAY_ACCOUNTING_LIMIT'} !~ /^\d+$/) {
 159                 $errormessage = "$Lang::tr{'tor errmsg invalid accounting limit'}: $settings{'TOR_RELAY_ACCOUNTING_LIMIT'}";
 160         }
 161
 162         my @temp = split(/[\n,]/,$settings{'TOR_ALLOWED_SUBNETS'});
 163         $settings{'TOR_ALLOWED_SUBNETS'} = "";
 164         foreach (@temp) {
 165                 s/^\s+//g; s/\s+$//g;
 166                 if ($_) {
 167                         unless (&General::validipandmask($_)) {
 168                                 $errormessage = "$Lang::tr{'tor errmsg invalid ip or mask'}: $_";
 169                         }
 170                         $settings{'TOR_ALLOWED_SUBNETS'} .= $_.",";
 171                 }
 172         }
 173
 174         @temp = split(/[\n,]/,$settings{'TOR_USE_EXIT_NODES'});
 175         $settings{'TOR_USE_EXIT_NODES'} = "";
 176         foreach (@temp) {
 177                 s/^\s+//g; s/\s+$//g;
 178                 if ($_) {
 179                         $settings{'TOR_USE_EXIT_NODES'} .= $_.",";
 180                 }
 181         }
 182
 183         @temp = split(/[\n,]/,$settings{'TOR_USE_GUARD_NODES'});
 184         $settings{'TOR_USE_GUARD_NODES'} = "";
 185         foreach (@temp) {
 186                 s/^\s+//g; s/\s+$//g;
 187                 if ($_) {
 188                         $settings{'TOR_USE_GUARD_NODES'} .= $_.",";
 189                 }
 190         }
 191
 192         # Burst bandwidth must be less or equal to bandwidth rate.
 193         if ($settings{'TOR_RELAY_BANDWIDTH_RATE'} == 0) {
 194                 $settings{'TOR_RELAY_BANDWIDTH_BURST'} = 0;
 195
 196         } elsif ($settings{'TOR_RELAY_BANDWIDTH_BURST'} < $settings{'TOR_RELAY_BANDWIDTH_RATE'}) {
 197                 $settings{'TOR_RELAY_BANDWIDTH_BURST'} = $settings{'TOR_RELAY_BANDWIDTH_RATE'};
 198         }
 199
 200         if ($errormessage eq '') {
 201                 # Write configuration settings to file.
 202                 &General::writehash("${General::swroot}/tor/settings", \%settings);
 203
 204                 # Update configuration files.
 205                 &BuildConfiguration();
 206         }
 207 } else {
 208         # Load settings from file.
 209         &General::readhash("${General::swroot}/tor/settings", \%settings);
 210 }
 211
 212 &showMainBox();
 213
 214 # Close Tor control connection.
 215 &TorClose($torctrl);
 216
 217 # Functions
 218
 219 sub showMainBox() {
 220         my %checked = ();
 221         my %selected = ();
 222
 223         $checked{'TOR_ENABLED'}{'on'} = '';
 224         $checked{'TOR_ENABLED'}{'off'} = '';
 225         $checked{'TOR_ENABLED'}{$settings{'TOR_ENABLED'}} = 'checked';
 226
 227         $checked{'TOR_RELAY_ENABLED'}{'on'} = '';
 228         $checked{'TOR_RELAY_ENABLED'}{'off'} = '';
 229         $checked{'TOR_RELAY_ENABLED'}{$settings{'TOR_RELAY_ENABLED'}} = 'checked';
 230
 231         &Header::openpage($Lang::tr{'tor configuration'}, 1, '');
 232         &Header::openbigbox('100%', 'left', '', $errormessage);
 233
 234         if ($errormessage) {
 235                 &Header::openbox('100%', 'left', $Lang::tr{'error messages'});
 236                 print "<font class='base'>$errormessage&nbsp;</font>\n";
 237                 &Header::closebox();
 238         }
 239
 240         print "<form method='post' action='$ENV{'SCRIPT_NAME'}'>\n";
 241
 242         &Header::openbox('100%', 'center', $Lang::tr{'tor'});
 243
 244
 245 if ( ($memory != 0) && (@pid[0] ne "///") ){
 246                 print "<table width='95%' cellspacing='0' class='tbl'>";
 247                 print "<tr><th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'tor service'}</strong></th></tr>";
 248                 print "<tr><td class='base'>$Lang::tr{'tor daemon'}</td>";
 249                 print "<td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td></tr>";
 250                 print "<tr><td class='base'></td>";
 251                 print "<td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>";
 252                 print "<td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td></tr>";
 253                 print "<tr><td class='base'></td>";
 254                 print "<td bgcolor='$color{'color22'}' align='center'>@pid[0]</td>";
 255                 print "<td bgcolor='$color{'color22'}' align='center'>$memory KB</td></tr>";
 256                 print "</table>";
 257         } else {
 258                 print "<table width='95%' cellspacing='0' class='tbl'>";
 259                 print "<tr><th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'tor service'}</strong></th></tr>";
 260                 print "<tr><td class='base'>$Lang::tr{'tor daemon'}</td>";
 261                 print "<td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td></tr>";
 262                 print "</table>";
 263         }
 264
 265         &Header::closebox();
 266
 267         &Header::openbox('100%', 'center', $Lang::tr{'tor configuration'});
 268
 269         print <<END;
 270                 <table width='95%'>
 271                         <tr>
 272                                 <td colspan='4' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'tor common settings'}</b></td>
 273                         </tr>
 274                         <tr>
 275                                 <td width='25%' class='base'>$Lang::tr{'tor enabled'}:</td>
 276                                 <td width='30%'><input type='checkbox' name='TOR_ENABLED' $checked{'TOR_ENABLED'}{'on'} /></td>
 277                                 <td width='25%' class='base'>$Lang::tr{'tor socks port'}:&nbsp;<img src='/blob.gif' alt='*' /></td>
 278                                 <td width='20%'><input type='text' name='TOR_SOCKS_PORT' value='$settings{'TOR_SOCKS_PORT'}' size='5' /></td>
 279                         </tr>
 280                         <tr>
 281                                 <td width='25%' class='base'>$Lang::tr{'tor relay enabled'}:</td>
 282                                 <td width='30%'><input type='checkbox' name='TOR_RELAY_ENABLED' $checked{'TOR_RELAY_ENABLED'}{'on'} /></td>
 283                                 <td width='25%' class='base'></td>
 284                                 <td width='20%'></td>
 285                         </tr>
 286                 </table>
 287 END
 288
 289         my @temp = split(",", $settings{'TOR_ALLOWED_SUBNETS'});
 290         $settings{'TOR_ALLOWED_SUBNETS'} = join("\n", @temp);
 291
 292         @temp = split(",", $settings{'TOR_USE_EXIT_NODES'});
 293         $settings{'TOR_USE_EXIT_NODES'} = join("\n", @temp);
 294
 295         @temp = split(",", $settings{'TOR_USE_GUARD_NODES'});
 296         $settings{'TOR_USE_GUARD_NODES'} = join("\n", @temp);
 297
 298         print <<END;
 299                 <br>
 300                 <br>
 301
 302                 <table width='95%'>
 303                         <tr>
 304                                 <td colspan='4' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'tor acls'}</b></td>
 305                         </tr>
 306                         <tr>
 307                                 <td colspan='2' class='base' width='55%'>
 308                                         $Lang::tr{'tor allowed subnets'}:
 309                                 </td>
 310                                 <td colspan='2' width='45%'></td>
 311                         </tr>
 312                         <tr>
 313                                 <td colspan='2' class='base' width='55%'>
 314                                         <textarea name='TOR_ALLOWED_SUBNETS' cols='32' rows='3' wrap='off'>$settings{'TOR_ALLOWED_SUBNETS'}</textarea>
 315                                 </td>
 316                                 <td colspan='2' width='45%'></td>
 317                         </tr>
 318                 </table>
 319
 320                 <br />
 321                 <br />
 322
 323                 <table width='95%'>
 324                         <tr>
 325                                 <td colspan='4' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'tor guard nodes'}</b></td>
 326                         </tr>
 327                         <tr>
 328                                 <td colspan='2' class='base' width='55%'></td>
 329                                 <td colspan='2' class='base' width='45%'>$Lang::tr{'tor use guard nodes'}:</td>
 330                         </tr>
 331                         <tr>
 332                                 <td width='50%' colspan='2'>
 333                                         <select name='TOR_GUARD_COUNTRY' multiple='multiple'>
 334                                                 <option value=''>- $Lang::tr{'tor guard country any'} -</option>
 335 END
 336
 337                 # Convert Guard country strings into lists to make comparison easier
 338                 my @guard_countries;
 339                 if ($settings{'TOR_GUARD_COUNTRY'} ne '') {
 340                         @guard_countries = split(/\|/, $settings{'TOR_GUARD_COUNTRY'});
 341                 }
 342
 343                 my @country_codes = &Location::Functions::get_locations("no_special_locations");
 344                 foreach my $country_code (@country_codes) {
 345                         # Convert country code into upper case format.
 346                         $country_code = uc($country_code);
 347
 348                         # Get country name.
 349                         my $country_name = &Location::Functions::get_full_country_name($country_code);
 350
 351                         print "<option value='$country_code'";
 352
 353                         if ($settings{'TOR_GUARD_COUNTRY'} ne '') {
 354                                 print " selected" if grep /$country_code/, @guard_countries;
 355                         }
 356
 357                         print ">$country_name ($country_code)</option>\n";
 358                 }
 359
 360         print <<END;
 361                                         </select>
 362                                 </td>
 363                                 <td width='50%' colspan='2'>
 364                                         <textarea name='TOR_USE_GUARD_NODES' cols='32' rows='3' wrap='off'>$settings{'TOR_USE_GUARD_NODES'}</textarea>
 365                                 </td>
 366                         </tr>
 367                 </table>
 368
 369                 <br />
 370                 <br />
 371
 372                 <table width='95%'>
 373                         <tr>
 374                                 <td colspan='4' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'tor exit nodes'}</b></td>
 375                         </tr>
 376                         <tr>
 377                                 <td colspan='2' class='base' width='55%'></td>
 378                                 <td colspan='2' class='base' width='45%'>$Lang::tr{'tor use exit nodes'}:</td>
 379                         </tr>
 380                         <tr>
 381                                 <td width='50%' colspan='2'>
 382                                         <select name='TOR_EXIT_COUNTRY' multiple='multiple'>
 383                                                 <option value=''>- $Lang::tr{'tor exit country any'} -</option>
 384 END
 385                 my @country_codes = &Location::Functions::get_locations("no_special_locations");
 386
 387                 # Convert Exit country strings into lists to make comparison easier
 388                 my @exit_countries;
 389                 if ($settings{'TOR_EXIT_COUNTRY'} ne '') {
 390                         @exit_countries = split(/\|/, $settings{'TOR_EXIT_COUNTRY'});
 391                 }
 392
 393                 foreach my $country_code (@country_codes) {
 394                         # Convert country code into upper case format.
 395                         $country_code = uc($country_code);
 396
 397                         # Get country name.
 398                         my $country_name = &Location::Functions::get_full_country_name($country_code);
 399
 400                         print "<option value='$country_code'";
 401
 402                         if ($settings{'TOR_EXIT_COUNTRY'} ne '') {
 403                                 print " selected" if grep /$country_code/, @exit_countries;
 404                         }
 405
 406                         print ">$country_name ($country_code)</option>\n";
 407                 }
 408
 409         print <<END;
 410                                         </select>
 411                                 </td>
 412                                 <td width='50%' colspan='2'>
 413                                         <textarea name='TOR_USE_EXIT_NODES' cols='32' rows='3' wrap='off'>$settings{'TOR_USE_EXIT_NODES'}</textarea>
 414                                 </td>
 415                         </tr>
 416                 </table>
 417 END
 418
 419         &Header::closebox();
 420
 421         # Tor relay box
 422         $selected{'TOR_RELAY_MODE'}{'bridge'} = '';
 423         $selected{'TOR_RELAY_MODE'}{'exit'} = '';
 424         $selected{'TOR_RELAY_MODE'}{'private-bridge'} = '';
 425         $selected{'TOR_RELAY_MODE'}{'relay'} = '';
 426         $selected{'TOR_RELAY_MODE'}{$settings{'TOR_RELAY_MODE'}} = 'selected';
 427
 428         $selected{'TOR_RELAY_BANDWIDTH_RATE'}{'0'} = '';
 429         foreach (@bandwidth_limits) {
 430                 $selected{'TOR_RELAY_BANDWIDTH_RATE'}{$_} = '';
 431         }
 432         $selected{'TOR_RELAY_BANDWIDTH_RATE'}{$settings{'TOR_RELAY_BANDWIDTH_RATE'}} = 'selected';
 433
 434         $selected{'TOR_RELAY_BANDWIDTH_BURST'}{'0'} = '';
 435         foreach (@bandwidth_limits) {
 436                 $selected{'TOR_RELAY_BANDWIDTH_BURST'}{$_} = '';
 437         }
 438         $selected{'TOR_RELAY_BANDWIDTH_BURST'}{$settings{'TOR_RELAY_BANDWIDTH_BURST'}} = 'selected';
 439
 440         foreach (@accounting_periods) {
 441                 $selected{'TOR_RELAY_ACCOUNTING_PERIOD'}{$_} = '';
 442         }
 443         $selected{'TOR_RELAY_ACCOUNTING_PERIOD'}{$settings{'TOR_RELAY_ACCOUNTING_PERIOD'}} = 'selected';
 444
 445         &Header::openbox('100%', 'center', $Lang::tr{'tor relay configuration'});
 446
 447         print <<END;
 448                 <table width='95%'>
 449                         <tr>
 450                                 <td width='25%' class='base'>$Lang::tr{'tor relay mode'}:</td>
 451                                 <td width='30%'>
 452                                         <select name='TOR_RELAY_MODE'>
 453                                                 <option value='exit' $selected{'TOR_RELAY_MODE'}{'exit'}>$Lang::tr{'tor relay mode exit'}</option>
 454                                                 <option value='relay' $selected{'TOR_RELAY_MODE'}{'relay'}>$Lang::tr{'tor relay mode relay'}</option>
 455                                                 <option value='bridge' $selected{'TOR_RELAY_MODE'}{'bridge'}>$Lang::tr{'tor relay mode bridge'}</option>
 456                                                 <option value='private-bridge' $selected{'TOR_RELAY_MODE'}{'private-bridge'}>$Lang::tr{'tor relay mode private bridge'}</option>
 457                                         </select>
 458                                 </td>
 459                                 <td width='25%' class='base'>$Lang::tr{'tor relay nickname'}:</td>
 460                                 <td width='20%'>
 461                                         <input type='text' name='TOR_RELAY_NICKNAME' value='$settings{'TOR_RELAY_NICKNAME'}' maxlength='19' />
 462                                 </td>
 463                         </tr>
 464                         <tr>
 465                                 <td width='25%' class='base'>$Lang::tr{'tor relay address'}:</td>
 466                                 <td width='30%'>
 467                                         <input type='text' name='TOR_RELAY_ADDRESS' value='$settings{'TOR_RELAY_ADDRESS'}' />
 468                                 </td>
 469                                 <td width='25%' class='base'>$Lang::tr{'tor relay port'}:&nbsp;<img src='/blob.gif' alt='*' /></td>
 470                                 <td width='20%'>
 471                                         <input type='text' name='TOR_RELAY_PORT' value='$settings{'TOR_RELAY_PORT'}' size='5' />
 472                                 </td>
 473                         </tr>
 474                         <tr>
 475                                 <td width='25%'>&nbsp;</td>
 476                                 <td width='30%'>&nbsp;</td>
 477                                 <td width='25%' class='base'>$Lang::tr{'tor directory port'}:&nbsp;<img src='/blob.gif' alt='*' /></td>
 478                                 <td width='20%'>
 479                                         <input type='text' name='TOR_RELAY_DIRPORT' value='$settings{'TOR_RELAY_DIRPORT'}' size='5' />&nbsp;$Lang::tr{'tor 0 = disabled'}
 480                                 </td>
 481                         </tr>
 482                         <tr>
 483                                 <td width='25%' class='base'>$Lang::tr{'tor contact info'}:</td>
 484                                 <td width='75%' colspan='3'>
 485                                         <input type='text' name='TOR_RELAY_CONTACT_INFO' value='$settings{'TOR_RELAY_CONTACT_INFO'}' style='width: 98%;' />
 486                                 </td>
 487                         </tr>
 488                 </table>
 489
 490                 <br>
 491
 492                 <table width='95%'>
 493                         <tr>
 494                                 <td colspan='4' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'tor bandwidth settings'}</b></td>
 495                         </tr>
 496                         <tr>
 497                                 <td width='25%' class='base'>$Lang::tr{'tor bandwidth rate'}:</td>
 498                                 <td width='30%' class='base'>
 499                                         <select name='TOR_RELAY_BANDWIDTH_RATE'>
 500 END
 501
 502         foreach (@bandwidth_limits) {
 503                 if ($_ >= 1024) {
 504                         print "<option value='$_' $selected{'TOR_RELAY_BANDWIDTH_RATE'}{$_}>". $_ / 1024 ." Mbit/s</option>\n";
 505                 } else {
 506                         print "<option value='$_' $selected{'TOR_RELAY_BANDWIDTH_RATE'}{$_}>$_ kbit/s</option>\n";
 507                 }
 508         }
 509
 510         print <<END;
 511                                                 <option value='0' $selected{'TOR_RELAY_BANDWIDTH_RATE'}{'0'}>$Lang::tr{'tor bandwidth unlimited'}</option>
 512                                         </select>
 513                                 </td>
 514                                 <td width='25%' class='base'>$Lang::tr{'tor accounting limit'}:&nbsp;<img src='/blob.gif' alt='*' /></td>
 515                                 <td width='20%'>
 516                                         <input type='text' name='TOR_RELAY_ACCOUNTING_LIMIT' value='$settings{'TOR_RELAY_ACCOUNTING_LIMIT'}' size='12' />
 517                                 </td>
 518                         </tr>
 519                         <tr>
 520                                 <td width='25%' class='base'>$Lang::tr{'tor bandwidth burst'}:</td>
 521                                 <td width='20%' class='base'>
 522                                         <select name='TOR_RELAY_BANDWIDTH_BURST'>
 523 END
 524
 525         foreach (@bandwidth_limits) {
 526                 if ($_ >= 1024) {
 527                         print "<option value='$_' $selected{'TOR_RELAY_BANDWIDTH_BURST'}{$_}>". $_ / 1024 ." Mbit/s</option>\n";
 528                 } else {
 529                         print "<option value='$_' $selected{'TOR_RELAY_BANDWIDTH_BURST'}{$_}>$_ kbit/s</option>\n";
 530                 }
 531         }
 532         print <<END;
 533                                                 <option value='0' $selected{'TOR_RELAY_BANDWIDTH_BURST'}{'0'}>$Lang::tr{'tor bandwidth unlimited'}</option>
 534                                         </select>
 535                                 </td>
 536                                 <td width='25%' class='base'>$Lang::tr{'tor accounting period'}:</td>
 537                                 <td width='20%'>
 538                                         <select name='TOR_RELAY_ACCOUNTING_PERIOD'>
 539 END
 540
 541         foreach (@accounting_periods) {
 542                 print "<option value='$_' $selected{'TOR_RELAY_ACCOUNTING_PERIOD'}{$_}>$Lang::tr{'tor accounting period '.$_}</option>";
 543         }
 544
 545         print <<END;
 546                                         </select>
 547                                 </td>
 548                         </tr>
 549                 </table>
 550 END
 551
 552         &Header::closebox();
 553
 554         print <<END;
 555                 <table width='95%'>
 556                         <tr>
 557                                 <td><img src='/blob.gif' align='top' alt='*' />&nbsp;<font class='base'>$Lang::tr{'required field'}</font></td>
 558                                 <td align='right'>&nbsp;</td>
 559                         </tr>
 560                 </table>
 561
 562                 <hr>
 563
 564                 <table width='95%'>
 565                         <tr>
 566                                 <td>&nbsp;</td>
 567                                 <td align='center'><input type='submit' name='ACTION' value='$Lang::tr{'save'}' /></td>
 568                                 <td>&nbsp;</td>
 569                         </tr>
 570                 </table>
 571 END
 572
 573         # If we have a control connection, show the stats.
 574         if ($torctrl) {
 575                 &Header::openbox('100%', 'center', $Lang::tr{'tor stats'});
 576
 577                 my @traffic = &TorTrafficStats($torctrl);
 578
 579                 if (@traffic) {
 580                         print <<END;
 581                                 <table width='95%'>
 582 END
 583
 584                 if ($settings{'TOR_RELAY_ENABLED'} eq 'on') {
 585                         my $fingerprint = &TorRelayFingerprint($torctrl);
 586                         if ($fingerprint) {
 587                                 print <<END;
 588                                         <tr>
 589                                                 <td width='40%' class='base'>$Lang::tr{'tor relay fingerprint'}:</td>
 590                                                 <td width='60%'>
 591                                                         <a href='https://metrics.torproject.org/rs.html#details/$fingerprint' target='_blank'>$fingerprint</a>
 592                                                 </td>
 593                                         </tr>
 594 END
 595                         }
 596                 }
 597
 598                 my $address = TorGetInfo($torctrl, "address");
 599                 if ($address) {
 600                         print <<END;
 601                                 <tr>
 602                                         <td width='40%' class='base'>$Lang::tr{'tor relay external address'}:</td>
 603                                         <td width='60%'>$address</td>
 604                                 </tr>
 605 END
 606                 }
 607
 608                 print <<END;
 609                                         <tr>
 610                                                 <td width='40%'>$Lang::tr{'tor traffic read written'}:</td>
 611 END
 612                         print "<td width='60%'>" . &FormatBytes($traffic[0]) ."/". &FormatBytes($traffic[1]) . "</td>";
 613                         print <<END;
 614                                         </tr>
 615                                 </table>
 616 END
 617                 }
 618
 619                 my $accounting = &TorAccountingStats($torctrl);
 620                 if ($accounting) {
 621                         print <<END;
 622                                 <table width='95%'>
 623                                         <tr>
 624                                                 <td colspan='2' class='base'><b>$Lang::tr{'tor accounting'}</b></td>
 625                                         </tr>
 626 END
 627
 628                         if ($accounting->{'hibernating'} eq "hard") {
 629                                 print <<END;
 630                                         <tr>
 631                                                 <td class='base' colspan='2' bgcolor="$Header::colourred" align='center'>
 632                                                         <font color='white'>$Lang::tr{'tor traffic limit hard'}</font>
 633                                                 </td>
 634                                         </tr>
 635 END
 636                         } elsif ($accounting->{'hibernating'} eq "soft") {
 637                                 print <<END;
 638                                         <tr>
 639                                                 <td class='base' colspan='2' bgcolor="$Header::colourorange" align='center'>
 640                                                         <font color='white'>$Lang::tr{'tor traffic limit soft'}</font>
 641                                                 </td>
 642                                         </tr>
 643 END
 644                         }
 645
 646                         print <<END;
 647                                         <tr>
 648                                                 <td width='40%' class='base'>$Lang::tr{'tor accounting interval'}</td>
 649                                                 <td width='60%'>
 650                                                         $accounting->{'interval-start'} - $accounting->{'interval-end'}
 651                                                 </td>
 652                                         </tr>
 653                                         <tr>
 654                                                 <td width='40%' class='base'>$Lang::tr{'tor accounting bytes'}</td>
 655                                                 <td width='60%'>
 656 END
 657
 658                         print &FormatBytes($accounting->{'bytes_read'}) . "/" . &FormatBytes($accounting->{'bytes_written'});
 659                         print " (" . &FormatBytes($accounting->{'bytes-left_read'}) . "/" . &FormatBytes($accounting->{'bytes-left_written'});
 660                         print " $Lang::tr{'tor accounting bytes left'})";
 661
 662                         print <<END;
 663                                                 </td>
 664                                         </tr>
 665                                 </table>
 666 END
 667                 }
 668
 669                 my @nodes = &TorORConnStatus($torctrl);
 670                 if (@nodes) {
 671                         my $nodes_length = scalar @nodes;
 672                         print <<END;
 673                                 <table width='95%'>
 674                                         <tr>
 675                                                 <td width='40%' class='base'><b>$Lang::tr{'tor connected relays'}</b></td>
 676                                                 <td width='60%' colspan='2'>($nodes_length)</td>
 677                                         </tr>
 678 END
 679
 680                         foreach my $node (@nodes) {
 681                                 print <<END;
 682                                         <tr>
 683                                                 <td width='40%'>
 684                                                         <a href='https://metrics.torproject.org/rs.html#details/$node->{'fingerprint'}' target='_blank'>
 685                                                                 $node->{'name'}
 686                                                         </a>
 687                                                 </td>
 688                                                 <td width='30%'>
 689 END
 690
 691                                 if (exists($node->{'country_code'})) {
 692                                         # Get the flag icon of the country.
 693                                         my $flag_icon = &Location::Functions::get_flag_icon($node->{'country_code'});
 694
 695                                         # Check if a flag for the given country is available.
 696                                         if ($flag_icon) {
 697                                                 print "<a href='country.cgi#$node->{'country_code'}'><img src='$flag_icon' border='0' align='absmiddle' alt='$node->{'country_code'}'></a>";
 698                                         } else {
 699                                                 print "<img src='/images/flags/blank.png' border='0' align='absmiddle'/>";
 700                                         }
 701                                 }
 702
 703                                 print <<END;
 704                                                         <a href='ipinfo.cgi?ip=$node->{'address'}'>$node->{'address'}</a>:$node->{'port'}
 705                                                 </td>
 706                                                 <td width='30%' align='right'>
 707                                                         ~$node->{'bandwidth_string'}
 708                                                 </td>
 709                                         </tr>
 710 END
 711                         }
 712                         print "</table>";
 713                 }
 714
 715                 &Header::closebox();
 716         }
 717
 718         print "</form>\n";
 719
 720         &Header::closebigbox();
 721         &Header::closepage();
 722 }
 723
 724 sub BuildConfiguration() {
 725         my %settings = ();
 726         &General::readhash("${General::swroot}/tor/settings", \%settings);
 727
 728         my $torrc = "${General::swroot}/tor/torrc";
 729
 730         open(FILE, ">$torrc");
 731
 732         # Global settings.
 733         print FILE "Sandbox 1\n";
 734         print FILE "HardwareAccel 1\n";
 735         print FILE "ControlPort $TOR_CONTROL_PORT\n";
 736
 737         if ($settings{'TOR_ENABLED'} eq 'on') {
 738                 my $strict_nodes = 0;
 739
 740                 print FILE "SocksPort 0.0.0.0:$settings{'TOR_SOCKS_PORT'}\n";
 741
 742                 my @subnets = split(",", $settings{'TOR_ALLOWED_SUBNETS'});
 743                 foreach (@subnets) {
 744                         print FILE "SocksPolicy accept $_\n" if (&General::validipandmask($_));
 745                 }
 746                 print FILE "SocksPolicy reject *\n" if (@subnets);
 747
 748                 if ($settings{'TOR_GUARD_COUNTRY'} ne '') {
 749                         $strict_nodes = 1;
 750                         my $countrylist;
 751
 752                         for my $singlecountry (split(/\|/, $settings{'TOR_GUARD_COUNTRY'})) {
 753                                 if ($countrylist eq '') {
 754                                         $countrylist = "{" . lc $singlecountry . "}";
 755                                 } else {
 756                                         $countrylist = $countrylist . "," . "{" . lc $singlecountry . "}";
 757                                 }
 758                         }
 759
 760                         print FILE "EntryNodes $countrylist\n";
 761                 }
 762
 763                 if ($settings{'TOR_USE_GUARD_NODES'} ne '') {
 764                         $strict_nodes = 1;
 765
 766                         my @nodes = split(",", $settings{'TOR_USE_GUARD_NODES'});
 767                         foreach (@nodes) {
 768                                 print FILE "EntryNode $_\n";
 769                         }
 770                 }
 771
 772                 if ($settings{'TOR_EXIT_COUNTRY'} ne '') {
 773                         $strict_nodes = 1;
 774                         my $countrylist;
 775
 776                         for my $singlecountry (split(/\|/, $settings{'TOR_EXIT_COUNTRY'})) {
 777                                 if ($countrylist eq '') {
 778                                         $countrylist = "{" . lc $singlecountry . "}";
 779                                 } else {
 780                                         $countrylist = $countrylist . "," . "{" . lc $singlecountry . "}";
 781                                 }
 782                         }
 783
 784                         print FILE "ExitNodes $countrylist\n";
 785                 }
 786
 787                 if ($settings{'TOR_USE_EXIT_NODES'} ne '') {
 788                         $strict_nodes = 1;
 789
 790                         my @nodes = split(",", $settings{'TOR_USE_EXIT_NODES'});
 791                         foreach (@nodes) {
 792                                 print FILE "ExitNode $_\n";
 793                         }
 794                 }
 795
 796                 if ($strict_nodes > 0) {
 797                         print FILE "StrictNodes 1\n";
 798                 }
 799         }
 800
 801         if ($settings{'TOR_RELAY_ENABLED'} eq 'on') {
 802                 # Reject access to private networks.
 803                 print FILE "ExitPolicyRejectPrivate 1\n";
 804
 805                 print FILE "ORPort $settings{'TOR_RELAY_PORT'} IPv4Only\n";
 806
 807                 if ($settings{'TOR_RELAY_DIRPORT'} ne '0') {
 808                         print FILE "DirPort $settings{'TOR_RELAY_DIRPORT'} IPv4Only\n";
 809                 }
 810
 811                 if ($settings{'TOR_RELAY_ADDRESS'} ne '') {
 812                         print FILE "Address $settings{'TOR_RELAY_ADDRESS'}\n";
 813                 }
 814
 815                 if ($settings{'TOR_RELAY_NICKNAME'} ne '') {
 816                         print FILE "Nickname $settings{'TOR_RELAY_NICKNAME'}\n";
 817                 }
 818
 819                 if ($settings{'TOR_RELAY_CONTACT_INFO'} ne '') {
 820                         print FILE "ContactInfo $settings{'TOR_RELAY_CONTACT_INFO'}\n";
 821                 }
 822
 823                 # Limit to bridge mode.
 824                 my $is_bridge = 0;
 825
 826                 if ($settings{'TOR_RELAY_MODE'} eq 'bridge') {
 827                         $is_bridge++;
 828
 829                 # Private bridge.
 830                 } elsif ($settings{'TOR_RELAY_MODE'} eq 'private-bridge') {
 831                         $is_bridge++;
 832
 833                         print FILE "PublishServerDescriptor 0\n";
 834
 835                 # Exit node.
 836                 } elsif ($settings{'TOR_RELAY_MODE'} eq 'exit') {
 837                         print FILE "ExitPolicy accept *:*\n";
 838
 839                 # Relay only.
 840                 } elsif ($settings{'TOR_RELAY_MODE'} eq 'relay') {
 841                         print FILE "ExitPolicy reject *:*\n";
 842                 }
 843
 844                 if ($is_bridge > 0) {
 845                         print FILE "BridgeRelay 1\n";
 846                         print FILE "Exitpolicy reject *:*\n";
 847                 }
 848
 849                 if ($settings{'TOR_RELAY_BANDWIDTH_RATE'} > 0) {
 850                         print FILE "RelayBandwidthRate ";
 851                         print FILE $settings{'TOR_RELAY_BANDWIDTH_RATE'} / 8;
 852                         print FILE " KB\n";
 853
 854                         if ($settings{'TOR_RELAY_BANDWIDTH_BURST'} > 0) {
 855                                 print FILE "RelayBandwidthBurst ";
 856                                 print FILE $settings{'TOR_RELAY_BANDWIDTH_BURST'} / 8;
 857                                 print FILE " KB\n";
 858                         }
 859                 }
 860
 861                 if ($settings{'TOR_RELAY_ACCOUNTING_LIMIT'} > 0) {
 862                         print FILE "AccountingMax ".$settings{'TOR_RELAY_ACCOUNTING_LIMIT'}." MB\n";
 863
 864                         if ($settings{'TOR_RELAY_ACCOUNTING_PERIOD'} eq 'daily') {
 865                                 print FILE "AccountingStart day 00:00\n";
 866                         } elsif ($settings{'TOR_RELAY_ACCOUNTING_PERIOD'} eq 'weekly') {
 867                                 print FILE "AccountingStart week 1 00:00\n";
 868                         } elsif ($settings{'TOR_RELAY_ACCOUNTING_PERIOD'} eq 'monthly') {
 869                                 print FILE "AccountingStart month 1 00:00\n";
 870                         }
 871                 }
 872         }
 873
 874         close(FILE);
 875
 876         # Restart the service.
 877         if (($settings{'TOR_ENABLED'} eq 'on') || ($settings{'TOR_RELAY_ENABLED'} eq 'on')) {
 878                 &General::system("/usr/local/bin/torctrl", "restart");
 879         } else {
 880                 &General::system("/usr/local/bin/torctrl", "stop");
 881         }
 882         # Update pid and memory
 883         daemonstats();
 884 }
 885
 886 sub TorConnect() {
 887         my $socket = new IO::Socket::INET(
 888                 Proto => 'tcp', PeerAddr => '127.0.0.1', PeerPort => $TOR_CONTROL_PORT,
 889         ) or return;
 890
 891         $socket->autoflush(1);
 892
 893         # Authenticate.
 894         &TorSendCommand($socket, "AUTHENTICATE");
 895
 896         return $socket;
 897 }
 898
 899 sub TorSendCommand() {
 900         my ($socket, $cmd) = @_;
 901
 902         # Replace line ending with \r\n.
 903         chomp $cmd;
 904         $cmd .= "\r\n";
 905
 906         $socket->send($cmd);
 907
 908         my @output = ();
 909         while (my $line = <$socket>) {
 910                 # Skip empty lines.
 911                 if ($line =~ /^.\r\n$/) {
 912                         next;
 913                 }
 914
 915                 # Command has been successfully executed.
 916                 if ($line =~ /250 OK/) {
 917                         last;
 918
 919                 # Error.
 920                 } elsif ($line =~ /^5\d+/) {
 921                         last;
 922
 923                 } else {
 924                         # Remove line endings.
 925                         $line =~ s/\r\n$//;
 926
 927                         push(@output, $line);
 928                 }
 929         }
 930
 931         return @output;
 932 }
 933
 934 sub TorSendCommandOneLine() {
 935         my ($tor, $cmd) = @_;
 936
 937         my @output = &TorSendCommand($tor, $cmd);
 938         return $output[0];
 939 }
 940
 941 sub TorGetInfo() {
 942         my ($tor, $cmd) = @_;
 943
 944         my $output = &TorSendCommandOneLine($tor, "GETINFO ".$cmd);
 945
 946         my ($key, $value) = split("=", $output);
 947         return $value;
 948 }
 949
 950 sub TorClose() {
 951         my $socket = shift;
 952
 953         if ($socket) {
 954                 $socket->shutdown(2);
 955         }
 956 }
 957
 958 sub TorTrafficStats() {
 959         my $tor = shift;
 960
 961         my $output_read    = &TorGetInfo($tor, "traffic/read");
 962         my $output_written = &TorGetInfo($tor, "traffic/written");
 963
 964         return ($output_read, $output_written);
 965 }
 966
 967 sub TorRelayFingerprint() {
 968         my $tor = shift;
 969
 970         return &TorGetInfo($tor, "fingerprint");
 971 }
 972
 973 sub TorORConnStatus() {
 974         my $tor = shift;
 975         my @nodes = ();
 976
 977         my @output = &TorSendCommand($tor, "GETINFO orconn-status");
 978         foreach (@output) {
 979                 $_ =~ s/^250[\+-]orconn-status=//;
 980                 next if ($_ eq "");
 981                 last if ($_ eq ".");
 982                 next unless ($_ =~ /^\$/);
 983
 984                 my @line = split(" ", $_);
 985                 my @node = split(/[=~]/, $line[0]);
 986
 987                 my $node = &TorNodeDescription($tor, $node[0]);
 988                 if ($node) {
 989                         push(@nodes, $node);
 990                 }
 991         }
 992
 993         # Sort by names.
 994         @nodes = sort { $a->{'name'} cmp $b->{'name'} } @nodes;
 995
 996         return @nodes;
 997 }
 998
 999 sub TorNodeDescription() {
1000         my ($tor, $fingerprint) = @_;
1001         $fingerprint =~ s/\$//;
1002
1003         my $node = {
1004                 fingerprint  => $fingerprint,
1005                 exit_node    => 0,
1006         };
1007
1008         my @output = &TorSendCommand($tor, "GETINFO ns/id/$node->{'fingerprint'}");
1009
1010         foreach (@output) {
1011                 # Router
1012                 if ($_ =~ /^r (\w+) (.*) (\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) (\d+)/) {
1013                         $node->{'name'}    = $1;
1014                         $node->{'address'} = $3;
1015                         $node->{'port'}    = $4;
1016
1017                         my $country_code = &Location::Functions::lookup_country_code($node->{'address'});
1018                         $node->{'country_code'} = $country_code;
1019
1020                 # Flags
1021                 } elsif ($_ =~ /^s (.*)$/) {
1022                         $node->{'flags'} = split(" ", $1);
1023
1024                         foreach my $flag ($node->{'flags'}) {
1025                                 if ($flag eq "Exit") {
1026                                         $node->{'exit_node'}++;
1027                                 }
1028                         }
1029
1030                 # Bandwidth
1031                 } elsif ($_ =~ /^w Bandwidth=(\d+)/) {
1032                         $node->{'bandwidth'} = $1 * 8;
1033                         $node->{'bandwidth_string'} = &FormatBitsPerSecond($node->{'bandwidth'});
1034                 }
1035         }
1036
1037         if (exists($node->{'name'})) {
1038                 return $node;
1039         }
1040 }
1041
1042 sub TorAccountingStats() {
1043         my $tor = shift;
1044         my $ret = {};
1045
1046         my $enabled = &TorGetInfo($tor, "accounting/enabled");
1047         if ($enabled ne '1') {
1048                 return;
1049         }
1050
1051         my @cmds = ("hibernating", "interval-start", "interval-end");
1052         foreach (@cmds) {
1053                 $ret->{$_} = &TorGetInfo($tor, "accounting/$_");
1054         }
1055
1056         my @cmds = ("bytes", "bytes-left");
1057         foreach (@cmds) {
1058                 my $output = &TorGetInfo($tor, "accounting/$_");
1059                 my @bytes = split(" ", $output);
1060
1061                 $ret->{$_."_read"}    = $bytes[0];
1062                 $ret->{$_."_written"} = $bytes[1];
1063         }
1064
1065         return $ret;
1066 }
1067
1068 sub FormatBytes() {
1069         my $bytes = shift;
1070
1071         my @units = ("B", "KB", "MB", "GB", "TB");
1072         my $units_index = 0;
1073
1074         while (($units_index <= $#units) && ($bytes >= 1024)) {
1075                 $units_index++;
1076                 $bytes /= 1024;
1077         }
1078
1079         return sprintf("%.2f %s", $bytes, $units[$units_index]);
1080 }
1081
1082 sub FormatBitsPerSecond() {
1083         my $bits = shift;
1084
1085         my @units = ("bit/s", "kbit/s", "Mbit/s", "Gbit/s", "Tbit/s");
1086         my $units_index = 0;
1087
1088         while (($units_index <= $#units) && ($bits >= 1024)) {
1089                 $units_index++;
1090                 $bits /= 1024;
1091         }
1092
1093         return sprintf("%.2f %s", $bits, $units[$units_index]);
1094 }