WireGuard-Verbindung

warp1
warp2
warp3
wem
any

`wireguard/state`

Der aktuelle WireGuard-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/wireguard/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/state

{ "state": 3, "connection_start": 15346, "connection_end": 0 }

Name Bedeutung

Name	Bedeutung
`state` int	Zustand der Verbindung zum WireGuard-Peer 0 - Nicht konfiguriert 1 - Warte auf Zeitsynchronisierung 2 - Nicht verbunden 3 - Verbunden
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

state
int

Zustand der Verbindung zum WireGuard-Peer

0 - Nicht konfiguriert
1 - Warte auf Zeitsynchronisierung
2 - Nicht verbunden
3 - Verbunden

connection_start
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.

connection_end
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`wireguard/config`

Die WireGuard-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

curl http://$HOST/wireguard/config -d '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

Mit MQTT auf $PREFIX/wireguard/config_update

mosquitto_pub -h $BROKER -t $PREFIX/wireguard/config_update -m '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

Name	Bedeutung
`enable` bool	Gibt an ob eine WireGuard-Verbindung zum konfigurierten Peer aufgebaut werden soll. true - Wenn WireGuard aktiviert ist. false - Wenn WireGuard deaktiviert ist.
`make_default_interface` bool	Gibt an ob aller nicht-lokaler Netzwerkverkehr über WireGuard geroutet werden soll. true - Wenn WireGuard das Default-Interface ist: Sämtlicher nicht-lokaler Netzwerkverkehr wird über WireGuard geroutet. false - Wenn WireGuard nicht das Default-Interface ist: Nur Netzwerkverkehr im WireGuard-Subnetz wird über WireGuard geroutet.
`internal_ip` string	IP-Adresse des Geräts im WireGuard-Netzwerk
`internal_subnet` string	Subnetzmaske des WireGuard-Netzwerks
`internal_gateway` string	Gateway des WireGuard-Netzwerks
`remote_host` string	öffentliche Adresse oder Hostname des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`remote_port` int	Port des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`local_port` int	Port von dem aus die WireGuard-Verbindung aufgebaut wird
`private_key` string	Privater Schlüssel des Geräts (44 Base64-Zeichen oder leer)
`remote_public_key` string	Öffentlicher Schlüssel des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll (44 Base64-Zeichen oder leer)
`preshared_key` string	Geteilter Schlüssel (PSK) der Verbindung zwischen Gerät und Peer (44 Base64-Zeichen oder leer)
`allowed_ip` string	Erlaubte Quell-IP von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden
`allowed_subnet` string	Erlaubte Subnetzmaske von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden

`wireguard/state`

Der aktuelle WireGuard-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/wireguard/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/state

{ "state": 3, "connection_start": 15346, "connection_end": 0 }

Name Bedeutung

Name	Bedeutung
`state` int	Zustand der Verbindung zum WireGuard-Peer 0 - Nicht konfiguriert 1 - Warte auf Zeitsynchronisierung 2 - Nicht verbunden 3 - Verbunden
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

state
int

Zustand der Verbindung zum WireGuard-Peer

0 - Nicht konfiguriert
1 - Warte auf Zeitsynchronisierung
2 - Nicht verbunden
3 - Verbunden

connection_start
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.

connection_end
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`wireguard/config`

Die WireGuard-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

curl http://$HOST/wireguard/config -d '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

Mit MQTT auf $PREFIX/wireguard/config_update

mosquitto_pub -h $BROKER -t $PREFIX/wireguard/config_update -m '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

Name	Bedeutung
`enable` bool	Gibt an ob eine WireGuard-Verbindung zum konfigurierten Peer aufgebaut werden soll. true - Wenn WireGuard aktiviert ist. false - Wenn WireGuard deaktiviert ist.
`make_default_interface` bool	Gibt an ob aller nicht-lokaler Netzwerkverkehr über WireGuard geroutet werden soll. true - Wenn WireGuard das Default-Interface ist: Sämtlicher nicht-lokaler Netzwerkverkehr wird über WireGuard geroutet. false - Wenn WireGuard nicht das Default-Interface ist: Nur Netzwerkverkehr im WireGuard-Subnetz wird über WireGuard geroutet.
`internal_ip` string	IP-Adresse des Geräts im WireGuard-Netzwerk
`internal_subnet` string	Subnetzmaske des WireGuard-Netzwerks
`internal_gateway` string	Gateway des WireGuard-Netzwerks
`remote_host` string	öffentliche Adresse oder Hostname des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`remote_port` int	Port des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`local_port` int	Port von dem aus die WireGuard-Verbindung aufgebaut wird
`private_key` string	Privater Schlüssel des Geräts (44 Base64-Zeichen oder leer)
`remote_public_key` string	Öffentlicher Schlüssel des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll (44 Base64-Zeichen oder leer)
`preshared_key` string	Geteilter Schlüssel (PSK) der Verbindung zwischen Gerät und Peer (44 Base64-Zeichen oder leer)
`allowed_ip` string	Erlaubte Quell-IP von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden
`allowed_subnet` string	Erlaubte Subnetzmaske von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden

