Freifunk Dresden: ffdd-server -

Configures an Debian (11/12) or Ubuntu-Server LTS (20.04/22.04/24.04) as Freifunk-Dresden Server, that could be used as internet gateway an as basis to add further services.

Releases - latest Stable Release - CHANGELOG

Issues - Wiki Documentation (German)

Debian Security Informations

Freifunk Ziel

Freifunk hat es sich zum Ziel gesetzt, Menschen möglichst flächendeckend mit freiem WLAN zu versorgen. Freier Zugang zu Informationen ist nicht nur eine Quelle für Wissen, sondern kann sich auch positiv auf die wirtschaftliche und kulturelle Entwicklung einer Stadt, Region und Land auswirken, da das Internet in der heutigen Zeit sicher ein fester Bestandteil des täglichen Lebens geworden ist. Freifunk bietet die Möglichkeit, Internet per WLAN frei zu nutzen - ohne Zugangssperren und sicher, da der Internettraffic via verschlüsselten Internettunnel (VPN) ins Ausland geroutet wird.

Freifunk Dresden Server (ffdd-server)

Dieses Repository bildet die Funktionalität eines Servers für Freifunk Dresden. Der ffdd-server arbeitet wie ein Freifunk Knoten und ist soweit konfiguriert, dass dieser eine Knotenwebseite anbietet, Backboneverbindungen (fastd2) akzeptiert und via Openvpn Internettunnel für den Internetverkehr aus dem Freifunknetz aufbauen kann.

HINWEIS: Der ffdd-server ist auf Freifunk Dresden zugeschnitten. Soll dieses als Basis für andere Freifunk Communities verwendet werden, müssen Anpassungen gemacht werden. Bitte dazu ein Issue im Github erstellen.

• Es empfiehlt sich dringend für andere Communities, dieses Repository zu forken, da hier generelle Umstellungen zusammen mit der passenden Firmware für Dresdener Anforderungen erfolgen.
  Communities sollten dann auf das geforkte Repository (gilt auch für das "firmware-freifunk-dresden" Repository) aufbauen. Jede Community trägt die alleinige Verantwortung und Kontrolle über ihr Netz und sollte eigene Erfahrene Leute/Admins bereitstellen. Hilfe von Dresden ist aber jederzeit möglich, aber Administrative Aufgaben oder Garantien werden nicht übernommen, da das einfach den organisatorischen Aufwand sprengt.
  Wir wissen selber nicht, wie sich das Netz in Zukunft noch verhält, wenn dieses weiter wächst.

