Skip to content

Commit

Permalink
DOCS Update naming convention from 'SilverStripe' to 'Silverstripe' a…
Browse files Browse the repository at this point in the history
…s per brand change
  • Loading branch information
sachajudd committed Jun 4, 2020
1 parent ec0bc87 commit 83a1ebd
Show file tree
Hide file tree
Showing 14 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/en/backup-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ verify with their registered multi-factor authentication methods, e.g. they lost

Backup codes are generated by the `BackupCodeGeneratorInterface` service, which has a default implementation of
`SilverStripe\MFA\Service\BackupCodeGenerator`. This service will hash the generated backup codes using the
default SilverStripe `PasswordEncryptor` service and algorithm, and returns an array of
default Silverstripe CMS `PasswordEncryptor` service and algorithm, and returns an array of
`SilverStripe\MFA\State\BackupCode` instances.

You can use this service class to generate codes:
Expand Down
4 changes: 2 additions & 2 deletions docs/en/broadening-the-scope-of-mfa.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The EnforcementManager class is responsible for making decisions regarding the multi factor authentication app flow, e.g. "should we redirect to the MFA section", "can the user skip MFA registration" etc.

By default, the MFA flow will only be presented during the login process to members who have access to some part of the CMS or administration area.
By default, the MFA flow will only be presented during the login process to members who have access to some part of Silverstripe CMS or administration area.

## Applying MFA more widely