`wireguard/state`

Der aktuelle WireGuard-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/wireguard/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/state

{ "state": 3, "connection_start": 15346, "connection_end": 0 }

Name Bedeutung

Name	Bedeutung
`state` int	Zustand der Verbindung zum WireGuard-Peer 0 - Nicht konfiguriert 1 - Warte auf Zeitsynchronisierung 2 - Nicht verbunden 3 - Verbunden
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

state
int

Zustand der Verbindung zum WireGuard-Peer

0 - Nicht konfiguriert
1 - Warte auf Zeitsynchronisierung
2 - Nicht verbunden
3 - Verbunden

connection_start
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.

connection_end
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`wireguard/config`

Die WireGuard-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

curl http://$HOST/wireguard/config -d '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

Mit MQTT auf $PREFIX/wireguard/config_update

mosquitto_pub -h $BROKER -t $PREFIX/wireguard/config_update -m '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

Name	Bedeutung
`enable` bool	Gibt an ob eine WireGuard-Verbindung zum konfigurierten Peer aufgebaut werden soll. true - Wenn WireGuard aktiviert ist. false - Wenn WireGuard deaktiviert ist.
`make_default_interface` bool	Gibt an ob aller nicht-lokaler Netzwerkverkehr über WireGuard geroutet werden soll. true - Wenn WireGuard das Default-Interface ist: Sämtlicher nicht-lokaler Netzwerkverkehr wird über WireGuard geroutet. false - Wenn WireGuard nicht das Default-Interface ist: Nur Netzwerkverkehr im WireGuard-Subnetz wird über WireGuard geroutet.
`internal_ip` string	IP-Adresse des Geräts im WireGuard-Netzwerk
`internal_subnet` string	Subnetzmaske des WireGuard-Netzwerks
`internal_gateway` string	Gateway des WireGuard-Netzwerks
`remote_host` string	öffentliche Adresse oder Hostname des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`remote_port` int	Port des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`local_port` int	Port von dem aus die WireGuard-Verbindung aufgebaut wird
`private_key` string	Privater Schlüssel des Geräts (44 Base64-Zeichen oder leer)
`remote_public_key` string	Öffentlicher Schlüssel des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll (44 Base64-Zeichen oder leer)
`preshared_key` string	Geteilter Schlüssel (PSK) der Verbindung zwischen Gerät und Peer (44 Base64-Zeichen oder leer)
`allowed_ip` string	Erlaubte Quell-IP von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden
`allowed_subnet` string	Erlaubte Subnetzmaske von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden

`wireguard/state`

Der aktuelle WireGuard-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/wireguard/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/state

{ "state": 3, "connection_start": 15346, "connection_end": 0 }

Name Bedeutung

Name	Bedeutung
`state` int	Zustand der Verbindung zum WireGuard-Peer 0 - Nicht konfiguriert 1 - Warte auf Zeitsynchronisierung 2 - Nicht verbunden 3 - Verbunden
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

state
int

Zustand der Verbindung zum WireGuard-Peer

0 - Nicht konfiguriert
1 - Warte auf Zeitsynchronisierung
2 - Nicht verbunden
3 - Verbunden

connection_start
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.

connection_end
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`wireguard/config`

Die WireGuard-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

curl http://$HOST/wireguard/config -d '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

Mit MQTT auf $PREFIX/wireguard/config_update

mosquitto_pub -h $BROKER -t $PREFIX/wireguard/config_update -m '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

Name	Bedeutung
`enable` bool	Gibt an ob eine WireGuard-Verbindung zum konfigurierten Peer aufgebaut werden soll. true - Wenn WireGuard aktiviert ist. false - Wenn WireGuard deaktiviert ist.
`make_default_interface` bool	Gibt an ob aller nicht-lokaler Netzwerkverkehr über WireGuard geroutet werden soll. true - Wenn WireGuard das Default-Interface ist: Sämtlicher nicht-lokaler Netzwerkverkehr wird über WireGuard geroutet. false - Wenn WireGuard nicht das Default-Interface ist: Nur Netzwerkverkehr im WireGuard-Subnetz wird über WireGuard geroutet.
`internal_ip` string	IP-Adresse des Geräts im WireGuard-Netzwerk
`internal_subnet` string	Subnetzmaske des WireGuard-Netzwerks
`internal_gateway` string	Gateway des WireGuard-Netzwerks
`remote_host` string	öffentliche Adresse oder Hostname des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`remote_port` int	Port des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`local_port` int	Port von dem aus die WireGuard-Verbindung aufgebaut wird
`private_key` string	Privater Schlüssel des Geräts (44 Base64-Zeichen oder leer)
`remote_public_key` string	Öffentlicher Schlüssel des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll (44 Base64-Zeichen oder leer)
`preshared_key` string	Geteilter Schlüssel (PSK) der Verbindung zwischen Gerät und Peer (44 Base64-Zeichen oder leer)
`allowed_ip` string	Erlaubte Quell-IP von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden
`allowed_subnet` string	Erlaubte Subnetzmaske von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden

