linux-tor-prio.sh 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. #!/bin/bash
  2. # Written by Marco Bonetti & Mike Perry
  3. # Based on instructions from Dan Singletary's ADSL BW Management HOWTO:
  4. # http://www.faqs.org/docs/Linux-HOWTO/ADSL-Bandwidth-Management-HOWTO.html
  5. # This script is Public Domain.
  6. ############################### README #################################
  7. # This script provides prioritization of Tor traffic below other
  8. # traffic on a Linux server. It has two modes of operation: UID based
  9. # and IP based. The UID based method requires that Tor be launched from
  10. # a specific user ID. The "User" and "Group" Tor config settings are
  11. # insufficient, as they set the UID after the socket is created.
  12. # Here is a three line C wrapper you can use to execute Tor and drop
  13. # privs to UID 501 before it creates any sockets. Change the UID
  14. # to the UID for your tor server user, and compile with
  15. # 'gcc tor_wrap.c -o tor_wrap':
  16. # #include <unistd.h>
  17. # int main(int argc, char **argv) {
  18. # if(setresuid(501, 501, 501) == -1) { perror("setresuid"); return 1; }
  19. # execl("/bin/tor", "/bin/tor", "-f", "/etc/tor/torrc", NULL);
  20. # perror("execl"); return 1;
  21. # }
  22. # The IP setting requires that a separate IP address be dedicated to Tor.
  23. # Your Torrc should be set to bind to this IP for "OutboundBindAddress",
  24. # "ListenAddress", and "Address".
  25. # You should also tune the individual connection rate parameters below
  26. # to your individual connection. In particular, you should leave *some*
  27. # minimum amount of bandwidth for Tor, so that Tor users are not
  28. # completely choked out when you use your server's bandwidth. 30% is
  29. # probably a reasonable choice. More is better of course.
  30. # To start the shaping, run it as:
  31. # ./linux-tor-prio.sh
  32. # To get status information (useful to verify packets are getting marked
  33. # and prioritized), run:
  34. # ./linux-tor-prio.sh status
  35. # And to stop prioritization:
  36. # ./linux-tor-prio.sh stop
  37. ########################################################################
  38. # BEGIN USER TUNABLE PARAMETERS
  39. DEV=eth0
  40. # NOTE! You must START Tor under this UID. Using the Tor User/Group
  41. # config setting is NOT sufficient.
  42. TOR_UID=$(id -u tor)
  43. # If the UID mechanism doesn't work for you, you can set this parameter
  44. # instead. If set, it will take precedence over the UID setting. Note that
  45. # you need multiple IPs for this to work.
  46. #TOR_IP="42.42.42.42"
  47. # Average ping to most places on the net, milliseconds
  48. RTT_LATENCY=40
  49. # RATE_UP must be less than your connection's upload capacity in
  50. # kbits/sec. If it is larger, then the bottleneck will be at your
  51. # router's queue, which you do not control. This will cause congestion
  52. # and a revert to normal TCP fairness no matter what the queing
  53. # priority is.
  54. RATE_UP=5000
  55. # RATE_UP_TOR is the minimum speed your Tor connections will have in
  56. # kbits/sec. They will have at least this much bandwidth for upload.
  57. # In general, you probably shouldn't set this too low, or else Tor
  58. # users who use your node will be completely choked out whenever your
  59. # machine does any other network activity. That is not very fun.
  60. RATE_UP_TOR=1500
  61. # RATE_UP_TOR_CEIL is the maximum rate allowed for all Tor trafic in
  62. # kbits/sec.
  63. RATE_UP_TOR_CEIL=5000
  64. CHAIN=OUTPUT
  65. #CHAIN=PREROUTING
  66. #CHAIN=POSTROUTING
  67. MTU=1500
  68. AVG_PKT=900 # should be more like 600 for non-exit nodes
  69. # END USER TUNABLE PARAMETERS
  70. # The queue size should be no larger than your bandwidth-delay
  71. # product. This is RT latency*bandwidth/MTU/2
  72. BDP=$(expr $RTT_LATENCY \* $RATE_UP / $AVG_PKT)
  73. # Further research indicates that the BDP calculations should use
  74. # RTT/sqrt(n) where n is the expected number of active connections..
  75. BDP=$(expr $BDP / 4)
  76. if [ "$1" = "status" ]
  77. then
  78. echo "[qdisc]"
  79. tc -s qdisc show dev $DEV
  80. tc -s qdisc show dev imq0
  81. echo "[class]"
  82. tc -s class show dev $DEV
  83. tc -s class show dev imq0
  84. echo "[filter]"
  85. tc -s filter show dev $DEV
  86. tc -s filter show dev imq0
  87. echo "[iptables]"
  88. iptables -t mangle -L TORSHAPER-OUT -v -x 2> /dev/null
  89. exit
  90. fi
  91. # Reset everything to a known state (cleared)
  92. tc qdisc del dev $DEV root 2> /dev/null > /dev/null
  93. tc qdisc del dev imq0 root 2> /dev/null > /dev/null
  94. iptables -t mangle -D POSTROUTING -o $DEV -j TORSHAPER-OUT 2> /dev/null > /dev/null
  95. iptables -t mangle -D PREROUTING -o $DEV -j TORSHAPER-OUT 2> /dev/null > /dev/null
  96. iptables -t mangle -D OUTPUT -o $DEV -j TORSHAPER-OUT 2> /dev/null > /dev/null
  97. iptables -t mangle -F TORSHAPER-OUT 2> /dev/null > /dev/null
  98. iptables -t mangle -X TORSHAPER-OUT 2> /dev/null > /dev/null
  99. ip link set imq0 down 2> /dev/null > /dev/null
  100. rmmod imq 2> /dev/null > /dev/null
  101. if [ "$1" = "stop" ]
  102. then
  103. echo "Shaping removed on $DEV."
  104. exit
  105. fi
  106. # Outbound Shaping (limits total bandwidth to RATE_UP)
  107. ip link set dev $DEV qlen $BDP
  108. # Add HTB root qdisc, default is high prio
  109. tc qdisc add dev $DEV root handle 1: htb default 20
  110. # Add main rate limit class
  111. tc class add dev $DEV parent 1: classid 1:1 htb rate ${RATE_UP}kbit
  112. # Create the two classes, giving Tor at least RATE_UP_TOR kbit and capping
  113. # total upstream at RATE_UP so the queue is under our control.
  114. tc class add dev $DEV parent 1:1 classid 1:20 htb rate $(expr $RATE_UP - $RATE_UP_TOR)kbit ceil ${RATE_UP}kbit prio 0
  115. tc class add dev $DEV parent 1:1 classid 1:21 htb rate $[$RATE_UP_TOR]kbit ceil ${RATE_UP_TOR_CEIL}kbit prio 10
  116. # Start up pfifo
  117. tc qdisc add dev $DEV parent 1:20 handle 20: pfifo limit $BDP
  118. tc qdisc add dev $DEV parent 1:21 handle 21: pfifo limit $BDP
  119. # filter traffic into classes by fwmark
  120. tc filter add dev $DEV parent 1:0 prio 0 protocol ip handle 20 fw flowid 1:20
  121. tc filter add dev $DEV parent 1:0 prio 0 protocol ip handle 21 fw flowid 1:21
  122. # add TORSHAPER-OUT chain to the mangle table in iptables
  123. iptables -t mangle -N TORSHAPER-OUT
  124. iptables -t mangle -I $CHAIN -o $DEV -j TORSHAPER-OUT
  125. # Set firewall marks
  126. # Low priority to Tor
  127. if [ ""$TOR_IP == "" ]
  128. then
  129. echo "Using UID-based QoS. UID $TOR_UID marked as low priority."
  130. iptables -t mangle -A TORSHAPER-OUT -m owner --uid-owner $TOR_UID -j MARK --set-mark 21
  131. else
  132. echo "Using IP-based QoS. $TOR_IP marked as low priority."
  133. iptables -t mangle -A TORSHAPER-OUT -s $TOR_IP -j MARK --set-mark 21
  134. fi
  135. # High prio for everything else
  136. iptables -t mangle -A TORSHAPER-OUT -m mark --mark 0 -j MARK --set-mark 20
  137. echo "Outbound shaping added to $DEV. Rate for Tor upload at least: ${RATE_UP_TOR}Kbyte/sec."