147 lines
8.4 KiB
Markdown
147 lines
8.4 KiB
Markdown
[](README.md)
|
|
[](README.en.md)
|
|
|
|
# Passwortloses Anmelden für OXID eShop
|
|
|
|
|
|
|
|
Mit diesem Modul kann die Anmeldung im OXID-Shop mit einem hardwarebasierten Anmeldeschlüssel (WebAuthn / FIDO2 basierter passkey) anstelle eines Passworts durchgeführt werden.
|
|
|
|
Hierbei wird die Anmeldung im Frontend und (sofern für den Benutzer erlaubt) auch im Backend gesichert.
|
|
|
|
Anmeldeschlüssel stammen von Geräten, die kryptografische Schlüssel beeinhalten. Diese können für die Zwei-Faktor-Authentifizierung verwendet werden. Das Anmeldeschlüsselgerät muss den Standard "[WebAuthn](https://w3c.github.io/webauthn/#webauthn-authenticator)" unterstützen.
|
|
|
|
Die Schlüsselverwaltung erfolgt im Adminbereich sowie im "Mein Konto" des Benutzers.
|
|
|
|
## Inhaltsverzeichnis
|
|
|
|
- [Was ist FIDO2?](#was-ist-fido2)
|
|
- [Modulinstallation](#modulinstallation)
|
|
- [Verwendung](#verwendung)
|
|
- [Konfiguration](#konfiguration)
|
|
- [Changelog](#changelog)
|
|
- [Beitragen](#beitragen)
|
|
- [Lizenz](#lizenz)
|
|
- [weitere Lizenzen und Nutzungsbedingungen](#weitere-lizenzen-und-nutzungsbedingungen)
|
|
|
|
## Was ist FIDO2?
|
|
|
|
Es ermöglicht die sichere Authentisierung des Benutzers in webbasierten Benutzeroberflächen über einen Browser. Statt eines Passworts (Faktor "Wissen") meldet man sich mit einer speziellen Hardware an, die zur Prüfung die starke Public Key cryptography verwendet (Faktor "Besitz"). FIDO2-Anmeldungen können durch die Art der Umsetzung nicht mit Phishing abgefangen werden.
|
|
|
|
FIDO2 beschreibt den gesamten Authentisierungsprozess, WebAuthn und CTAP sind Unterbestandteile dieses Prozesses. Bei CTAP handelt es sich um die Kommunikation vom FIDO2-Gerät zum Client / Browser. WebAuthn übernimmt die Übermittlung vom Browser zur Anwendung (Shop).
|
|
|
|
Zur Anmeldung ist jede FIDO2-zertifizierte Hardware nutzbar. Das können sein:
|
|
|
|
- Cross-Platform Authenticators (geräteunabhängig):
|
|
- USB-Tokens (z.B. [Solokey](https://solokeys.com/) oder [YubiKey](https://www.yubico.com/)),
|
|
- NFC-Sender
|
|
- Bluetoothsender
|
|
- Smartcards
|
|
- Platform Authenticators (geräteabhängig)
|
|
- Face ID Geräte
|
|
- Windows Hello Geräte
|
|
- hybride Authenticators
|
|
- Smartphones mit Touch ID (Android ab Version 7, iOS ab Version 14),
|
|
|
|
FIDO2 kann verwendet werden als:
|
|
- ein zusätzlicher 2. Faktor zur bisherigen Benutzername-Passwort-Kombination
|
|
- als sicherer Ersatz statt eines Passworts (passwortlos, noch in Verbindung mit der Eingabe eines Benutzernamens)
|
|
- als kompletter Ersatz für Benutzernamen und Passwort (mit im FIDO2-Gerät abgelegten Anmeldedaten)
|
|
|
|
In diesem Modul ist derzeit die passwortlose Anmeldung umgesetzt (2. Option).
|
|
Für die 1. Optionen sehen wir einen zu geringen Sicherheitsgewinn gegenüber Option 2. Die Umsetzung der 3. Option ist technisch machbar, jedoch für den normalen Einsatzbereich wenig relevant und technisch aufwändig. Bei Bedarf stehen wir gern für Anfragen zur Verfügung.
|
|
|
|
Bei der Registrierung eines FIDO2-Keys werden Zugangsdaten erstellt, um einen späteren Anmeldeversuch prüfen zu können. Diese Zugangsdaten sind fest an das Kundenkonto und an den Shop gebunden und nicht untereinander austauschbar.
|
|
|
|
## Systemanforderungen
|
|
|
|
Dieses Paket erfordert einen mit Composer installierten OXID eShop in einer der folgenden Versionen:
|
|
|
|
- 6.3.x
|
|
- 6.4.x
|
|
- 6.5.x
|
|
|
|
und dessen Anforderungen.
|
|
|
|
Im Standard wird das Flow- und Wave-Theme unterstützt. Andere Themes können Anpassungen erfordern.
|
|
|
|
## Modulinstallation / -update
|
|
|
|
Öffnen Sie eine Kommandozeile und navigieren Sie zum Stammverzeichnis des Shops (Elternverzeichnis von source und vendor). Führen Sie die folgenden Befehle aus. Passen Sie die Pfadangaben an Ihre Installationsumgebung an.
|
|
|
|
```bash
|
|
composer require d3/oxid-twofactor-passwordless:^1.0
|
|
|
|
./vendor/bin/oe-eshop-db_migrate migrations:migrate d3webauthn
|
|
```
|
|
|
|
Wird ein Hinweis auf ein unpassendes Paket "symfony/process" gezeigt, muss dieses geändert werden. Fügen Sie dazu in den oben genannten Befehl bitte den Schalter `-W` ein (`... require -W ...`).
|
|
|
|
Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
|
|
|
|
## Verwendung
|
|
|
|
Die Eröffnung des Shopkontos erfolgt (wie gewohnt) mit Benutzername und Passwort. Im Anschluss lassen sich [FIDO2](https://fidoalliance.org/)-Keys als zusätzliche Authensierungsmöglichkeit hinzufügen. Ab diesem Moment kann die Anmeldung im Shop (Frontend und Backend) entweder mit FIDO2 oder mit Passwort erfolgen. Beides funktioniert unabhängig voneinander.
|
|
|
|
Die Anmeldung mit Passwort unterscheidet sich nicht vom Shopstandard und bleibt als Rückfalloption weiterhin bestehen.
|
|
|
|
Zur Verwendung der registrierten FIDO2-Keys wird bei der Anmeldung einfach das Passwortfeld leer gelassen. Sobald in das Passwortfeld mindestens ein Zeichen eingegeben wurde, wird von einer Anmeldung mit Passwort ausgegangen. Bei leerer Übergabe des Passwortfeldes wird auf die Existenz einer Keyregistrierung geprüft und im Erfolgsfall das entsprechende Gerät angefordert. Liegt keine Registrierung vor, wird ebenfalls von einer Anmeldung mit Passwort ausgegangen.
|
|
|
|
Die Keys können einfach im Mein-Konto-Bereich des Frontends und auch im Kundenkonto im Backend verwaltet werden. Die Verwaltung umfasst das Registrieren neuer Keys (mehrfache Keys pro Konto sind möglich und empfohlen). Jedem Key kann ein Freitextname zugeordnet werden. Weiterhin werden alle registrierten Keys mit ihrem Namen dargestellt. Ebenso sind registrierte Keys dort löschbar.
|
|
|
|
Da bei einer FIDO2-basierten Anmeldung kein Passwort mehr benötigt wird, kann das Backupkennwort auch komplexer als alltagstaugliche Passworte sein.
|
|
|
|
## Konfiguration
|
|
|
|
Verwendete Optionen:
|
|
|
|
- erlaubt Platform und Cross-Platform Authenticators
|
|
- definiert keine Schnittstellen-Einschränkungen (USB, NFC, ...)
|
|
- User Verification empfohlen, aber nicht erforderlich
|
|
- nicht alle Browser können z.B. die PIN bei Cross-Platform Authenticators anfordern, bei User Verification sind diese Browser von der Verwendung ausgeschlossen
|
|
- fordert keine Attestation an
|
|
- keine Abfrage von auf dem Gerät gespeicherter Benutzerdaten
|
|
- Timeout: 60 Sekunden
|
|
|
|
Alle weiteren Optionen sind durch Überladungen frei an individuelle Erfordernisse anpassbar.
|
|
|
|
## Changelog
|
|
|
|
Siehe [CHANGELOG](CHANGELOG.md) für weitere Informationen.
|
|
|
|
## Beitragen
|
|
|
|
Wenn Sie eine Verbesserungsvorschlag haben, legen Sie einen Fork des Repositories an und erstellen Sie einen Pull Request. Alternativ können Sie einfach ein Issue erstellen. Fügen Sie das Projekt zu Ihren Favoriten hinzu. Vielen Dank.
|
|
|
|
- Erstellen Sie einen Fork des Projekts
|
|
- Erstellen Sie einen Feature Branch (git checkout -b feature/AmazingFeature)
|
|
- Fügen Sie Ihre Änderungen hinzu (git commit -m 'Add some AmazingFeature')
|
|
- Übertragen Sie den Branch (git push origin feature/AmazingFeature)
|
|
- Öffnen Sie einen Pull Request
|
|
|
|
## Lizenz
|
|
(Stand: 25.10.2022)
|
|
|
|
Vertrieben unter der GPLv3 Lizenz.
|
|
|
|
```
|
|
Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
|
|
|
|
Diese Software wird unter der GNU GENERAL PUBLIC LICENSE Version 3 vertrieben.
|
|
```
|
|
|
|
Die vollständigen Copyright- und Lizenzinformationen entnehmen Sie bitte der [LICENSE](LICENSE.md)-Datei, die mit diesem Quellcode verteilt wurde.
|
|
|
|
## weitere Lizenzen und Nutzungsbedingungen
|
|
|
|
### ArrayBuffer to Base64 converting JavaScript [MIT]
|
|
(https://gist.github.com/jonleighton/958841 - Stand: 04.11.2022)
|
|
|
|
```
|
|
MIT LICENSE
|
|
Copyright 2011 Jon Leighton
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
```
|