`wireguard/state`

Der aktuelle WireGuard-Zustand.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/wireguard/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/state

{ "state": 3, "connection_start": 15346, "connection_end": 0 }

Name Bedeutung

Name	Bedeutung
`state` int	Zustand der Verbindung zum WireGuard-Peer 0 - Nicht konfiguriert 1 - Warte auf Zeitsynchronisierung 2 - Nicht verbunden 3 - Verbunden
`connection_start` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.
`connection_end` int (ms)	Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

state
int

Zustand der Verbindung zum WireGuard-Peer

0 - Nicht konfiguriert
1 - Warte auf Zeitsynchronisierung
2 - Nicht verbunden
3 - Verbunden

connection_start
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.

connection_end
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.

`wireguard/config`

Die WireGuard-Konfiguration.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

curl http://$HOST/wireguard/config -d '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/wireguard/config

{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  // werden nicht zurückgegeben
  // null = key gesetzt
  // "" = key nicht gesetzt
  "private_key": null,
  "remote_public_key": null,
  "preshared_key": "",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}

Schreiben

Mit MQTT auf $PREFIX/wireguard/config_update

mosquitto_pub -h $BROKER -t $PREFIX/wireguard/config_update -m '{
  "enable": true,
  "make_default_interface": true,
  "internal_ip": "123.145.167.189",
  "internal_subnet": "255.255.255.0",
  "internal_gateway": "123.145.167.1",
  "remote_host": "1.2.3.4",
  "remote_port": 51820,
  "local_port": 51820,
  "private_key": "7aufw3iiQRVs9HyN8sGPeAHtVKVMVgV+bdRrql5S6ac=",
  "remote_public_key": "VKKqmbJ97OTKbqCBszfUaa/H1Tzy7IO9f+TWhwH7m9o=",
  "preshared_key": "tZtZ59nx5uIQma7phYTA4b8P28ogSzKHFC40izC6y4c=",
  "allowed_ip": "0.0.0.0",
  "allowed_subnet": "0.0.0.0"
}'

Name	Bedeutung
`enable` bool	Gibt an ob eine WireGuard-Verbindung zum konfigurierten Peer aufgebaut werden soll. true - Wenn WireGuard aktiviert ist. false - Wenn WireGuard deaktiviert ist.
`make_default_interface` bool	Gibt an ob aller nicht-lokaler Netzwerkverkehr über WireGuard geroutet werden soll. true - Wenn WireGuard das Default-Interface ist: Sämtlicher nicht-lokaler Netzwerkverkehr wird über WireGuard geroutet. false - Wenn WireGuard nicht das Default-Interface ist: Nur Netzwerkverkehr im WireGuard-Subnetz wird über WireGuard geroutet.
`internal_ip` string	IP-Adresse des Geräts im WireGuard-Netzwerk
`internal_subnet` string	Subnetzmaske des WireGuard-Netzwerks
`internal_gateway` string	Gateway des WireGuard-Netzwerks
`remote_host` string	öffentliche Adresse oder Hostname des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`remote_port` int	Port des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll
`local_port` int	Port von dem aus die WireGuard-Verbindung aufgebaut wird
`private_key` string	Privater Schlüssel des Geräts (44 Base64-Zeichen oder leer)
`remote_public_key` string	Öffentlicher Schlüssel des Peers zu dem eine WireGuard-Verbindung aufgebaut werden soll (44 Base64-Zeichen oder leer)
`preshared_key` string	Geteilter Schlüssel (PSK) der Verbindung zwischen Gerät und Peer (44 Base64-Zeichen oder leer)
`allowed_ip` string	Erlaubte Quell-IP von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden
`allowed_subnet` string	Erlaubte Subnetzmaske von Paketen, die über die WireGuard-Verbindung empfangen werden. 0.0.0.0 damit alle empfangenen Pakete verarbeitet werden

WireGuard-Verbindung

wireguard/state​

Lesen​

Lesen​

wireguard/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

wireguard/state​

Lesen​

Lesen​

wireguard/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

wireguard/state​

Lesen​

Lesen​

wireguard/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

wireguard/state​

Lesen​

Lesen​

wireguard/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

wireguard/state​

Lesen​

Lesen​

wireguard/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

`wireguard/state`

Lesen

Lesen

`wireguard/config`

Lesen

Schreiben

Lesen

Schreiben

`wireguard/state`

Lesen

Lesen

`wireguard/config`

Lesen

Schreiben

Lesen

Schreiben

`wireguard/state`

Lesen

Lesen

`wireguard/config`

Lesen

Schreiben

Lesen

Schreiben

`wireguard/state`

Lesen

Lesen

`wireguard/config`

Lesen

Schreiben

Lesen

Schreiben

`wireguard/state`

Lesen

Lesen

`wireguard/config`

Lesen

Schreiben

Lesen

Schreiben