Übersicht
Fess unterstützt Single Sign-On (SSO) Authentifizierung mit SAML (Security Assertion Markup Language) 2.0. Durch die Verwendung von SAML-Authentifizierung können Benutzerinformationen, die von einem IdP (Identity Provider) authentifiziert wurden, mit Fess integriert werden. In Kombination mit rollenbasierter Suche ermöglicht dies die Anzeige von Suchergebnissen basierend auf Benutzerberechtigungen.
Funktionsweise der SAML-Authentifizierung
Bei der SAML-Authentifizierung fungiert Fess als SP (Service Provider) und arbeitet mit einem externen IdP zur Authentifizierung zusammen.
Benutzer greift auf den Fess SSO-Endpunkt (
/sso/) zuFess leitet die Authentifizierungsanfrage an den IdP weiter
Benutzer authentifiziert sich beim IdP
IdP sendet SAML-Assertion an Fess
Fess validiert die Assertion und meldet den Benutzer an
Bemerkung
Unterstützt wird ausschließlich die SP-initiierte Anmeldung, die wie oben beschrieben am Fess SSO-Endpunkt (/sso/) beginnt. Fess bindet jede SAML-Antwort an die ID der von ihm gesendeten AuthnRequest. Eine IdP-initiierte (unaufgeforderte) Antwort, etwa von einer Fess -Kachel im Okta-Dashboard oder im Portal „Meine Apps“ von Microsoft Entra ID, hat daher keine zugehörige AuthnRequest und wird abgelehnt. Wenn Sie auf der IdP-Seite eine Kachel anlegen, lassen Sie diese auf den Fess -Endpunkt /sso/ verweisen.
Beachten Sie: In 15.7 funktionierte eine IdP-initiierte Anmeldung zufällig, wenn tomcat.sameSiteCookies=none gesetzt war. Fess schickte die nicht zuordenbare Antwort an den IdP zurück, und der IdP lieferte sofort eine angeforderte Assertion. In 15.8 erfolgt dieses Zurückschicken nicht mehr, sodass die IdP-initiierte Anmeldung nicht funktioniert.
Für die Integration mit rollenbasierter Suche siehe Konfiguration rollenbasierter Suche.
Voraussetzungen
Überprüfen Sie vor der Konfiguration der SAML-Authentifizierung die folgenden Voraussetzungen:
Fess 15.8 oder höher ist installiert
Ein SAML 2.0-kompatibler IdP (Identity Provider) ist verfügbar
Fess ist über HTTPS erreichbar (erforderlich für Produktionsumgebungen)
Sie haben die Berechtigung, Fess als SP beim IdP zu registrieren
Unterstützte IdP-Beispiele:
Microsoft Entra ID (Azure AD)
Okta
Google Workspace
Keycloak
OneLogin
Andere SAML 2.0-kompatible IdPs
Grundkonfiguration
SSO aktivieren
Um die SAML-Authentifizierung zu aktivieren, fügen Sie die folgende Einstellung in app/WEB-INF/conf/system.properties hinzu:
Bemerkung
sso.type und die grundlegenden SAML-Einstellungen (IdP-Informationen, SP-Informationen, Benutzerattribut-Zuordnung) können auch über die Administrationsseite „System > Allgemein“ konfiguriert werden. Im Admin-Bereich vorgenommene Änderungen werden in system.properties gespeichert und bleiben nach einem Neustart erhalten. Sicherheitseinstellungen wie Signierung/Verschlüsselung sowie das SP-Zertifikat und der private Schlüssel können jedoch nicht über die Administrationsseite konfiguriert werden und müssen direkt in system.properties eingetragen werden.
Bemerkung
Einstellungen, die mit saml. beginnen, werden ausschließlich aus system.properties gelesen. JVM-Systemeigenschaften wie -Dsaml.security.... oder -Dfess.saml.security.... werden nicht ausgewertet. Insbesondere saml.security.*, saml.strict und saml.debug haben auch kein Feld auf der Administrationsseite; der einzige Weg, sie zu setzen, ist der direkte Eintrag in system.properties.
SP (Service Provider) Konfiguration
Um Fess als SP zu konfigurieren, geben Sie die SP Base URL an.
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.sp.base.url | SP Basis-URL | http://localhost:8080 |
Bemerkung
Der Standardwert von saml.sp.base.url ist http://localhost:8080. Außerhalb von Testumgebungen muss immer die URL gesetzt werden, über die Fess von außen erreichbar ist (in Produktionsumgebungen HTTPS).
Diese Einstellung konfiguriert automatisch die folgenden Endpunkte:
Entity ID:
{saml.sp.base.url}/sso/metadataACS URL:
{saml.sp.base.url}/sso/SLO URL:
{saml.sp.base.url}/sso/logout
Beispiel:
Individuelle URL-Konfiguration
Normalerweise werden durch das Setzen von saml.sp.base.url alle Endpunkt-URLs automatisch konfiguriert. Bei Bedarf können einzelne URLs jedoch auch explizit mit den folgenden Eigenschaften überschrieben werden.
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.sp.entityid | SP Entity ID | {saml.sp.base.url}/sso/metadata |
saml.sp.assertion_consumer_service.url | Assertion Consumer Service URL | {saml.sp.base.url}/sso/ |
saml.sp.single_logout_service.url | Single Logout Service URL | {saml.sp.base.url}/sso/logout |
IdP (Identity Provider) Konfiguration
Konfigurieren Sie die von Ihrem IdP erhaltenen Informationen.
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.idp.entityid | IdP Entity ID | (Erforderlich) |
saml.idp.single_sign_on_service.url | IdP SSO-Service-URL | (Erforderlich) |
saml.idp.x509cert | IdP-Signatur X.509-Zertifikat (Base64-codiert, ohne Zeilenumbrüche) | (Erforderlich) |
saml.idp.single_logout_service.url | IdP SLO-Service-URL | (Optional) |
Bemerkung
Geben Sie für saml.idp.x509cert nur den Base64-codierten Inhalt des Zertifikats in einer einzigen Zeile ohne Zeilenumbrüche an. Die Zeilen -----BEGIN CERTIFICATE----- und -----END CERTIFICATE----- dürfen nicht enthalten sein.
SP-Metadaten abrufen
Nach dem Start von Fess können Sie die SP-Metadaten im XML-Format vom Endpunkt /sso/metadata abrufen.
Importieren Sie diese Metadaten in Ihren IdP oder registrieren Sie den SP manuell auf der IdP-Seite unter Verwendung der Metadateninhalte.
Bemerkung
Um die Metadaten abzurufen, müssen Sie zuerst die grundlegende SAML-Konfiguration (sso.type=saml und saml.sp.base.url) abschließen und Fess starten.
IdP-seitige Konfiguration
Bei der Registrierung von Fess als SP auf der IdP-Seite konfigurieren Sie die folgenden Informationen:
| Einstellung | Wert |
|---|---|
| ACS URL / Reply URL | https://<Fess-Host>/sso/ |
| Entity ID / Audience URI | https://<Fess-Host>/sso/metadata |
| Name ID Format | urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress (Empfohlen) |
Informationen vom IdP abrufen
Holen Sie die folgenden Informationen aus der Konfigurationsoberfläche oder den Metadaten Ihres IdPs für die Fess-Konfiguration:
IdP Entity ID: URI zur Identifizierung des IdP
SSO URL (HTTP-Redirect): Single Sign-On Endpunkt-URL
X.509-Zertifikat: Öffentliches Schlüsselzertifikat zur Überprüfung der SAML-Assertion-Signatur
Benutzerattribut-Zuordnung
Sie können Benutzerattribute aus SAML-Assertionen Fess-Gruppen und -Rollen zuordnen.
Gruppenattribut-Konfiguration
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.attribute.group.name | Attributname mit Gruppeninformationen | memberOf |
saml.default.groups | Standardgruppen (kommagetrennt) | (Keine) |
Beispiel:
Bemerkung
Fess übernimmt die Gruppenwerte aus der Assertion unverändert: Es findet keine Verzeichnisabfrage statt, und verschachtelte (transitive) Gruppen werden nicht aufgelöst. Ob übergeordnete Gruppen enthalten sind, hängt daher allein von der Claim-Konfiguration des IdP ab – anders als bei SSO-Konfiguration mit Entra ID, wo Fess übergeordnete Gruppen über die Microsoft Graph API auflöst.
Rollenattribut-Konfiguration
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.attribute.role.name | Attributname mit Rolleninformationen | (Keine) |
saml.default.roles | Standardrollen (kommagetrennt) | (Keine) |
Beispiel:
Bemerkung
Wenn Attribute nicht vom IdP abgerufen werden können, werden Standardwerte verwendet. Bei Verwendung der rollenbasierten Suche konfigurieren Sie entsprechende Gruppen oder Rollen.
Warnung
Wenn saml.attribute.role.name gesetzt ist, werden die vom IdP gesendeten Attributwerte unverändert zu Fess-Rollen. Da authentication.admin.roles in fess_config.properties standardmäßig admin lautet, erhält jeder Benutzer, dessen Rollenattribut admin enthält, Administratorrechte in Fess. Prüfen Sie, wer das Rollenattribut auf der IdP-Seite steuern kann, und ändern Sie authentication.admin.roles bei Bedarf in einen anderen Namen.
IdPs mit wiederholten Attributnamen
Wenn der IdP denselben Attributnamen auf mehrere <Attribute>-Elemente verteilt, weist Fess die Assertion zurück und die Anmeldung selbst schlägt fehl.
Keycloak sendet standardmäßig Assertions dieser Form: Seine Rollen- und Gruppen-Mapper geben pro Wert ein eigenes <Attribute>-Element aus, solange deren Option single nicht aktiviert ist, und jedes Keycloak-Konto besitzt mehrere Standard-Realm-Rollen.
Es gibt zwei Abhilfen:
Die Werte auf der IdP-Seite in einem einzigen Element zusammenfassen (bei Keycloak die Option
singleder Mapper aktivieren)In Fess die Wiederholungen zulassen und die Werte zusammenführen
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.security.allow_duplicated_attribute_name | Erlaubt denselben Attributnamen auf mehreren Elementen und führt die Werte zusammen | false |
Beispiel:
Sicherheitskonfiguration
Für Produktionsumgebungen wird empfohlen, die folgenden Sicherheitseinstellungen zu aktivieren.
Bemerkung
Wenn nicht empfohlene Einstellungen bestehen bleiben, wird beim Laden der SAML-Einstellungen eine Warnung Insecure SAML settings: ... in das Protokoll geschrieben.
Signatureinstellungen
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.security.authnrequest_signed | Authentifizierungsanfragen signieren | false |
saml.security.want_messages_signed | Nachrichtensignaturen erfordern | false |
saml.security.want_assertions_signed | Assertion-Signaturen erfordern | false |
saml.security.logoutrequest_signed | Logout-Anfragen signieren | false |
saml.security.logoutresponse_signed | Logout-Antworten signieren | false |
saml.security.reject_deprecated_alg | Veraltete Signaturalgorithmen wie SHA-1 ablehnen | false |
Warnung
Sicherheitsfunktionen sind standardmäßig deaktiviert. Für Produktionsumgebungen wird dringend empfohlen, mindestens saml.security.want_assertions_signed=true zu setzen.
Bemerkung
Solange saml.security.reject_deprecated_alg auf false steht, werden auch Assertions und Nachrichten akzeptiert, die mit SHA-1 (rsa-sha1 und dsa-sha1) signiert wurden. Die Option ist nicht standardmäßig aktiviert, weil sie IdPs ablehnt, die weiterhin mit SHA-1 signieren. Stellen Sie sicher, dass Ihr IdP mit SHA-256 oder stärker signiert, und setzen Sie anschließend saml.security.reject_deprecated_alg=true.
Warnung
Wenn Single Logout konfiguriert ist (saml.idp.single_logout_service.url), setzen Sie unbedingt auch saml.security.want_messages_signed=true. Solange die Option false ist, wird eine LogoutRequest ohne Signatur akzeptiert, sodass eine präparierte URL die Sitzung eines authentifizierten Benutzers beenden kann. Die Auswirkung ist eine erzwungene Abmeldung (Denial of Service), keine Kontoübernahme.
Verschlüsselungseinstellungen
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.security.want_assertions_encrypted | Assertion-Verschlüsselung erfordern | false |
saml.security.want_nameid_encrypted | NameID-Verschlüsselung erfordern | false |
saml.security.allowed_key_transport_algorithms | Beim Entschlüsseln einer Assertion akzeptierte Key-Transport-Algorithmen (kommagetrennte URIs) | (leer: jeder Algorithmus wird akzeptiert) |
Bemerkung
Fess validiert Antworten, die mit XML Encryption 1.1 verschlüsselt sind. Das aktuelle Keycloak verwendet zum Beispiel http://www.w3.org/2009/xmlenc11#rsa-oaep und nimmt ein <xenc11:MGF>-Element in seine Antwort auf; eine solche Antwort wird bei aktivierter Schemaprüfung angenommen. Frühere Versionen wiesen sie mit Invalid SAML Response. Not match the saml-schema-protocol-2.0.xsd zurück. Wurde dafür saml.security.want_xml_validation=false gesetzt, entfernen Sie die Einstellung wieder.
Bemerkung
Setzen Sie saml.security.allowed_key_transport_algorithms, sobald ein privater SP-Schlüssel konfiguriert ist. Solange die Einstellung fehlt, wird jeder Key-Transport-Algorithmus akzeptiert, auch das veraltete http://www.w3.org/2001/04/xmlenc#rsa-1_5. Der Assertion-Consumer-Endpunkt ist ohne Anmeldung erreichbar, und die Entschlüsselung läuft vor der Validierung der Antwort. Ein nicht authentifizierter Aufrufer kann den privaten SP-Schlüssel daher einen Geheimtext seiner Wahl entschlüsseln lassen. Fess meldet in diesem Fall beim Start key_transport_algorithms_not_restricted in der Zeile Insecure SAML settings. Beschränken Sie die Einstellung auf das, was der IdP tatsächlich verwendet:
Konfiguration von SP-Zertifikat und privatem Schlüssel
Wenn der SP Authentifizierungsanfragen oder Logout-Nachrichten signiert (z. B. saml.security.authnrequest_signed) oder die Verschlüsselung von Assertions oder der NameID anfordert (z. B. saml.security.want_assertions_encrypted), müssen der private Schlüssel und das X.509-Zertifikat des SP konfiguriert werden.
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.sp.x509cert | SP X.509-Zertifikat (Base64-codiert, ohne Zeilenumbrüche) | |
saml.sp.privatekey | Privater Schlüssel des SP (Base64-codiert, ohne Zeilenumbrüche) |
Bemerkung
Für saml.sp.x509cert und saml.sp.privatekey gilt, wie bei saml.idp.x509cert, dass der Base64-codierte Inhalt als einzelne Zeile ohne Zeilenumbrüche angegeben werden muss (die Zeilen -----BEGIN ...----- und -----END ...----- dürfen nicht enthalten sein). Wenn Signierung oder Verschlüsselung aktiviert wird, muss das SP-Zertifikat auch auf der IdP-Seite registriert werden. Das SP-Zertifikat wird im SP-Metadaten-Endpunkt unter /sso/metadata veröffentlicht.
Weitere Sicherheitseinstellungen
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.strict | Strikter Modus (strenge Validierung durchführen) | true |
saml.security.want_xml_validation | XML-Schema-Validierung von Nachrichten durchführen | true |
saml.security.signature_algorithm | Signaturalgorithmus | http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 |
saml.security.requested_authncontext | Angeforderter Authentifizierungskontext | urn:oasis:names:tc:SAML:2.0:ac:classes:Password |
saml.sp.nameidformat | NameID-Format | urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress |
Bemerkung
Fess verwendet intern eine SAML-Bibliothek (java-saml), und Eigenschaften mit dem Präfix saml. werden auf die entsprechenden Einstellungen der Bibliothek (Präfix onelogin.saml2.) abgebildet. Daher können in system.properties neben den hier aufgeführten Einstellungen auch detailliertere Einstellungen vorgenommen werden, wie z. B. Bindings (z. B. saml.sp.assertion_consumer_service.binding), Organisationsinformationen (saml.organization.*) und Kontaktinformationen (saml.contacts.*).
AuthnRequest-Gültigkeitsdauer
Fess sendet bei jedem Zugriff auf /sso/ eine AuthnRequest an den IdP und speichert deren ID in der Sitzung. Die vom IdP zurückgegebene SAML-Antwort wird anhand der gespeicherten ID validiert.
| Eigenschaft | Beschreibung | Standard |
|---|---|---|
saml.request.id.ttl | Wie lange die ID einer unbeantworteten AuthnRequest aufbewahrt wird (Sekunden) | 3600 |
Eine gespeicherte ID wird verworfen, sobald dieser Zeitraum verstrichen ist. Ist die Gültigkeit abgelaufen (zum Beispiel weil die Anmeldeseite des IdP offen gelassen wurde), kann die zurückgegebene Assertion nicht zugeordnet werden, und die Anmeldung schlägt einmalig fehl.
Konfigurationsbeispiele
Minimale Konfiguration (für Tests)
Das Folgende ist ein minimales Konfigurationsbeispiel zur Überprüfung in einer Testumgebung.
Empfohlene Konfiguration (für Produktion)
Das Folgende ist ein empfohlenes Konfigurationsbeispiel für Produktionsumgebungen.
Fehlerbehebung
Häufige Probleme und Lösungen
Kann nach der Authentifizierung nicht zu Fess zurückkehren
Überprüfen Sie, ob die ACS URL auf der IdP-Seite korrekt konfiguriert ist
Stellen Sie sicher, dass der Wert von
saml.sp.base.urlmit der IdP-Konfiguration übereinstimmtDie SAML-Assertion trifft als seitenübergreifender POST vom IdP ein. Wenn
tomcat.sameSiteCookiesintomcat_config.propertiesauflax(Standard) steht, sendet der Browser das Sitzungs-Cookie nicht mit, und die Anmeldung schlägt einmalig fehl. Setzen Sie in diesem Falltomcat.sameSiteCookies = none(SameSite=Noneerfordert HTTPS)Wenn die Anmeldung am IdP zu lange gedauert hat, ist die AuthnRequest-ID nicht mehr vorhanden, sobald die Assertion zurückkommt; die Anmeldung schlägt einmalig fehl und muss neu gestartet werden
Fess setzt in
app/WEB-INF/web.xmlkeinsession-timeout, sodass der Standardwert des Servlet-Containers von 30 Minuten gilt; er ist kürzer als die 3600 Sekunden vonsaml.request.id.ttl, sodass die Sitzung zuerst verworfen wird. Ein höherer Wert fürsaml.request.id.ttlallein verlängert daher nicht die Zeit, die Benutzer für die Anmeldung am IdP haben. Erhöhen Sie dafür auch den Sitzungs-Timeout
Destination-Validierung schlägt hinter einem Reverse Proxy fehl
Wenn Fess hinter einem TLS-terminierenden Reverse Proxy oder Load Balancer betrieben wird, kann die Assertion-Validierung fehlschlagen, obwohl saml.sp.base.url korrekt gesetzt ist.
Das Attribut Destination der Assertion wird mit der URL der Anfrage verglichen, so wie sie bei Fess ankommt – hinter einem TLS-terminierenden Proxy also eine interne http://-URL und nicht die externe, an die der IdP die Assertion gesendet hat. saml.sp.base.url wird für diesen Vergleich nicht herangezogen; die Einstellung allein behebt das Problem daher nicht.
Setzen Sie saml.debug=true, damit der Grund ins Protokoll geschrieben wird:
Passen Sie die Connector-Einstellungen in tomcat_config.properties an das von außen sichtbare Schema und den Port an. Diese Einstellungen werden auskommentiert ausgeliefert:
Konfigurieren Sie außerdem den Reverse Proxy so, dass er den ursprünglichen Host-Header an Fess durchreicht, denn der Hostname-Teil der Anfrage-URL wird aus diesem Header gebildet. Nach Änderungen an tomcat_config.properties muss Fess neu gestartet werden.
Dieselbe Prüfung gilt für Single-Logout-Nachrichten; konfigurieren Sie dies bei Verwendung von SLO entsprechend.
Signaturüberprüfungsfehler
Überprüfen Sie, ob das IdP-Zertifikat korrekt konfiguriert ist
Stellen Sie sicher, dass das Zertifikat nicht abgelaufen ist
Das Zertifikat sollte nur als Base64-codierter Inhalt ohne Zeilenumbrüche angegeben werden
Anmeldung schlägt wegen wiederholter Attributnamen fehl
Wenn im Log eine Warnung beginnend mit
The IdP repeated an attribute name in the SAML assertionerscheint, verteilt der IdP denselben Attributnamen auf mehrere<Attribute>-ElementeDie Assertion selbst wurde erfolgreich geprüft; Zertifikat und Zeitabweichung sind nicht die Ursache
Fassen Sie die Attribute auf der IdP-Seite zusammen oder setzen Sie
saml.security.allow_duplicated_attribute_name=true
Benutzergruppen/-rollen werden nicht reflektiert
Überprüfen Sie, ob die Attribute auf der IdP-Seite korrekt konfiguriert sind
Stellen Sie sicher, dass der Wert von
saml.attribute.group.namemit dem vom IdP gesendeten Attributnamen übereinstimmtBei Microsoft Entra ID enthält der Gruppen-Claim die
ObjectId-GUIDs der Gruppen, sofern kein anderes Quellattribut ausgewählt ist; die Werte stimmen daher nicht mit den Gruppennamen übereinMicrosoft Entra ID lässt den Gruppen-Claim vollständig weg, wenn ein Benutzer mehr als 150 Gruppen angehört (verschachtelte Gruppen zählen mit); Fess greift dann auf
saml.default.groupszurückAktivieren Sie den Debug-Modus, um den Inhalt der SAML-Assertion zu überprüfen
Debug-Einstellungen
Um Probleme zu untersuchen, können Sie den Debug-Modus mit der folgenden Einstellung aktivieren:
Durch das Setzen von saml.debug=true wird bei einem fehlgeschlagenen SAML-Authentifizierungsversuch die detaillierte Fehlerursache in das Protokoll ausgegeben.
Außerdem können detaillierte SAML-bezogene Protokolle ausgegeben werden, indem der folgende Logger in app/WEB-INF/classes/log4j2.xml hinzugefügt wird:
Referenz
Konfiguration rollenbasierter Suche - Konfiguration der rollenbasierten Suche
SSO-Konfiguration mit OpenID Connect - SSO-Konfiguration mit OpenID Connect
SSO-Konfiguration mit Entra ID - SSO-Konfiguration speziell für Microsoft Entra ID