Zum Inhalt springen

OBS/Kostenpflichtige Module/REST-Server/Server-Profile: Unterschied zwischen den Versionen

Aus OBS Wiki
MINERVA-Rademacker (Diskussion | Beiträge)
Zertifikats-Pin: zwei Felder, eigener Abschnitt und Validierung ergaenzt [Volltext ersetzt]
MINERVA-Rademacker (Diskussion | Beiträge)
Typ Maske: Liste/Tasten/Registerkarten 1-5, Bindungen; Rate-Limit-Fehlanfrage, TLS 1.2 exklusiv, Startfehler je Profil, Pin, Speicherprüfungen nach Code korrigiert [Volltext ersetzt]
Zeile 1: Zeile 1:
{{Vorlage:Kostenpflichtige Module}}
{{Vorlage:Kostenpflichtige Module}}
{{Seitentyp|Maske}}
= Server-Profile =


=Server-Profile=
Ein Server-Profil ist eine eigenständige Instanz des REST-Servers mit eigenem Modus, eigenen Zertifikaten, eigenen Grenzen und eigenen Bindungen. Sie betreiben beliebig viele Profile parallel und trennen so öffentliche Zugriffe sauber von internen. Sie erreichen die Profile über '''Stammdaten → Z Weitere Stammdaten → REST-Server → Server'''.
 
Ein '''Server''' im REST-Modul ist ein eigenständiges TLS-Profil mit einer eigenen HTTP-Server-Instanz. In OBS können beliebig viele Server-Profile parallel betrieben werden, jedes mit eigenem Modus, eigenen Zertifikaten und eigenen Bindungen.


Typische Einsatzfälle für mehrere Profile:
Typische Einsatzfälle für mehrere Profile:
* Ein '''öffentliches Profil''' mit TLS auf Port 443 für externe Clients.
* Ein '''mTLS-Profil''' auf einem internen Port für Systeme, die ein Client-Zertifikat vorlegen müssen.
* Ein '''Debug-Profil''' mit Plain-HTTP, nur lokal erreichbar, für Tests.


* Ein '''Public-Profil''' mit Standard-TLS auf Port 443 für externe Konsumenten.
== Liste ==
* Ein '''Internal-mTLS-Profil''' auf einem internen Port für Microservices, die zwingend ein Client-Zertifikat vorlegen müssen.
Die Liste zeigt alle Server-Profile mit '''Name''' und '''Nr'''. Aktive Profile erscheinen fett.
* Ein '''Debug-Profil''' mit Plain-HTTP auf 127.0.0.1, ausschliesslich für lokale Tests.


