forked from D3Public/oxtotp
adjust documentation
This commit is contained in:
parent
643794c09d
commit
bbfdbd29c9
|
|
@ -0,0 +1,8 @@
|
|||
Die [2-Faktor-Authentisierung](https://de.wikipedia.org/wiki/Zwei-Faktor-Authentisierung) ermöglicht es den Shopbesuchern, neben der üblichen Kombination aus Benutzername und Passwort auch ein [zeitgesteuertes Einmalpasswort](https://de.wikipedia.org/wiki/Time-based_One-time_Password_Algorithmus) zur Anmeldung abfragen zu lassen. Dies erhöht die Sicherheit im Anmeldeprozess deutlich und macht auch Anmeldungen in öffentlichen Netzwerken oder Internet-Cafés sicherer.
|
||||
Das abgefragte Einmalpasswort wird z.B. durch entsprechende Apps auf dem Smartphone erzeugt.
|
||||
|
||||
Die Einrichtung dieses 2. Faktors ist optional und lässt sich für jedes Benutzerkonto separat einrichten. Die Einrichtung erfolgt im "Mein Konto"-Bereich, über das Shopbackend kann die Einrichtung ebenfalls durchgeführt werden.
|
||||
|
||||
Erst dann wird die zusätzliche Sicherheit genutzt. Sofern der Benutzer auch Zugang zum Adminbereich hat, wird das Einmalpasswort dort ebenfalls abgefragt.
|
||||
|
||||
Zur Einrichtung wird ein scanbarer QR-Code angeboten. Bei der Einrichtung werden statische Backup-Codes angelegt, die verwendet werden können, wenn ein Anmelden mit den Einmalpasswörtern nicht möglich ist. Die Einrichtung kann jederzeit wieder gelöscht werden.
|
||||
|
|
@ -2,13 +2,12 @@
|
|||
title: Changelog
|
||||
---
|
||||
|
||||
## noch nicht veröffentlicht
|
||||
|
||||
## 1.0.0.0 (2018-10-24)
|
||||
## 1.0.0.0 (2019-08-19)
|
||||
|
||||
### Added
|
||||
- 2-Faktor-Authentisierung für Backend-Logins zusätzlich zu Benutzername und Passwort
|
||||
- 2-Faktor-Authentisierung für Logins in Front- und Backend zusätzlich zu Benutzername und Passwort
|
||||
- Authentisierung wird nur bei Benutzerkonten gezeigt, die dieses aktiviert haben - sonst nur Standardanmeldung
|
||||
- die Basis der Passwortgenerierung wird für jedes Benutzerkonto individuell angelegt
|
||||
- Einrichtung des Zugangs in der Auth-App kann durch scanbaren QR-Code oder kopierbare Zeichenkette erfolgen
|
||||
- Validierung der Einmalpassworte und Generierung der QR-Codes werden ausschließlich innerhalb des Shops durchgeführt - keine Kommunikation nach außen nötig
|
||||
- statische Backupcodes ermöglichen auch eine (begrenzte) Anmeldung ohne Zugang zum Generierungstool
|
||||
|
|
|
|||
|
|
@ -2,8 +2,14 @@
|
|||
title: TMP-Ordner leeren
|
||||
---
|
||||
|
||||
# mit installiertem D3 Modul-Connector
|
||||
|
||||
Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ].
|
||||
|
||||
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
|
||||
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
|
||||
# ohne installiertem D3 Modul-Connector
|
||||
|
||||
Verbinden Sie sich mit Hilfe Ihres FTP-Programms zu Ihrem Server und löschen Sie alle Dateien bis auf `.htaccess` in den Ordnern `source/tmp` und `source/tmp/smarty` innerhalb Ihrer Shopinstallation.
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
title: Paketquelle entfernen
|
||||
---
|
||||
|
||||
Durch einen Wechsel der Paketquelle ist die veraltete Angabe nicht mehr erforderlich. Um Konflikte zu vermeiden, sollte die alte Paketquelle entfernt werden. Haben Sie diese schon früher entfernt, können Sie diesen Schritt überspringen.
|
||||
|
||||
Starten Sie die Konsole Ihres Webservers und wechseln in das Hauptverzeichnis Ihres Shops (oberhalb des `source`- und `vendor`-Verzeichnisses). Senden Sie dort diesen Befehl ab:
|
||||
|
||||
```bash
|
||||
php composer config --unset repositories.d3
|
||||
php composer config --unset repositories.D3modules
|
||||
```
|
||||
|
||||
> [!] Achten Sie darauf, dass die Installation über Composer mit derselben PHP-Version erfolgt, in der auch Ihr Shop installiert ist. Sie erhalten sonst unpassende Modulpakete.
|
||||
|
||||
> [i] Benötigt Ihre Installation einen anderen Aufruf von Composer, ändern Sie den Befehl bitte entsprechend ab. Für weitere Optionen dieses Befehls lesen Sie bitte die [Dokumentation von Composer](https://getcomposer.org/doc/03-cli.md#require).
|
||||
|
|
@ -2,8 +2,14 @@
|
|||
title: TMP-Ordner leeren
|
||||
---
|
||||
|
||||
# mit installiertem D3 Modul-Connector
|
||||
|
||||
Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ].
|
||||
|
||||
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
|
||||
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
|
||||
# ohne installiertem D3 Modul-Connector
|
||||
|
||||
Verbinden Sie sich mit Hilfe Ihres FTP-Programms zu Ihrem Server und löschen Sie alle Dateien bis auf `.htaccess` in den Ordnern `source/tmp` und `source/tmp/smarty` innerhalb Ihrer Shopinstallation.
|
||||
|
|
@ -11,8 +11,16 @@ Um die erfolgreiche Installation zu prüfen, können Sie die folgende(n) Checkli
|
|||
* Modul ist unter [ Erweiterungen ] -> [ Module ] aktiv geschaltet
|
||||
* Modul zeigt unter [ Benutzer verwalten ] -> [ Benutzer ] -> [ 2-Faktor-Authentisierung ] einen eigenen Bereich für Einstellungen
|
||||
|
||||
### Frontend
|
||||
|
||||
* Modul zeigt in "Mein Konto" einen Bereich zur Einrichtung des 2. Faktors
|
||||
|
||||
## Einstellungsabhängige Prüfungen
|
||||
|
||||
### Backend
|
||||
|
||||
* Nach Aktivierung fragt das Backend neben Benutzername und Passwort auch ein Einmalpasswort ab.
|
||||
|
||||
### Frontend
|
||||
|
||||
* Nach Aktivierung fragt das Frontend neben Benutzername und Passwort auch ein Einmalpasswort ab.
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
title: Schnellstart
|
||||
---
|
||||
|
||||
Aktivieren Sie die 2-Faktor-Authentisierung im Backend unter [ Benutzer verwalten ] -> [ Benutzer ] -> [ 2-Faktor-Authentisierung ].
|
||||
Aktivieren Sie die 2-Faktor-Authentisierung im Backend unter [ Benutzer verwalten ] -> [ Benutzer ] -> [ 2-Faktor-Authentisierung ] oder im "Mein Konto" des Shopfrontends.
|
||||
|
||||
Ab dann erfordert das Login im Backend für das jeweilige Benutzerkonto neben Benutzername auch die Angabe eines Einmalpasswortes.
|
||||
Ab dann erfordert das Login im Shop (Front- und Backend) für das jeweilige Benutzerkonto neben Benutzername und Passwort auch die Angabe eines Einmalpasswortes.
|
||||
|
||||
Diese zusätzliche Absicherung kann im Adminbereich jederzeit wieder entfernt werden.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,14 @@
|
|||
title: TMP-Ordner leeren
|
||||
---
|
||||
|
||||
# mit installiertem D3 Modul-Connector
|
||||
|
||||
Leeren Sie das Verzeichnis `tmp` über [ Admin ] -> [ (D3) Module ] -> [ Modul-Connector ] -> [ TMP leeren ]. Markieren Sie [ komplett leeren ] und klicken auf [ TMP leeren ].
|
||||
|
||||
Sofern die Views nicht automatisch aktualisiert werden, führen Sie dies noch durch.
|
||||
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
> [i] Erfordert Ihre Installation eine andere Vorgehensweise zum Leeren des Caches oder zum Aktualisieren der Datenbank-Viewtabellen, führen Sie diese bitte aus.
|
||||
|
||||
# ohne installiertem D3 Modul-Connector
|
||||
|
||||
Verbinden Sie sich mit Hilfe Ihres FTP-Programms zu Ihrem Server und löschen Sie alle Dateien bis auf `.htaccess` in den Ordnern `source/tmp` und `source/tmp/smarty` innerhalb Ihrer Shopinstallation.
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
title: optische Anpassungen
|
||||
---
|
||||
|
||||
Die Modulausgaben können durch eigene CSS-Styles angepasst werden. Um die Updatefähigkeit des Moduls zu
|
||||
erhalten, übernehmen Sie die neuen Stylesheets bitte in modulunabhängige Dateien.
|
||||
|
||||
Die mitgelieferten Assets (CSS, JavaScripts) werden von uns über einen vorkonfigurierten Kompilierungstask
|
||||
erstellt. Dieser kann via [Grunt](https://gruntjs.com/) ausgeführt werden. Möchten Sie eigene oder
|
||||
angepasste Inhalte daraus kompilieren lassen, installieren Sie das Modul bitte mit Composer und der
|
||||
`--prefer-source`-Option. Dann stehen Ihnen die Quelldateien im Ordner `src/build` zur Verfügung.
|
||||
|
||||
Diese können direkt aufgerufen werden, um eventuelle Anpassungen im zu Grunde liegenden Theme zu
|
||||
integrieren. Alternativ können Sie die Sources auch in eigene Kompilierungsprozesse einbinden,
|
||||
um projektspezifische Assets zu erstellen.
|
||||
|
||||
Details zur Verwendung des Taskrunners und der Quelldateien entnehmen Sie bitte der `README.md` im
|
||||
oben erwähnten Build-Ordner.
|
||||
|
|
@ -57,7 +57,7 @@ $aModule = [
|
|||
'en' => 'Two-factor authentication (TOTP) for OXID eSales shop',
|
||||
],
|
||||
'thumbnail' => 'picture.png',
|
||||
'version' => '1.0',
|
||||
'version' => '1.0.0.0',
|
||||
'author' => 'D³ Data Development (Inh.: Thomas Dartsch)',
|
||||
'email' => 'support@shopmodule.com',
|
||||
'url' => 'http://www.oxidmodule.com/',
|
||||
|
|
|
|||
Loading…
Reference in New Issue