Zum Inhalt springen

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

Aus OBS Wiki
Rademacker (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
MINERVA-Rademacker (Diskussion | Beiträge)
Weiterleitung auf Pflege#Server-Profil, Inhalt in die Seite Pflege übernommen [Volltext ersetzt]
Markierung: Neue Weiterleitung
 
(10 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{Kostenpflichtige Module}}
#WEITERLEITUNG [[OBS/Kostenpflichtige Module/REST-Server/Pflege#Server-Profil]]
 
=Server-Profile=
 
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:
 
* Ein '''Public-Profil''' mit Standard-TLS auf Port 443 für externe Konsumenten.
* Ein '''Internal-mTLS-Profil''' auf einem internen Port für Microservices, die zwingend ein Client-Zertifikat vorlegen müssen.
* Ein '''Debug-Profil''' mit Plain-HTTP auf 127.0.0.1, ausschliesslich für lokale Tests.
 
==Aufruf==
 
'''Stammdaten -> Z Weitere Stammdaten -> REST-Server -> Server'''
 
==Felder des Server-Profils==
 
{| class="wikitable"
! Feld                !! Beschreibung
|-
| Nr                  || Eindeutige Nummer 1-99, einmalig vergeben, kann später nicht mehr geändert werden
|-
| Name                || Sprechender Name, eindeutig - erscheint in Protokoll, Statistik und Endpunkt-Zuordnung
|-
| Aktiv              || Profil wird beim Start des REST-Dienstes geladen. Inaktive Profile starten nicht
|-
| Info                || Freitext zur Dokumentation (interner Kommentar, wird nicht ausgewertet)
|-
| Kein SSL            || Plain-HTTP-Modus, ausschliesslich für Debug. TLS-Felder werden ignoriert
|-
| mTLS                || Mutual TLS: jeder Client muss ein gültiges Client-Zertifikat vorlegen
|-
| Cert                || PEM-Inhalt des Server-Zertifikats (inkl. ggf. Zwischen-CA-Kette)
|-
| Key                || PEM-Inhalt des privaten Schlüssels
|-
| Root-Cert          || PEM-Inhalt des CA-Root-Zertifikats (Pflicht bei Standard-TLS, dort für Chain-Validierung, sowie bei mTLS, dort zusätzlich für Client-Cert-Verifikation)
|-
| Limit-Fenster      || Länge des Rate-Limit-Fensters in Sekunden. Leer/0 = Standard 60
|-
| Limit Erfolg        || Erlaubte erfolgreiche Anfragen je Schlüssel und Fenster. Leer/0 = Standard 120
|-
| Limit Fehler        || Erlaubte fehlgeschlagene Anfragen je Schlüssel und Fenster. Leer/0 = Standard 10
|-
| Limit gesamt        || Erlaubte Anfragen des gesamten Profils je Fenster. Leer/0 = Standard 600
|-
| 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
|-
| Max. parallel      || 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
|-
| 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
|}
 
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.
 
==Modi==
 
{| class="wikitable"
! Modus              !! Voraussetzungen                      !! Anwendung
|-
| '''Standard-TLS'''  || Cert + Key + Root-Cert hinterlegt    || Empfohlener Default für alle Server, die über das öffentliche Netz erreichbar sind
|-
| '''mTLS'''          || Cert + Key + Root-Cert (CA)          || Maschine-zu-Maschine-Kommunikation, in der jeder Client mit Cert validiert wird
|-
| '''Plain-HTTP'''    || Haken ''Kein SSL''                    || Ausschliesslich lokale Tests. Erkennt TLS-Versuche auf dem Plain-Port und trennt sie direkt
|}
 
Beide Richtungen werden erkannt: Eine '''unverschlüsselte Anfrage an einen
TLS-Port''' (''http'' statt ''https'') beantwortet der Server mit '''HTTP 400'''
und einem Klartext-Hinweis. Die Abweisung erfolgt '''vor''' Authentifizierung,
Rate-Limit und Endpunkt-Skript - ein falsch konfigurierter Client löst also
keine Verarbeitung aus.
 
{{Hinweis|Bei Standard-TLS und mTLS fährt der Server ohne Cert/Key gar nicht erst hoch. Bei Standard-TLS ohne Root-Cert wird die Anlage abgelehnt - die Chain-Validierung benötigt das CA-Root. 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.
* '''Rotation:''' Ein Zertifikatswechsel erfolgt durch ändern der PEM-Inhalte in der DB und einen '''Neustart''' des REST-Dienstes (kein Hot-Reload). Bis zum Neustart 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.
==Rate-Limit je Profil==
 
Jedes Server-Profil führt '''eigene Zähler''' und kann '''eigene Schwellen''' haben.
Ein Profil, das gerade überrannt wird, bremst damit die anderen Profile nicht mit
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.
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
Benutzer hinter einer gemeinsamen Firmen-IP und sendet die App keinen eigenen
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
Passworteingaben steht die Abteilung. Für solche Profile die Schwellen bewusst
höher setzen oder jedem Konsumenten einen eigenen API-Key geben.}}
 
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==
 
Beim Speichern wird geprüft:
 
* Nr und Name müssen vergeben sein.
* Nr muss eindeutig sein.
* Name muss eindeutig sein.
* Bei nicht aktiviertem ''Kein SSL'' müssen Cert und Key vorhanden sein.
* Bei nicht aktiviertem ''mTLS'' (= Standard-TLS) muss Root-Cert vorhanden sein.
 
==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"
! Feld    !! Beschreibung
|-
| 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
|-
| Port    || TCP-Port (1-65535). 443/8443 für HTTPS, frei wählbar für Debug-Profile
|-
| Aktiv  || Bindung wird beim Server-Start geladen
|-
| Standard|| Markiert die Standard-Bindung des Servers. Pro Server-Profil ist nur eine Standard-Bindung erlaubt
|}
 
===Wirksamkeit===
 
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:
 
* '''Einfg''' - neues Server-Profil
* '''Return''' - vorhandenes Profil bearbeiten
* '''F4''' - Sortierung wählen
* '''F6''' - Bindungs-Liste des markierten Servers

Aktuelle Version vom 17. November 2026, 11:53 Uhr