├── .gitignore
├── registration.php
├── etc
    ├── adminhtml
    │   ├── routes.xml
    │   ├── di.xml
    │   ├── menu.xml
    │   └── system.xml
    ├── crontab.xml
    ├── module.xml
    ├── email_templates.xml
    ├── config.xml
    └── acl.xml
├── view
    └── adminhtml
    │   ├── layout
    │       ├── sansec_composer_integrity_checker_index_index.xml
    │       └── sansec_composer_integrity_checker_failure_items_email.xml
    │   ├── email
    │       └── sansec-composer-integrity-check-failure.html
    │   ├── hyva-grid
    │       └── sansec-composer-integrity-results-grid.xml
    │   └── templates
    │       └── email
    │           └── failure-list.phtml
├── Block
    └── Adminhtml
    │   └── Form
    │       └── Field
    │           ├── IgnoredPackages.php
    │           └── ComposerIntegrityNotificationEmailRecipients.php
├── composer.json
├── Controller
    └── Adminhtml
    │   ├── Index
    │       └── Index.php
    │   └── Scan
    │       └── Run.php
├── Service
    ├── Scanner.php
    └── EmailNotifier.php
├── Model
    ├── System
    │   └── Message
    │   │   └── PackageBelowThreshold.php
    └── IntegrityResultsRegistry.php
├── Cron
    └── Scan.php
├── Scope
    └── Config.php
├── README.md
└── LICENSE.txt


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | node_modules/
3 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | use Magento\Framework\Component\ComponentRegistrar;
 9 | 
10 | ComponentRegistrar::register(
11 |     ComponentRegistrar::MODULE,
12 |     'Element119_SansecComposerIntegrityChecker',
13 |     __DIR__
14 | );
15 | 


--------------------------------------------------------------------------------
/etc/adminhtml/routes.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
10 |     <router id="admin">
11 |         <route id="sansec_composer_integrity_checker" frontName="sansec_composer_integrity_checker">
12 |             <module name="Element119_SansecComposerIntegrityChecker"/>
13 |         </route>
14 |     </router>
15 | </config>
16 | 


--------------------------------------------------------------------------------
/etc/crontab.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
10 |     <group id="default">
11 |         <job name="sansec_composer_integrity_checker"
12 |              instance="Element119\SansecComposerIntegrityChecker\Cron\Scan"
13 |              method="execute">
14 |             <schedule>0 * * * *</schedule>
15 |         </job>
16 |     </group>
17 | </config>
18 | 


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
10 |     <module name="Element119_SansecComposerIntegrityChecker">
11 |         <sequence>
12 |             <module name="Hyva_Admin"/>
13 |             <module name="Magento_Backend"/>
14 |             <module name="Magento_Config"/>
15 |             <module name="Magento_Store"/>
16 |         </sequence>
17 |     </module>
18 | </config>
19 | 


--------------------------------------------------------------------------------
/view/adminhtml/layout/sansec_composer_integrity_checker_index_index.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |       xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
10 |     <update handle="hyva_admin_grid"/>
11 |     <body>
12 |         <referenceContainer name="content">
13 |             <block class="Hyva\Admin\Block\Adminhtml\HyvaGrid" name="sansec-composer-integrity-results-grid"/>
14 |         </referenceContainer>
15 |     </body>
16 | </page>
17 | 


--------------------------------------------------------------------------------
/etc/email_templates.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Email:etc/email_templates.xsd">
10 |     <template id="sansec_composer_integrity_checker_failure"
11 |               label="Sansec Composer Integrity Check Failure"
12 |               file="sansec-composer-integrity-check-failure.html"
13 |               type="html"
14 |               module="Element119_SansecComposerIntegrityChecker"
15 |               area="adminhtml"/>
16 | </config>
17 | 


--------------------------------------------------------------------------------
/etc/adminhtml/di.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
10 |     <type name="Magento\Framework\Notification\MessageList">
11 |         <arguments>
12 |             <argument name="messages" xsi:type="array">
13 |                 <item name="sansec_composer_integrity_checker_failed_scan" xsi:type="string">
14 |                     Element119\SansecComposerIntegrityChecker\Model\System\Message\PackageBelowThreshold
15 |                 </item>
16 |             </argument>
17 |         </arguments>
18 |     </type>
19 | </config>
20 | 


--------------------------------------------------------------------------------
/view/adminhtml/layout/sansec_composer_integrity_checker_failure_items_email.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |       xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd"
10 |       label="Sansec Composer Integrity Check Failure List">
11 |     <update handle="empty"/>
12 |     <body>
13 |         <referenceContainer name="main">
14 |             <block name="sansec-composer-integrity-check.failure-list"
15 |                    template="Element119_SansecComposerIntegrityChecker::email/failure-list.phtml"
16 |                    cacheable="false"/>
17 |         </referenceContainer>
18 |     </body>
19 | </page>
20 | 


--------------------------------------------------------------------------------
/view/adminhtml/email/sansec-composer-integrity-check-failure.html:
--------------------------------------------------------------------------------
 1 | <!--
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | -->
 7 | <!--@subject {{trans "Sansec Composer Integrity Checker Report Failure: %failure_count Issue(s) Found" failure_count=$failure_count}} @-->
 8 | <!--@vars {
 9 | "var failure_count":"Failure Count",
10 | "var package_data":"Package Data",
11 | } @-->
12 | <table>
13 |     <tr class="email-intro">
14 |         <td>
15 |             <p class="greeting">
16 |                 {{trans "%failure_count packages failed to meet your threshold for the Sansec Composer integrity check:" failure_count=$failure_count}}
17 |             </p>
18 |         </td>
19 |     </tr>
20 |     <tr class="email-information">
21 |         {{layout handle="sansec_composer_integrity_checker_failure_items_email" package_data=$package_data area="adminhtml"}}
22 |     </tr>
23 | </table>
24 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/Form/Field/IgnoredPackages.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Block\Adminhtml\Form\Field;
 9 | 
