Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The module blocks access to REST API endpoints that require authentication. Only the IP addresses defined in the allowed list will have access granted.

The module supports IPv4 and IPv6.

Installation

Info

This module is optional.

Code Block
composer require "creativestyle/magesuite-rest-rictor" ^1.0.0

Admin settings

The module is activated by default and will block all requests not defined in the allow list (even when the list of allowed IPs is empty).

Configuration can be found in two places:

Stores -> Configuration -> Services -> Magento Web API -> Web API Security

SCR-20240807-duh.pngImage Modified

...

System -> Extensions -> Integrations -> {Select Integration} -> {Change Tab} IP Restriction

image-20240814-090859.pngImage Added

PHP function fnmatch is used for IP matching so * is allowed to define groups of addresses

Backend

The module implements a plugin for the \Magento\Webapi\Controller\Rest\RequestValidator class.

Frontend

There are no frontend functionalities in the module.