Expand All @@ -21,4 +21,4 @@ However, note that users without access to the CMS will be unable to access thei
* removing, resetting, and changing default MFA methods; and
* resetting recovery codes.
A custom implementation would be required to provide this functionality. Otherwise it would be limited to CMS Administrators to [reset MFA settings](https://userhelp.silverstripe.org/en/4/optional_features/multi-factor_authentication/administrator_manual/resetting_accounts/) for a member on their behalf.
A custom implementation would be required to provide this functionality. Otherwise it would be limited to Silverstripe CMS Administrators to [reset MFA settings](https://userhelp.silverstripe.org/en/4/optional_features/multi-factor_authentication/administrator_manual/resetting_accounts/) for a member on their behalf.
2 changes: 1 addition & 1 deletion docs/en/creating-mfa-method-frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ with React / Redux is recommended.

The front-end components of MFA make use of [`react-injector`](https://github.com/silverstripe/react-injector/)
(Injector) to allow sharing of React components and Redux reducers between separate JS bundles. You can find more
documentation on the Injector API in the [SilverStripe docs](https://docs.silverstripe.org/en/4/developer_guides/customising_the_admin_interface/reactjs_redux_and_graphql/#the-injector-api).
documentation on the Injector API in the [Silverstripe docs](https://docs.silverstripe.org/en/4/developer_guides/customising_the_admin_interface/reactjs_redux_and_graphql/#the-injector-api).

You'll find it easiest to get up and running by matching the NPM dependencies and Webpack configuration used in the TOTP
and WebAuthn modules, with a single entry point that handles registering your components with Injector. We also suggest
Expand Down
2 changes: 1 addition & 1 deletion docs/en/datastores.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Since the MFA architecture is largely designed to be decoupled, we use a `StoreInterface` implementation to retain
data between requests. The default implementation for this interface is `SessionStore` which stores data using the
SilverStripe `Session` API provided by silverstripe/framework.
Silverstripe CMS `Session` API provided by silverstripe/framework.

If you need to use a different storage mechanism (e.g. Redis, DynamoDB etc) you can implement and configure your
own `StoreInterface`, and register it with Injector:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/other-authenticators.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Integrating with other authenticators

**This version relates to SilverStripe 4.x configuration.**
**This version relates to Silverstripe CMS 4.x configuration.**

If your project uses a non-standard authentication module, such as silverstripe/ldap, you will
need to implement some customisations to connect the modules together. The following notes should serve as a guide
Expand Down
2 changes: 1 addition & 1 deletion docs/en/userguide/01_User_manual/01_Setting_up_MFA.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ prompted to set it up for your account.
![A screenshot of the introduction step in the MFA setup flow](../_images/01-01-1-mfa-setup-intro.png)

If MFA is optional, you can choose to skip setup, and you won’t be prompted
again. You can manually add MFA from your profile in the CMS at a later time.
again. You can manually add MFA from your profile in Silverstripe CMS at a later time.

If an administrator has configured MFA as _required_, it will prompt you every
time you attempt to log in. You will be unable to access the CMS until you have
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Enter the verification code generated by the app to verify MFA setup.

## Logging in using your app

Login to your SilverStripe CMS account with your email and password. You’ll then
Login to your Silverstripe CMS account with your email and password. You’ll then
be prompted to enter a verification code from your authenticator app on your
phone.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/userguide/01_User_manual/03_Using_security_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ pressing **Retry**.

## Logging in using a security key

Login to your SilverStripe CMS account with your email and password. You’ll then
Login to your Silverstripe CMS account with your email and password. You’ll then
be prompted to activate your security key.

![A screenshot of a user being prompted to activate their security key during login](../_images/01-03-5-security-key-login.png)
Expand Down
2 changes: 1 addition & 1 deletion docs/en/userguide/01_User_manual/04_Regaining_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ summary: Steps to recover your account if your primary MFA method is unavailable
If your phone or security key is lost/damaged, you can use one of the backup
codes that were generated during the MFA setup process to log in.

Login to your SilverStripe CMS account with your email and password. When
Login to your Silverstripe CMS account with your email and password. When
prompted for your primary MFA method, press **Other options** and select
**Verify with backup code**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ summary: Steps for adding, removing and resetting MFA methods

# Managing your MFA settings

You can add, reset, or remove MFA methods in your CMS Profile, which can be
visited by clicking on your name in the top left area of the CMS interface. The
You can add, reset, or remove MFA methods in your Silverstripe CMS Profile, which can be
visited by clicking on your name in the top left area of the CMS. The
MFA settings are protected by "sudo mode", which means you may need to
re-enter your password to access them.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ It is important that you only choose to use this option on a device you know to
**A device shared between multiple people would not be considered secure and you should not use this option.**
</div>

This functionality is provided by default with the SilverStripe CMS however it may be disabled by a Developer in some projects.
This functionality is provided by default with the Silverstripe CMS however it may be disabled by a Developer in some projects.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Here, you can select one of two modes of operation for MFA on your site:
This is the default setting when MFA is installed. Everyone will be prompted to
set up multi-factor authentication upon their first login, but they can skip the
setup process and continue to log in as they did before. They will be able to
set up MFA later via their Profile page in the CMS.
set up MFA later via their Profile page in Silverstripe CMS.

## MFA is required for everyone

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ summary: How to reset a user's account if they lose access to it
# Resetting accounts

As an administrator, you can assist other users that have been locked out of
their accounts by sending them an email to reset their account via the CMS.
their accounts by sending them an email to reset their account via Silverstripe CMS.

![A screenshot of a user's profile from the perspective of an administrator](../_images/02-02-1-account-reset.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/en/userguide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ like your phone or a USB device. Some services can also verify something you
are - for example your fingerprint or face. For more information, see
[the CERT NZ guide](https://www.cert.govt.nz/individuals/guides/getting-started-with-cyber-security/two-factor-authentication/).

Two popular verification methods are supported by SilverStripe MFA:
Two popular verification methods are supported by the MFA feature of Silverstripe CMS:

### Authenticator apps (TOTP)

Expand All @@ -29,7 +29,7 @@ short period of time before a new one is automatically generated.
A security key is a physical device, such as a USB key, that is activated during
MFA verification. This may involve plugging the device into your computer or
bringing the key in range of a compatible device supporting wireless
communications (NFC). To use a security key with SilverStripe MFA, you must log
communications (NFC). To use a security key for MFA within Silverstripe CMS, you must log
in using a supported browser over HTTPS
(see [Using security keys](user_manual/using_security_keys) for details).

Expand Down

0 comments on commit 83a1ebd

Please sign in to comment.