Add withPasswordCallback

Author: cataphract

libarchive.stub.php

@@ -363,6 +363,22 @@ public function __construct(string $file, int $flags = 0) {}
          */
         public static function fromStream(mixed $stream, int $flags = 0): static {}
 
+        /**
+         * Set a PHP callable that will be invoked by libarchive whenever a
+         * passphrase is needed to decrypt an entry.
+         *
+         * The callable receives no arguments and must return either a string
+         * (the passphrase) or null to signal that no passphrase is available.
+         * It may be called multiple times if several passphrases need to be
+         * tried.
+         *
+         * Must be called before iteration begins.
+         *
+         * @param callable $callable  Callback with signature {@code function(): ?string}.
+         * @throws Exception          If the archive has already been opened.
+         */
+        public function withPasswordCallback(callable $callable): static {}
+
         /**
          * Restrict reading to specific archive formats.
          *

libarchive_arginfo.h

@@ -14,6 +14,10 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_libarchive_Archive_fromStr
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, flags, IS_LONG, 0, "0")
 ZEND_END_ARG_INFO()
 
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_libarchive_Archive_withPasswordCallback, 0, 1, IS_STATIC, 0)
+	ZEND_ARG_TYPE_INFO(0, callable, IS_CALLABLE, 0)
+ZEND_END_ARG_INFO()
+
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_libarchive_Archive_supportFormats, 0, 1, IS_STATIC, 0)
 	ZEND_ARG_VARIADIC_TYPE_INFO(0, formats, IS_LONG, 0)
 ZEND_END_ARG_INFO()
@@ -36,6 +40,7 @@ ZEND_END_ARG_INFO()
 ZEND_METHOD(libarchive_Entry, __construct);
 ZEND_METHOD(libarchive_Archive, __construct);
 ZEND_METHOD(libarchive_Archive, fromStream);
+ZEND_METHOD(libarchive_Archive, withPasswordCallback);
 ZEND_METHOD(libarchive_Archive, supportFormats);
 ZEND_METHOD(libarchive_Archive, supportFilters);
 ZEND_METHOD(libarchive_Archive, extractCurrent);
@@ -57,6 +62,7 @@ static const zend_function_entry class_libarchive_Entry_methods[] = {
 static const zend_function_entry class_libarchive_Archive_methods[] = {
 	ZEND_ME(libarchive_Archive, __construct, arginfo_class_libarchive_Archive___construct, ZEND_ACC_PUBLIC)
 	ZEND_ME(libarchive_Archive, fromStream, arginfo_class_libarchive_Archive_fromStream, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
+	ZEND_ME(libarchive_Archive, withPasswordCallback, arginfo_class_libarchive_Archive_withPasswordCallback, ZEND_ACC_PUBLIC)
 	ZEND_ME(libarchive_Archive, supportFormats, arginfo_class_libarchive_Archive_supportFormats, ZEND_ACC_PUBLIC)
 	ZEND_ME(libarchive_Archive, supportFilters, arginfo_class_libarchive_Archive_supportFilters, ZEND_ACC_PUBLIC)
 	ZEND_ME(libarchive_Archive, extractCurrent, arginfo_class_libarchive_Archive_extractCurrent, ZEND_ACC_PUBLIC)

php_libarchive.h

@@ -51,6 +51,9 @@ typedef struct _arch_object {
     int *nullable filters; /* NULL = auto-detect all; emalloc'd array of ARCHIVE_FILTER_* codes */
     uint32_t filters_count;
     uint32_t entry_generation; /* incremented before each archive_read_next_header2 call */
+    zend_fcall_info password_fci;               /* size == 0 if not set */
+    zend_fcall_info_cache password_fcc;
+    zend_string *nullable password_cb_last_result; /* owns the last passphrase string */
     zend_object parent;
 } arch_object;
 

tests/arch/encrypted/test_encrypted.zip

@@ -0,0 +1,55 @@
+--TEST--
+withPasswordCallback() supplies a passphrase for encrypted archives
+--FILE--
+<?php
+
+echo "-- callback is invoked when reading data --\n";
+$called = 0;
+$a = (new libarchive\Archive('arch/encrypted/test_encrypted.zip'))
+    ->withPasswordCallback(function() use (&$called) {
+        $called++;
+        return 'password';
+    });
+foreach ($a as $e) {
+    if ($e->size) {
+    $content = trim(stream_get_contents($a->currentEntryStream()));
+    echo $e->pathname, ' ', $content, "\n";
+    }
+}
+echo "callback invoked: ", $called, " time(s)\n";
+
+echo "-- wrong password, give up after 10 attempts --\n";
+$called = 0;
+$a = (new libarchive\Archive('arch/encrypted/test_encrypted.zip'))
+    ->withPasswordCallback(function() use (&$called) {
+        $called++;
+        return $called <= 10 ? 'wrong' : null;
+    });
+foreach ($a as $e) {
+    if (!$e->size) continue;
+    $content = stream_get_contents($a->currentEntryStream());
+    echo $e->pathname, ' len=', strlen($content), "\n";
+}
+echo "callback invoked: ", $called, " time(s)\n";
+
+echo "-- withPasswordCallback after open --\n";
+$a = new libarchive\Archive('arch/encrypted/test_encrypted.zip');
+foreach ($a as $e) { break; }
+try {
+    $a->withPasswordCallback(fn() => 'password');
+} catch (libarchive\Exception $e) {
+    echo "Exception: ", $e->getMessage(), "\n";
+}
+
+?>
+--EXPECTF--
+-- callback is invoked when reading data --
+encrypted/file.txt plaintext
+callback invoked: 1 time(s)
+-- wrong password, give up after 10 attempts --
+
+Warning: stream_get_contents(): Error reading data: Incorrect passphrase [-1] in %s on line %d
+encrypted/file.txt len=0
+callback invoked: 11 time(s)
+-- withPasswordCallback after open --
+Exception: Cannot set password callback after archive has been opened