Add distributed cluster mode and sync peer network routes on reload

This commit is contained in:
Eduardo Silva
2026-11-20 20:42:42 -03:00
parent 5f6e2cd61c
commit 0ee6c2b864
25 changed files with 993 additions and 70 deletions
+8
View File
@@ -13,6 +13,7 @@ from django.utils.translation import gettext_lazy as _
from scheduler.models import PeerScheduling
from wireguard.models import NETMASK_CHOICES, Peer, PeerAllowedIP
from wireguard_peer.functions import find_network_in_other_instance
class PeerModelForm(forms.ModelForm):
@@ -101,6 +102,13 @@ class PeerAllowedIPForm(forms.ModelForm):
else:
if ipaddress.ip_address(allowed_ip) in wireguard_network:
raise forms.ValidationError(_("The IP address belongs to the Peer's WireGuard instance network range. Please check the IP address or change use priority 0 instead."))
other_network = find_network_in_other_instance(self.current_peer.wireguard_instance, allowed_ip, netmask)
if other_network:
raise forms.ValidationError(
_("This network is already used by peer %(peer)s of wg%(instance)s. A network can be routed to only one WireGuard instance.") % {
'peer': other_network.peer, 'instance': other_network.peer.wireguard_instance.instance_id
}
)
elif self.config_file == 'client':
if self.current_peer.routing_template and not self.current_peer.routing_template.allow_peer_custom_routes:
raise forms.ValidationError(_("The peer's routing template does not allow custom routes."))
+22
View File
@@ -1,3 +1,4 @@
import ipaddress
import subprocess
from typing import Any, Dict, Optional, Tuple
@@ -7,6 +8,27 @@ from routing_templates.models import RoutingTemplate
from wireguard.models import Peer, PeerAllowedIP, WireGuardInstance
def find_network_in_other_instance(wireguard_instance, allowed_ip, netmask):
"""
Server side network of a peer of another instance that is the same as the given one. Each instance routes its
peer networks to its own interface, so the same network on two instances cannot be routed: the second interface
fails to start.
"""
try:
network = ipaddress.ip_network(f'{allowed_ip}/{netmask}', strict=False)
except ValueError:
return None
other_networks = PeerAllowedIP.objects.filter(config_file='server').exclude(
peer__wireguard_instance=wireguard_instance
).select_related('peer__wireguard_instance')
for other_network in other_networks:
try:
if ipaddress.ip_network(f'{other_network.allowed_ip}/{other_network.netmask}', strict=False) == network:
return other_network
except ValueError:
continue
return None
def generate_peer_default(wireguard_instance):
private_key = subprocess.check_output('wg genkey', shell=True).decode('utf-8').strip()
public_key = subprocess.check_output(f'echo {private_key} | wg pubkey', shell=True).decode('utf-8').strip()
+96 -1
View File
@@ -1,3 +1,98 @@
import json
from django.test import TestCase
# Create your tests here.
from api_v2.models import ApiKey
from wireguard.models import Peer, PeerAllowedIP, WireGuardInstance
from wireguard_peer.forms import PeerAllowedIPForm
def create_instance(instance_id):
return WireGuardInstance.objects.create(
instance_id=instance_id, private_key=f'private-{instance_id}', public_key=f'public-{instance_id}',
hostname='primary.example.test', listen_port=51820 + instance_id, address=f'10.188.{instance_id}.1',
)
def create_peer(instance, name, address):
peer = Peer.objects.create(
name=name, public_key=f'public-{name}', pre_shared_key=f'psk-{name}', wireguard_instance=instance,
)
PeerAllowedIP.objects.create(peer=peer, config_file='server', priority=0, allowed_ip=address, netmask=32)
return peer
class NetworkSetupMixin:
"""wg0 already routes 192.168.74.0/24 to one of its peers."""
def setUp(self):
super().setUp()
self.wg0 = create_instance(0)
self.wg1 = create_instance(1)
self.peer_wg0 = create_peer(self.wg0, 'peer-wg0', '10.188.0.2')
self.peer_wg0_other = create_peer(self.wg0, 'peer-wg0-other', '10.188.0.3')
self.peer_wg1 = create_peer(self.wg1, 'peer-wg1', '10.188.1.2')
self.network_wg0 = PeerAllowedIP.objects.create(
peer=self.peer_wg0, config_file='server', priority=1, allowed_ip='192.168.74.0', netmask=24,
)
class NetworkInOtherInstanceTests(NetworkSetupMixin, TestCase):
"""The same network cannot be routed to peers of two instances: the second interface would fail to start."""
def form(self, peer, allowed_ip, netmask, config_file='server', instance=None):
return PeerAllowedIPForm(
data={'allowed_ip': allowed_ip, 'netmask': netmask, 'priority': 1},
instance=instance, current_peer=peer, config_file=config_file,
)
def test_form_refuses_network_of_other_instance(self):
form = self.form(self.peer_wg1, '192.168.74.0', 24)
self.assertFalse(form.is_valid())
self.assertIn('peer-wg0', str(form.errors))
self.assertIn('wg0', str(form.errors))
def test_form_refuses_same_network_written_with_host_address(self):
self.assertFalse(self.form(self.peer_wg1, '192.168.74.9', 24).is_valid())
def test_form_accepts_different_prefix(self):
self.assertTrue(self.form(self.peer_wg1, '192.168.74.128', 25).is_valid())
def test_form_accepts_same_instance_and_editing_itself(self):
self.assertTrue(self.form(self.peer_wg0_other, '192.168.74.0', 24).is_valid())
self.assertTrue(self.form(self.peer_wg0, '192.168.74.0', 24, instance=self.network_wg0).is_valid())
def test_form_does_not_check_client_routes(self):
self.assertTrue(self.form(self.peer_wg1, '192.168.74.0', 24, config_file='client').is_valid())
class NetworkInOtherInstanceApiTests(NetworkSetupMixin, TestCase):
def setUp(self):
super().setUp()
self.api_key = ApiKey.objects.create(name='tests')
def call(self, method, payload):
payload = dict(payload, instance='wg1', skip_reload=True)
return getattr(self.client, method)(
'/api/v2/manage_peer/', data=json.dumps(payload), content_type='application/json',
HTTP_TOKEN=str(self.api_key.token),
)
def test_api_create_refuses_network_of_other_instance(self):
peer_count = Peer.objects.count()
response = self.call('post', {'name': 'api-peer', 'announced_networks': ['192.168.74.0/24']})
self.assertEqual(response.status_code, 400)
self.assertIn('wg0', response.json()['error_message'])
self.assertEqual(Peer.objects.count(), peer_count)
def test_api_update_refuses_network_of_other_instance(self):
response = self.call('put', {
'peer_public_key': self.peer_wg1.public_key, 'announced_networks': ['192.168.75.0/24', '192.168.74.0/24'],
})
self.assertEqual(response.status_code, 400)
self.assertFalse(PeerAllowedIP.objects.filter(peer=self.peer_wg1, priority__gte=1).exists())
def test_api_update_accepts_free_network(self):
response = self.call('put', {'peer_public_key': self.peer_wg1.public_key, 'announced_networks': ['192.168.75.0/24']})
self.assertEqual(response.status_code, 200, response.content)
self.assertTrue(PeerAllowedIP.objects.filter(peer=self.peer_wg1, allowed_ip='192.168.75.0', netmask=24).exists())
+9 -9
View File
@@ -6,7 +6,7 @@ from django.http import Http404
from django.shortcuts import get_object_or_404, redirect, render
from django.utils.translation import gettext_lazy as _
from cluster.models import ClusterSettings, Worker
from cluster.models import ClusterSettings
from routing_templates.models import RoutingTemplate
from scheduler.models import PeerScheduling
from user_manager.models import UserAcl
@@ -15,7 +15,7 @@ from wgwadmlibrary.tools import check_sort_order_conflict, deduplicate_sort_orde
from wireguard.models import Peer, PeerAllowedIP, WireGuardInstance
from wireguard_peer.forms import PeerAllowedIPForm, PeerNameForm, PeerKeepaliveForm, PeerKeysForm, PeerSuspensionForm, \
PeerScheduleProfileForm
from wireguard_tools.functions import func_reload_wireguard_interface
from wireguard_tools.functions import func_reload_wireguard_interface, get_config_servers
from wireguard_tools.views import export_wireguard_configuration
from .functions import func_create_new_peer
@@ -24,6 +24,12 @@ def _auto_apply(request, instance):
if not settings.AUTO_APPLY:
return False
export_wireguard_configuration(instance)
hosting_worker = instance.hosting_worker
if hosting_worker:
messages.info(request, _('wg%(id)s runs on %(worker)s, which applies the change on its next synchronization.') % {
'id': instance.instance_id, 'worker': hosting_worker
})
return True
success, message = func_reload_wireguard_interface(instance)
if success:
messages.info(request, _('wg%(id)s reloaded automatically.') % {'id': instance.instance_id})
@@ -88,13 +94,7 @@ def view_wireguard_peer_list(request):
refresh_interval = settings.WIREGUARD_STATUS_CACHE_REFRESH_INTERVAL
cluster_settings = ClusterSettings.objects.filter(name='cluster_settings', enabled=True).first()
servers = []
if cluster_settings:
if cluster_settings.primary_enable_wireguard:
servers.append({'name': _('Primary Server'), 'uuid': ''})
for worker in Worker.objects.filter(enabled=True):
servers.append({'name': worker.display_name, 'uuid': str(worker.uuid)})
servers = get_config_servers(current_instance)
context = {
'page_title': page_title, 'wireguard_instances': wireguard_instances,