Why phar stream is being unregistered?

[kassner]

Summary

The 2.3.1 release introduced the line stream_wrapper_unregister('phar'); in the app/boostrap.php. It's unclear why it was added, but it breaks a few external tools, like PHPStan.

Examples

/var/www/magento $ phpstan analyse --autoload-file=app/bootstrap.php -c dev/tools/phpstan/config.neon --level=max app/code/
PHP Warning:  include(): Unable to find the wrapper "phar" - did you forget to enable it when you configured PHP? in /var/www/magento/vendor/composer/ClassLoader.php on line 444

Warning: include(): Unable to find the wrapper "phar" - did you forget to enable it when you configured PHP? in /var/www/magento/vendor/composer/ClassLoader.php on line 444
PHP Warning:  include(): Unable to find the wrapper "phar" - did you forget to enable it when you configured PHP? in /var/www/magento/vendor/composer/ClassLoader.php on line 444

Warning: include(): Unable to find the wrapper "phar" - did you forget to enable it when you configured PHP? in /var/www/magento/vendor/composer/ClassLoader.php on line 444
PHP Warning:  include(phar:///usr/local/bin/phpstan/vendor/composer/../../src/DependencyInjection/ContainerFactory.php): failed to open stream: No such file or directory in /var/www/magento/vendor/composer/ClassLoader.php on line 444

Warning: include(phar:///usr/local/bin/phpstan/vendor/composer/../../src/DependencyInjection/ContainerFactory.php): failed to open stream: No such file or directory in /var/www/magento/vendor/composer/ClassLoader.php on line 444
PHP Warning:  include(): Failed opening 'phar:///usr/local/bin/phpstan/vendor/composer/../../src/DependencyInjection/ContainerFactory.php' for inclusion (include_path='/var/www/magento/generated/code:/var/www/magento/generated/code:/var/www/magento/vendor/magento/zendframework1/library:.:') in /var/www/magento/vendor/composer/ClassLoader.php on line 444

Warning: include(): Failed opening 'phar:///usr/local/bin/phpstan/vendor/composer/../../src/DependencyInjection/ContainerFactory.php' for inclusion (include_path='/var/www/magento/generated/code:/var/www/magento/generated/code:/var/www/magento/vendor/magento/zendframework1/library:.:') in /var/www/magento/vendor/composer/ClassLoader.php on line 444
string(44) "PHPStan\DependencyInjection\ContainerFactory"
PHP Fatal error:  Uncaught Error: Class 'PHPStan\DependencyInjection\ContainerFactory' not found in phar:///usr/local/bin/phpstan/src/Command/CommandHelper.php:73
Stack trace:
#0 phar:///usr/local/bin/phpstan/src/Command/AnalyseCommand.php(46): PHPStan\Command\CommandHelper::begin(Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Input\ArgvInput), Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Output\ConsoleOutput), Array, NULL, NULL, '/var/www/magent...', 'dev/tools/phpst...', 'max')
#1 phar:///usr/local/bin/phpstan/vendor/symfony/console/Command/Command.php(228): PHPStan\Command\AnalyseCommand->execute(Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Input\ArgvInput), Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Output\ConsoleOutput))
#2 phar:///usr/local/bin/phpstan/vendor/symfony/console/Application.php(831): _HumbugBox3fccee4f38a4\Symfony\Component\Console\Command\Command->run(Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Input\ArgvInput), Object(_HumbugBox3fccee4f38a4\Symfony\Co in phar:///usr/local/bin/phpstan/src/Command/CommandHelper.php on line 73

Fatal error: Uncaught Error: Class 'PHPStan\DependencyInjection\ContainerFactory' not found in phar:///usr/local/bin/phpstan/src/Command/CommandHelper.php:73
Stack trace:
#0 phar:///usr/local/bin/phpstan/src/Command/AnalyseCommand.php(46): PHPStan\Command\CommandHelper::begin(Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Input\ArgvInput), Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Output\ConsoleOutput), Array, NULL, NULL, '/var/www/magent...', 'dev/tools/phpst...', 'max')
#1 phar:///usr/local/bin/phpstan/vendor/symfony/console/Command/Command.php(228): PHPStan\Command\AnalyseCommand->execute(Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Input\ArgvInput), Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Output\ConsoleOutput))
#2 phar:///usr/local/bin/phpstan/vendor/symfony/console/Application.php(831): _HumbugBox3fccee4f38a4\Symfony\Component\Console\Command\Command->run(Object(_HumbugBox3fccee4f38a4\Symfony\Component\Console\Input\ArgvInput), Object(_HumbugBox3fccee4f38a4\Symfony\Co in phar:///usr/local/bin/phpstan/src/Command/CommandHelper.php on line 73

And removing the aforementioned line:

/var/www/magento $ phpstan analyse --autoload-file=app/bootstrap.php -c dev/tools/phpstan/config.neon --level=max app/code/
 203/203 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

                                                                                                                        
 [OK] No errors                                                                                                         
                                                                                                                        

/var/www/magento $ 

Proposed solution

Ideally, we wouldn't have this line at all in the code, but someone added it there for some reason. I couldn't find any context about it why it's there, it's not mentioned in the Release Notes for the 2.3.1 version, neither the commit that introduced it gives any context about it.

Can we either have it removed or have an explanation about why we can't?

Thanks!

[magento-engcom-team]

Hi @kassner. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento-engcom-team give me 2.3-develop instance - upcoming 2.3.x release

For more details, please, review the Magento Contributor Assistant documentation.

@kassner do you confirm that you was able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

[kierenevans]

This was likely added due to PRODSECBUG-2261: Arbitrary code execution due to unsafe deserialization of a PHP archive - check https://magento.com/security/patches/magento-2.3.1-2.2.8-and-2.1.17-security-update

[m2-assistant]

Hi @engcom-backlog-nazar. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

• 6. Add label Issue: Confirmed once verification is complete.

• 7. Make sure that automatic system confirms that report has been added to the backlog.

HI @kassner thank you for you report, I'm closing this one as this is resolved, if not, feel free to reopen ticket, thanks for collaboration.

[lhall-amphibee]

Hi there,

We just ran into this issue and had to comment out the added line of code, which is ... not ideal. We are running a 2.3.1 Community Magento.

@engcom-backlog-nazar I don't see where it's been fixed, did I miss something ? I looked into 2.3-develop but it's untouched from what I can tell.

Thanks for your support.