Set register_argc_argv to Off by default
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 40.4k
- Forks
- 8.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 96
Description
(I'm not reporting this as a security issue as it's about a setting "[...] not recommended for production - ex. error reporting to output" or "[...] known to be insecure".)
Many PHP CLI tools are shipped in the form of Phar files (e.g. Composer), and while never really recommended, some users tend to put these archives under the web root (tutorials from shared hosting providers, when you need per-project Composer releases, etc.). On distributions like Debian and Ubuntu, Apache is treating these files as PHP scripts.
Since these scripts use $_SERVER['argc'] to find out how they are invoked and parse their arguments, direct access to these files is not a problem when register_argc_argv is set to Off. Looking into this topic, I noticed that PHP is still shipped with register_argc_argv set to On by default:
https://github.com/php/php-src/blob/21d9fd3bc1ccf376438e4b5c38bb1945ae3bfe8c/main/main.c#L709
The recommended default configuration for the production environment and shipped with most distributions set it to Off–note that it only mentions performance reasons and not security:
There are still environments in which this setting can be set to On, either involuntarily by keeping the development configuration or voluntarily by manually setting it. For instance, the main PHP Docker image for PHP has it set to On.
We can then assume that there is a non-zero chance of deployments processing Phar files as PHP scripts and with this setting left to its default value, introducing potential vulnerabilities. I've already reached out to Composer and they now refuse to run in non-CLI SAPIs if register_argc_argv is On (CVE-2023-43655).
Outside of the risk caused by Phar files, register_argc_argv is also a known "trick" to exploit limited Local File Inclusion vulnerabilities in a generic way in Docker php images, using /usr/local/lib/php/pearcmd.php (i.e. 2linephp by @w181496 during Balsn CTF 2021). This exploitation method was also shared with a wider audience in a video of @JohnHammond (https://www.youtube.com/watch?v=yq2rq50IMSQ).
I think it would be great to set register_argc_argv to Off by default, keeping it to On only for these SAPIs: embed, phpdbg and cli. I'm not sure about litespeed but from what I'm reading in the code, it seems important too. The documentation in php.ini could also mention the potential security risks caused by this setting.
I'll be happy to work on the PR if this sounds like something that could happen to be merged, let me know!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the register_argc_argv default in main/main.c and the corresponding guidance in php.ini-production. Trace how the setting applies across the embed, phpdbg, cli, and litespeed SAPIs, then determine the compatibility impact of changing the default. Done means the default behavior and php.ini documentation consistently reflect the accepted SAPI policy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, php
- Domain
- backend, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100