==Aufruf==
== Tasten und Schaltflächen ==
{| class="wikitable"
! Taste !! Funktion
|-
| {{Einfg}} || Legt ein neues Server-Profil an.
|-
| {{Return}} || Öffnet das markierte Profil in der Eingabemaske.
|-
| {{F4}} || Wählt die Sortierung.
|-
| {{F6}} || Schaltfläche '''F6 Binding''': öffnet die Bindungen des markierten Profils, siehe [[#Bindungen|Bindungen]].
|}


'''Stammdaten -> Z Weitere Stammdaten -> REST-Server -> Server'''
== Eingabemaske ==
{{Return}} öffnet die Eingabemaske '''REST-Server''' mit fünf Registerkarten. Ein neues Profil ist vorbelegt mit '''Aktiv''', '''mTLS-Modus aktiv''' und den Standardwerten der Rate-Limits.


==Felder des Server-Profils==
Die Einstellungen liest der REST-Dienst beim Start. Eine Änderung wirkt erst nach einem Neustart des Dienstes. Ausnahme sind die Angaben zur automatischen Erneuerung auf den Registerkarten 4 und 5: Sie liest der Dienst bei jeder Prüfung neu.


=== Registerkarte: 1 Stammdaten ===
{| class="wikitable"
{| class="wikitable"
! Feld               !! Beschreibung
! Feld !! Bedeutung
|-
|-
| Nr                 || Eindeutige Nummer 1-99, einmalig vergeben, kann später nicht mehr geändert werden
| '''Nr''' || Nummer des Profils von 1 bis 99. OBS schlägt die nächste freie Nummer vor. Nach dem Anlegen ist sie nicht mehr änderbar.
|-
|-
| Name               || Sprechender Name, eindeutig - erscheint in Protokoll, Statistik und Endpunkt-Zuordnung
| '''Name''' || Eindeutiger Name. Er erscheint in Protokoll, Statistik und bei der Zuordnung der Endpunkte.
|-
|-
| Aktiv              || Profil wird beim Start des REST-Dienstes geladen. Inaktive Profile starten nicht
| '''zusätzliche Infos''' || Freitext zur Dokumentation. Wird nicht ausgewertet.
|-
|-
| zusätzliche Infos  || Freitext zur Dokumentation (interner Kommentar, wird nicht ausgewertet)
| '''kein SSL (Plain-HTTP - nur für Debug!)''' || Das Profil spricht unverschlüsseltes HTTP. Die Zertifikatsfelder werden nicht ausgewertet. Nur für lokale Tests.
|-
|-
| kein SSL            || Plain-HTTP-Modus, ausschliesslich für Debug. TLS-Felder werden ignoriert
| '''mTLS-Modus aktiv''' || Jeder Client muss ein gültiges Client-Zertifikat vorlegen. Geprüft wird gegen das '''Root-Zertifikat (ca)'''.
|-
|-
| mTLS-Modus aktiv    || Mutual TLS: jeder Client muss ein gültiges Client-Zertifikat vorlegen
| '''keine Kompression''' || Antworten dieses Profils werden nicht mit gzip gepackt. Gepackte Anfragen nimmt der Server weiterhin an. Details: [[OBS/Kostenpflichtige Module/RESTServer/HTTP-Schnittstelle#Kompression|HTTP-Schnittstelle]].
|-
|-
| Zertifikat (cert)  || PEM-Inhalt des Server-Zertifikats (inkl. ggf. Zwischen-CA-Kette)
| '''Aktiv''' || Der REST-Dienst lädt das Profil beim Start. Inaktive Profile starten nicht.
|}
 
Aus den Haken ergeben sich drei Betriebsarten:
 
{| class="wikitable"
! Betriebsart !! Voraussetzungen !! Anwendung
|-
|-
| Schlüssel (key)    || PEM-Inhalt des privaten Schlüssels
| '''Standard-TLS''' || Zertifikat und Schlüssel || Betrieb, auch intern, hinter einem Reverse-Proxy oder im VPN.
|-
|-
| Root-Zertifikat (ca) || PEM-Inhalt des CA-Zertifikats, gegen das '
| '''mTLS''' || Zertifikat, Schlüssel und Root-Zertifikat, Haken '''mTLS-Modus aktiv''' || Maschine-zu-Maschine-Verbindungen, bei denen jeder Client ein Zertifikat vorlegt.
|-
|-
| Rate-Limit-Fenster  || Länge des Rate-Limit-Fensters in Sekunden. Leer/0 = Standard 60
| '''Plain-HTTP''' || Haken '''kein SSL (Plain-HTTP - nur für Debug!)''' || Nur lokale Tests.
|}
 
Falsch adressierte Verbindungen weist der Server vor jeder Verarbeitung ab:
* '''<code>http</code> an ein TLS-Profil:''' Antwort '''400''' mit dem Klartext-Hinweis „Dieser Port erwartet eine TLS-Verbindung. Die Anfrage wurde im Klartext gesendet - bitte https verwenden.“
* '''<code>https</code> an ein Plain-HTTP-Profil:''' Der Server trennt die Verbindung sofort. Kommt der TLS-Handshake erst nach dem Verbindungsaufbau, antwortet er mit '''400'''. Im Protokoll steht die Meldung unter dem Host <code>TLS:<Profil></code>.
 
{{Hinweis|Fehlen bei Standard-TLS oder mTLS Zertifikat oder Schlüssel, startet nur dieses Profil nicht. Die übrigen Profile laufen. Im Protokoll steht „SSL/TLS-Konfiguration fehlt“. Bei aktiver Erneuerung trägt der Dienst beides selbst ein, mit '''Eigenes Zertifikat (Pin)''' stellt er sich selbst eines aus.}}
 
=== Registerkarte: 2 Rate-Limits ===
{| class="wikitable"
! Feld !! Standard !! Bedeutung
|-
|-
| Erfolgsanfragen    || Erlaubte erfolgreiche Anfragen je Schlüssel und Fenster. Leer/0 = Standard 120
| '''Rate-Limit-Fenster''' || 60 || Länge des Zählfensters in Sekunden.
|-
|-
| Fehlanfragen        || Erlaubte fehlgeschlagene Anfragen je Schlüssel und Fenster. Leer/0 = Standard 10
| '''Erfolgsanfragen''' || 120 || Erlaubte Anfragen je Schlüssel und Fenster.
|-
|-
| Anfragen            || Erlaubte Anfragen des gesamten Profils je Fenster. Leer/0 = Standard 600
| '''Fehlanfragen''' || 10 || Erlaubte Fehlanfragen je Schlüssel und Fenster.
|-
|-
| max. Verbindungen  || Obergrenze gleichzeitiger '''Verbindungen''' (<code>rsv_max_conn</code>). Leer/0 = unbegrenzt. Sie deckt auch laufende Datei-Downloads ab, weil der Platz erst beim Trennen frei wird. Bei Überschreitung trennt der Server '''ohne HTTP-Antwort''' - der Wert gehört deutlich über den Normalbetrieb, als Reissleine
| '''Anfragen''' || 600 || Erlaubte Anfragen aller Clients des Profils je Fenster.
|-
|-
| max. Anfragen      || Obergrenze gleichzeitig '''verarbeiteter Anfragen''' (<code>rsv_max_parallel</code>). Leer/0 = unbegrenzt. Bei Überschreitung antwortet der Server '''503''' mit <code>Retry-After</code>, der Client darf es also gleich erneut versuchen
| '''max. Verbindungen''' || 200 || Obergrenze gleichzeitig offener Verbindungen. Sie umfasst auch laufende Datei-Downloads. Darüber trennt der Server neue Verbindungen ohne HTTP-Antwort. Setzen Sie den Wert deutlich über den Normalbetrieb.
|-
|-
| keine Kompression  || Antworten dieses Profils werden '''nicht''' gepackt (<code>rsv_no_gzip</code>). Ohne Haken packt der Server JSON- und Textantworten ab 1024 Byte mit gzip, sofern der Client sie über <code>Accept-Encoding</code> annimmt. Der Haken betrifft nur die Antwortrichtung - komprimierte '''Anfragen''' nimmt der Server weiterhin entgegen
| '''max. Anfragen''' || 16 || Obergrenze gleichzeitig verarbeiteter Anfragen. Darüber antwortet der Server mit '''503''' und <code>Retry-After: 2</code>. Der Client darf es also gleich erneut versuchen.
|}
|}


{{Hinweis|''max. Verbindungen'' und ''max. Anfragen'' sind die beiden
Die Spalte Standard nennt die Vorbelegung eines neuen Profils. Bei den vier Rate-Limit-Feldern gilt ''0'' als Standardwert, bei '''max. Verbindungen''' und '''max. Anfragen''' als unbegrenzt.
'''Lastgrenzen''' des Profils. Davon zu unterscheiden sind die festen Grenzen der
persistenten Verbindungen - 10 Sekunden Leerlauf, 100 Anfragen je Verbindung -,
die nicht der Last dienen, sondern der Hygiene und nicht einstellbar sind. Siehe
[[OBS/Kostenpflichtige Module/RESTServer|REST-Server]], Abschnitt Persistente
Verbindungen.}}


Die Inhalte der Zertifikate werden direkt in OBS als Text gespeichert. Zur Laufzeit schreibt der Server die PEM-Inhalte für den Bruchteil einer Sekunde in ein Temp-Verzeichnis, damit OpenSSL sie beim Start lesen kann; danach werden die Temp-Dateien sofort wieder gelöscht.
Jedes Profil führt eigene Zähler. Ein Profil unter Last bremst die anderen nicht aus.


==Modi==
Gezählt wird je Schlüssel. Schlüssel ist der Wert des Headers <code>apikey</code>, ohne Header die IP-Adresse. Alle Geräte mit demselben API-Key teilen sich also einen Zähler. Als Fehlanfrage zählt nur eine Anfrage, deren Zugang abgewiesen wird: API-Key unbekannt, Zugang inaktiv, Host-Beschränkung, <code>Origin</code> nicht erlaubt oder Client-Zertifikat passt nicht. Ein falsches Passwort bei der Anmeldung ist keine Fehlanfrage.
 
{{Hinweis|Setzen Sie die Schwellen hoch genug für alle Geräte, die denselben API-Key verwenden. Hinter einem Reverse-Proxy teilen sich alle Anfragen ohne API-Key den Zähler der Proxy-Adresse, siehe [[OBS/Kostenpflichtige Module/RESTServer/Betrieb und Fehlersuche#Betrieb hinter einem Reverse-Proxy|Betrieb und Fehlersuche]].}}
 
Was der Client bei einer Überschreitung erhält, beschreibt [[OBS/Kostenpflichtige Module/RESTServer/HTTP-Schnittstelle#Anfragegrenze|HTTP-Schnittstelle]].
 
=== Registerkarte: 3 Zertifikate ===
Die Zertifikate stehen als Text im Profil. Tragen Sie sie im PEM-Format ein.


{| class="wikitable"
{| class="wikitable"
! Modus              !! Voraussetzungen                      !! Anwendung
! Feld !! Bedeutung
|-
|-
| '''Standard-TLS''' || Zertifikat + Schlüssel                || Für den Betrieb, auch wenn der Server nur intern, hinter einem Reverse-Proxy oder per VPN erreichbar ist
| '''Zertifikat (cert)''' || Server-Zertifikat als vollständige Kette: zuerst das Server-Zertifikat, danach die Zwischenzertifikate.
|-
|-
| '''mTLS'''         || Zertifikat + Schlüssel + Root-Zert.   || Maschine-zu-Maschine-Kommunikation, in der jeder Client mit Cert validiert wird
| '''Schlüssel (key)''' || Privater Schlüssel zum Server-Zertifikat.
|-
|-
| '''Plain-HTTP'''   || Haken ''kein SSL''                    || Ausschliesslich lokale Tests. Erkennt TLS-Versuche auf dem Plain-Port und trennt sie direkt
| '''Root-Zertifikat (ca)''' || Zertifikat der Zertifizierungsstelle, gegen das die Client-Zertifikate geprüft werden. Nur bei mTLS, sonst leer.
|}
|}


Beide Richtungen werden erkannt: Eine '''unverschlüsselte Anfrage an einen
Für TLS gilt:
TLS-Port''' (''http'' statt ''https'') beantwortet der Server mit '''HTTP 400'''
* '''TLS-Version:''' Der Server spricht ausschließlich TLS 1.2. Die Verschlüsselungsverfahren sind auf ECDHE-Schlüsselaustausch (Forward Secrecy) mit AES-GCM oder ChaCha20-Poly1305 beschränkt.
und einem Klartext-Hinweis. Die Abweisung erfolgt '''vor''' Authentifizierung,
* '''HSTS:''' Jede Antwort eines TLS-Profils trägt <code>Strict-Transport-Security: max-age=31536000; includeSubDomains</code>. Ein Browser spricht die Adresse damit ein Jahr lang nur über HTTPS an. Plain-HTTP-Profile setzen den Header nicht.
Rate-Limit und Endpunkt-Skript - ein falsch konfigurierter Client löst also
* '''Zertifikatswechsel:''' Bei automatischer Erneuerung tauscht der Dienst das Zertifikat selbst und startet nur das betroffene Profil neu. Bei Pflege von Hand tragen Sie die neuen PEM-Inhalte ein und starten den REST-Dienst neu. Bis dahin läuft das alte Zertifikat weiter.
keine Verarbeitung aus.
 
{{Hinweis|Bei Standard-TLS und mTLS fährt der Server ohne Zertifikat und Schlüssel gar nicht erst hoch. Bei aktiver Erneuerung trägt der Dienst beides selbst ein, mit ''Eigenes Zertifikat (Pin)'' stellt er sich selbst eines aus. Plain-HTTP umgeht TLS komplett und ist nicht für Produktivumgebungen geeignet.}}
 
==TLS-Version, Cipher und Zertifikats-Rotation==
 
* '''TLS-Version:''' Der Server erzwingt '''TLS 1.2'''. Die Cipher-Liste ist auf ECDHE-Schlüsselaustausch (Forward Secrecy) mit AEAD-Verfahren (AES-GCM, ChaCha20-Poly1305) beschränkt; CBC, statisches RSA-KEX und DHE sind ausgeschlossen.
* '''HSTS:''' Jede Antwort eines TLS-Profils trägt ''Strict-Transport-Security: max-age=31536000; includeSubDomains''. Ein Browser spricht die Adresse damit ein Jahr lang nur noch über HTTPS an. Beim Profil ''Kein SSL'' wird der Header bewusst '''nicht''' gesetzt - der Browser würde ihn sonst speichern und die Erzwingung auch auf produktive Sitzungen anwenden.
* '''Rotation:''' Bei '''automatischer Erneuerung''' tauscht der Dienst das Zertifikat selbst und startet dabei nur das betroffene Server-Profil neu; die übrigen Profile und der Dienst laufen weiter. Bei manueller Pflege ändern Sie die PEM-Inhalte und starten den REST-Dienst neu - bis dahin läuft das alte Zertifikat weiter.
* '''Certificate-Pinning:''' Mobile Clients können den Server-Public-Key pinnen. Zertifikatswechsel daher '''rechtzeitig ankündigen''' und mit einem '''Backup-Pin''' vorbereiten - der neue Pin muss vor dem Wechsel in einer Client-Version ausgerollt sein, sonst sperrt sich die App aus. Mit ''Eigenes Zertifikat (Pin)'' gibt OBS den Pin über den Zugangscode an die App weiter. Gepinnt wird der '''Schlüssel''', nicht das Zertifikat: Erneuern Sie das Zertifikat mit demselben Schlüssel, bleibt der Pin gleich und kein Gerät braucht einen neuen Zugangscode.
==Automatische Zertifikatserneuerung==
 
Der REST-Server kann sein TLS-Zertifikat selbst bei einer Zertifizierungsstelle beantragen und vor Ablauf erneuern. Prüfarten, Voraussetzungen, Einrichtung, Ablauf und Konsolenbefehle beschreibt [[OBS/Kostenpflichtige Module/RESTServer/Zertifikatserneuerung|Zertifikatserneuerung]].
 
===Felder===


Registerkarte '''4 Zertifikaterneuerung''':
=== Registerkarte: 4 Zertifikaterneuerung ===
Der REST-Server kann sein Zertifikat selbst bei einer Zertifizierungsstelle beantragen und vor Ablauf erneuern. Einrichtung und Ablauf beschreibt [[OBS/Kostenpflichtige Module/RESTServer/Zertifikatserneuerung|Zertifikatserneuerung]].


{| class="wikitable"
{| class="wikitable"
! Feld                       !! Beschreibung
! Feld !! Bedeutung
|-
|-
| Automatische Erneuerung   || ''deaktiviert'' = aus. ''Produktivbetrieb'' = der Dienst beantragt und erneuert das Zertifikat selbst. ''Testbetrieb'' = nur für Testsysteme, siehe [[OBS/Kostenpflichtige Module/RESTServer/Zertifikatserneuerung#Testbetrieb|Testbetrieb]]
| '''Automatische Erneuerung''' || ''deaktiviert'': aus. ''Produktivbetrieb'': Der Dienst beantragt und erneuert das Zertifikat selbst. ''Testbetrieb'': nur für Testsysteme, siehe [[OBS/Kostenpflichtige Module/RESTServer/Zertifikatserneuerung#Testbetrieb|Testbetrieb]].
|-
|-
| Zertifikatsname (FQDN)     || Der Name, auf den das Zertifikat ausgestellt wird. Pflicht, sobald die Erneuerung aktiv ist
| '''Zertifikatsname (FQDN)''' || Name, auf den das Zertifikat ausgestellt wird. Pflicht, sobald die Erneuerung aktiv ist. Für die Erneuerung muss er von außen auf diesen Server zeigen.
|-
|-
| Kontakt bei der CA         || Optional. Die Zertifizierungsstelle schickt an diese Adresse Warnungen, wenn ein Zertifikat abzulaufen droht
| '''Kontakt bei der CA''' || Optional. E-Mail-Adresse, an die die Zertifizierungsstelle Warnungen schickt, wenn ein Zertifikat abzulaufen droht.
|-
|-
| Zertifikat gültig bis     || Ablaufdatum des aktiven Zertifikats
| '''Zertifikat gültig bis''' || Ablaufdatum des aktiven Zertifikats. Erneuert wird ab 30 Tagen Restlaufzeit.
|-
|-
| Testzertifikat aus Staging || Gesetzt, wenn das aktive Zertifikat aus dem Testbetrieb stammt
| '''Testzertifikat aus Staging''' || Gesetzt, wenn das aktive Zertifikat aus dem Testbetrieb stammt. Ihm vertraut kein Client.
|-
|-
| Zustand                   || ''idle'' = nichts zu tun, ''pending'' = Vorgang läuft, ''error'' = letzter Versuch fehlgeschlagen
| '''Zustand''' || ''idle'': nichts zu tun. ''pending'': Vorgang läuft. ''error'': letzter Versuch fehlgeschlagen.
|-
|-
| Letzte Meldung             || Ergebnis des letzten Vorgangs - im Störungsfall das erste Feld, in das Sie sehen
| '''Letzte Meldung''' || Ergebnis des letzten Vorgangs. Im Störungsfall das erste Feld, in das Sie sehen.
|-
|-
| Gesperrt bis               || Nach einem Fehlschlag wartet der Dienst bis zu diesem Zeitpunkt, bevor er es erneut versucht
| '''Gesperrt bis''' || Nach einem Fehlschlag wartet der Dienst bis zu diesem Zeitpunkt, bevor er es erneut versucht.
|-
|-
| Letzter Selbsttest am     || Zeitpunkt der letzten Prüfung über das Testsystem der Zertifizierungsstelle
| '''Letzter Selbsttest am''' || Zeitpunkt der letzten Prüfung über das Testsystem der Zertifizierungsstelle. Sie läuft wöchentlich und prüft, ob der Server von außen erreichbar ist.
|-
|-
| Selbsttest bestanden       || Ergebnis dieser Prüfung
| '''Selbsttest bestanden''' || Ergebnis dieser Prüfung.
|-
|-
| Eigenes Zertifikat (Pin)   || Der Dienst stellt für dieses Profil ein eigenes Zertifikat aus, sobald Zertifikat und Schlüssel leer sind, und berechnet den zugehörigen Pin. Gedacht für interne Netze ohne eigene Domain, in denen keine Zertifizierungsstelle erreichbar ist. Nicht zusammen mit der automatischen Erneuerung
| '''Eigenes Zertifikat (Pin)''' || Der Dienst stellt für dieses Profil ein eigenes Zertifikat aus und berechnet den Pin. Für interne Netze ohne eigene Domain, siehe [[#Eigenes Zertifikat und Pin|Eigenes Zertifikat und Pin]].
|-
|-
| Zertifikats-Pin           || Pin des Schlüssels, mit dem dieses Profil TLS spricht, in der Form <code>sha256/…</code>. Der Dienst berechnet ihn; die App erhält ihn über den Zugangscode und prüft damit jede Verbindung
| '''Zertifikats-Pin''' || Pin des Schlüssels, mit dem das Profil TLS spricht, in der Form <code>sha256/…</code>. Der Dienst berechnet ihn. Nur Anzeige.
|}
|}


Die Felder von ''Zertifikat gültig bis'' bis ''Selbsttest bestanden'' sowie ''Zertifikats-Pin'' füllt der Dienst selbst; sie dienen der Anzeige.
Die Felder von '''Zertifikat gültig bis''' bis '''Selbsttest bestanden''' sowie '''Zertifikats-Pin''' füllt der Dienst selbst.
 
Registerkarte '''5 DNS-Prüfung''':


=== Registerkarte: 5 DNS-Prüfung ===
{| class="wikitable"
{| class="wikitable"
! Feld                       !! Beschreibung
! Feld !! Bedeutung
|-
|-
| Prüfart                   || ''http-01 (Port 80)'' oder ''dns-01 (DNS-Eintrag)'', siehe [[OBS/Kostenpflichtige Module/RESTServer/Zertifikatserneuerung#Welche Prüfart?|Welche Prüfart?]]
| '''Prüfart''' || ''http-01 (Port 80)'' oder ''dns-01 (DNS-Eintrag)'', siehe [[OBS/Kostenpflichtige Module/RESTServer/Zertifikatserneuerung#Welche Prüfart?|Welche Prüfart?]]
|-
|-
| DNS-Anbieter               || Nur dns-01: ''acme-dns'', ''Hetzner'', ''Cloudflare'' oder ''IONOS''
| '''DNS-Anbieter''' || Nur dns-01: ''acme-dns'', ''Hetzner'', ''Cloudflare'' oder ''IONOS''.
|-
|-
| Adresse (acme-dns)         || Nur acme-dns: Adresse der Instanz, beginnt mit <code>https://</code>
| '''Adresse (acme-dns)''' || Nur acme-dns: Adresse der Instanz. Sie beginnt mit <code>https://</code>.
|-
|-
| Benutzer (acme-dns)       || Nur acme-dns: Benutzer des Kontos. Bleiben Benutzer, Schlüssel und Name leer, legt der Dienst das Konto selbst an
| '''Benutzer (acme-dns)''' || Nur acme-dns: Benutzer des Kontos. Bleiben Benutzer, Schlüssel und Name leer, legt der Dienst das Konto selbst an.
|-
|-
| Schlüssel / API-Token     || acme-dns: Passwort des Kontos. Hetzner und Cloudflare: API-Token. IONOS: API-Schlüssel in der Form <code>Präfix.Secret</code>
| '''Schlüssel / API-Token''' || acme-dns: Passwort des Kontos. Hetzner und Cloudflare: API-Token. IONOS: API-Schlüssel in der Form <code>Präfix.Secret</code>.
|-
|-
| Name des TXT-Eintrags     || Leer = <code>_acme-challenge.<Zertifikatsname></code>. Bei CNAME-Delegation das Ziel des CNAME, bei acme-dns die ''fulldomain'' des Kontos
| '''Name des TXT-Eintrags''' || Leer: <code>_acme-challenge.<Zertifikatsname></code>. Bei CNAME-Delegation das Ziel des CNAME, bei acme-dns die ''fulldomain'' des Kontos.
|}
|}


{{Hinweis|Die Zugangsdaten stehen im Klartext im Server-Profil. Verwenden Sie Token, die nur die nötige Zone ändern dürfen.}}
{{Hinweis|Die Zugangsdaten stehen im Klartext im Server-Profil. Verwenden Sie Token, die nur die nötige Zone ändern dürfen.}}


==Eigenes Zertifikat und Pin==
=== Eigenes Zertifikat und Pin ===
In internen Netzen ohne eigene Domain ist keine Zertifizierungsstelle erreichbar. Für diesen Fall stellt der Dienst selbst ein Zertifikat aus, und die App vertraut über einen Pin genau diesem Schlüssel.


In internen Netzen ohne eigene Domain ist keine Zertifizierungsstelle erreichbar, und ein von Hand erstelltes Zertifikat kennt keine App. Für diesen Fall setzen Sie den Haken '''Eigenes Zertifikat (Pin)''' und tragen unter '''Zertifikatsname (FQDN)''' die Adresse ein, unter der das Gerät den Server erreicht - auch eine IP-Adresse ist zulässig.
# Setzen Sie auf der Registerkarte '''4 Zertifikaterneuerung''' den Haken '''Eigenes Zertifikat (Pin)'''.
# Tragen Sie unter '''Zertifikatsname (FQDN)''' die Adresse ein, unter der das Gerät den Server erreicht. Auch eine IP-Adresse ist zulässig.
# Lassen Sie '''Zertifikat (cert)''' und '''Schlüssel (key)''' leer und starten Sie den REST-Dienst neu.


Beim nächsten Start des REST-Dienstes stellt der Dienst ein Zertifikat aus, sofern '''Zertifikat (cert)''' und '''Schlüssel (key)''' leer sind, und berechnet den Pin. Ein bereits hinterlegtes Zertifikat bleibt unangetastet - der Dienst füllt nur, was leer ist.
Fehlt Zertifikat oder Schlüssel, stellt der Dienst beim Start ein Zertifikat aus: RSA 3072, gültig 3650 Tage. Er berechnet den Pin und zeigt ihn unter '''Zertifikats-Pin'''. Ein vollständig hinterlegtes Zertifikat ändert er nie. Den Pin gibt OBS im Zugangscode an die App weiter.


Den Pin gibt OBS zusammen mit Adresse und API-Key im Zugangscode an die App weiter. Die App vertraut dann genau diesem Schlüssel und keiner Zertifizierungsstelle; Name und Ablaufdatum des Zertifikats prüft sie nicht.
{{Achtung|Ein neuer Schlüssel macht jeden bisher ausgegebenen Zugangscode mit Pin ungültig. Ändert sich der Pin, meldet der Dienst das im Protokoll. Für einen Wechsel ohne Ausfall geben Sie vorher Codes mit altem und neuem Pin aus. Im Feld '''Zertifikats-Pin''' des Zugangscode-Dialogs trennen Sie mehrere Pins durch Komma.}}


{{Achtung|Ein Wechsel des Schlüssels macht '''jeden bisher ausgegebenen Zugangscode ungültig''' - die Geräte kommen dann nicht mehr durch. Wollen Sie den Schlüssel wechseln, geben Sie vorher Zugangscodes mit altem und neuem Pin aus und stellen erst um, wenn alle Geräte den neuen Code haben. Das Ausstellen wiederholt der Dienst von sich aus nie: Solange ein Zertifikat hinterlegt ist, bleibt es stehen.}}
'''Eigenes Zertifikat (Pin)''' schließt sich aus mit '''Automatische Erneuerung''' und mit '''kein SSL (Plain-HTTP - nur für Debug!)'''. Pin-Format, Prüfung durch die App und Schlüsselwechsel beschreibt [[OBS/Kostenpflichtige Module/RESTServer/Zugangscode und Zertifikats-Pin#Zertifikats-Pin|Zugangscode und Zertifikats-Pin]].


{{Hinweis|Der Pin und die automatische Erneuerung schliessen sich aus. Jede Erneuerung erzeugt einen neuen Schlüssel und damit einen neuen Pin; die Geräte wären danach ausgesperrt. OBS weist die Kombination beim Speichern zurück.}}
=== Prüfungen beim Speichern ===
Was Sie eintragen, prüft OBS immer, auch bei einem nicht aktiven Profil:
* '''Nr''' und '''Name''' sind vergeben. '''Nr''' besteht nur aus Ziffern und liegt zwischen 1 und 99.
* '''Nr''' und '''Name''' sind eindeutig.
* '''Zertifikat (cert)''' und '''Schlüssel (key)''' liegen im PEM-Format vor. Bei '''kein SSL (Plain-HTTP - nur für Debug!)''' entfällt diese Prüfung.
* '''Zertifikatsname (FQDN)''' ist ein Name mit Punkt, ohne Adresse, Port, Leerzeichen und Platzhalter <code>*</code>. Er beginnt und endet nicht mit Punkt oder Bindestrich.
* '''Kontakt bei der CA''' ist eine E-Mail-Adresse.
* '''Eigenes Zertifikat (Pin)''' ist weder mit der automatischen Erneuerung noch mit '''kein SSL (Plain-HTTP - nur für Debug!)''' kombiniert.
* '''Adresse (acme-dns)''' beginnt mit <code>https://</code>. '''Name des TXT-Eintrags''' ist ein gültiger Name.


==Rate-Limit je Profil==
Nur bei einem '''aktiven''' Profil prüft OBS zusätzlich:
* Ohne '''kein SSL (Plain-HTTP - nur für Debug!)''', ohne automatische Erneuerung und ohne '''Eigenes Zertifikat (Pin)''' sind Zertifikat und Schlüssel vorhanden.
* Bei '''mTLS-Modus aktiv''' ist das Root-Zertifikat vorhanden.
* Bei aktiver Erneuerung ist '''Zertifikatsname (FQDN)''' vergeben und '''kein SSL (Plain-HTTP - nur für Debug!)''' nicht gesetzt.
* Bei '''Eigenes Zertifikat (Pin)''' ohne hinterlegtes Zertifikat ist '''Zertifikatsname (FQDN)''' vergeben.
* Bei der Prüfart dns-01 ist ein '''DNS-Anbieter''' gewählt. Bei acme-dns ist die Adresse eingetragen, und Benutzer, Schlüssel und Name sind entweder alle gefüllt oder alle leer. Bei den übrigen Anbietern ist '''Schlüssel / API-Token''' gefüllt.
* Bei ''Testbetrieb'' fragt OBS vor dem Speichern nach, weil dem Testzertifikat kein Client vertraut.


Jedes Server-Profil führt '''eigene Zähler''' und kann '''eigene Schwellen''' haben.
== Bindungen ==
Ein Profil, das gerade überrannt wird, bremst damit die anderen Profile nicht mit
Eine Bindung ist die Kombination aus IP-Adresse und Port, auf der ein Server-Profil lauscht. Ein Profil kann mehrere Bindungen haben, z.B. um dieselbe TLS-Konfiguration auf zwei Ports anzubieten. Sie öffnen die Bindungen mit {{F6}} in der Liste der Server-Profile.
aus - das Public-Profil und das interne mTLS-Profil sind voneinander unabhängig.


Gezählt wird pro Schlüssel, und der Schlüssel ist der '''API-Key''' des Zugangs.
Die Liste zeigt '''Host''', '''Port''' und in Spalte '''D''' die Standard-Bindung. Aktive Bindungen erscheinen fett.
Sendet ein Konsument keinen API-Key (Zugang mit ''*''), wird ersatzweise auf die
'''IP-Adresse''' gezählt.


{{Hinweis|Das ist der wichtigste Punkt bei mobilen Anwendungen: Sitzen alle
{| class="wikitable"
Benutzer hinter einer gemeinsamen Firmen-IP und sendet die App keinen eigenen
! Taste !! Funktion
API-Key, teilen sich '''alle Benutzer einen Zähler'''. Mit den Standardwerten sind
|-
das 10 Fehlversuche für den ganzen Betrieb pro Minute - nach ein paar falschen
| {{Einfg}} || Legt eine neue Bindung für dieses Profil an.
Passworteingaben steht die Abteilung. Für solche Profile die Schwellen bewusst
|-
höher setzen oder jedem Konsumenten einen eigenen API-Key geben.}}
| {{Return}} || Öffnet die markierte Bindung in der Eingabemaske '''REST-Bindung'''.
 
|-
Dasselbe gilt hinter einem Reverse-Proxy: Alle Anfragen kommen dort von der IP-Adresse
| {{F4}} || Wählt die Sortierung.
des Proxys, und alle Konsumenten ohne API-Key teilen sich einen Zähler. Der Header
|}
''X-Forwarded-For'' ändert daran nichts, er wird nur protokolliert.
 
Bleiben alle vier Felder leer (bzw. 0), gelten die Standardwerte. Die Werte werden
'''beim Start''' des REST-Dienstes gelesen - eine Änderung wird erst nach einem
Neustart wirksam.
 
==Validierung beim Speichern==
 
Immer geprüft wird:
 
* Nr und Name sind vergeben, Nr liegt zwischen 1 und 99.
* Nr und Name sind eindeutig.
* Eingetragene Zertifikate und Schlüssel liegen im PEM-Format vor.
* Ein eingetragener Zertifikatsname enthält keine Adresse, keinen Port und keine Leerzeichen.
* ''Eigenes Zertifikat (Pin)'' ist weder zusammen mit der automatischen Erneuerung noch zusammen mit ''kein SSL'' gesetzt.
 
Nur bei '''aktivem''' Profil zusätzlich:
 
* Ohne ''kein SSL'', ohne automatische Erneuerung und ohne ''Eigenes Zertifikat (Pin)'' sind Zertifikat und Schlüssel vorhanden.
* Bei ''mTLS-Modus aktiv'' ist das Root-Zertifikat vorhanden.
* Bei aktiver Erneuerung ist der Zertifikatsname vergeben, und ''kein SSL'' ist nicht gesetzt.
* Bei ''Eigenes Zertifikat (Pin)'' ist der Zertifikatsname vergeben, solange kein Zertifikat hinterlegt ist - der Dienst stellt das Zertifikat auf diesen Namen aus.
 
{{Hinweis|Ein '''nicht aktives''' Profil dürfen Sie unvollständig speichern - es wird beim Start des Dienstes nicht geladen. Was Sie eintragen, wird trotzdem auf Plausibilität geprüft.}}
 
==Bindungen==
 
Eine Bindung ist die Kombination aus IP-Adresse und Port, auf der ein Server-Profil lauscht. Pro Server-Profil können mehrere Bindungen existieren, z.B. um die gleiche TLS-Konfiguration parallel auf 443 und 8443 anzubieten.
 
===Aufruf===
 
In der Server-Liste den gewünschten Server markieren und '''F6''' drücken. Es öffnet sich die zum Server gehörende Bindungs-Liste.
 
===Felder===


{| class="wikitable"
{| class="wikitable"
! Feld   !! Beschreibung
! Feld !! Bedeutung
|-
|-
| Host   || IP-Adresse oder Hostname, auf dem gelauscht wird. ''0.0.0.0'' = alle IPv4-Adressen; ''127.0.0.1'' = nur lokal; explizite IPs binden gezielt auf eine Netzwerkkarte
| '''Host''' || IP-Adresse, auf der der Server lauscht. ''0.0.0.0'' steht für alle IPv4-Adressen. Eine bestimmte Adresse bindet an genau diese Netzwerkkarte. Pflichtfeld.
|-
|-
| Port   || TCP-Port (1-65535). 443/8443 für HTTPS, frei wählbar für Debug-Profile
| '''Port''' || TCP-Port. Pflichtfeld.
|-
|-
| Aktiv  || Bindung wird beim Server-Start geladen
| '''Server''' || Das Server-Profil, zu dem die Bindung gehört. Vorbelegt mit dem Profil, aus dem Sie die Liste geöffnet haben.
|-
|-
| Standard|| Markiert die Standard-Bindung des Servers. Pro Server-Profil ist nur eine Standard-Bindung erlaubt
| '''Aktiv''' || Der Dienst legt die Bindung beim Start an.
|-
| '''Standard''' || Markiert die Standard-Bindung des Profils. Ihren Port übernimmt der Dialog '''Zugangscode für OBS-Smart-App'''. Je Profil ist nur eine aktive Standard-Bindung erlaubt.
|}
|}


===Wirksamkeit===
Bindungen liest der Dienst nur beim Start. Bis zum Neustart laufen die alten Bindungen weiter. Lässt sich das Profil auf einer Bindung nicht starten, z.B. weil der Port belegt ist, steht im Protokoll:
 
Bindungen werden ausschliesslich beim Start des REST-Dienstes geladen. Änderungen werden daher erst nach einem Neustart aktiv. Bis dahin laufen die alten Bindungen weiter.
 
==Listen-Funktionen==


In der Server-Liste:
<syntaxhighlight lang="text">
Fehler: Server [<Name>] konnte nicht gestartet werden (…)
</syntaxhighlight>


* '''Einfg''' - neues Server-Profil
== Siehe auch ==
* '''Return''' - vorhandenes Profil bearbeiten
* [[OBS/Kostenpflichtige Module/RESTServer/Einrichtung|Einrichtung]]
* '''F4''' - Sortierung wählen
* [[OBS/Kostenpflichtige Module/RESTServer/Zertifikatserneuerung|Zertifikatserneuerung]]
* '''F6''' - Bindungs-Liste des markierten Servers
* [[OBS/Kostenpflichtige Module/RESTServer/Zugangscode und Zertifikats-Pin|Zugangscode und Zertifikats-Pin]]
* [[OBS/Kostenpflichtige Module/RESTServer/Öffentliche Freigabe|Öffentliche Freigabe]]
* [[OBS/Kostenpflichtige Module/RESTServer/HTTP-Schnittstelle|HTTP-Schnittstelle]]
* [[OBS/Kostenpflichtige Module/RESTServer/Betrieb und Fehlersuche|Betrieb und Fehlersuche]]

Version vom 17. November 2026, 06:59 Uhr

Server-Profile

Ein Server-Profil ist eine eigenständige Instanz des REST-Servers mit eigenem Modus, eigenen Zertifikaten, eigenen Grenzen und eigenen Bindungen. Sie betreiben beliebig viele Profile parallel und trennen so öffentliche Zugriffe sauber von internen. Sie erreichen die Profile über Stammdaten → Z Weitere Stammdaten → REST-Server → Server.

Typische Einsatzfälle für mehrere Profile:

  • Ein öffentliches Profil mit TLS auf Port 443 für externe Clients.
  • Ein mTLS-Profil auf einem internen Port für Systeme, die ein Client-Zertifikat vorlegen müssen.
  • Ein Debug-Profil mit Plain-HTTP, nur lokal erreichbar, für Tests.

Liste

Die Liste zeigt alle Server-Profile mit Name und Nr. Aktive Profile erscheinen fett.

Tasten und Schaltflächen

Taste Funktion
Einfg Legt ein neues Server-Profil an.
 ↩ Enter Öffnet das markierte Profil in der Eingabemaske.
F4 Wählt die Sortierung.
F6 Schaltfläche F6 Binding: öffnet die Bindungen des markierten Profils, siehe Bindungen.

Eingabemaske

 ↩ Enter öffnet die Eingabemaske REST-Server mit fünf Registerkarten. Ein neues Profil ist vorbelegt mit Aktiv, mTLS-Modus aktiv und den Standardwerten der Rate-Limits.

Die Einstellungen liest der REST-Dienst beim Start. Eine Änderung wirkt erst nach einem Neustart des Dienstes. Ausnahme sind die Angaben zur automatischen Erneuerung auf den Registerkarten 4 und 5: Sie liest der Dienst bei jeder Prüfung neu.

Registerkarte: 1 Stammdaten

Feld Bedeutung
Nr Nummer des Profils von 1 bis 99. OBS schlägt die nächste freie Nummer vor. Nach dem Anlegen ist sie nicht mehr änderbar.
Name Eindeutiger Name. Er erscheint in Protokoll, Statistik und bei der Zuordnung der Endpunkte.
zusätzliche Infos Freitext zur Dokumentation. Wird nicht ausgewertet.
kein SSL (Plain-HTTP - nur für Debug!) Das Profil spricht unverschlüsseltes HTTP. Die Zertifikatsfelder werden nicht ausgewertet. Nur für lokale Tests.
mTLS-Modus aktiv Jeder Client muss ein gültiges Client-Zertifikat vorlegen. Geprüft wird gegen das Root-Zertifikat (ca).
keine Kompression Antworten dieses Profils werden nicht mit gzip gepackt. Gepackte Anfragen nimmt der Server weiterhin an. Details: HTTP-Schnittstelle.
Aktiv Der REST-Dienst lädt das Profil beim Start. Inaktive Profile starten nicht.

Aus den Haken ergeben sich drei Betriebsarten:

Betriebsart Voraussetzungen Anwendung
Standard-TLS Zertifikat und Schlüssel Betrieb, auch intern, hinter einem Reverse-Proxy oder im VPN.
mTLS Zertifikat, Schlüssel und Root-Zertifikat, Haken mTLS-Modus aktiv Maschine-zu-Maschine-Verbindungen, bei denen jeder Client ein Zertifikat vorlegt.
Plain-HTTP Haken kein SSL (Plain-HTTP - nur für Debug!) Nur lokale Tests.

Falsch adressierte Verbindungen weist der Server vor jeder Verarbeitung ab:

  • http an ein TLS-Profil: Antwort 400 mit dem Klartext-Hinweis „Dieser Port erwartet eine TLS-Verbindung. Die Anfrage wurde im Klartext gesendet - bitte https verwenden.“
  • https an ein Plain-HTTP-Profil: Der Server trennt die Verbindung sofort. Kommt der TLS-Handshake erst nach dem Verbindungsaufbau, antwortet er mit 400. Im Protokoll steht die Meldung unter dem Host TLS:<Profil>.
HINWEIS: Fehlen bei Standard-TLS oder mTLS Zertifikat oder Schlüssel, startet nur dieses Profil nicht. Die übrigen Profile laufen. Im Protokoll steht „SSL/TLS-Konfiguration fehlt“. Bei aktiver Erneuerung trägt der Dienst beides selbst ein, mit Eigenes Zertifikat (Pin) stellt er sich selbst eines aus.

Registerkarte: 2 Rate-Limits

Feld Standard Bedeutung
Rate-Limit-Fenster 60 Länge des Zählfensters in Sekunden.
Erfolgsanfragen 120 Erlaubte Anfragen je Schlüssel und Fenster.
Fehlanfragen 10 Erlaubte Fehlanfragen je Schlüssel und Fenster.
Anfragen 600 Erlaubte Anfragen aller Clients des Profils je Fenster.
max. Verbindungen 200 Obergrenze gleichzeitig offener Verbindungen. Sie umfasst auch laufende Datei-Downloads. Darüber trennt der Server neue Verbindungen ohne HTTP-Antwort. Setzen Sie den Wert deutlich über den Normalbetrieb.
max. Anfragen 16 Obergrenze gleichzeitig verarbeiteter Anfragen. Darüber antwortet der Server mit 503 und Retry-After: 2. Der Client darf es also gleich erneut versuchen.

Die Spalte Standard nennt die Vorbelegung eines neuen Profils. Bei den vier Rate-Limit-Feldern gilt 0 als Standardwert, bei max. Verbindungen und max. Anfragen als unbegrenzt.

Jedes Profil führt eigene Zähler. Ein Profil unter Last bremst die anderen nicht aus.

Gezählt wird je Schlüssel. Schlüssel ist der Wert des Headers apikey, ohne Header die IP-Adresse. Alle Geräte mit demselben API-Key teilen sich also einen Zähler. Als Fehlanfrage zählt nur eine Anfrage, deren Zugang abgewiesen wird: API-Key unbekannt, Zugang inaktiv, Host-Beschränkung, Origin nicht erlaubt oder Client-Zertifikat passt nicht. Ein falsches Passwort bei der Anmeldung ist keine Fehlanfrage.

HINWEIS: Setzen Sie die Schwellen hoch genug für alle Geräte, die denselben API-Key verwenden. Hinter einem Reverse-Proxy teilen sich alle Anfragen ohne API-Key den Zähler der Proxy-Adresse, siehe Betrieb und Fehlersuche.

Was der Client bei einer Überschreitung erhält, beschreibt HTTP-Schnittstelle.

Registerkarte: 3 Zertifikate

Die Zertifikate stehen als Text im Profil. Tragen Sie sie im PEM-Format ein.

Feld Bedeutung
Zertifikat (cert) Server-Zertifikat als vollständige Kette: zuerst das Server-Zertifikat, danach die Zwischenzertifikate.
Schlüssel (key) Privater Schlüssel zum Server-Zertifikat.
Root-Zertifikat (ca) Zertifikat der Zertifizierungsstelle, gegen das die Client-Zertifikate geprüft werden. Nur bei mTLS, sonst leer.

Für TLS gilt:

  • TLS-Version: Der Server spricht ausschließlich TLS 1.2. Die Verschlüsselungsverfahren sind auf ECDHE-Schlüsselaustausch (Forward Secrecy) mit AES-GCM oder ChaCha20-Poly1305 beschränkt.
  • HSTS: Jede Antwort eines TLS-Profils trägt Strict-Transport-Security: max-age=31536000; includeSubDomains. Ein Browser spricht die Adresse damit ein Jahr lang nur über HTTPS an. Plain-HTTP-Profile setzen den Header nicht.
  • Zertifikatswechsel: Bei automatischer Erneuerung tauscht der Dienst das Zertifikat selbst und startet nur das betroffene Profil neu. Bei Pflege von Hand tragen Sie die neuen PEM-Inhalte ein und starten den REST-Dienst neu. Bis dahin läuft das alte Zertifikat weiter.

Registerkarte: 4 Zertifikaterneuerung

Der REST-Server kann sein Zertifikat selbst bei einer Zertifizierungsstelle beantragen und vor Ablauf erneuern. Einrichtung und Ablauf beschreibt Zertifikatserneuerung.

Feld Bedeutung
Automatische Erneuerung deaktiviert: aus. Produktivbetrieb: Der Dienst beantragt und erneuert das Zertifikat selbst. Testbetrieb: nur für Testsysteme, siehe Testbetrieb.
Zertifikatsname (FQDN) Name, auf den das Zertifikat ausgestellt wird. Pflicht, sobald die Erneuerung aktiv ist. Für die Erneuerung muss er von außen auf diesen Server zeigen.
Kontakt bei der CA Optional. E-Mail-Adresse, an die die Zertifizierungsstelle Warnungen schickt, wenn ein Zertifikat abzulaufen droht.
Zertifikat gültig bis Ablaufdatum des aktiven Zertifikats. Erneuert wird ab 30 Tagen Restlaufzeit.
Testzertifikat aus Staging Gesetzt, wenn das aktive Zertifikat aus dem Testbetrieb stammt. Ihm vertraut kein Client.
Zustand idle: nichts zu tun. pending: Vorgang läuft. error: letzter Versuch fehlgeschlagen.
Letzte Meldung Ergebnis des letzten Vorgangs. Im Störungsfall das erste Feld, in das Sie sehen.
Gesperrt bis Nach einem Fehlschlag wartet der Dienst bis zu diesem Zeitpunkt, bevor er es erneut versucht.
Letzter Selbsttest am Zeitpunkt der letzten Prüfung über das Testsystem der Zertifizierungsstelle. Sie läuft wöchentlich und prüft, ob der Server von außen erreichbar ist.
Selbsttest bestanden Ergebnis dieser Prüfung.
Eigenes Zertifikat (Pin) Der Dienst stellt für dieses Profil ein eigenes Zertifikat aus und berechnet den Pin. Für interne Netze ohne eigene Domain, siehe Eigenes Zertifikat und Pin.
Zertifikats-Pin Pin des Schlüssels, mit dem das Profil TLS spricht, in der Form sha256/…. Der Dienst berechnet ihn. Nur Anzeige.

Die Felder von Zertifikat gültig bis bis Selbsttest bestanden sowie Zertifikats-Pin füllt der Dienst selbst.

Registerkarte: 5 DNS-Prüfung

Feld Bedeutung
Prüfart http-01 (Port 80) oder dns-01 (DNS-Eintrag), siehe Welche Prüfart?
DNS-Anbieter Nur dns-01: acme-dns, Hetzner, Cloudflare oder IONOS.
Adresse (acme-dns) Nur acme-dns: Adresse der Instanz. Sie beginnt mit https://.
Benutzer (acme-dns) Nur acme-dns: Benutzer des Kontos. Bleiben Benutzer, Schlüssel und Name leer, legt der Dienst das Konto selbst an.
Schlüssel / API-Token acme-dns: Passwort des Kontos. Hetzner und Cloudflare: API-Token. IONOS: API-Schlüssel in der Form Präfix.Secret.
Name des TXT-Eintrags Leer: _acme-challenge.<Zertifikatsname>. Bei CNAME-Delegation das Ziel des CNAME, bei acme-dns die fulldomain des Kontos.
HINWEIS: Die Zugangsdaten stehen im Klartext im Server-Profil. Verwenden Sie Token, die nur die nötige Zone ändern dürfen.

Eigenes Zertifikat und Pin

In internen Netzen ohne eigene Domain ist keine Zertifizierungsstelle erreichbar. Für diesen Fall stellt der Dienst selbst ein Zertifikat aus, und die App vertraut über einen Pin genau diesem Schlüssel.

  1. Setzen Sie auf der Registerkarte 4 Zertifikaterneuerung den Haken Eigenes Zertifikat (Pin).
  2. Tragen Sie unter Zertifikatsname (FQDN) die Adresse ein, unter der das Gerät den Server erreicht. Auch eine IP-Adresse ist zulässig.
  3. Lassen Sie Zertifikat (cert) und Schlüssel (key) leer und starten Sie den REST-Dienst neu.

Fehlt Zertifikat oder Schlüssel, stellt der Dienst beim Start ein Zertifikat aus: RSA 3072, gültig 3650 Tage. Er berechnet den Pin und zeigt ihn unter Zertifikats-Pin. Ein vollständig hinterlegtes Zertifikat ändert er nie. Den Pin gibt OBS im Zugangscode an die App weiter.

ACHTUNG: Ein neuer Schlüssel macht jeden bisher ausgegebenen Zugangscode mit Pin ungültig. Ändert sich der Pin, meldet der Dienst das im Protokoll. Für einen Wechsel ohne Ausfall geben Sie vorher Codes mit altem und neuem Pin aus. Im Feld Zertifikats-Pin des Zugangscode-Dialogs trennen Sie mehrere Pins durch Komma.

Eigenes Zertifikat (Pin) schließt sich aus mit Automatische Erneuerung und mit kein SSL (Plain-HTTP - nur für Debug!). Pin-Format, Prüfung durch die App und Schlüsselwechsel beschreibt Zugangscode und Zertifikats-Pin.

Prüfungen beim Speichern

Was Sie eintragen, prüft OBS immer, auch bei einem nicht aktiven Profil:

  • Nr und Name sind vergeben. Nr besteht nur aus Ziffern und liegt zwischen 1 und 99.
  • Nr und Name sind eindeutig.
  • Zertifikat (cert) und Schlüssel (key) liegen im PEM-Format vor. Bei kein SSL (Plain-HTTP - nur für Debug!) entfällt diese Prüfung.
  • Zertifikatsname (FQDN) ist ein Name mit Punkt, ohne Adresse, Port, Leerzeichen und Platzhalter *. Er beginnt und endet nicht mit Punkt oder Bindestrich.
  • Kontakt bei der CA ist eine E-Mail-Adresse.
  • Eigenes Zertifikat (Pin) ist weder mit der automatischen Erneuerung noch mit kein SSL (Plain-HTTP - nur für Debug!) kombiniert.
  • Adresse (acme-dns) beginnt mit https://. Name des TXT-Eintrags ist ein gültiger Name.

Nur bei einem aktiven Profil prüft OBS zusätzlich:

  • Ohne kein SSL (Plain-HTTP - nur für Debug!), ohne automatische Erneuerung und ohne Eigenes Zertifikat (Pin) sind Zertifikat und Schlüssel vorhanden.
  • Bei mTLS-Modus aktiv ist das Root-Zertifikat vorhanden.
  • Bei aktiver Erneuerung ist Zertifikatsname (FQDN) vergeben und kein SSL (Plain-HTTP - nur für Debug!) nicht gesetzt.
  • Bei Eigenes Zertifikat (Pin) ohne hinterlegtes Zertifikat ist Zertifikatsname (FQDN) vergeben.
  • Bei der Prüfart dns-01 ist ein DNS-Anbieter gewählt. Bei acme-dns ist die Adresse eingetragen, und Benutzer, Schlüssel und Name sind entweder alle gefüllt oder alle leer. Bei den übrigen Anbietern ist Schlüssel / API-Token gefüllt.
  • Bei Testbetrieb fragt OBS vor dem Speichern nach, weil dem Testzertifikat kein Client vertraut.

Bindungen

Eine Bindung ist die Kombination aus IP-Adresse und Port, auf der ein Server-Profil lauscht. Ein Profil kann mehrere Bindungen haben, z.B. um dieselbe TLS-Konfiguration auf zwei Ports anzubieten. Sie öffnen die Bindungen mit F6 in der Liste der Server-Profile.

Die Liste zeigt Host, Port und in Spalte D die Standard-Bindung. Aktive Bindungen erscheinen fett.

Taste Funktion
Einfg Legt eine neue Bindung für dieses Profil an.
 ↩ Enter Öffnet die markierte Bindung in der Eingabemaske REST-Bindung.
F4 Wählt die Sortierung.
Feld Bedeutung
Host IP-Adresse, auf der der Server lauscht. 0.0.0.0 steht für alle IPv4-Adressen. Eine bestimmte Adresse bindet an genau diese Netzwerkkarte. Pflichtfeld.
Port TCP-Port. Pflichtfeld.
Server Das Server-Profil, zu dem die Bindung gehört. Vorbelegt mit dem Profil, aus dem Sie die Liste geöffnet haben.
Aktiv Der Dienst legt die Bindung beim Start an.
Standard Markiert die Standard-Bindung des Profils. Ihren Port übernimmt der Dialog Zugangscode für OBS-Smart-App. Je Profil ist nur eine aktive Standard-Bindung erlaubt.

Bindungen liest der Dienst nur beim Start. Bis zum Neustart laufen die alten Bindungen weiter. Lässt sich das Profil auf einer Bindung nicht starten, z.B. weil der Port belegt ist, steht im Protokoll:

Fehler: Server [<Name>] konnte nicht gestartet werden (…)

Siehe auch