Merge pull request #227 from magento-borg/MC-30537

2fa Automation and WebApi

Author: nathanjosiah

TwoFactorAuth/Api/AdminTokenServiceInterface.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api;
+
+use Magento\Integration\Api\AdminTokenServiceInterface as OriginalTokenServiceInterface;
+
+/**
+ * Obtain basic information about the user required to setup or use 2fa
+ */
+interface AdminTokenServiceInterface extends OriginalTokenServiceInterface
+{
+
+}

TwoFactorAuth/Api/AuthyAuthenticateInterface.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;
+
+/**
+ * Represents the authy provider authentication
+ */
+interface AuthyAuthenticateInterface
+{
+    /**
+     * Get an admin token using authy 2fa
+     *
+     * @param string $username
+     * @param string $password
+     * @param string $otp
+     * @return string $otp
+     */
+    public function createAdminAccessTokenWithCredentials(
+        string $username,
+        string $password,
+        string $otp
+    ): string;
+
+    /**
+     * Send a one time password to a device using authy
+     *
+     * @param string $username
+     * @param string $password
+     * @param string $via
+     * @return void
+     */
+    public function sendToken(
+        string $username,
+        string $password,
+        string $via
+    ): void;
+
+    /**
+     * Authenticate using the present one touch response and get an admin token
+     *
+     * @param string $username
+     * @param string $password
+     * @return string
+     */
+    public function creatAdminAccessTokenWithOneTouch(
+        string $username,
+        string $password
+    ): string;
+}

TwoFactorAuth/Api/AuthyConfigureInterface.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\TwoFactorAuth\Api;
+
+use Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface;
+use Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface as ResponseInterface;
+
+/**
+ * Represents the authy provider
+ */
+interface AuthyConfigureInterface
+{
+    /**
+     * Get the information required to configure google
+     *
+     * @param string $tfaToken
+     * @param AuthyDeviceInterface $deviceData
+     * @return \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
+     */
+    public function sendDeviceRegistrationPrompt(
+        string $tfaToken,
+        AuthyDeviceInterface $deviceData
+    ): ResponseInterface;
+
+    /**
+     * Activate the provider and get an admin token
+     *
+     * @param string $tfaToken
+     * @param string $otp
+     * @return void
+     */
+    public function activate(string $tfaToken, string $otp): void;
+}

TwoFactorAuth/Api/CountryRepositoryInterface.php

@@ -14,40 +14,46 @@
 
 /**
  * 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
      */

TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php

@@ -0,0 +1,96 @@
+<?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;
+
+/**
+ * Represents the response to the new admin token response
+ */
+interface AdminTokenResponseInterface extends ExtensibleDataInterface
+{
+    /**
+     * User id field
+     */
+    const USER_ID = 'user_id';
+
+    /**
+     * Message field
+     */
+    const MESSAGE = 'message';
+
+    /**
+     * Providers field
+     */
+    const ACTIVE_PROVIDERS = 'active_providers';
+
+    /**
+     * Get the id of the authenticated user
+     *
+     * @return string
+     */
+    public function getUserId(): string;
+
+    /**
+     * Set the id of the authenticated user
+     *
+     * @param int $value
+     * @return void
+     */
+    public function setUserId(int $value): void;
+
+    /**
+     * Get the message from the response
+     *
+     * @return string
+     */
+    public function getMessage(): string;
+
+    /**
+     * Set the id of the message
+     *
+     * @param string $value
+     * @return void
+     */
+    public function setMessage(string $value): void;
+
+    /**
+     * Get the providers
+     *
+     * @return \Magento\TwoFactorAuth\Api\ProviderInterface[]
+     */
+    public function getActiveProviders(): array;
+
+    /**
+     * Set the providers
+     *
+     * @param \Magento\TwoFactorAuth\Api\ProviderInterface[] $value
+     * @return void
+     */
+    public function setActiveProviders(array $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\AdminTokenResponseExtensionInterface|null
+     */
+    public function getExtensionAttributes(): ?AdminTokenResponseExtensionInterface;
+
+    /**
+     * Set an extension attributes object
+     *
+     * @param \Magento\TwoFactorAuth\Api\Data\AdminTokenResponseExtensionInterface $extensionAttributes
+     * @return void
+     */
+    public function setExtensionAttributes(
+        AdminTokenResponseExtensionInterface $extensionAttributes
+    ): void;
+}

TwoFactorAuth/Api/Data/AuthyDeviceInterface.php

@@ -0,0 +1,105 @@
+<?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;
+
+/**
+ * Authy device data interface
+ */
+interface AuthyDeviceInterface extends ExtensibleDataInterface
+{
+    /**
+     * Country field
+     */
+    public const COUNTRY = 'country';
+
+    /**
+     * Phone number field
+     */
+    public const PHONE = 'phone_number';
+
+    /**
+     * Method of authentication field
+     */
+    public const METHOD = 'method';
+
+    /**
+     * Authenticate via sms
+     */
+    public const METHOD_SMS = 'sms';
+
+    /**
+     * Authenticate via phone call
+     */
+    public const METHOD_CALL = 'call';
+
+    /**
+     * Get the country
+     *
+     * @return string
+     */
+    public function getCountry(): string;
+
+    /**
+     * Set the country
+     *
+     * @param string $value
+     * @return void
+     */
+    public function setCountry(string $value): void;
+
+    /**
+     * Get the phone number
+     *
+     * @return string
+     */
+    public function getPhoneNumber(): string;
+
+    /**
+     * Set the phone number
+     *
+     * @param string $value
+     * @return void
+     */
+    public function setPhoneNumber(string $value): void;
+
+    /**
+     * Get the method to authenticate with
+     *
+     * @return string
+     */
+    public function getMethod(): string;
+
+    /**
+     * Set the method to authenticate with
+     *
+     * @param string $value
+     * @return void
+     */
+    public function setMethod(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\AuthyDeviceExtensionInterface|null
+     */
+    public function getExtensionAttributes(): ?AuthyDeviceExtensionInterface;
+
+    /**
+     * Set an extension attributes object
+     *
+     * @param \Magento\TwoFactorAuth\Api\Data\AuthyDeviceExtensionInterface $extensionAttributes
+     * @return void
+     */
+    public function setExtensionAttributes(
+        AuthyDeviceExtensionInterface $extensionAttributes
+    ): void;
+}