Skip to content

Commit b1abdaa

Browse files
nathanjosiahnathanjosiah
committed
MC-42010: Update README.md of all of modules
Fixes magento#41
1 parent e4aea96 commit b1abdaa

File tree

23 files changed

+158
-119
lines changed

23 files changed

+158
-119
lines changed

‎ReCaptchaAdminUi/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA UI files related to views in the admin panel.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaCheckout/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to checkout.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaContact/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to the contact page.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaCustomer/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to customer actions.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaFrontendUi/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the UI related to customer-facing reCAPTCHA views.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaMigration/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module helps migrate data from the old reCAPTCHA implementation to the new one.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaNewsletter/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to newsletter subscriptions.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaPaypal/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to PayPal payments.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaReview/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to product reviews.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaSendFriend/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to store send to friend actions.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaStorePickup/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to store pickup actions.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaUi/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module contains the base UI related to all reCAPTCHA features.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaUser/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementations related to user actions.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).
8+
29

310
## Emergency commandline disable for Admin panel Login page:
411

‎ReCaptchaValidation/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the base implementation for reCAPTCHA.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaValidationApi/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the service contracts for the base reCAPTCHA implementation.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaVersion2Checkbox/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementation for the V2 Checkbox variation.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaVersion2Invisible/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementation for the V2 Invisible variation.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaVersion3Invisible/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the reCAPTCHA implementation for the V3 Invisible variation.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaWebapiApi/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the service contracts related to the base reCAPTCHA implementation.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaWebapiGraphQl/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the GraphQl implementation of reCAPTCHA.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaWebapiRest/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the WebAPI REST implementation of reCAPTCHA.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎ReCaptchaWebapiUi/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
Please refer to: https://github.com/magento/security-package
1+
# Magento reCAPTCHA
2+
3+
Google reCAPTCHA ensures that a human being, rather than a computer (or “bot”), is interacting with your website. Unlike the standard Magento CAPTCHA, Google reCAPTCHA provides enhanced security with a selection of different display options and methods. Additional website traffic information is available in the dashboard of your Google reCAPTCHA account.
4+
5+
This module provides the UI files related to the WebAPI implementation of reCAPTCHA.
6+
7+
For more information please visit the [Magento document for reCAPTCHA](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html).

‎TwoFactorAuth/README.md

+3-97
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,5 @@
1-
MSP TwoFactorAuth
1+
# Magento Two Factor Authentication
22

3-
Two Factor Authentication module for maximum **backend access protection** in Magento 2.
4-
5-
> Member of **MSP Security Suite**
6-
>
7-
> See: https://github.com/magespecialist/m2-MSP_Security_Suite
8-
9-
Did you lock yourself out from Magento backend? <a href="https://github.com/magespecialist/m2-Magento_TwoFactorAuth#emergency-commandline-disable">click here.</a>
10-
11-
## Main features:
12-
13-
* Providers:
14-
* Google authenticator
15-
* QR code enroll
16-
* Authy
17-
* SMS
18-
* Call
19-
* Token
20-
* One touch
21-
* U2F keys (Yubico and others)
22-
* Duo Security
23-
* SMS
24-
* Push notification
25-
* Central security suite events logging
26-
* Per user configuration
27-
* Forced global 2FA configuration
28-
29-
## Installing on Magento2:
30-
31-
**1. Install using composer**
32-
33-
From command line:
34-
35-
`composer require msp/twofactorauth`
36-
37-
**2. Enable and configure from your Magento backend config**
38-
39-
Enable from **Store > Config > SecuritySuite > Two Factor Authentication**.
40-
41-
<img src="https://raw.githubusercontent.com/magespecialist/m2-Magento_TwoFactorAuth/master/screenshots/config.png" />
42-
43-
**3. Enable two factor authentication for your user**
44-
45-
You can select among a set of different 2FA providers. **Multiple concurrent providers** are supported.
46-
47-
<img src="https://raw.githubusercontent.com/magespecialist/m2-Magento_TwoFactorAuth/master/screenshots/user_tfa.png" />
48-
49-
**4. Subscribe / Configure your 2FA provider(s):**
50-
51-
**4.1 Google Authenticator example**
52-
53-
<img src="https://raw.githubusercontent.com/magespecialist/m2-Magento_TwoFactorAuth/master/screenshots/google_qr.png" />
54-
55-
**4.2. Duo Security example**
56-
57-
<img src="https://raw.githubusercontent.com/magespecialist/m2-Magento_TwoFactorAuth/master/screenshots/duo_auth.png" />
58-
59-
**4.3. U2F key (Yubico and others) example**
60-
61-
<img src="https://raw.githubusercontent.com/magespecialist/m2-Magento_TwoFactorAuth/master/screenshots/u2f_auth.png" />
62-
63-
**4.4. Authy example**
64-
65-
<img src="https://raw.githubusercontent.com/magespecialist/m2-Magento_TwoFactorAuth/master/screenshots/authy_auth.png" />
66-
67-
## Emergency commandline disable:
68-
69-
If you messed up with two factor authentication you can disable it from command-line:
70-
71-
`php bin/magento msp:security:tfa:disable`
72-
73-
This will disable two factor auth globally.
74-
75-
## Emergency commandline reset:
76-
77-
If you need to manually reset one single user configuration (so you can restart configuration / subscription), type:
78-
79-
`php bin/magento msp:security:tfa:reset <username> <provider>`
80-
81-
e.g.:
82-
83-
`php bin/magento msp:security:tfa:reset admin google`
84-
85-
`php bin/magento msp:security:tfa:reset admin u2fkey`
86-
87-
`php bin/magento msp:security:tfa:reset admin authy`
88-
89-
## Emergency of emergency and your house is on fire, your dog is lost and your wife doesn't love you anymore:
90-
91-
**DO NOT ATTEMPT TO MODIFY ANY DB INFORMATION UNLESS YOU UNDERSTAND WHAT YOU ARE DOING**
92-
93-
Table `core_config_data`:
94-
* `msp/twofactorauth/enabled`: Set to zero to disable 2fa globally
95-
* `msp/twofactorauth/force_providers`: Delete this entry to remove forced providers option
96-
97-
Table `msp_tfa_user_config`:
98-
* Delete one user row to reset user's 2FA preference and configuration
3+
The Magento Admin provides all access to your store, orders, and customer data. To prevent unauthorized access to your data, all users who attempt to sign in to the Admin of your Magento installation must complete a second step to verify their identity.
994

5+
For more information please view the Magento documentation for [a general guide on 2fa](https://docs.magento.com/user-guide/stores/security-two-factor-authentication.html) as well as a [a more technical guide](https://devdocs.magento.com/guides/v2.4/security/two-factor-authentication.html).

0 commit comments

Comments
 (0)