• Routingprotokoll BMXD: Diese Protokoll wurde anstelle von bmx6 oder bmx-advanced aus verschiedenen Gründen gewählt. Es wird vom eigentlich Author nicht mehr weiterentwickelt oder gepflegt. Für die Dresdener-Firmware wurden einige Fehler behoben. (siehe http://wiki.freifunk-dresden.de/)

• Anpassungen: Speziell gilt das für den IP Bereich und der Knotenberechnung. Aus Knotennummern werden mit ddmesh-ipcalc.sh alle notwendigen IP Adressen berechnet. (siehe Technische Information)
  
  Freifunk Dresden verwendet zwei IP Bereiche, eines für die Knoten selber (10.200.0.0/16) und eines für das Backbone (10.201.0.0/16). Dieses ist technisch bedingt. Wird bei freifunk.net nur ein solcher Bereich reserviert (z.b. 10.13.0.0/16), so muss das Script ddmesh-ipcalc.sh in der Berechnung angepasst werden, so dass zwei separate Bereich entstehen. Die Bereiche für 10.13.0.0/16 würden dann 10.13.0.0/17 und 10.128.0.0/17 sein.
  
  Das Script ddmesh-ipcalc.sh wird ebenfalls in der Firmware verwendet, welches dort auch angepasst werden muss.
  In der Firmware gibt es zwei weitere Stellen, die dafür angepasst werden müssen. Das sind /www/nodes.cgi und /www/admin/nodes.cgi. Hier wurde auf den Aufruf von ddmesh-ipcalc.sh verzichtet und die Berechnung direkt gemacht, da die Ausgabe der Router-Webpage extrem lange dauern würde.
  
  In /etc/config/ffdd werden die meisten Einstellungen für den Server hinterlegt.

• Weiterhin verwendet das Freifunk Dresden Netz als Backbone-VPN Tool fastd2.

  fastd2 ist ein für Freifunk entwickeltes VPN, welches eine schnelle und zuverlässige Verbindung bereitstellt.
  Bei der aktuellen Installation werden alle Verbindungen von Freifunk-Router zum Server zugelassen, welche sich mit dem korrekten Public-Key des Servers verbinden. Dieser Public-Key kann über http://ip-des-knotens/sysinfo-json.cgi ausgelesen werden.
  Verbindet sich ein Router mit einem Server erfolgreich, so "lernt" der Server diese Verbindung und erzeugt ein entsprechendes Konfigurationsfile unterhalb von /etc/fastd/peers2.
  Später kann der Server umgestellt werden, so dass nur noch dort abgelegte Konfigurationen (Verbindungen) akzeptiert werden. Gesteuert wird dieses durch das Konfigurationsfile von fastd (/etc/fastd/fastd2.conf).

• Der ffdd-server unterstützt derzeit zwei VPN Implementationen Openvpn und Wireguard. Wireguard ist aber noch im BETA-Zustand. (Wireguard Unterstützung in Containern ist nur möglich wenn auch die kernel-headers verfügbar sind.)
  /etc/openvpn und /etc/wireguard enthält je ein Script, mit dem verschiedene VPN Konfigurationen von Tunnelanbietern so aufbereitet werden, das diese für Freifunk Dresden richtig arbeiten.
  Wie in der Firmware läuft per cron.d ein Internet-check, der in der ersten Stufe das lokale Internet testet und wenn dieses funktioniert, wird das Openvpn/Wireguard Internet geprüft. Ist das Openvpn/Wireguard Internet verfügbar, wird dieser Server als Internet-Gateway im Freifunknetz bekannt gegeben.

• Der ffdd-server selbst arbeitet ebenfalls als DNS Server für die Knoten, die ihn als Gateway ausgewählt haben. Die DNS Anfragen werden dabei auch über den VPN Tunnel geleitet.

Wichtig ist, dass tun/tap devices und alle möglichen iptables module verfügbar sind. IPv6 ist nicht notwendig, da das Freifunk Netz in Dresden nur IPv4 unterstützt. (Platzmangel auf Routern und bmxd unterstützt dieses nicht.)

Voraussetzungen

• mindestens Grundkenntnisse über Linux Server und Kenntnisse im Bereich Netzwerke / Routing.

• Notwendig ist eine Debian (11/12) oder Ubuntu-Server LTS (20.04/22.04/24.04) Installation.
  Wähle dafür aber die "Server-⁠Variante" nicht Desktop! (Empfehlung: Debian)

• Speicher: min. 1GByte RAM, 2GByte Swap

• Netzwerk: min. 100Mbit/s

• Kernel Module: tun.ko muss vorhanden sein. Evt sollte man sich vorher beim Server Anbieter informieren. Nicht alle Anbieter haben einen Support im Kernel. Genutzt wird es vom Routing Protokoll, Backbone, Openvpn und Wireguard.

• Virtualisierung: Wird der Freifunk Server auf einem virtuellen Server oder Container aufgesetzt, so funktionieren als Umgebungen QEMU(KVM), XEN, LXC / LXD und OPENVZ sehr gut.

• Firewall: Bitte stelle sicher dass der Server über Port: 80/tcp , 443/tcp, 5002/udp und 5003/udp aus dem Internet erreichbar ist.

Installation

• Bringe Debian/Ubuntu auf die aktuelle Version. Das geht bei Ubuntu Schrittweise von Version zu Version. (https://help.ubuntu.com/community/UpgradeNotes)
  

Wichtig:

• Habt ihr bereits einen Registrierten Gateway-Knoten und die dazugehörige /etc/config/ffdd solltet ihr diese jetzt auf dem Server hinterlegen! Anderen falls wird diese automatisch generiert und eine neue Knotennummer vergeben und registriert.

• Installations Path in /etc/config/ffdd
  Eine Änderung des Path sollte unbedingt vermieden werden da ansonsten kein Salt-Service und ein Autoupdate mehr gewährleistet werden kann! Es gibt aber die einfache Möglichkeit sich bei Bedarf einen Symlink zu erstellen.

• /etc/hostname (sollte aussehen wie z.B.: hostname.domainname.tld) > Bitte versichert euch nun dass euer Hostname korrekt gesetzt ist und der entsprechende DNS Eintrag mit der öffentlichen IP des Servers von euch hinterlegt wurde! Andernfalls wird kein SSL-Zertifikat von letsencrypt zur Verfügung gestellt.
  Beispiel: hostnamectl set-hostname vpnX.freifunk-dresden.de

• networking > Bitte überprüfe ob alle Netzwerkeinstellungen korrekt sind und stelle sicher dass mindestens ein DNS-Server hinterlegt ist. (Debian-Wiki:NetworkConfiguration)

• execute in screen or use mosh > Es wird empfohlen bei der Erstinstallation sowie bei manuellen Updates das Script in einem screen auszuführen! Sollte es zu Verbindungsabbrüchen während der Installations oder den Updates kommen so kann man nach dem erneuten Verbinden sich einfach den screen wieder öffnen (attach). man screen für weitere Informationen. Alternativ kann man auch mosh anstelle von ssh nutzen.

Folgendes cloned und Installiert das Repository.
Es wird beim ersten Durchführen einige Zeit in Anspruch nehmen da einige Packages und ihre Abhängigkeiten installiert, Files kopiert und noch einige Tools compiliert werden müssen.

git:

apt-get -y install git
git clone https://github.com/Freifunk-Dresden/ffdd-server.git /srv/ffdd-server
cd /srv/ffdd-server && git checkout T_RELEASE_latest
./init_server.sh -i -u

Alternative Installations Möglichkeiten:

curl:

apt-get -y install curl
bash -c "$(curl -fsSL https://raw.githubusercontent.com/Freifunk-Dresden/ffdd-server/T_RELEASE_latest/init_server.sh)" -c "-i"

wget:

apt-get -y install wget
bash -c "$(wget https://raw.githubusercontent.com/Freifunk-Dresden/ffdd-server/T_RELEASE_latest/init_server.sh -O -)" -c "-i"

Coffee Time (~ 10min)

Manuelle Anpassungen

Nun müssen noch Host-Spezifische Dinge kontrolliert und angepasst werden:

• /etc/hostname (FQDN)

• /etc/config/ffdd

  • servername
  • ifname
  • contact informations

• Create your first Backbone Connection (Freifunk Netzwerk - Backbone Übersicht)
  

  • fastd2 /etc/fastd/peers2/
/etc/init.d/S53backbone-fastd2 add_connect vpnX.freifunk-dresden.de 5002
    or: /etc/init.d/S53backbone-fastd2 add_connect <host> <port> <key>
  • wireguard /etc/wireguard/
/usr/local/bin/wg-backbone.sh register vpnX.freifunk-dresden.de
    or: /usr/local/bin/wg-backbone.sh connect <host> <port> <node> <key>

• VPN-Gateway Service

  • Notice: OVPN/WG supports interface vpn0 and vpn1
  • /etc/openvpn/
    creates openvpn-vpn0.conf with:
    /etc/openvpn/gen-config.sh vpn0 <original-provider-config-file>
    for vpn user and password credantials use: /etc/openvpn/openvpn.login
  • /etc/wireguard/
    creates vpn0.conf with:
    /etc/wireguard/gen-config.sh vpn0 <original-provider-config-file>

Apply

Im letzten Schritt müssen die Änderungen noch übernommen und überprüft werden. (Dies geschieht auch automatisch jede Stunde per cronjob).
Wir wollen aber sehen ob alles läuft und auch alles erfolgreich initialisiert wird:

salt-call state.highstate --local

# Debug Mode
salt-call state.highstate --local -l debug

Nachdem dem nun alle deine Einstellungen überprüft und gesetzt hast sollte der Server einmal sauber neu gestartet werden.

Optional

Du hast selbstverständlich zu jeder Zeit die Möglichkeit dein System nach deinen wünschen anzupassen. Dazu gehören unter anderem auch folgende Optionen:

• /root/.bash_user_aliases
  Kann verwendet werden um eigene bash-aliases (default shell) für den Benutzer 'root' anzulegen. Diese werden in /root/.bash_aliases eingebunden und automatisch mit geladen.
• /etc/firewall.user
  Kann verwendet werden um eigene Firewall regeln (iptables) zu definieren. Diese werden in /etc/init.d/S41firewall eingebunden und automatisch mit geladen.
• /etc/network_rules.user
  Kann verwendet werden um eigene Netzwerk regeln (ip rule/route) zu definieren. Diese werden in /etc/init.d/S40network eingebunden und automatisch mit geladen.

Autoupdate

Bei jeder Durchführung des salt-Befehls wird überprüft ob das locale ffdd-server Repository unter /srv/ffdd-server auf dem aktuellsten Stand ist. Dies gewährleistet dass Änderungen sowie Bugfixes aber auch Neuerungen schnellst möglich zur Verfügung gestellt werden können.

Manuell Update

Das Autoupdate kann zur jeder Zeit abgeschaltet werden. Dazu muss dieses lediglich über das folgende Kommando in der /etc/config/ffdd deaktiviert werden:
uci set ffdd.sys.autoupdate=0 ; uci commit

Ein manuelles Update durchzuführen:
use: /srv/ffdd-server/init_server.sh (incl. OS Upgrade)
or: /usr/local/bin/freifunk-manuell_update.sh

OR

cd /srv/ffdd-server
git stash
git checkout $(uci -qX get ffdd.sys.branch)
git pull -f origin $(uci -qX get ffdd.sys.branch)
salt-call state.highstate --local -l error

Fehlerhaftes Repository

Sollte es Probleme jeglicher Art mit dem 'ffdd-server' repo geben dann ist der einfachste Weg dieses neu zu erstellen und salt aufzurufen.

use: /usr/local/bin/freifunk-manuell_update.sh

OR

cd /srv/ && rm -rf /srv/ffdd-server
git clone https://github.com/Freifunk-Dresden/ffdd-server/ /srv/ffdd-server
cd /srv/ffdd-server/ && git checkout T_RELEASE_latest
salt-call state.highstate --local -l error

Development

Um eine andere Release-Version zu benutzen ist ein notwendig in der /etc/config/ffdd die Option "branch" anzupassen.

Default (Stable):

uci set ffdd.sys.branch='T_RELEASE_latest' ; uci commit

Development:

uci set ffdd.sys.branch='master' ; uci commit

Zudem ist es auch möglich seine eigene Repository URL zu nutzen.

uci set ffdd.sys.freifunk_repo='https://your_repo_url/' ; uci commit

DEV init_server.sh - Installation

git clone https://github.com/Freifunk-Dresden/ffdd-server.git /srv/ffdd-server
cd /srv/ffdd-server

# install master (devel) branch
./init_server.sh -i -b
# or
./init_server.sh -i -b <rev/branch/tag>

# do not overwrite local changes (disable git update)
./init_server.sh -i -u

Wichig für Communitiy Forks

Im moment gibt es keinen Schutz, dass Routerfirmware einer Communitiy sich mit Servern oder Routern anderer Communities verbinden. Es ist Fatal, wenn sich die Netze wegen gleicher WLAN BSSID oder via Backbone verbinden. Da überall das gleiche Routingprotokoll verwendet wird, würden Geräte von verschiedenen Communities miteinander reden können und das Netz würde gigantisch groß und die Router überlasten.

Bitte einhalten:

• Ändern der BSSID auf eine eigene! Nutze NICHT/NOT 1206!
• Keine Verwendung von Registratoren anderen Communities (Webserverdienst zum Verteilen von Knotennummern)
• Kein Aufbau von Brücken zwischen Routern/Servern verschiedener Communities über Backboneverbindungen. (das wird in Zukunft noch unterbunden, dazu ist aber eine Änderung am Routingprotokoll notwendig). Verbindungen von Communities dürfen nur über das ICVPN erfolgen.
• Das Repository muss an mehreren Stellen angepasst werden:
  • config.jinja
  • ddmesh/init.sls
  • ddmesh/autoupdate.sls
  • ddmesh/usr/local/bin/ddmesh-ipcalc.sh
  • ddmesh/usr/local/bin/freifunk-register-local-node.sh
  • ddmesh/var/www_freifunk/
  • bind/init.sls
  • bind/etc/bind/zones/
  • bind/etc/bind/named.conf.tmpl
  • bind/etc/bind/named.conf.option.tmpl
  • bind/etc/bind/named.conf.local_master
  • bind/etc/bind/named.conf.local_slave

Links

Freifunk Dresden
Wiki: Freifunk Dresden
Issues
Twitter
Facebook