10 | use Magento\Config\Block\System\Config\Form\Field\FieldArray\AbstractFieldArray;
11 | 
12 | class IgnoredPackages extends AbstractFieldArray
13 | {
14 |     public const PACKAGE = 'package';
15 | 
16 |     /**
17 |      * @inheritDoc
18 |      */
19 |     protected function _prepareToRender(): void
20 |     {
21 |         // package name column index
22 |         $this->addColumn(
23 |             self::PACKAGE,
24 |             [
25 |                 'label' => __('Package'),
26 |                 'class' => 'required-entry',
27 |             ]
28 |         );
29 | 
30 |         $this->_addAfter = false;
31 |         $this->_addButtonLabel = __('Add Package');
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "element119/module-sansec-composer-integrity-checker",
 3 |     "type": "magento2-module",
 4 |     "description": "A Magento 2 module wrapper for the Sansec Composer Integrity plugin.",
 5 |     "license": "proprietary",
 6 |     "authors": [
 7 |         {
 8 |             "name": "element119",
 9 |             "email": "hello@element119.co.uk"
10 |         },
11 |         {
12 |             "name": "Kiel Pykett",
13 |             "email": "pykettk@gmail.com"
14 |         }
15 |     ],
16 |     "require": {
17 |         "hyva-themes/module-magento2-admin": "^1.1",
18 |         "sansec/composer-integrity-plugin": "^0.2.0"
19 |     },
20 |     "suggest": {
21 |         "ethanyehuda/magento2-cronjobmanager": "A module for managing scheduled cron jobs from magento's admin panel"  
22 |     },
23 |     "autoload": {
24 |         "psr-4": {
25 |             "Element119\\SansecComposerIntegrityChecker\\": ""
26 |         },
27 |         "files": [
28 |             "registration.php"
29 |         ]
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/Form/Field/ComposerIntegrityNotificationEmailRecipients.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Block\Adminhtml\Form\Field;
 9 | 
10 | use Magento\Config\Block\System\Config\Form\Field\FieldArray\AbstractFieldArray;
11 | 
12 | class ComposerIntegrityNotificationEmailRecipients extends AbstractFieldArray
13 | {
14 |     public const CSV_REPORT_EMAIL_ADDRESS = 'email_address';
15 | 
16 |     /**
17 |      * @inheritDoc
18 |      */
19 |     protected function _prepareToRender(): void
20 |     {
21 |         // CSV column index
22 |         $this->addColumn(
23 |             self::CSV_REPORT_EMAIL_ADDRESS,
24 |             [
25 |                 'label' => __('Email Address'),
26 |                 'class' => 'required-entry',
27 |             ]
28 |         );
29 | 
30 |         $this->_addAfter = false;
31 |         $this->_addButtonLabel = __('Add Email Address');
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
10 |     <default>
11 |         <system>
12 |             <sansec_composer_integrity_checker>
13 |                 <scan_enable>1</scan_enable>
14 |                 <grid_failures_only>0</grid_failures_only>
15 |                 <scan_email_notification_enable>0</scan_email_notification_enable>
16 |                 <package_ignore_list_enable>0</package_ignore_list_enable>
17 |                 <remove_ignored_packages_from_admin_grid>0</remove_ignored_packages_from_admin_grid>
18 |                 <remove_ignored_packages_from_admin_notif>0</remove_ignored_packages_from_admin_notif>
19 |                 <remove_ignored_packages_from_emails>0</remove_ignored_packages_from_emails>
20 |             </sansec_composer_integrity_checker>
21 |         </system>
22 |     </default>
23 | </config>
24 | 


--------------------------------------------------------------------------------
/Controller/Adminhtml/Index/Index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Controller\Adminhtml\Index;
 9 | 
10 | use Magento\Backend\App\Action;
11 | use Magento\Backend\App\Action\Context;
12 | use Magento\Framework\View\Result\Page;
13 | use Magento\Framework\View\Result\PageFactory;
14 | 
15 | class Index extends Action
16 | {
17 |     public const ADMIN_RESOURCE = 'Element119_SansecComposerIntegrityChecker::status';
18 | 
19 |     public function __construct(
20 |         Context $context,
21 |         private readonly PageFactory $resultPageFactory
22 |     ) {
23 |         parent::__construct($context);
24 |     }
25 | 
26 |     public function execute(): Page
27 |     {
28 |         $resultPage = $this->resultPageFactory->create();
29 |         $resultPage->setActiveMenu(self::ADMIN_RESOURCE);
30 |         $resultPage->getConfig()->getTitle()->prepend(__('Sansec Composer Integrity Checker'));
31 | 
32 |         return $resultPage;
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/etc/acl.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
10 |     <acl>
11 |         <resources>
12 |             <resource id="Magento_Backend::admin">
13 |                 <resource id="Magento_Backend::system">
14 |                     <resource id="Magento_Backend::tools">
15 |                         <resource id="Element119_SansecComposerIntegrityChecker::view"
16 |                                   title="Sansec Composer Integrity Checker"
17 |                                   translate="title"
18 |                                   sortOrder="10"/>
19 |                         <resource id="Element119_SansecComposerIntegrityChecker::run"
20 |                                   title="Run Sansec Composer Integrity Checker"
21 |                                   translate="title"
22 |                                   sortOrder="11"/>
23 |                     </resource>
24 |                 </resource>
25 |             </resource>
26 |         </resources>
27 |     </acl>
28 | </config>
29 | 


--------------------------------------------------------------------------------
/etc/adminhtml/menu.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Backend:etc/menu.xsd">
10 |     <menu>
11 |         <add id="Element119_SansecComposerIntegrityChecker::view"
12 |              title="Sansec Composer Integrity Checker"
13 |              translate="title"
14 |              module="Element119_SansecComposerIntegrityChecker"
15 |              sortOrder="1000"
16 |              parent="Magento_Reports::report"
17 |              resource="Element119_SansecComposerIntegrityChecker::view"/>
18 |         <add id="Element119_SansecComposerIntegrityChecker::status"
19 |              title="Integrity Status"
20 |              translate="title"
21 |              module="Element119_SansecComposerIntegrityChecker"
22 |              sortOrder="10"
23 |              parent="Element119_SansecComposerIntegrityChecker::view"
24 |              action="sansec_composer_integrity_checker/index"
25 |              resource="Element119_SansecComposerIntegrityChecker::view"/>
26 |     </menu>
27 | </config>
28 | 


--------------------------------------------------------------------------------
/Service/Scanner.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Service;
 9 | 
10 | use Magento\Framework\App\Filesystem\DirectoryList;
11 | use Magento\Framework\Exception\FileSystemException;
12 | use Sansec\Integrity\PackageResolver\LockReaderStrategyFactory;
13 | use Sansec\Integrity\PackageSubmitterFactory;
14 | use Symfony\Component\Console\Output\NullOutputFactory;
15 | 
16 | class Scanner
17 | {
18 |     public function __construct(
19 |         private readonly DirectoryList $directoryList,
20 |         private readonly LockReaderStrategyFactory $lockReaderFactory,
21 |         private readonly NullOutputFactory $nullOutputFactory,
22 |         private readonly PackageSubmitterFactory $scannerFactory,
23 |     ) {}
24 | 
25 |     /**
26 |      * @return array
27 |      * @throws FileSystemException
28 |      */
29 |     public function scan(): array
30 |     {
31 |         $lockReader = $this->lockReaderFactory->create([
32 |             'rootDirectory' => $this->directoryList->getPath(DirectoryList::ROOT),
33 |         ]);
34 |         $scanner = $this->scannerFactory->create([
35 |             'packageResolverStrategy' => $lockReader,
36 |         ]);
37 |         $output = $this->nullOutputFactory->create();
38 | 
39 |         return $scanner->getPackageVerdicts($output);
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/Controller/Adminhtml/Scan/Run.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Controller\Adminhtml\Scan;
 9 | 
10 | use Element119\SansecComposerIntegrityChecker\Model\IntegrityResultsRegistry;
11 | use Element119\SansecComposerIntegrityChecker\Service\Scanner;
12 | use Exception;
13 | use Magento\Backend\App\Action;
14 | use Magento\Backend\App\Action\Context;
15 | use Magento\Framework\Controller\ResultInterface;
16 | use Magento\Framework\Exception\FileSystemException;
17 | 
18 | class Run extends Action
19 | {
20 |     public const ADMIN_RESOURCE = 'Element119_SansecComposerIntegrityChecker::run';
21 | 
22 |     public function __construct(
23 |         Context $context,
24 |         private readonly IntegrityResultsRegistry $integrityResultsRegistry,
25 |         private readonly Scanner $scanner
26 |     ) {
27 |         parent::__construct($context);
28 |     }
29 | 
30 |     /**
31 |      * @throws FileSystemException
32 |      * @throws Exception
33 |      */
34 |     public function execute(): ResultInterface
35 |     {
36 |         $results = $this->scanner->scan();
37 | 
38 |         if ($results) {
39 |             $this->integrityResultsRegistry->setResults($results);
40 |             $this->messageManager->addSuccessMessage(__('Scan complete.'));
41 |         } else {
42 |             $this->messageManager->addErrorMessage(__('Could not scan packages.'));
43 |         }
44 | 
45 |         $resultRedirect = $this->resultRedirectFactory->create();
46 |         $resultRedirect->setPath('sansec_composer_integrity_checker/index/index');
47 | 
48 |         return $resultRedirect;
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/view/adminhtml/hyva-grid/sansec-composer-integrity-results-grid.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © element119. All rights reserved.
 5 |  * See LICENCE.txt for licence details.
 6 |  */
 7 |  -->
 8 | <grid xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |       xsi:noNamespaceSchemaLocation="urn:magento:module:Hyva_Admin:etc/hyva-grid.xsd">
10 |     <source>
11 |         <arrayProvider>Element119\SansecComposerIntegrityChecker\Model\IntegrityResultsRegistry</arrayProvider>
12 |     </source>
13 |     <columns>
14 |         <include>
15 |             <column name="name"/>
16 |             <column name="version"/>
17 |             <column name="verdict"/>
18 |             <column name="percentage"/>
19 |             <column name="checksum"/>
20 |             <column name="id"/>
21 |         </include>
22 |     </columns>
23 |     <navigation>
24 |         <buttons>
25 |             <button id="run_scan" label="Run Scan" url="sansec_composer_integrity_checker/scan/run"/>
26 |         </buttons>
27 |         <exports>
28 |             <export type="csv" label="Export as CSV"/>
29 |             <export type="xml" label="Export as XML"/>
30 |             <export type="xlsx" label="Export as XLSX"/>
31 |         </exports>
32 |         <filters>
33 |             <filter column="name"/>
34 |             <filter column="version"/>
35 |             <filter column="verdict"/>
36 |             <filter column="percentage"/>
37 |             <filter column="checksum"/>
38 |             <filter column="id"/>
39 |         </filters>
40 |         <pager>
41 |             <defaultPageSize>20</defaultPageSize>
42 |             <pageSizes>20,30,50,100,200</pageSizes>
43 |         </pager>
44 |         <sorting>
45 |             <defaultSortByColumn>name</defaultSortByColumn>
46 |             <defaultSortDirection>asc</defaultSortDirection>
47 |         </sorting>
48 |     </navigation>
49 | </grid>
50 | 


--------------------------------------------------------------------------------
/view/adminhtml/templates/email/failure-list.phtml:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | use Magento\Framework\Escaper;
 9 | use Magento\Framework\View\Element\Template;
10 | 
11 | /** @var Escaper $escaper */
12 | /** @var Template $block */
13 | ?>
14 | <?php if ($packageData = $block->getData('package_data')): ?>
15 |     <table>
16 |         <thead>
17 |             <tr>
18 |                 <th><strong><?= $escaper->escapeHtml(__('Package')); ?></strong></th>
19 |                 <th><strong><?= $escaper->escapeHtml(__('Version')); ?></strong></th>
20 |                 <th><strong><?= $escaper->escapeHtml(__('Verdict')); ?></strong></th>
21 |                 <th><strong><?= $escaper->escapeHtml(__('Percentage')); ?></strong></th>
22 |                 <th><strong><?= $escaper->escapeHtml(__('Checksum')); ?></strong></th>
23 |                 <th><strong><?= $escaper->escapeHtml(__('Package ID')); ?></strong></th>
24 |             </tr>
25 |         </thead>
26 |         <tbody>
27 |             <?php foreach ($packageData as $data): ?>
28 |                 <tr>
29 |                     <td style="padding: 10px;"><?= $escaper->escapeHtml($data['name']); ?></td>
30 |                     <td style="padding: 10px;"><?= $escaper->escapeHtml($data['version']); ?></td>
31 |                     <td style="padding: 10px;"><?= $escaper->escapeHtml($data['verdict']); ?></td>
32 |                     <td style="padding: 10px;"><?= $escaper->escapeHtml($data['percentage']); ?></td>
33 |                     <td style="padding: 10px;"><?= $escaper->escapeHtml($data['checksum']); ?></td>
34 |                     <td style="padding: 10px;"><?= $escaper->escapeHtml($data['id']); ?></td>
35 |                 </tr>
36 |             <?php endforeach; ?>
37 |         </tbody>
38 |     </table>
39 | <?php endif; ?>
40 | 


--------------------------------------------------------------------------------
/Service/EmailNotifier.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Service;
 9 | 
10 | use Element119\SansecComposerIntegrityChecker\Scope\Config;
11 | use Magento\Framework\App\Area;
12 | use Magento\Framework\Exception\LocalizedException;
13 | use Magento\Framework\Exception\MailException;
14 | use Magento\Framework\Mail\Template\TransportBuilder;
15 | use Magento\Store\Model\StoreManagerInterface;
16 | 
17 | class EmailNotifier
18 | {
19 |     public const INTEGRITY_FAILURE_EMAIL_TEMPLATE_ID = 'sansec_composer_integrity_checker_failure';
20 | 
21 |     public function __construct(
22 |         private readonly Config $moduleConfig,
23 |         private readonly TransportBuilder $transportBuilder,
24 |         private readonly StoreManagerInterface $storeManager
25 |     ) {}
26 | 
27 |     /**
28 |      * @param array $data
29 |      * @return void
30 |      * @throws LocalizedException
31 |      * @throws MailException
32 |      */
33 |     public function sendErrorNotification(array $data): void
34 |     {
35 |         if (!$data || !($recipients = $this->moduleConfig->getSansecComposerIntegrityEmailRecipients())) {
36 |             return;
37 |         }
38 | 
39 |         $email = $this->transportBuilder->setTemplateIdentifier(self::INTEGRITY_FAILURE_EMAIL_TEMPLATE_ID)
40 |             ->setTemplateOptions(
41 |                 [
42 |                     'area' => Area::AREA_ADMINHTML,
43 |                     'store' => $this->storeManager->getStore()->getId(),
44 |                 ]
45 |             )->setTemplateVars(
46 |                 [
47 |                     'failure_count' => count($data),
48 |                     'package_data' => $data,
49 |                 ]
50 |             )->addTo($recipients)
51 |             ->setFromByScope('general')
52 |             ->getTransport();
53 | 
54 |         $email->sendMessage();
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/Model/System/Message/PackageBelowThreshold.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Model\System\Message;
 9 | 
10 | use Element119\SansecComposerIntegrityChecker\Model\IntegrityResultsRegistry;
11 | use Element119\SansecComposerIntegrityChecker\Scope\Config as ModuleConfig;
12 | use Magento\Framework\Notification\MessageInterface;
13 | use Magento\Framework\Phrase;
14 | use Magento\Framework\UrlInterface;
15 | 
16 | class PackageBelowThreshold implements MessageInterface
17 | {
18 |     public function __construct(
19 |         private readonly ModuleConfig $moduleConfig,
20 |         private readonly IntegrityResultsRegistry $integrityResultsRegistry,
21 |         private readonly UrlInterface $urlBuilder
22 |     ) {}
23 | 
24 |     public function getText(): Phrase
25 |     {
26 |         return __(
27 |             'Sansec Composer Integrity checker found %1 package(s) that did not meet the match threshold. <a href="%2">View scan results.</a>',
28 |             count($this->getFailedMatches()),
29 |             $this->urlBuilder->getUrl('sansec_composer_integrity_checker/index/index')
30 |         );
31 |     }
32 | 
33 |     public function isDisplayed(): bool
34 |     {
35 |         return (bool)$this->getFailedMatches();
36 |     }
37 | 
38 |     public function getSeverity(): int
39 |     {
40 |         return MessageInterface::SEVERITY_MAJOR;
41 |     }
42 | 
43 |     public function getIdentity(): string
44 |     {
45 |         return 'sansec_composer_integrity_checker_failed_scan';
46 |     }
47 | 
48 |     public function getFailedMatches(): array
49 |     {
50 |         $failedMatches = $this->integrityResultsRegistry->getFailedMatches();
51 | 
52 |         return $this->moduleConfig->isIgnoreListEnabled() && $this->moduleConfig->shouldRemoveIgnoredPackagesFromAdminNotification()
53 |             ? $this->integrityResultsRegistry->removeIgnoredPackages($failedMatches)
54 |             : $failedMatches;
55 |     }
56 | }
57 | 


--------------------------------------------------------------------------------
/Cron/Scan.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © element119. All rights reserved.
 4 |  * See LICENCE.txt for licence details.
 5 |  */
 6 | declare(strict_types=1);
 7 | 
 8 | namespace Element119\SansecComposerIntegrityChecker\Cron;
 9 | 
10 | use Element119\SansecComposerIntegrityChecker\Model\IntegrityResultsRegistry;
11 | use Element119\SansecComposerIntegrityChecker\Scope\Config;
12 | use Element119\SansecComposerIntegrityChecker\Service\EmailNotifier;
13 | use Element119\SansecComposerIntegrityChecker\Service\Scanner;
14 | use Exception;
15 | use Magento\Framework\Exception\FileSystemException;
16 | use Magento\Framework\Exception\LocalizedException;
17 | use Magento\Framework\Exception\MailException;
18 | 
19 | class Scan
20 | {
21 |     public function __construct(
22 |         private readonly IntegrityResultsRegistry $integrityResultsRegistry,
23 |         private readonly Config $moduleConfig,
24 |         private readonly EmailNotifier $emailNotifier,
25 |         private readonly Scanner $scanner,
26 |     ) {}
27 | 
28 |     /**
29 |      * Run the Sansec Composer Integrity Checker and store the results.
30 |      *
31 |      * @return void
32 |      * @throws FileSystemException
33 |      * @throws LocalizedException
34 |      * @throws MailException
35 |      * @throws Exception
36 |      */
37 |     public function execute(): void
38 |     {
39 |         if (!$this->moduleConfig->isSansecComposerIntegrityScanEnabled()) {
40 |             return;
41 |         }
42 | 
43 |         if ($results = $this->scanner->scan()) {
44 |             $this->integrityResultsRegistry->setResults($results);
45 | 
46 |             if ($this->moduleConfig->isSansecComposerIntegrityEmailNotificationEnabled()
47 |                 && $failedMatches = $this->integrityResultsRegistry->getFailedMatches($results)
48 |             ) {
49 |                 if ($this->moduleConfig->isIgnoreListEnabled()
50 |                     && $this->moduleConfig->shouldRemoveIgnoredPackagesFromEmail()
51 |                 ) {
52 |                     $failedMatches = $this->integrityResultsRegistry->removeIgnoredPackages($failedMatches);
53 |                 }
54 | 
55 |                 if ($failedMatches) {
56 |                     $this->emailNotifier->sendErrorNotification($failedMatches);
57 |                 }
58 |             }
59 |         }
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/Model/IntegrityResultsRegistry.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | namespace Element119\SansecComposerIntegrityChecker\Model;
  9 | 
 10 | use Element119\SansecComposerIntegrityChecker\Scope\Config;
 11 | use Exception;
 12 | use Hyva\Admin\Api\HyvaGridArrayProviderInterface;
 13 | use Magento\Framework\Data\Collection\AbstractDb;
 14 | use Magento\Framework\Exception\LocalizedException;
 15 | use Magento\Framework\Flag;
 16 | use Magento\Framework\Model\Context;
 17 | use Magento\Framework\Model\ResourceModel\AbstractResource;
 18 | use Magento\Framework\Registry;
 19 | use Magento\Framework\Serialize\Serializer\Json;
 20 | use Magento\Framework\Serialize\Serializer\Serialize;
 21 | 
 22 | class IntegrityResultsRegistry extends Flag implements HyvaGridArrayProviderInterface
 23 | {
 24 |     protected $_flagCode = 'sansec_composer_integrity_checker_results';
 25 | 
 26 |     public function __construct(
 27 |         Context $context,
 28 |         Registry $registry,
 29 |         private readonly Config $moduleConfig,
 30 |         AbstractResource $resource = null,
 31 |         AbstractDb $resourceCollection = null,
 32 |         array $data = [],
 33 |         Json $json = null,
 34 |         Serialize $serialize = null
 35 |     ) {
 36 |         parent::__construct($context, $registry, $resource, $resourceCollection, $data, $json, $serialize);
 37 |     }
 38 | 
 39 |     public function getHyvaGridData(): array
 40 |     {
 41 |         $packageData = $this->moduleConfig->shouldOnlyShowFailuresInGrid()
 42 |             ? $this->getFailedMatches()
 43 |             : $this->getLastResults();
 44 | 
 45 |         return $this->moduleConfig->isIgnoreListEnabled() && $this->moduleConfig->shouldRemoveIgnoredPackagesFromAdminGrid()
 46 |             ? $this->removeIgnoredPackages($packageData)
 47 |             : $packageData;
 48 |     }
 49 | 
 50 |     public function getLastResults(): ?array
 51 |     {
 52 |         try {
 53 |             return $this->loadSelf()->getFlagData();
 54 |         } catch (LocalizedException $e) {
 55 |             return [];
 56 |         }
 57 |     }
 58 | 
 59 |     /**
 60 |      * @throws Exception
 61 |      */
 62 |     public function setResults(array $data): self
 63 |     {
 64 |         $packages = [];
 65 | 
 66 |         foreach ($data as $package) {
 67 |             $packages[$package->name] = $package;
 68 |         }
 69 | 
 70 |         $this->loadSelf()->setFlagData($packages);
 71 | 
 72 |         return $this->save();
 73 |     }
 74 | 
 75 |     public function getFailedMatches(array $packages = []): array
 76 |     {
 77 |         $failures = [];
 78 |         $threshold = $this->moduleConfig->getSansecComposerIntegrityMatchThreshold();
 79 | 
 80 |         foreach ($packages ?: $this->getLastResults() ?? [] as $package) {
 81 |             $package = (array)$package;
 82 | 
 83 |             if ((int)$package['percentage'] < $threshold) {
 84 |                 $failures[$package['name']] = $package;
 85 |             }
 86 |         }
 87 | 
 88 |         return $failures;
 89 |     }
 90 | 
 91 |     public function removeIgnoredPackages(array &$packages): array
 92 |     {
 93 |         if (!$packages || !($ignoredPackages = $this->moduleConfig->getIgnoredPackageList())) {
 94 |             return $packages;
 95 |         }
 96 | 
 97 |         $allPackageNames = array_keys($packages);
 98 | 
 99 |         foreach ($ignoredPackages as $ignoredPackage) {
100 |             if (in_array($ignoredPackage, $allPackageNames)) {
101 |                 unset($packages[$ignoredPackage]);
102 |             }
103 |         }
104 | 
105 |         return $packages;
106 |     }
107 | }
108 | 


--------------------------------------------------------------------------------
/Scope/Config.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © element119. All rights reserved.
  4 |  * See LICENCE.txt for licence details.
  5 |  */
  6 | declare(strict_types=1);
  7 | 
  8 | namespace Element119\SansecComposerIntegrityChecker\Scope;
  9 | 
 10 | use Element119\SansecComposerIntegrityChecker\Block\Adminhtml\Form\Field\ComposerIntegrityNotificationEmailRecipients;
 11 | use Element119\SansecComposerIntegrityChecker\Block\Adminhtml\Form\Field\IgnoredPackages;
 12 | use Magento\Framework\App\Config\ScopeConfigInterface;
 13 | use Magento\Framework\Serialize\SerializerInterface;
 14 | 
 15 | class Config
 16 | {
 17 |     private const XML_PATH_SCAN_ENABLED = 'system/sansec_composer_integrity_checker/scan_enable';
 18 |     private const XML_PATH_GRID_FAILURES_ONLY = 'system/sansec_composer_integrity_checker/grid_failures_only';
 19 |     private const XML_PATH_EMAIL_ENABLED = 'system/sansec_composer_integrity_checker/scan_email_notification_enable';
 20 |     private const XML_PATH_EMAIL_THRESHOLD = 'system/sansec_composer_integrity_checker/scan_failure_threshold';
 21 |     private const XML_PATH_EMAIL_RECIPIENTS = 'system/sansec_composer_integrity_checker/scan_error_email_recipient';
 22 |     private const XML_PATH_IGNORE_LIST_ENABLE = 'system/sansec_composer_integrity_checker/package_ignore_list_enable';
 23 |     private const XML_PATH_IGNORED_PACKAGES = 'system/sansec_composer_integrity_checker/ignored_packages';
 24 |     private const XML_PATH_REMOVE_IGNORED_PACKAGES_FROM_ADMIN_GRID =
 25 |         'system/sansec_composer_integrity_checker/remove_ignored_packages_from_admin_grid';
 26 |     private const XML_PATH_REMOVE_IGNORED_PACKAGES_FROM_ADMIN_NOTIFICATION =
 27 |         'system/sansec_composer_integrity_checker/remove_ignored_packages_from_admin_notif';
 28 |     private const XML_PATH_REMOVE_IGNORED_PACKAGES_FROM_EMAIL =
 29 |         'system/sansec_composer_integrity_checker/remove_ignored_packages_from_emails';
 30 | 
 31 |     public function __construct(
 32 |         private readonly ScopeConfigInterface $scopeConfig,
 33 |         private readonly SerializerInterface $serializer
 34 |     ) {}
 35 | 
 36 |     public function isSansecComposerIntegrityScanEnabled(): bool
 37 |     {
 38 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_SCAN_ENABLED);
 39 |     }
 40 | 
 41 |     public function isSansecComposerIntegrityEmailNotificationEnabled(): bool
 42 |     {
 43 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_EMAIL_ENABLED);
 44 |     }
 45 | 
 46 |     public function getSansecComposerIntegrityMatchThreshold(): int
 47 |     {
 48 |         return (int)$this->scopeConfig->getValue(self::XML_PATH_EMAIL_THRESHOLD);
 49 |     }
 50 | 
 51 |     public function shouldOnlyShowFailuresInGrid(): bool
 52 |     {
 53 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_GRID_FAILURES_ONLY);
 54 |     }
 55 | 
 56 |     public function getSansecComposerIntegrityEmailRecipients(): array
 57 |     {
 58 |         $recipients = [];
 59 |         $recipientsConfig = $this->scopeConfig->getValue(self::XML_PATH_EMAIL_RECIPIENTS) ?? [];
 60 | 
 61 |         if (!is_array($recipientsConfig)) {
 62 |             $recipientsConfig = $this->serializer->unserialize($recipientsConfig);
 63 |         }
 64 | 
 65 |         foreach ($recipientsConfig as $recipient) {
 66 |             $recipients[] = $recipient[ComposerIntegrityNotificationEmailRecipients::CSV_REPORT_EMAIL_ADDRESS];
 67 |         }
 68 | 
 69 |         return $recipients;
 70 |     }
 71 | 
 72 |     public function isIgnoreListEnabled(): bool
 73 |     {
 74 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_IGNORE_LIST_ENABLE);
 75 |     }
 76 | 
 77 |     public function getIgnoredPackageList(): array
 78 |     {
 79 |         $ignoredPackages = [];
 80 |         $ignoredPackagesConfig = $this->scopeConfig->getValue(self::XML_PATH_IGNORED_PACKAGES) ?? [];
 81 | 
 82 |         if (!is_array($ignoredPackagesConfig)) {
 83 |             $ignoredPackagesConfig = $this->serializer->unserialize($ignoredPackagesConfig);
 84 |         }
 85 | 
 86 |         foreach ($ignoredPackagesConfig as $ignoredPackage) {
 87 |             $ignoredPackages[] = $ignoredPackage[IgnoredPackages::PACKAGE];
 88 |         }
 89 | 
 90 |         return $ignoredPackages;
 91 |     }
 92 | 
 93 |     public function shouldRemoveIgnoredPackagesFromAdminGrid(): bool
 94 |     {
 95 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_REMOVE_IGNORED_PACKAGES_FROM_ADMIN_GRID);
 96 |     }
 97 | 
 98 |     public function shouldRemoveIgnoredPackagesFromAdminNotification(): bool
 99 |     {
100 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_REMOVE_IGNORED_PACKAGES_FROM_ADMIN_NOTIFICATION);
101 |     }
102 | 
103 |     public function shouldRemoveIgnoredPackagesFromEmail(): bool
104 |     {
105 |         return $this->scopeConfig->isSetFlag(self::XML_PATH_REMOVE_IGNORED_PACKAGES_FROM_EMAIL);
106 |     }
107 | }
108 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <h1 align="center">element119 | Sansec Composer Integrity Checker</h1>
  2 | 
  3 | ## 📝 Features
  4 | ✔️ Identify potentially unwanted changes made to your project dependencies using the [Sansec Composer integrity plugin](https://github.com/sansecio/composer-integrity-plugin)
  5 | 
  6 | ✔️ Scan files automatically via cron or as a manual admin action
  7 | 
  8 | ✔️ Email and admin notifications for packages that do not meet your desired integrity rating
  9 | 
 10 | ✔️ Configure a safe list to reduce the noise generated by the scanner
 11 | 
 12 | ✔️ Supports Magento Open Source and Adobe Commerce
 13 | 
 14 | ✔️ Theme agnostic
 15 | 
 16 | ✔️ Dedicated module configuration section secured with custom admin user controls
 17 | 
 18 | ✔️ Seamless integration with Magento
 19 | 
 20 | ✔️ Built with developers and extensibility in mind to make customisations as easy as possible
 21 | 
 22 | ✔️ Installable via Composer
 23 | 
 24 | <br/>
 25 | 
 26 | ## 🔌 Installation
 27 | Run the following command to *install* this module:
 28 | ```bash
 29 | composer require element119/module-sansec-composer-integrity-checker
 30 | php bin/magento setup:upgrade
 31 | ```
 32 | 
 33 | ### Post-Installation Steps
 34 | It is also recommended that you enable the scans and lock the related config value:
 35 | ```bash
 36 | php bin/magento config:set --lock-config system/sansec_composer_integrity_checker/scan_enable 1
 37 | ```
 38 | 
 39 | <br/>
 40 | 
 41 | ## ⏫ Updating
 42 | Run the following command to *update* this module:
 43 | ```bash
 44 | composer update element119/module-sansec-composer-integrity-checker
 45 | php bin/magento setup:upgrade
 46 | ```
 47 | 
 48 | <br/>
 49 | 
 50 | ## ❌ Uninstallation
 51 | Run the following command to *uninstall* this module:
 52 | ```bash
 53 | composer remove element119/module-sansec-composer-integrity-checker
 54 | php bin/magento setup:upgrade
 55 | ```
 56 | 
 57 | <br/>
 58 | 
 59 | ## 📚 User Guide
 60 | Configuration for this module can be found in the Magento admin under `Stores -> Settings -> Configuration -> Advanced
 61 | -> System -> Sansec Composer Integrity Checker`
 62 | 
 63 | <br>
 64 | 
 65 | ### Scan Results Grid
 66 | The results of the most recent scan can be seen in the admin by navigating to `Reports -> Sansec Composer
 67 | Integrity Checker -> Integrity Status`.
 68 | 
 69 | <br>
 70 | 
 71 | ### Enable/Disable Scanning
 72 | The Sansec Composer integrity scan can be disabled by setting this option to `No`. This is set to `Yes` by default.
 73 | 
 74 | <br>
 75 | 
 76 | ### Match Percentage Threshold for Notification
 77 | The value specified here determines the minimum match percentage required for the integrity checks to be considered
 78 | sucessful. Admins will be notified of any packages that fail to meet this number via a warning and email notifications
 79 | will be sent if enabled.
 80 | 
 81 | <br>
 82 | 
 83 | ### Only Show Failures in Admin Grid
 84 | Determines whether to only show packages that have failed to meet the match threshold in the admin grid. This feature is
 85 | disabled by default but can be enabled by setting this option to `Yes`.
 86 | 
 87 | <br>
 88 | 
 89 | ### Report Integrity Failures by Email
 90 | Allow emails to be sent when the Sansec Composer integrity checker finds discrepancies with your dependency files.
 91 | This feature is disabled by default but can be enabled by setting this option to `Yes`. Once enabled you will be able
 92 | to configure a threshold for dependency matching as well as a list of email address to notify when a failure occurs.
 93 | 
 94 | <br>
 95 | 
 96 | ### Report Errors To
 97 | This option is only considered when integrity failure emails are enabled. These dynamic rows allow you to configure a
 98 | series of email addresses that should be notified when packages fail to meet the configured threshold.
 99 | 
100 | <br>
101 | 
102 | ### Enable Package Ignore List
103 | Allows specified packages to be removed from various reporting channels. This feature is disabled by default but can
104 | be enabled by setting this option to `Yes`.
105 | 
106 | <br>
107 | 
108 | ### Ignored Packages
109 | This option is only considered when the package ignore list is enabled. These dynamic rows allow you to configure a
110 | set of packages that should be ignored for various reporting channels. The values expected here are the Composer
111 | package names in the format `vendor/package-name`.
112 | 
113 | <br>
114 | 
115 | ### Remove Ignored Packages from Admin Grid
116 | This option is only considered when the package ignore list is enabled. This feature is disabled by default but can
117 | be enabled by setting this option to `Yes`. When enabled, ignored packages will be removed from the admin grid.
118 | 
119 | <br>
120 | 
121 | ### Remove Ignored Packages from Admin Notifications
122 | This option is only considered when the package ignore list is enabled. This feature is disabled by default but can
123 | be enabled by setting this option to `Yes`. When enabled, ignored packages will not be considered when determining
124 | whether to display the admin notification and the number of packages it reports as having failed to meet the
125 | threshold.
126 | 
127 | <br>
128 | 
129 | ### Remove Ignored Packages from Email Notifications
130 | This option is only considered when email notifications are enabled **and** when the package ignore list is enabled.
131 | This feature is disabled by default but can be enabled by setting this option to `Yes`. When enabled, ignored
132 | packages will be removed from email notifications.
133 | 
134 | <br>
135 | 
136 | ## 📸 Screenshots & GIFs
137 | ### Admin Configuration
138 | ![admin-config](https://github.com/element119/module-sansec-composer-integrity-checker/assets/40261741/d6ee992f-a513-473f-b607-7497723b2d99)
139 | 
140 | <br>
141 | 
142 | ### Admin Grid
143 | ![admin-grid](https://user-images.githubusercontent.com/40261741/234440974-3ff17d18-faa0-407b-9b25-0e7e76e7d8aa.png)
144 | 
145 | <br>
146 | 
147 | ### Admin Notification
148 | ![admin-notification](https://user-images.githubusercontent.com/40261741/234434736-0e187e19-f474-47cd-804b-7f4d150ba31b.png)
149 | 
150 | <br>
151 | 
152 | ### Example Email Notification
153 | ![email-example](https://user-images.githubusercontent.com/40261741/234102797-8937df5a-7312-4750-a9ca-09c2ad7379bd.png)
154 | 


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <!--
  3 | /**
  4 |  * Copyright © element119. All rights reserved.
  5 |  * See LICENCE.txt for licence details.
  6 |  */
  7 | -->
  8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
 10 |     <system>
 11 |         <section id="system">
 12 |             <group id="sansec_composer_integrity_checker"
 13 |                    translate="label"
 14 |                    type="text"
 15 |                    sortOrder="1100"
 16 |                    showInDefault="1"
 17 |                    showInWebsite="0"
 18 |                    showInStore="0">
 19 |                 <label>Sansec Composer Integrity Checker</label>
 20 |                 <field id="scan_enable"
 21 |                        translate="label"
 22 |                        type="select"
 23 |                        sortOrder="10"
 24 |                        showInDefault="1"
 25 |                        showInWebsite="0"
 26 |                        showInStore="0"
 27 |                        canRestore="1">
 28 |                     <label>Enable Scanning</label>
 29 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 30 |                 </field>
 31 |                 <field id="scan_failure_threshold"
 32 |                        translate="label comment"
 33 |                        type="text"
 34 |                        sortOrder="20"
 35 |                        showInDefault="1"
 36 |                        showInWebsite="0"
 37 |                        showInStore="0"
 38 |                        canRestore="1">
 39 |                     <label>Match Percentage Threshold for Notification</label>
 40 |                     <comment>Match percentages lower than this will result in notifications being sent or displayed.</comment>
 41 |                     <validate>required-entry validate-digits validate-not-negative-number validate-digits-range digits-range-0-100</validate>
 42 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 43 |                     <depends>
 44 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
 45 |                     </depends>
 46 |                 </field>
 47 |                 <field id="grid_failures_only"
 48 |                        translate="label"
 49 |                        type="select"
 50 |                        sortOrder="25"
 51 |                        showInDefault="1"
 52 |                        showInWebsite="0"
 53 |                        showInStore="0"
 54 |                        canRestore="1">
 55 |                     <label>Only Show Failures in Admin Grid</label>
 56 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 57 |                     <depends>
 58 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
 59 |                     </depends>
 60 |                 </field>
 61 |                 <field id="scan_email_notification_enable"
 62 |                        translate="label"
 63 |                        type="select"
 64 |                        sortOrder="30"
 65 |                        showInDefault="1"
 66 |                        showInWebsite="0"
 67 |                        showInStore="0"
 68 |                        canRestore="1">
 69 |                     <label>Report Integrity Failures by Email</label>
 70 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 71 |                     <depends>
 72 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
 73 |                     </depends>
 74 |                 </field>
 75 |                 <field id="scan_error_email_recipient"
 76 |                        translate="label"
 77 |                        sortOrder="40"
 78 |                        showInDefault="1"
 79 |                        showInWebsite="0"
 80 |                        showInStore="0"
 81 |                        canRestore="1">
 82 |                     <label>Report Errors To</label>
 83 |                     <validate>validate-email</validate>
 84 |                     <frontend_model>Element119\SansecComposerIntegrityChecker\Block\Adminhtml\Form\Field\ComposerIntegrityNotificationEmailRecipients</frontend_model>
 85 |                     <backend_model>Magento\Config\Model\Config\Backend\Serialized\ArraySerialized</backend_model>
 86 |                     <depends>
 87 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
 88 |                         <field id="system/sansec_composer_integrity_checker/scan_email_notification_enable">1</field>
 89 |                     </depends>
 90 |                 </field>
 91 |                 <field id="package_ignore_list_enable"
 92 |                        translate="label comment"
 93 |                        type="select"
 94 |                        sortOrder="50"
 95 |                        showInDefault="1"
 96 |                        showInWebsite="0"
 97 |                        showInStore="0"
 98 |                        canRestore="1">
 99 |                     <label>Enable Package Ignore List</label>
100 |                     <comment>Allow reporting to be ignored for some packages.</comment>
101 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
102 |                     <depends>
103 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
104 |                     </depends>
105 |                 </field>
106 |                 <field id="ignored_packages"
107 |                        translate="label comment"
108 |                        sortOrder="60"
109 |                        showInDefault="1"
110 |                        showInWebsite="0"
111 |                        showInStore="0">
112 |                     <label>Ignored Packages</label>
113 |                     <comment>Values should be in the vendor/package format.</comment>
114 |                     <validate>no-marginal-whitespace validate-no-html-tags</validate>
115 |                     <frontend_model>Element119\SansecComposerIntegrityChecker\Block\Adminhtml\Form\Field\IgnoredPackages</frontend_model>
116 |                     <backend_model>Magento\Config\Model\Config\Backend\Serialized\ArraySerialized</backend_model>
117 |                     <depends>
118 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
119 |                         <field id="system/sansec_composer_integrity_checker/package_ignore_list_enable">1</field>
120 |                     </depends>
121 |                 </field>
122 |                 <field id="remove_ignored_packages_from_admin_grid"
123 |                        translate="label"
124 |                        type="select"
125 |                        sortOrder="70"
126 |                        showInDefault="1"
127 |                        showInWebsite="0"
128 |                        showInStore="0"
129 |                        canRestore="1">
130 |                     <label>Remove Ignored Packages from Admin Grid</label>
131 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
132 |                     <depends>
133 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
134 |                         <field id="system/sansec_composer_integrity_checker/package_ignore_list_enable">1</field>
135 |                     </depends>
136 |                 </field>
137 |                 <field id="remove_ignored_packages_from_admin_notif"
138 |                        translate="label comment"
139 |                        type="select"
140 |                        sortOrder="80"
141 |                        showInDefault="1"
142 |                        showInWebsite="0"
143 |                        showInStore="0"
144 |                        canRestore="1">
145 |                     <label>Remove Ignored Packages from Admin Notifications</label>
146 |                     <comment>If only ignored packages fail to meet the threshold, no notification will be shown.</comment>
147 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
148 |                     <depends>
149 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
150 |                         <field id="system/sansec_composer_integrity_checker/package_ignore_list_enable">1</field>
151 |                     </depends>
152 |                 </field>
153 |                 <field id="remove_ignored_packages_from_emails"
154 |                        translate="label comment"
155 |                        type="select"
156 |                        sortOrder="90"
157 |                        showInDefault="1"
158 |                        showInWebsite="0"
159 |                        showInStore="0"
160 |                        canRestore="1">
161 |                     <label>Remove Ignored Packages from Email Notifications</label>
162 |                     <comment>If only ignored packages fail to meet the threshold, no email will be sent.</comment>
163 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
164 |                     <depends>
165 |                         <field id="system/sansec_composer_integrity_checker/scan_enable">1</field>
166 |                         <field id="system/sansec_composer_integrity_checker/package_ignore_list_enable">1</field>
167 |                         <field id="system/sansec_composer_integrity_checker/scan_email_notification_enable">1</field>
168 |                     </depends>
169 |                 </field>
170 |             </group>
171 |         </section>
172 |     </system>
173 | </config>
174 | 


--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
 1 | Open Software License ("OSL") v. 3.0
 2 | 
 3 | This Open Software License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following licensing notice adjacent to the copyright notice for the Original Work:
 4 | 
 5 | Licensed under the Open Software License version 3.0
 6 | 
 7 |    1. Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following:
 8 | 
 9 |          1. to reproduce the Original Work in copies, either alone or as part of a collective work;
10 | 
11 |          2. to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby creating derivative works ("Derivative Works") based upon the Original Work;
12 | 
13 |          3. to distribute or communicate copies of the Original Work and Derivative Works to the public, with the proviso that copies of Original Work or Derivative Works that You distribute or communicate shall be licensed under this Open Software License;
14 | 
15 |          4. to perform the Original Work publicly; and
16 | 
17 |          5. to display the Original Work publicly.
18 | 
19 |    2. Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works.
20 | 
21 |    3. Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work.
22 | 
23 |    4. Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as expressly stated herein, nothing in this License grants any license to Licensor's trademarks, copyrights, patents, trade secrets or any other intellectual property. No patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims other than the licensed claims defined in Section 2. No license is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license.
24 | 
25 |    5. External Deployment. The term "External Deployment" means the use, distribution, or communication of the Original Work or Derivative Works in any way such that the Original Work or Derivative Works may be used by anyone other than You, whether those works are distributed or communicated to those persons or made available as an application intended for use over a network. As an express condition for the grants of license hereunder, You must treat any External Deployment by You of the Original Work or a Derivative Work as a distribution under section 1(c).
26 | 
27 |    6. Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent, or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work.
28 | 
29 |    7. Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately preceding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer.
30 | 
31 |    8. Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to anyone for any indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation.
32 | 
33 |    9. Acceptance and Termination. If, at any time, You expressly assented to this License, that assent indicates your clear and irrevocable acceptance of this License and all of its terms and conditions. If You distribute or communicate copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. This License conditions your rights to undertake the activities listed in Section 1, including your right to create Derivative Works based upon the Original Work, and doing so without honoring these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations (including 'fair use' or 'fair dealing'). This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to honor the conditions in Section 1(c).
34 | 
35 |   10. Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware.
36 | 
37 |   11. Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License.
38 | 
39 |   12. Attorneys' Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License.
40 | 
41 |   13. Miscellaneous. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
42 | 
43 |   14. Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
44 | 
45 |   15. Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You.
46 | 
47 |   16. Modification of This License. This License is Copyright (C) 2005 Lawrence Rosen. Permission is granted to copy, distribute, or communicate this License without modification. Nothing in this License permits You to modify this License as applied to the Original Work or to Derivative Works. However, You may modify the text of this License and copy, distribute or communicate your modified version (the "Modified License") and apply it to other original works of authorship subject to the following conditions: (i) You may not indicate in any way that your Modified License is the "Open Software License" or "OSL" and you may not use those names in the name of your Modified License; (ii) You must replace the notice specified in the first paragraph above with the notice "Licensed under <insert your license name here>" or with a notice of your own that is not confusingly similar to the notice in this License; and (iii) You may not claim that your original works are open source software unless your Modified License has been approved by Open Source Initiative (OSI) and You comply with its license review and certification process.
48 | 


--------------------------------------------------------------------------------