From 40cc747a0f964885c1c272931bb7a2c797d61972 Mon Sep 17 00:00:00 2001 From: Daniel Seifert Date: Wed, 25 Jan 2023 22:04:29 +0100 Subject: [PATCH] rename package --- CHANGELOG.md | 16 ++++++++++++++++ README.en.md | 22 ++++++++++++++++------ README.md | 22 ++++++++++++++++------ composer.json | 17 ++++++++++++++--- src/metadata.php | 11 +++++++---- 5 files changed, 69 insertions(+), 19 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c0f1bbd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased](https://git.d3data.de/D3Public/webauthn/compare/2.0.0.1...rel_2.x) + +## [1.0.0.0](https://git.d3data.de/D3Public/webauthn/releases/tag/1.0.0.0) - 2019-08-19 +### Added +- 2-factor authentication for logins in front- and backend in addition to username and password +- Activation and setup possible in the front and back end +- Authentication is shown for user accounts that have this enabled - otherwise the usual default login. +- Access can be set up in the Auth app by scannable QR code or copyable character string +- Validation of one-time passwords and generation of QR codes are only carried out within the shop - no communication to the outside necessary +- static backup codes also allow (limited) login without access to the generation tool diff --git a/README.en.md b/README.en.md index ae780b8..161d1ee 100644 --- a/README.en.md +++ b/README.en.md @@ -1,9 +1,9 @@ [![deutsche Version](https://logos.oxidmodule.com/de2_xs.svg)](README.md) [![english version](https://logos.oxidmodule.com/en2_xs.svg)](README.en.md) -# D³ WebAuthn / FIDO2 Login for OXID eShop +# D³ Passwordless login for OXID eShop -With this module, the login in the OXID shop can be carried out with a hardware token instead of a password. +With this module, the login in the OXID shop can be carried out with a hardware token instead of a password (WebAuthn / FIDO2 based). This secures the login in the frontend and (if allowed for the user) also in the backend. @@ -31,7 +31,7 @@ FIDO2 describes the entire authentication process, WebAuthn and CTAP are subcomp Any FIDO2-certified hardware can be used for registration. This can be: - Cross-Platform Authenticators (device-independent): - - USB tokens (e.g. Solokey or YubiKey), + - USB tokens (e.g. [Solokey](https://solokeys.com/) oder [YubiKey](https://www.yubico.com/)), - NFC transmitters - Bluetooth transmitters - Smartcards @@ -51,14 +51,24 @@ For the 1st options we see too little security gain compared to option 2. The im When registering a FIDO2 key, access data is created in order to be able to check a later login attempt. These access data are firmly bound to the customer account and the shop and cannot be exchanged with each other. -## Module installation +## System requirements -This package requires an Composer installed OXID eShop as defined in [composer.json](composer.json). +This package requires an OXID eShop installed with Composer in one of the following versions: + +- 6.3.x +- 6.4.x +- 6.5.x + +and its requirements. + +The Flow and Wave themes are supported by default. Other themes may require customisation. + +## Module installation Open a command line interface and navigate to the shop root directory (parent of source and vendor). Execute the following command. Adapt the paths to your environment. ```bash -php composer require d3/oxwebauthn:^1.0 +php composer require d3/oxid-twofactor-passwordless:^1.0 ``` If a reference to an unsuitable package `symfony/process` is shown, this must be changed. To do this, please add the switch `-W` to the above command (`... require -W ...`). diff --git a/README.md b/README.md index 445ddd0..922f606 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ [![deutsche Version](https://logos.oxidmodule.com/de2_xs.svg)](README.md) [![english version](https://logos.oxidmodule.com/en2_xs.svg)](README.en.md) -# D³ WebAuthn / FIDO2 Login für OXID eShop +# D³ Passwortloses Anmelden für OXID eShop -Mit diesem Modul kann die Anmeldung im OXID-Shop mit einem Hardwaretoken anstelle eines Passworts durchgeführt werden. +Mit diesem Modul kann die Anmeldung im OXID-Shop mit einem Hardwaretoken anstelle eines Passworts durchgeführt werden (WebAuthn / FIDO2 basiert). Hierbei wird die Anmeldung im Frontend und (sofern für den Benutzer erlaubt) auch im Backend gesichert. @@ -31,7 +31,7 @@ FIDO2 beschreibt den gesamten Authentisierungsprozess, WebAuthn und CTAP sind Un Zur Anmeldung ist jede FIDO2-zertifizierte Hardware nutzbar. Das können sein: - Cross-Platform Authenticators (geräteunabhängig): - - USB-Tokens (z.B. Solokey oder YubiKey), + - USB-Tokens (z.B. [Solokey](https://solokeys.com/) oder [YubiKey](https://www.yubico.com/)), - NFC-Sender - Bluetoothsender - Smartcards @@ -51,14 +51,24 @@ Für die 1. Optionen sehen wir einen zu geringen Sicherheitsgewinn gegenüber Op 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. -## Modulinstallation +## Systemanforderungen -Dieses Paket erfordert einen mit Composer installierten OXID eShop in einer in der [composer.json](composer.json) definierten Version. +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 Öffnen Sie eine Kommandozeile und navigieren Sie zum Stammverzeichnis des Shops (Elternverzeichnis von source und vendor). Führen Sie den folgenden Befehl aus. Passen Sie die Pfadangaben an Ihre Installationsumgebung an. ```bash -php composer require d3/oxwebauthn:^1.0 +php composer require d3/oxid-twofactor-passwordless:^1.0 ``` 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 ...`). diff --git a/composer.json b/composer.json index e3fd33a..89cd32f 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { - "name": "d3/oxwebauthn", - "description": "Webauthn / FIDO2 based login for OXID eShop.", + "name": "d3/oxid-twofactor-passwordless", + "description": "Passwordless login for OXID eShop (Webauthn / FIDO2 based)", "type": "oxideshop-module", "keywords": [ "oxid", @@ -10,7 +10,15 @@ "webauthn", "FIDO2", "CTAP", - "public key" + "public key", + "2FA", + "two factor", + "second factor", + "passwordless", + "token", + "yubikey", + "solokey", + "credential" ], "authors": [ { @@ -48,5 +56,8 @@ "psr-4": { "D3\\Webauthn\\": "../../../source/modules/d3/oxwebauthn" } + }, + "suggest": { + "d3/oxid-twofactor-onetimepassword": "Registrations can be supplemented with time-based one-time passwords as a second factor." } } diff --git a/src/metadata.php b/src/metadata.php index 36652a9..4eb8452 100755 --- a/src/metadata.php +++ b/src/metadata.php @@ -65,10 +65,13 @@ $logo = '