Skip to content

Phar extraction: add warning about following symlinks #5864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DanielEScherzer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Phar extraction: add warning about following symlinks #5864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions reference/phar/Phar/extractTo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@
set to true to enable overwriting of files.
This method is similar to <function>ZipArchive::extractTo</function>.
</para>

<warning>
<simpara>
Extraction follows any existing symlinks in the target
<parameter>directory</parameter>. If there is a symlink to some other
directory, files may be extracted outside of the desired location; if
there is a symlink to a file, the target of the symlink will be
overwritten when <parameter>overwrite</parameter> is true.

@lacatoire lacatoire Sep 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
overwritten when <parameter>overwrite</parameter> is true.
overwritten when <parameter>overwrite</parameter> is true, or created
if it does not exist, whatever the value of <parameter>overwrite</parameter>.

</simpara>
</warning>
</refsect1>

<refsect1 role="parameters">
Expand Down
10 changes: 10 additions & 0 deletions reference/phar/PharData/extractTo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@
set to true to enable overwriting of files.
This method is similar to <function>ZipArchive::extractTo</function>.
</para>

<warning>
<simpara>
Extraction follows any existing symlinks in the target
<parameter>directory</parameter>. If there is a symlink to some other
directory, files may be extracted outside of the desired location; if
there is a symlink to a file, the target of the symlink will be
overwritten when <parameter>overwrite</parameter> is true.

@lacatoire lacatoire Sep 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
overwritten when <parameter>overwrite</parameter> is true.
overwritten when <parameter>overwrite</parameter> is true, or created
if it does not exist, whatever the value of <parameter>overwrite</parameter>.

</simpara>
</warning>
</refsect1>

<refsect1 role="parameters">
Expand Down
Loading