Document symbolic link and junction extraction behavior for TarFile and ZipFile #12009
+15
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… will not be followed
github-actions
bot
added
the
needs-area-label
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation about symbolic link and junction handling behavior to the extraction methods in both ZipFile and TarFile APIs.
- Clarifies that ZIP archives extract symbolic links as regular folders since symbolic link information isn't preserved in the ZIP format
- Documents that TAR archives throw an
IOExceptionwhen symbolic links or junctions would extract files outside the destination directory
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| xml/System.IO.Compression/ZipFile.xml | Added documentation stating that symbolic links in ZIP archives are extracted as regular folders across multiple ExtractToDirectory method overloads |
| xml/System.Formats.Tar/TarFile.xml | Added documentation explaining that symbolic links or junctions pointing outside the destination directory will throw an IOException across multiple ExtractToDirectory method overloads |
gewarren
approved these changes
Nov 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the API documentation for TarFile and ZipFile ExtractToDirectory methods. It clarifies how symbolic links and junctions are handled during extraction. For TarFile, the docs now state that extraction will throw an IOException if a symbolic link or junction would escape the destination directory. For ZipFile, the docs explain that symbolic link information is not preserved and such entries are extracted as regular folders.
Fixes dotnet/runtime#120966