Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
Merge pull request #128 from magento-devdocs/2FA-updates
Browse files Browse the repository at this point in the history
2FA updates
  • Loading branch information
ccondra authored Jun 24, 2021
2 parents 17a9ecb + b71dbde commit 594df6a
Show file tree
Hide file tree
Showing 9 changed files with 43 additions and 40 deletions.
2 changes: 1 addition & 1 deletion src/configuration/security/2fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Stores > Settings > [Configuration]({% link stores/configuration.md %}) > [Secu

|Field|[Scope]({% link configuration/scope.md %})|Description|
|--- |--- |--- |
|Providers to use|Global|Indicates the two-factor authentication (2FA) solution(s) that can be used to log in to the _Admin_. Authentication by only one 2FA solution is required to log in. If more than one 2FA solution is implemented, each user can choose the one they prefer to use.<br />Before logging in to the _Admin_, each user must follow the provider's instructions to install the app or complete other setup requirements. For complete details, see [Two-Factor Authentication]({% link stores/security-two-factor-authentication.md %}).|
|Providers to use|Global|Indicates the two-factor authentication (2FA) method(s) that are required to log in to the _Admin_. Authentication by only one 2FA method is required. If multiple 2FA authenticators are specified, users must be authenticated by them all to gain access to the _Admin_.<br />Before logging in to the _Admin_, each user must follow the provider's instructions to install the app or complete other setup requirements. For complete details, see [Two-Factor Authentication]({% link stores/security-two-factor-authentication.md %}).|
|Configuration Email URL for Web API|Global |For custom implementations, the URL for an alternate email configuration link that is sent to _Admin_ users at first login. In the email template, use the placeholder `:tfat` to indicate where the token is injected.|

## Google
Expand Down
Binary file modified src/images/images/admin-menu-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/images/magento-resources-security-center.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 8 additions & 6 deletions src/stores/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,22 @@ title: Store Admin
group: getting-started
---

Your store Admin is the password-protected back office where you, as the merchant, can set up products and promotions, manage orders, and perform other administrative tasks. All basic configuration tasks and store management operations are performed from the Admin.
Your store _Admin_ is the password-protected back office where you, as the merchant, can set up products and promotions, manage orders, and perform other administrative tasks. All basic configuration tasks and store management operations are performed from the _Admin_.

![Magento Admin - Dashboard]({% link images/images/admin-menu-dashboard.png %}){: .zoom}
For additional security, the _Admin_ login is protected by [two-factor authentication]({% link stores/security-two-factor-authentication.md %}), and can be configured to require a [CAPTCHA]({% link stores/security-captcha.md %}). To learn more, refer to [Configuring Admin Security]({% link stores/security-admin.md %}).

![Adobe Commerce Admin - Dashboard]({% link images/images/admin-menu-dashboard.png %}){: .zoom}
_Admin Sidebar and Dashboard_

Your initial sign-in credentials were set up during the Magento installation. If you forget your password, a temporary password can be sent to the email address that is associated with the account. For increased security, you can configure your store to require a case-sensitive user name and password. For additional security, the Admin login can be configured to require a [CAPTCHA]({% link stores/security-captcha.md %}). To learn more, see [Configuring Admin Security]({% link stores/security-admin.md %}).
Your initial [sign-in]({% link stores/admin-signin.md %}) credentials were set up during the installation of Adobe Commerce. If you forget your password, a temporary password can be sent to the email address that is associated with the account. For increased security, you can configure your store to require a case-sensitive user name and strong password.

In addition to the default Admin account, you can create as many [additional accounts]({% link system/permissions-users-all.md %}) that are needed to manage the store and to support customer accounts. Each account can be associated with a specific [role]({% link system/permissions-user-roles.md %}) and [level of access]({% link system/permissions-role-resources.md %}), based on the person’s business need to know. The email address that is associated with each Admin account must be unique.
In addition to the default _Admin_ account, you can create as many [additional accounts]({% link system/permissions-users-all.md %}) as needed to manage the store and support customer accounts. Each account can be associated with a specific [role]({% link system/permissions-user-roles.md %}) and [level of access]({% link system/permissions-role-resources.md %}), based on the person’s business need to know. The email address that is associated with each _Admin_ account must be unique.

## Usage data collection

The first time you log in to the Admin, it displays the **Allow admin usage data collection** dialog.
The first time you log in to the _Admin_, it displays the **Allow admin usage data collection** dialog.

![]({% link images/images/admin-menu-dashboard-usage-data.png %}){: .zoom}
_Allow admin usage data collection_

If you select **Allow**, Magento will gather usage data to help improve the user experience of the Admin as well as related products and services. Starting with Magento Commerce 2.4.2, this also enables interactive _In-Product Guidance_, providing Admin users with help and tips on better utilization of the product from within the Admin UI. Content such as new feature announcements, walk-through guides, onboarding information, tool tips, and more will be available through this feature. The usage data cannot be used to individually identify any administrator. You can change this setting at any time from the [Admin]({% link configuration/advanced/admin.md %}#admin-usage) configuration settings.
If you select **Allow**, Adobe Commerce will gather usage data to help improve the user experience of the _Admin_ as well as related products and services. Starting with Adobe Commerce 2.4.2, this also enables interactive _In-Product Guidance_, providing _Admin_ users with help and tips on better utilization of the product from within the _Admin_ UI. Content such as new feature announcements, walk-through guides, onboarding information, tool tips, and more will be available through this feature. The usage data cannot be used to individually identify any administrator. You can change this setting at any time from the [Admin]({% link configuration/advanced/admin.md %}#admin-usage) configuration settings.
6 changes: 3 additions & 3 deletions src/stores/security-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Configuring Admin Security
---

Magento recommends that you take a multifaceted approach to protect the security of your store. You can begin by using a [custom Admin URL]({% link stores/store-urls-custom-admin.md %}) that is not easy to guess, rather than the obvious “Admin” or “Backend.” By default, passwords that are used to [log in]({% link stores/admin-signin.md %}) to the Magento Admin must be seven or more characters long and include both letters and numbers. As a [best practice][1]{:target="_blank"}, use only strong Admin passwords that include a combination of letters, numbers, and symbols. Magento does not allow the reuse of the last four passwords assigned to the account.
We recommend that you take a multifaceted approach to protect the security of your store. You can begin by using a [custom Admin URL]({% link stores/store-urls-custom-admin.md %}) that is not easy to guess, rather than the obvious “Admin” or “Backend.” By default, passwords that are used to [log in]({% link stores/admin-signin.md %}) to the Adobe Commerce Admin must be seven or more characters long and include both letters and numbers. As a [best practice][1]{:target="_blank"}, use only strong Admin passwords that include a combination of letters, numbers, and symbols. Adobe Commerce does not allow the reuse of the last four passwords assigned to the account.

For increased security, consider implementing [two-factor authentication]({% link stores/security-two-factor-authentication.md %}) to verify users' identity with a one-time password that is generated on a separate device.
The Admin security configuration gives you the ability to add a secret key to URLs, require passwords to be case sensitive, and to limit the length of Admin sessions, the lifetime of passwords, and the number of login attempts that can be made before the Admin user account is [locked]({% link system/permissions-locked-users.md %}). For increased security, you can configure the length of keyboard inactivity before the current session expires, and require the user name and password to be case-sensitive.

The Admin security configuration gives you the ability to add a secret key to URLs, require passwords to be case sensitive, and to limit the length of Admin sessions, the lifetime of passwords, and the number of login attempts that can be made before the Admin user account is [locked]({% link system/permissions-locked-users.md %}). For increased security, you can configure the length of keyboard inactivity before the current session expires, and require the user name and password to be case-sensitive. For additional security, the Admin login can be configured to require a [CAPTCHA]({% link stores/security-captcha.md %}).
In addition to the security settings in this section, [Two-factor authentication]({% link stores/security-two-factor-authentication.md %}) (2FA) is required to verify users' identity with a one-time password that is generated by an app or device. You will be prompted to set up 2FA the first time you sign in to the Admin. For additional security, the Admin login can also be configured to require a [CAPTCHA]({% link stores/security-captcha.md %}).

For technical information, see [Security overview][3]{:target="_blank"} in the developer documentation.

Expand Down
12 changes: 6 additions & 6 deletions src/stores/security-two-factor-authentication-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
title: Managing Two-Factor Authentication
---

Users who are unable to sign in to the _Admin_ with two-factor authentication (2FA) can try to sync or troubleshoot the problem. You can also reset the authenticator associated with the account. When reset, the user must sign in again and reconfigure the authenticator.
Users who are unable to sign in to the _Admin_ with two-factor authentication (2FA) can try to sync or troubleshoot the problem. You can also reset the authenticator(s) associated with the account. When reset, the user must sign in again and reconfigure the required authenticator(s).

If you have trouble signing in with 2FA, consider the following:

- Some mobile apps include options to sync. This option reconnects the app and server, and synchronizes the time settings on the device and server.
- Some mobile apps include synchronization options. This option reconnects the app and server, and synchronizes the time settings on the device and server.
- Revoking a device or resetting an authenticator can help users connect.
- Clearing web cache and cookies for the Magento instance can also help. Authenticators, like Google, use generated cookies to save access and duration. Clear your cookies for your specific browser and Magento instance domain.
- Blocking cookies prevents some authenticators, such as Google Authenticator, from completing the verification process. Add a rule to your browser that allows cookies for your Magento instance.
- Clearing web cache and cookies for the Adobe Commerce installation can also help. Authenticators, like Google, use generated cookies to save access and duration. Clear the cookies for your specific browser and Adobe Commerce domain.
- Blocking cookies prevents some authenticators, such as Google Authenticator, from completing the verification process. Add a rule to your browser that allows cookies for your Adobe Commerce installation.

To reset authenticators from the command line and more advanced troubleshooting information, see [Two-Factor Authentication][1] in the Magento developer documentation.
To reset authenticators from the command line and more advanced troubleshooting information, see [Two-Factor Authentication][1] in the Adobe Commerce developer documentation.

## Reset authenticators per user account

Expand All @@ -27,7 +27,7 @@ To reset 2FA providers for other users, you must be an `administrator` or have c

1. In the _Configuration reset_ section, click <span class="btn">Reset [provider]</span>. When prompted, click **OK** to confirm.

If the user wants to restore the 2FA solution to their account, it must be reconfigured from the _Sign On_ page.
If the user wants to restore the required 2FA method(s) to their account, each must be reconfigured from the _Sign On_ page.

1. When complete, click <span class="btn">Save User</span>.

Expand Down
22 changes: 11 additions & 11 deletions src/stores/security-two-factor-authentication-use.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using Two-Factor-Authentication
title: Using Two-Factor Authentication
---

These instructions show how to set up two-factor authentication during your initial sign in and how to authenticate your identity using the following apps and devices:
Expand All @@ -15,7 +15,7 @@ For complete instructions, see [Admin Sign In]({% link stores/admin-signin.md %}

### Step 1: Set up Google Authenticator

1. Enter your account credentials and sign in to the Magento _Admin_.
1. Enter your account credentials and sign in to the Adobe Commerce _Admin_.

A new authenticator screen appears with a QR code.

Expand All @@ -34,7 +34,7 @@ For complete instructions, see [Admin Sign In]({% link stores/admin-signin.md %}

### Step 2: Sign in with Google Authenticator

1. Enter your account credentials and sign in to the Magento _Admin_.
1. Enter your account credentials and sign in to the Commerce _Admin_.

![Google Authenticator - signin]({% link images/images/storefront-2fa-google-code.png %}){: .zoom}
_Google Authenticator_
Expand All @@ -53,7 +53,7 @@ Duo offers a free trial, and charges according to the number of users that are a

### Step 1: Set up Duo Security

1. Enter your account credentials and sign in to the Magento _Admin_.
1. Enter your account credentials and sign in to the Adobe Commerce _Admin_.

1. When the Duo Setup page appears. Click **Start setup** and do the following:

Expand All @@ -77,16 +77,16 @@ Duo offers a free trial, and charges according to the number of users that are a
![Duo authentication - verify app installation]({% link images/images/storefront-2fa-duo-user5.png %}){: .zoom}
_Verify App Installation_

1. Open Duo Mobile and scan the **QR code** to sync the authenticator with Magento. A checkmark appears when the activation is complete.
1. Open Duo Mobile and scan the **QR code** to sync the authenticator with Adobe Commerce. A checkmark appears when the activation is complete.

![Duo authentication - verification code]({% link images/images/storefront-2fa-duo-user6.png %}){: .zoom}
_Duo Verification Code_

1. To configure your settings for the device, choose the action that you want to take place when you sign in.

- `Ask me to choose an authenticator method` — Allows the user to select when logging in and authenticating in the Magento _Admin_.
- `Ask me to choose an authenticator method` — Allows the user to select when logging in and authenticating in the _Admin_.
- `Automatically send this device a Duo Push` — Sends a message to your device to accept or deny for access.
- `Automatically call this device` — Calls and provides a passcode for entering
- `Automatically call this device` — Calls and provides a passcode to enter for access.

![Duo verification actions]({% link images/images/storefront-2fa-duo-user7.png %}){: .zoom}
_Duo verification code_
Expand All @@ -95,7 +95,7 @@ Duo offers a free trial, and charges according to the number of users that are a

The following example shows the options for `Ask me to choose an authenticator method`:

1. When prompted, enter your Magento _Admin_ credentials to sign in.
1. When prompted, enter your Adobe Commerce _Admin_ credentials to sign in.

![Duo - signin]({% link images/images/storefront-2fa-duo-auth.png %}){: .zoom}
_Duo access_
Expand All @@ -114,7 +114,7 @@ Authy offers their app and service at no charge to users. Follow their instructi

### Step 1: Set up Authy

1. Enter your account credentials and sign in to the Magento _Admin_.
1. Enter your account credentials and sign in to the Adobe Commerce _Admin_.

![Authy registration]({% link images/images/storefront-2fa-authy-auth.png %}){: .zoom}
_Authy registration_
Expand Down Expand Up @@ -143,7 +143,7 @@ Authy offers their app and service at no charge to users. Follow their instructi

### Step 2: Sign in with Authy

1. Enter your account credentials and sign in to the Magento _Admin_.
1. Enter your account credentials and sign in to the Adobe Commerce _Admin_.

![Authy - signin]({% link images/images/storefront-2fa-authy-access.png %}){: .zoom}
_Authy access_
Expand All @@ -167,7 +167,7 @@ Authy offers their app and service at no charge to users. Follow their instructi

Follow the instructions from the solution provider to configure your U2F device. For more information, see the vendor documentation, such as [YubiKey][1] by Yubico.

1. Enter Magento _Admin_ account credentials and sign in to your account.
1. Enter Adobe Commerce _Admin_ account credentials and sign in to your account.

![U2F key access]({% link images/images/storefront-2fa-u2f.png %}){: .zoom}
_U2F Key Access_
Expand Down
Loading

0 comments on commit 594df6a

Please sign in to comment.