Initial rewrite for changes in the Bootstrapping module #18
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| engines: | ||
| duplication: | ||
| enabled: true | ||
| config: | ||
| languages: | ||
| - php | ||
| fixme: | ||
| enabled: true | ||
| phpmd: | ||
| enabled: true | ||
| ratings: | ||
| paths: | ||
| - "**.php" | ||
| exclude_paths: | ||
| - docs/* | ||
| - tests/* | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| inherit: true | ||
| build: | ||
| nodes: | ||
| analysis: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,50 @@ | ||
| { | ||
| "name": "elliot-sawyer/totp-authenticator", | ||
| "description": "Enable 2FA authentication with TOTP", | ||
| "type": "silverstripe-vendormodule", | ||
| "license": "BSD-3-Clause", | ||
| "keywords": [ | ||
| "silverstripe", | ||
| "2-factor", | ||
| "authentication", | ||
| "module", | ||
| "security", | ||
| "TOTP", | ||
| "Authy", | ||
| "GoogleAuthenticator" | ||
| ], | ||
| "authors": [ | ||
| { | ||
| "name": "Elliot Sawyer" | ||
| } | ||
| ], | ||
| "require": { | ||
| "firesphere/bootstrapmfa": "dev-extension-hook-before-mfa", | ||
| "endroid/qr-code": "3.2.12", | ||
| "spomky-labs/otphp": "^9.1", | ||
| "silverstripe/framework": "^4" | ||
| }, | ||
| "require-dev": { | ||
| "roave/security-advisories": "dev-master", | ||
|
There was a problem hiding this comment. This isn't a standardised dependency so we shouldn't add it yet (see silverstripe/silverstripe-framework#8548) |
||
| "phpunit/phpunit": "^5.7", | ||
| "squizlabs/php_codesniffer": "^3.0" | ||
| }, | ||
| "autoload": { | ||
| "psr-4": { | ||
| "ElliotSawyer\\TOTPAuthenticator\\": "src/", | ||
| "ElliotSawyer\\TOTPAuthenticator\\Tests\\": "tests/" | ||
| } | ||
| }, | ||
| "extra": { | ||
| "installer-name": "totp-authenticator", | ||
| "branch-alias": { | ||
| "dev-master": "1.0.x-dev" | ||
| } | ||
| }, | ||
| "support": { | ||
| "issues": "https://github.com/elliot-sawyer/totp-authenticator/issues", | ||
| "source": "https://github.com/elliot-sawyer/totp-authenticator" | ||
| }, | ||
| "minimum-stability": "dev", | ||
| "prefer-stable": true | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,18 +3,21 @@ | |||||
| namespace ElliotSawyer\TOTPAuthenticator; | ||||||
|
|
||||||
| use Firesphere\BootstrapMFA\Authenticators\BootstrapMFAAuthenticator; | ||||||
| use SilverStripe\Control\HTTPRequest; | ||||||
| use SilverStripe\Core\Config\Configurable; | ||||||
| use Firesphere\BootstrapMFA\Forms\BootstrapMFALoginForm; | ||||||
| use Firesphere\BootstrapMFA\Handlers\BootstrapMFALoginHandler; | ||||||
| use Firesphere\BootstrapMFA\Interfaces\MFAAuthenticator; | ||||||
| use OTPHP\TOTP; | ||||||
| use SilverStripe\Core\Injector\Injector; | ||||||
| use SilverStripe\ORM\ValidationResult; | ||||||
| use SilverStripe\Security\Member; | ||||||
|
|
||||||
| /** | ||||||
| * Class TOTPAuthenticator | ||||||
| * @package ElliotSawyer\TOTPAuthenticator | ||||||
| */ | ||||||
| class TOTPAuthenticator extends BootstrapMFAAuthenticator implements MFAAuthenticator | ||||||
| { | ||||||
| use Configurable; | ||||||
|
|
||||||
|
|
@@ -25,44 +28,54 @@ class TOTPAuthenticator extends BootstrapMFAAuthenticator | |||||
| * a specific TOTP authenticator | ||||||
| */ | ||||||
| private static $algorithm = 'sha1'; | ||||||
|
|
||||||
| /** | ||||||
| * Get configured algorithm for TOTP Authenticator | ||||||
| * | ||||||
| * Must be one of: "sha1", "sha256", "sha512" | ||||||
| * If not specified or invalid, default to "sha1" | ||||||
| * @return string | ||||||
| */ | ||||||
| public static function get_algorithm() | ||||||
robbieaverill marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| { | ||||||
| $algorithm = self::config()->get('algorithm'); | ||||||
|
There was a problem hiding this comment. This should probably be |
||||||
|
|
||||||
| return in_array(strtolower($algorithm), ['sha1', 'sha256', 'sha512']) | ||||||
|
There was a problem hiding this comment. You could make this either a config array OR a class constant (if we don't want it to be configurable) There was a problem hiding this comment. I'd go with constants, but I think it came from a change @elliot-sawyer made somewhere else |
||||||
| ? $algorithm | ||||||
| : 'sha1'; | ||||||
|
There was a problem hiding this comment. If you did go with the above, then this could also be a constant e.g. |
||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @param array $data | ||||||
| * @param HTTPRequest $request | ||||||
| * @param $token | ||||||
|
There was a problem hiding this comment. Minor point: missing the type |
||||||
| * @param ValidationResult $result | ||||||
| * @return bool|null|Member | ||||||
| * @throws \Exception | ||||||
| */ | ||||||
| public function verifyMFA($data, $request, $token, &$result) | ||||||
| { | ||||||
| $memberID = $request->getSession()->get(BootstrapMFAAuthenticator::SESSION_KEY . '.MemberID'); | ||||||
|
|
||||||
| // First, let's see if we know the member | ||||||
| /** @var Member|null $member */ | ||||||
| $member = Member::get()->byID($memberID); | ||||||
|
|
||||||
| // Continue if we have a valid member | ||||||
| if ($member && $member instanceof Member) { | ||||||
| if (!$token) { | ||||||
| $member->registerFailedLogin(); | ||||||
|
|
||||||
| $result->addError(_t(self::class . '.NOTOKEN', 'No token sent')); | ||||||
| } else { | ||||||
| /** @var TOTPProvider $provider */ | ||||||
| $provider = Injector::inst()->get(TOTPProvider::class); | ||||||
|
There was a problem hiding this comment. I wonder if this might be better as a dependency? private static $dependencies = [
'totpProvider' => TOTPProvider::class,
];
protected $totpProvider;
public function setTOTPProvider(TOTPProvider $provider) ;
public function getTOTPProvider(); |
||||||
| $provider->setMember($member); | ||||||
| /** @var TOTP $totp */ | ||||||
|
There was a problem hiding this comment. At this point we know that Overloading it actually points out that the logic below is missing a check for a falsy return, which is a valid part of its API There was a problem hiding this comment. It's not overloading, it's my habit of adding these docs everywhere |
||||||
| $totp = $provider->fetchToken($token); | ||||||
|
|
||||||
|
|
||||||
| if (!$totp->verify($token)) { | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| $result->addError(_t(self::class . '.TOTPFAILED', 'TOTP Failed')); | ||||||
| } | ||||||
| } | ||||||
|
|
@@ -71,43 +84,26 @@ public function validateTOTP($data, $request, &$result) | |||||
| if ($result->isValid()) { | ||||||
| return $member; | ||||||
| } | ||||||
| } else { | ||||||
| $result->addError(_t(self::class . '.NOMEMBER', 'Member not found')); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @param BootstrapMFALoginHandler $controller | ||||||
| * @param string $name | ||||||
| * @return TOTPForm|BootstrapMFALoginForm | ||||||
|
There was a problem hiding this comment. This could possibly benefit from being a bit tighter. I see two possibilities:
|
||||||
| */ | ||||||
| public function getMFAForm($controller, $name) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| { | ||||||
| return TOTPForm::create($controller, $name, $this); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @return string | ||||||
| */ | ||||||
| public function getTokenField() | ||||||
| { | ||||||
| return 'token'; | ||||||
| } | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't use codeclimate as a part of our regular CI toolchain at the moment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough, it's just a copy-paste from other modules. I don't mind removing it