major
#29092
Mehrfaktorauthentifizierung und Selbstverwaltung von Konten
Übersicht
Erweiterung des TopLogic-Frameworks um plattformweite Unterstützung für Multi-Faktor-Authentifizierung (MFA), Self-Service-Kontoverwaltung und einladungsbasierte Selbstregistrierung.
Was wurde entwickelt
- Kern (tl-core): Jedes Konto verfügt über ein TOTP-Geheimnis (tl.accounts:Person#mfaSecret, RFC 6238) und eine Anforderung ( tl.accounts:Person#mfaRequirement;MfaRequirement: optional, erforderlich, deaktiviert; Standardwert entsprechend der Option „mfa-requirement“ des Authentifizierungsgeräts). Die Anmeldedialoge der klassischen und der React-Benutzeroberfläche fragen nach dem Code eines Kontos mit einem Geheimnis und ermöglichen es einem Benutzer, einen zweiten Faktor (QR-Code) einzurichten, der erzwungen wird, wenn das Konto einen solchen erfordert. Ein Administrator kann das Geheimnis eines Kontos entfernen.
- Modul tl-security-selfservice: Passwort-Zurücksetzen und Zurücksetzen des zweiten Authentifizierungsfaktors mittels eines per E-Mail gesendeten Codes sowie Einladungen per E-Mail, mit denen eine eingeladene Person ein Konto anlegt.
Die Entwicklerartikel „authentication“, „authentication/mfa“ (Modul „tl-core“) und „authentication/self-service“ (Modul „tl-security-selfservice“) beschreiben dies.
Motivation
Anwendungen erfordern zunehmend:
- Zwei-Faktor-Authentifizierung (Passwort + TOTP) für Benutzer ohne externe Identitätsanbieter
- Selbstständige Passwort- und TOTP-Zurücksetzung ohne Eingreifen eines Administrators
- Einladungsbasierte Selbstregistrierung für externe Benutzer
Migration
Das Modul „tl-security-selfservice“ ist eine optionale Abhängigkeit und erfordert keine Maßnahmen. Der Anmeldemechanismus des Kerns wurde jedoch für den Zwei-Schritt-Ablauf neu geschrieben, sodass Anwendungen, die die Anmeldeseite angepasst, die Klassen zur Kontoverwaltung erweitert oder Authentifizierungsgeräte konfiguriert haben, entsprechende Anpassungen vornehmen müssen.
Anmeldeseite durch einen In-App-Dialog ersetzt
LoginPageServlet (Mapping /servlet/login), login.jsp, login.banner.inc, doOnload.inc, jsp/main/loginError.jsp, jsp/util/administration/changePwd.jsp und script/tl/loginError.js werden gelöscht. Eine Anfrage ohne Sitzung erhält nun eine anonyme Sitzung, und das Layout bietet den „LoginViewDialog“ über den neuen <login-hooks> von MainLayout$GlobalConfig an (Framework-Standard: OpenLoginDialogHook).
- Löschen Sie Anwendungs-Overlays der entfernten JSPs und Includes sowie die Einträge für LoginPageServlet in der Datei web.xml. Lesezeichen und Überwachungssonden, die auf /login.jsp oder /servlet/login verweisen, müssen nun /servlet/LayoutServlet verwenden.
- Entfernen Sie „login“, „loginRetryPage“, „loginErrorPage“ und „changePassword“ aus einem „ApplicationPages$Config“-Override; die Eigenschaften existieren nicht mehr (unbekannte Eigenschaft = Startfehler). „loginPage“, „logoutPage“ und „loginRetrySSO“ sind standardmäßig auf „/servlet/LayoutServlet“ gesetzt.
- Add-on „Login-Messages“: „LoginMessagesMainLayout“ und dessen „GlobalConfig“ werden durch den Login-Hook „LoginMessagesHook“ ersetzt. Entfernen Sie eine Theme-Einstellung „MAIN_LAYOUT_CLASS“, die die alte Klasse benennt, sowie den Block „LoginMessagesMainLayout$GlobalConfig“; die Datei „loginMessagesConf.config.xml“ des Add-ons registriert den Hook:
{{{#!xml <config config:interface="com.top_logic.mig.html.layout.MainLayout$GlobalConfig">
<login-hooks>
<login-hook class="com.top_logic.addons.loginmessages.layout.LoginMessagesHook" showLoginMessages="true"/>
</login-hooks>
</config> }}}
- Ressourcenschlüssel: tl.logout lautet nun class.com.top_logic.layout.component.configuration.I18NConstants.LOGOUT; layouts.admin.persons.changePassword.* wurde in class.com.top_logic.knowledge.gui.layout.person.I18NConstants.CHANGE_PASSWORD_FORM.* verschoben; MAX_USERS_EXCEEDED wurde entfernt.
- Eine Sitzung kann nun zum anonymen Konto gehören (PersonManager.getAnonymous(), TLContext.isAnonymous()), und Person.all() enthält dieses Konto.
- Anwendungskopien der Engine-Layout-Dateien müssen an die anonyme Sitzung angepasst werden: Umschließen Sie in einer Kopie von toolrow/homeButton.xml das Benutzermenü (PopupViewConfiguration) mit einer ConditionalViewConfiguration mit condition="com.top_logic.util.IsAnonymousUser“ und invert=„true“ ein, andernfalls sehen anonyme Benutzer das Benutzermenü. Fügen Sie in einer Kopie von themes/core/templates/navigationComponent.xml login-image="theme:IMAGE_BUTTONS_LOGIN" zur logoutView hinzu (Symbol der Anmeldeaktion, solange kein Benutzer angemeldet ist); die Variante coreSidebar enthält keine logoutView mehr.
Java-API
- Login.login(userName, request, response) wird durch Login.checkUserPassword(userName, char[] password, request, response) ersetzt, und Login.login(request, response, credentials) durch Login.checkLoginCredentials(credentials, request, response). Beide überprüfen lediglich die Anmeldedaten; der Aufrufer erstellt die Sitzung mit `SessionService.getInstance().loginUser(request, response, person)`. `MaxUsersExceededException` wird durch `LoginHookFailedException` ersetzt. `LoginCredentials` ist nicht mehr `AutoCloseable`: Rufen Sie `clearPassword()` in einem `finally` -Block auf.
- ExternalAuthenticationServlet (Basisklasse der SSO-Servlets) erbt nun von NoContextServlet statt von LoginPageServlet: forwardPage(...) heißt nun forwardToPage(...), forwardToStartPage(...) heißt nun redirectToStartPage(...), checkRequest(...) und forwardToTarget(...) können nicht mehr überschrieben werden, und forwardToSSOLoginFailed(...) deklariert IOException und ServletException. Unterklassen, die lediglich ` retrieveLoginCredentials(...) ` implementieren, erfordern keine Änderung. `LoginPageServlet.appendCustomParameters(...) ` und `PARAM_START_PAGE ` wurden in `AbstractTopLogicServlet` verschoben.
- TLPersonManager wurde entfernt: Konfigurieren und erweitern Sie com.top_logic.knowledge.wrap.person.PersonManager (wie es ContactPersonManager tut; dessen Config ist nicht mehr generisch). PersonManager erweitert KBBasedManagedClass, daher rufen Unterklassen super(context, config) auf. Ersatz für getAllAliveFullPersons(): Person.all().stream().filter(Person.FULL_USER_FILTER).
- Person.create(kb, name, String deviceId) lautet nun Person.create(kb, name, AuthenticationDevice device).
- AuthenticationDevice.getMFARequirement() ist eine neue abstrakte Methode: Benutzerdefinierte Geräte implementieren sie (z. B. durch Rückgabe von MfaRequirement.DISABLED).
- FormMember.setLabel(ResKey), setTooltip(ResKey) und setTooltipCaption(ResKey) wurden zusätzlich zu den String-Varianten hinzugefügt; ein Aufruf mit einem literalen null ist mehrdeutig und muss umgewandelt werden (setLabel((String) null)).
- ListStorage.listConfig(...), SetStorage.setConfig(...) und SingletonLinkStorage.singletonLinkConfig(...) nehmen am Ende einen booleschen Wert entgegen ( ohne Typangabe; übergebe „false“, um das bisherige Verhalten beizubehalten).
- Die veralteten Methoden MetaElementUtil.getAllInstancesOf(TLClass) und getAllDirectInstancesOf(TLClass) wurden entfernt; verwenden Sie stattdessen die Überladungen mit der erwarteten Klasse (getAllInstancesOf(type, Wrapper.class)).
- „Base32“ wurde in „EncodeTypable“ umbenannt (gleiche statische Methodennamen).
- „forwardPage(...)“ wurde ebenfalls aus „TopLogicServlet“ und „AJAXServlet“ entfernt; „TopLogicServlet“ erbt nun von „AbstractTopLogicServlet“. Die Klassen „com.top_logic.base.accesscontrol.SessionAttributeKeys“ und „com.top_logic.util.DispatchException“ wurden gelöscht.
Konfiguration
- „mfa-requirement“ ist in „DBAuthenticationAccessDevice.Config“ und „LDAPAuthenticationAccessDevice.Config“ obligatorisch. Die Kernkonfiguration legt „optional“ für „dbSecurity“ und „%LDAP_MFA_REQUIREMENT%“ in der Datei „ldapConf.config.xml“ fest; eine Anwendung, die ein eigenes `<security-device>` einer dieser Klassen (oder eine kopierte „ldapConf“) deklariert, muss „mfa-requirement="optional|required|disabled"“ hinzufügen.
- Anwendungen, die ihre eigene <modules> -Liste verwalten, müssen „LoginFailuresModule$Module“ aktivieren.
- Die Migration „Ticket_29092_multi_factor_authentication“ (tl-element) fügt „Person#mfaSecret“ und „Person#mfaRequirement“ automatisch hinzu. Die gleichnamige Migration „tl-layout-formeditor“ ersetzt die Annotation zur Formulardefinition von tl.accounts:Person: Eine anwendungsinterne Anpassung des Kontoformulars geht dabei verloren und muss nach dem Update erneut vorgenommen werden.