Merge pull request #38 from magento-commerce/imported-magento-security-package-294

nathanjosiah · web-flow · commit 8d5c176194b5 · 2021-07-21T16:26:25.000-05:00
MC-40870: 290 - Mark interfaces as api, refactoring interfaces
diff --git a/TwoFactorAuth/Api/AdminTokenServiceInterface.php b/TwoFactorAuth/Api/AdminTokenServiceInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Obtain basic information about the user required to setup or use 2fa
+ *
+ * @api
  */
 interface AdminTokenServiceInterface extends OriginalTokenServiceInterface
 {
diff --git a/TwoFactorAuth/Api/AuthyAuthenticateInterface.php b/TwoFactorAuth/Api/AuthyAuthenticateInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Represents the authy provider authentication
+ *
+ * @api
  */
 interface AuthyAuthenticateInterface
 {
diff --git a/TwoFactorAuth/Api/AuthyConfigureInterface.php b/TwoFactorAuth/Api/AuthyConfigureInterface.php
@@ -13,6 +13,8 @@
 
 /**
  * Represents the authy provider
+ *
+ * @api
  */
 interface AuthyConfigureInterface
 {
diff --git a/TwoFactorAuth/Api/CountryRepositoryInterface.php b/TwoFactorAuth/Api/CountryRepositoryInterface.php
@@ -15,6 +15,7 @@
 /**
  * Countries repository
  *
+ * @api
  * @SuppressWarnings(PHPMD.ShortVariable)
  */
 interface CountryRepositoryInterface
diff --git a/TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php b/TwoFactorAuth/Api/Data/AdminTokenResponseInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Represents the response to the new admin token response
+ *
+ * @api
  */
 interface AdminTokenResponseInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/AuthyDeviceInterface.php b/TwoFactorAuth/Api/Data/AuthyDeviceInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Authy device data interface
+ *
+ * @api
  */
 interface AuthyDeviceInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php b/TwoFactorAuth/Api/Data/AuthyRegistrationPromptResponseInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Response for device registration prompt
+ *
+ * @api
  */
 interface AuthyRegistrationPromptResponseInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/CountryInterface.php b/TwoFactorAuth/Api/Data/CountryInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Country entity interface
+ *
+ * @api
  */
 interface CountryInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php b/TwoFactorAuth/Api/Data/CountrySearchResultsInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Represent country search results
+ *
+ * @api
  */
 interface CountrySearchResultsInterface extends SearchResultsInterface
 {
diff --git a/TwoFactorAuth/Api/Data/DuoDataInterface.php b/TwoFactorAuth/Api/Data/DuoDataInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Represents the data needed to use duo
+ *
+ * @api
  */
 interface DuoDataInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/GoogleAuthenticateInterface.php b/TwoFactorAuth/Api/Data/GoogleAuthenticateInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Represents the Google authentication data
+ *
+ * @api
  */
 interface GoogleAuthenticateInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/GoogleConfigureInterface.php b/TwoFactorAuth/Api/Data/GoogleConfigureInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Google configuration data interface
+ *
+ * @api
  */
 interface GoogleConfigureInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/U2fWebAuthnRequestInterface.php b/TwoFactorAuth/Api/Data/U2fWebAuthnRequestInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Represents a WebAuthn dataset
+ *
+ * @api
  */
 interface U2fWebAuthnRequestInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/UserConfigInterface.php b/TwoFactorAuth/Api/Data/UserConfigInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * User configuration interface
+ *
+ * @api
  */
 interface UserConfigInterface extends ExtensibleDataInterface
 {
diff --git a/TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php b/TwoFactorAuth/Api/Data/UserConfigSearchResultsInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * User config search result
+ *
+ * @api
  */
 interface UserConfigSearchResultsInterface extends SearchResultsInterface
 {
diff --git a/TwoFactorAuth/Api/DuoAuthenticateInterface.php b/TwoFactorAuth/Api/DuoAuthenticateInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Represents authentication for the duo security provider
+ *
+ * @api
  */
 interface DuoAuthenticateInterface
 {
diff --git a/TwoFactorAuth/Api/DuoConfigureInterface.php b/TwoFactorAuth/Api/DuoConfigureInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Represents configuration for the duo security provider
+ *
+ * @api
  */
 interface DuoConfigureInterface
 {
diff --git a/TwoFactorAuth/Api/EngineInterface.php b/TwoFactorAuth/Api/EngineInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * 2FA engine interface
+ *
+ * @api
  */
 interface EngineInterface
 {
diff --git a/TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php b/TwoFactorAuth/Api/Exception/NotificationExceptionInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Occurs when failed to notify a user.
+ *
+ * @api
  */
 interface NotificationExceptionInterface extends \Throwable
 {
diff --git a/TwoFactorAuth/Api/GoogleAuthenticateInterface.php b/TwoFactorAuth/Api/GoogleAuthenticateInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Represents google authentication
+ *
+ * @api
  */
 interface GoogleAuthenticateInterface
 {
diff --git a/TwoFactorAuth/Api/GoogleConfigureInterface.php b/TwoFactorAuth/Api/GoogleConfigureInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Represents the google provider
+ *
+ * @api
  */
 interface GoogleConfigureInterface
 {
diff --git a/TwoFactorAuth/Api/ProviderInterface.php b/TwoFactorAuth/Api/ProviderInterface.php
@@ -8,7 +8,9 @@
 namespace Magento\TwoFactorAuth\Api;
 
 /**
- * 2FA proviced interface
+ * 2FA provider interface
+ *
+ * @api
  */
 interface ProviderInterface
 {
diff --git a/TwoFactorAuth/Api/ProviderPoolInterface.php b/TwoFactorAuth/Api/ProviderPoolInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Providers pool
+ *
+ * @api
  */
 interface ProviderPoolInterface
 {
diff --git a/TwoFactorAuth/Api/TfaInterface.php b/TwoFactorAuth/Api/TfaInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * 2FA configuration manager.
+ *
+ * @api
  */
 interface TfaInterface
 {
diff --git a/TwoFactorAuth/Api/TfaSessionInterface.php b/TwoFactorAuth/Api/TfaSessionInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * 2FA session interface
+ *
+ * @api
  */
 interface TfaSessionInterface
 {
diff --git a/TwoFactorAuth/Api/TfatActionsInterface.php b/TwoFactorAuth/Api/TfatActionsInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Actions the user can perform using the pre-2fa token (tfat)
+ *
+ * @api
  */
 interface TfatActionsInterface
 {
diff --git a/TwoFactorAuth/Api/U2fKeyAuthenticateInterface.php b/TwoFactorAuth/Api/U2fKeyAuthenticateInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Represent Authentication for u2f key provider
+ *
+ * @api
  */
 interface U2fKeyAuthenticateInterface
 {
diff --git a/TwoFactorAuth/Api/U2fKeyConfigReaderInterface.php b/TwoFactorAuth/Api/U2fKeyConfigReaderInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Represents configuration for u2f key provider
+ *
+ * @api
  */
 interface U2fKeyConfigReaderInterface
 {
diff --git a/TwoFactorAuth/Api/U2fKeyConfigureInterface.php b/TwoFactorAuth/Api/U2fKeyConfigureInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Represent configuration for u2f key provider
+ *
+ * @api
  */
 interface U2fKeyConfigureInterface
 {
diff --git a/TwoFactorAuth/Api/UserConfigManagerInterface.php b/TwoFactorAuth/Api/UserConfigManagerInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * User configuration manager
+ *
+ * @api
  */
 interface UserConfigManagerInterface
 {
diff --git a/TwoFactorAuth/Api/UserConfigRepositoryInterface.php b/TwoFactorAuth/Api/UserConfigRepositoryInterface.php
@@ -15,6 +15,7 @@
 /**
  * User configuration repository
  *
+ * @api
  * @SuppressWarnings(PHPMD.ShortVariable)
  */
 interface UserConfigRepositoryInterface
diff --git a/TwoFactorAuth/Api/UserConfigRequestManagerInterface.php b/TwoFactorAuth/Api/UserConfigRequestManagerInterface.php
@@ -14,6 +14,8 @@
 
 /**
  * Manages configuration requests for users.
+ *
+ * @api
  */
 interface UserConfigRequestManagerInterface
 {
diff --git a/TwoFactorAuth/Api/UserConfigTokenManagerInterface.php b/TwoFactorAuth/Api/UserConfigTokenManagerInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Manages tokens issued to users to authorize them to configure 2FA.
+ *
+ * @api
  */
 interface UserConfigTokenManagerInterface
 {
diff --git a/TwoFactorAuth/Api/UserNotifierInterface.php b/TwoFactorAuth/Api/UserNotifierInterface.php
@@ -13,6 +13,8 @@
 
 /**
  * Sends notifications to users regarding 2FA.
+ *
+ * @api
  */
 interface UserNotifierInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Obtain basic information about the user required to setup or use 2fa`
	`15`	`+ *`
	`16`	`+ * @api`
`15`	`17`	`*/`
`16`	`18`	`interface AdminTokenServiceInterface extends OriginalTokenServiceInterface`
`17`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Represents the authy provider authentication`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`interface AuthyAuthenticateInterface`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* Represents the authy provider`
	`16`	`+ *`
	`17`	`+ * @api`
`16`	`18`	`*/`
`17`	`19`	`interface AuthyConfigureInterface`
`18`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`/**`
`16`	`16`	`* Countries repository`
`17`	`17`	`*`
	`18`	`+ * @api`
`18`	`19`	`* @SuppressWarnings(PHPMD.ShortVariable)`
`19`	`20`	`*/`
`20`	`21`	`interface CountryRepositoryInterface`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* Authy device data interface`
	`14`	`+ *`
	`15`	`+ * @api`
`14`	`16`	`*/`
`15`	`17`	`interface AuthyDeviceInterface extends ExtensibleDataInterface`
`16`	`18`	`{`