iv-org/smart-ipv6-rotator
1
0
Fork 0
mirror of https://github.com/iv-org/smart-ipv6-rotator.git synced 2024-11-23 05:59:45 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
IPv6 rotator for specific subnets - unblock restrictions on IPv6 enabled websites (Google by default but customizable for others)
21 Commits 1 Branch 0 Tags 125 KiB
Python 99%
Dockerfile 1%
6495ca30f2
Go to file
Kavin 6495ca30f2
Add gha workflow to publish to quay (#5)
2023-11-02 17:25:30 +00:00
.github/workflows Add gha workflow to publish to quay (#5) 2023-11-02 17:25:30 +00:00
.dockerignore Add a Dockerfile (#4) 2023-10-25 21:30:16 +02:00
.gitignore Add a Dockerfile (#4) 2023-10-25 21:30:16 +02:00
Dockerfile Add a Dockerfile (#4) 2023-10-25 21:30:16 +02:00
LICENSE LICENSE under the AGPLv3 2023-10-15 00:38:33 +02:00
README.md add example crontab 2023-10-15 11:16:30 +02:00
requirements.txt Add a Dockerfile (#4) 2023-10-25 21:30:16 +02:00
smart-ipv6-rotator.py enhance logging + remove some comments 2023-10-15 11:20:52 +02:00

README.md

Requirements

  • IPv6 on your server
  • Invidious works in IPv6
  • Install these two python packages:
    • pyroute2
    • requests
  • Your provider need to allow you to assign any arbitrary IPv6 address, your IPv6 space must be fully routed.
    Usually the case but some do not support it like the popular cloud providers: AWS, Google Cloud, Oracle Cloud, Azure and more.

How to setup (very simple tutorial)

Full detailed documentation: https://docs.invidious.io/ipv6-rotator/

  1. Git clone the repository somewhere.
  2. Find your IPv6 subnet. If you do not know it, you can use a tool like http://www.gestioip.net/cgi-bin/subnet_calculator.cgi
  3. Run once the script using sudo python smart-ipv6-rotator.py run --ipv6range=YOURIPV6SUBNET/64
  4. If everything went well then configure a cron to periodically rotate your IPv6 range. Twice a day (noon and midnight) is enough for YouTube servers. Also at the reboot of the server!
    Example crontab (crontab -e -u root): 
    @reboot sleep 30s && python smart-ipv6-rotator.py run --ipv6range=YOURIPV6SUBNET/64
0 */12 * * * python smart-ipv6-rotator.py run --ipv6range=YOURIPV6SUBNET/64
    The sleep command is used in case your network takes too much time time to be ready.

How to clean the configuration done by the script

sudo python smart-ipv6-rotator.py clean

Only works if the script did not crash. But in case of a crash, in most case the system should auto rollback the changes.

Why does this need root privileges?

You can only modify the network configuration of your server using root privileges.
The attack surface of this script is very limited as it is not running in the background, it's a one shot script.

How does this script work?

  1. First it check that you have IPv6 connectivity.
  2. It automatically find the default IPv6 gateway and automatically generate a random IPv6 address from the IPv6 subnet that you configured.
  3. It adds the random IPv6 address to the network interface.
  4. It configures route for only using that new random IPv6 address for the specific IPv6 subnets (Google ipv6 ranges by default).
    This way your current ipv6 network configuration is untouched and any change done by the script is temporary.

TODO (priority)

High

  • Docker image for easier use.
  • Allow to configure your IPv6 subnets yourself. (Could be used for other projects)
  • Better handle in case of errors in configuring IPv6 routes. Rollback the changes automatically
  • Allow to specify a specific network interface + ipv6 gateway instead of automatically discovering it.

Medium

  • Arg for spit out the IPv6 subnet of the current default ipv6 address instead of saying to use gestioip.net tool.
  • In most time, adding the new random IPv6 will take precedence over the existing IPv6. This may not be the expected behavior.

Low

  • Argument for testing if the setup will work without permanently do any modification.
  • Allow to remove debug info
  • Maybe not depend on icanhazip? Send requests in HTTPS?