Extracting ZIP Archives Safely

Inspect archive members before extracting them into a controlled destination. The examples focus on the implementation and the checks that matter before using it in an application.

What Is the Approach?

Inspect archive members before extracting them into a controlled destination.

The following sections use ZipArchive::getNameIndex() and related PHP facilities to demonstrate a small working pattern and the validation needed around it.

Example 1: Basic Usage

This example introduces Extracting ZIP Archives Safely with a direct call and a small, readable input.

<?php

$archive = new ZipArchive(); if ($archive->open($zipPath) !== true) { throw new RuntimeException("Invalid ZIP"); } echo $archive->numFiles; $archive->close();

Inspect archive members before extracting them into a controlled destination. Reject traversal, absolute paths, links and unexpectedly large archives; extractTo() alone is not a safety guarantee.

Example 2: Another Behavior or Input

Compare this input with the previous example: changing the data or option can affect how Extracting ZIP Archives Safely behaves.

<?php

$archive = new ZipArchive(); $archive->open($zipPath); for ($index = 0; $index < $archive->numFiles; $index++) { echo $archive->getNameIndex($index) . "\n"; } $archive->close();

The changed input illustrates why output may differ with the chosen values or environment. Reject traversal, absolute paths, links and unexpectedly large archives; extractTo() alone is not a safety guarantee.

Practical Example: Using the Feature

The following example incorporates Extracting ZIP Archives Safely into a workflow. Values such as paths, connection handles and configuration options must come from trusted application settings.

<?php

// Review each entry for absolute paths, ../ traversal, symlinks, file counts and inflated sizes before extraction.
// Extract only approved entries into a dedicated destination; never trust ZIP paths directly.
$archive = new ZipArchive(); if ($archive->open($zipPath) !== true) { throw new RuntimeException("Invalid ZIP"); } $entryName = $archive->getNameIndex(0); if ($entryName === false || str_contains($entryName, "..") || str_starts_with($entryName, "/")) { throw new RuntimeException("Unsafe entry"); } $archive->close();

In a real application, check each operation result, validate values before use and clean up acquired resources. Reject traversal, absolute paths, links and unexpectedly large archives; extractTo() alone is not a safety guarantee.

Important Behavior and Edge Cases

• Purpose: Inspect archive members before extracting them into a controlled destination.
• Key limitation: Reject traversal, absolute paths, links and unexpectedly large archives; extractTo() alone is not a safety guarantee.
• Failure handling: Check return values and handle invalid inputs and unavailable operating-system or extension features where relevant.

Comparison With Related Functions

Common Beginner Mistakes

Key Takeaways

• Inspect archive members before extracting them into a controlled destination.
• Reject traversal, absolute paths, links and unexpectedly large archives; extractTo() alone is not a safety guarantee.
• Use the examples as starting points, and adapt environmental paths, resources and permissions rather than assuming fixed results.

Extracting ZIP Archives Safely is useful when its specific behavior fits the problem. The safest implementations combine the correct API with input validation, error checking and resource cleanup.