Merge pull request #214 from magento-borg/MC-22950

MC-22950: Enable 2FA by default for Admins

Author: nathanjosiah

TwoFactorAuth/Api/CountryRepositoryInterface.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api;
+
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\TwoFactorAuth\Api\Data\CountryInterface;
+use Magento\TwoFactorAuth\Api\Data\CountrySearchResultsInterface;
+
+/**
+ * Countries repository
+ * @SuppressWarnings(PHPMD.ShortVariable)
+ */
+interface CountryRepositoryInterface
+{
+    /**
+     * Save object
+     * @param CountryInterface $object
+     * @return CountryInterface
+     */
+    public function save(CountryInterface $object): CountryInterface;
+
+    /**
+     * Get object by id
+     * @param int $id
+     * @return CountryInterface
+     */
+    public function getById(int $id): CountryInterface;
+
+    /**
+     * Get by Code value
+     * @param string $value
+     * @return CountryInterface
+     */
+    public function getByCode(string $value): CountryInterface;
+
+    /**
+     * Delete object
+     * @param CountryInterface $object
+     * @return void
+     */
+    public function delete(CountryInterface $object): void;
+
+    /**
+     * Get a list of object
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return CountrySearchResultsInterface
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;
+}

TwoFactorAuth/Api/Data/CountryInterface.php

@@ -0,0 +1,101 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api\Data;
+
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+/**
+ * Country entity interface
+ */
+interface CountryInterface extends ExtensibleDataInterface
+{
+    /**
+     * ID field name
+     */
+    public const ID = 'country_id';
+
+    /**
+     * Code field name
+     */
+    public const CODE = 'code';
+
+    /**
+     * Country name field name
+     */
+    public const NAME = 'name';
+
+    /**
+     * Dial code field name
+     */
+    public const DIAL_CODE = 'dial_code';
+
+    /**
+     * Get value for tfa_country_codes_id
+     * @return int
+     */
+    public function getId(): int;
+
+    /**
+     * Set value for country_id
+     * @param int $value
+     */
+    public function setId(int $value): void;
+
+    /**
+     * Get value for code
+     * @return string
+     */
+    public function getCode(): string;
+
+    /**
+     * Set value for code
+     * @param string $value
+     */
+    public function setCode(string $value): void;
+
+    /**
+     * Get value for name
+     * @return string
+     */
+    public function getName(): string;
+
+    /**
+     * Set value for name
+     * @param string $value
+     */
+    public function setName(string $value): void;
+
+    /**
+     * Get value for dial_code
+     * @return string
+     */
+    public function getDialCode(): string;
+
+    /**
+     * Set value for dial_code
+     * @param string $value
+     */
+    public function setDialCode(string $value): void;
+
+    /**
+     * Retrieve existing extension attributes object or create a new one
+     *
+     * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
+     *
+     * @return \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface|null
+     */
+    public function getExtensionAttributes(): ?CountryExtensionInterface;
+
+    /**
+     * Set an extension attributes object
+     * @param \Magento\TwoFactorAuth\Api\Data\CountryExtensionInterface $extensionAttributes
+     */
+    public function setExtensionAttributes(
+        CountryExtensionInterface $extensionAttributes
+    ): void;
+}

TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api\Data;
+
+use Magento\Framework\Api\SearchResultsInterface;
+
+/**
+ * Country search results interface
+ */
+interface CountrySearchResultsInterface extends SearchResultsInterface
+{
+    /**
+     * Get an array of objects
+     * @return CountryInterface[]
+     */
+    public function getItems(): array;
+
+    /**
+     * Set objects list
+     * @param CountryInterface[] $items
+     * @return CountrySearchResultsInterface
+     */
+    public function setItems(array $items): CountrySearchResultsInterface;
+}

TwoFactorAuth/Api/Data/UserConfigInterface.php

@@ -0,0 +1,99 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api\Data;
+
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+/**
+ * User configuration interface
+ */
+interface UserConfigInterface extends ExtensibleDataInterface
+{
+    /**
+     * Entity ID field name
+     */
+    public const ID = 'config_id';
+
+    /**
+     * User ID field name
+     */
+    public const USER_ID = 'user_id';
+
+    /**
+     * Encoded providers filed name
+     */
+    public const ENCODED_PROVIDERS = 'encoded_providers';
+
+    /**
+     * Selected default provider field name
+     */
+    public const DEFAULT_PROVIDER = 'default_provider';
+
+    /**
+     * Get value for config_id
+     * @return int
+     */
+    public function getId(): int;
+
+    /**
+     * Set value for config_id
+     * @param int $value
+     */
+    public function setId(int $value): void;
+
+    /**
+     * Get value for user_id
+     * @return int
+     */
+    public function getUserId(): int;
+
+    /**
+     * Set value for user_id
+     * @param int $value
+     */
+    public function setUserId(int $value): void;
+
+    /**
+     * Get value for encoded_providers
+     * @return string
+     */
+    public function getEncodedProviders(): string;
+
+    /**
+     * Set value for encoded_providers
+     * @param string $value
+     */
+    public function setEncodedProviders(string $value): void;
+
+    /**
+     * Get value for default_provider
+     * @return string
+     */
+    public function getDefaultProvider(): string;
+
+    /**
+     * Set value for default_provider
+     * @param string $value
+     */
+    public function setDefaultProvider(string $value): void;
+
+    /**
+     * Retrieve existing extension attributes object or create a new one
+     *
+     * Used fully qualified namespaces in annotations for proper work of extension interface/class code generation
+     *
+     * @return \Magento\TwoFactorAuth\Api\Data\UserConfigExtensionInterface|null
+     */
+    public function getExtensionAttributes(): ?UserConfigExtensionInterface;
+
+    /**
+     * Set an extension attributes object
+     * @param \Magento\TwoFactorAuth\Api\Data\UserConfigExtensionInterface $extensionAttributes
+     */
+    public function setExtensionAttributes(UserConfigExtensionInterface $extensionAttributes): void;
+}

TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api\Data;
+
+use Magento\Framework\Api\SearchResultsInterface;
+
+/**
+ * User config search result
+ */
+interface UserConfigSearchResultsInterface extends SearchResultsInterface
+{
+    /**
+     * Get an array of objects
+     * @return UserConfigInterface[]
+     */
+    public function getItems(): array;
+
+    /**
+     * Set objects list
+     * @param UserConfigInterface[] $items
+     * @return UserConfigSearchResultsInterface
+     */
+    public function setItems(array $items): UserConfigSearchResultsInterface;
+}

TwoFactorAuth/Api/EngineInterface.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api;
+
+use Magento\Framework\DataObject;
+use Magento\User\Api\Data\UserInterface;
+
+/**
+ * 2FA engine interface
+ */
+interface EngineInterface
+{
+    /**
+     * Return true if this provider has been enabled by admin
+     *
+     * @return bool
+     */
+    public function isEnabled(): bool;
+
+    /**
+     * Return true on token validation
+     * @param UserInterface $user
+     * @param DataObject $request
+     * @return bool
+     */
+    public function verify(UserInterface $user, DataObject $request): bool;
+}

TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php

@@ -0,0 +1,17 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api\Exception;
+
+/**
+ * Occurs when failed to notify a user.
+ */
+interface NotificationExceptionInterface extends \Throwable
+{
+
+}