PhpZip\IO\Filter\Cipher\Pkware\PKEncryptionStreamFilter

Complexity

Total Complexity

13

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	3	1
A	filter()	0	26	4
B	onCreate()	0	44	8

<?php

namespace PhpZip\IO\Filter\Cipher\Pkware;

use PhpZip\Exception\RuntimeException;
use PhpZip\Model\ZipEntry;

/**
 * Encryption PKWARE Traditional Encryption.
 */
class PKEncryptionStreamFilter extends \php_user_filter
{
    const FILTER_NAME = 'phpzip.encryption.pkware';

    /** @var int */
    private $size;

    /** @var string */
    private $headerBytes;

    /** @var int */
    private $writeLength;

    /** @var bool */
    private $writeHeader;

    /** @var PKCryptContext */
    private $context;

    /**
     * @return bool
     */
    public static function register()
    {
        return stream_filter_register(self::FILTER_NAME, __CLASS__);
    }

    /**
     * @see https://php.net/manual/en/php-user-filter.oncreate.php
     *
     * @return bool
     */
    public function onCreate()
    {
        if (\PHP_INT_SIZE === 4) {
            throw new RuntimeException('Traditional PKWARE Encryption is not supported in 32-bit PHP.');
        }

        if (!isset($this->params['entry'], $this->params['size'])) {
            return false;
        }

        if (!($this->params['entry'] instanceof ZipEntry)) {
            throw new \RuntimeException('ZipEntry expected');
        }
        /** @var ZipEntry $entry */
        $entry = $this->params['entry'];
        $password = $entry->getPassword();

        if ($password === null) {
            return false;
        }

        $this->size = (int) $this->params['size'];

        // init keys
        $this->context = new PKCryptContext($password);

        $crc = $entry->isDataDescriptorRequired() || $entry->getCrc() === ZipEntry::UNKNOWN ?
            ($entry->getDosTime() & 0x0000ffff) << 16 :
            $entry->getCrc();

        try {
            $headerBytes = random_bytes(PKCryptContext::STD_DEC_HDR_SIZE);
        } catch (\Exception $e) {
            throw new \RuntimeException('Oops, our server is bust and cannot generate any random data.', 1, $e);
        }

        $headerBytes[PKCryptContext::STD_DEC_HDR_SIZE - 1] = pack('c', ($crc >> 24) & 0xff);
        $headerBytes[PKCryptContext::STD_DEC_HDR_SIZE - 2] = pack('c', ($crc >> 16) & 0xff);

        $this->headerBytes = $headerBytes;
        $this->writeLength = 0;
        $this->writeHeader = false;

        return true;
    }

    /**
     * Encryption filter.
     *
     * @param resource $in
     * @param resource $out
     * @param int      $consumed
     * @param bool     $closing
     *
     * @return int
     *
     * @todo USE FFI in php 7.4
     */
    public function filter($in, $out, &$consumed, $closing)
    {
        while ($bucket = stream_bucket_make_writeable($in)) {
            $buffer = $bucket->data;
            $this->writeLength += $bucket->datalen;

            if ($this->writeLength > $this->size) {
                $buffer = substr($buffer, 0, $this->size - $this->writeLength);
            }

            $data = '';

            if (!$this->writeHeader) {
                $data .= $this->context->encryptString($this->headerBytes);
                $this->writeHeader = true;
            }

            $data .= $this->context->encryptString($buffer);

            $bucket->data = $data;

            $consumed += $bucket->datalen;
            stream_bucket_append($out, $bucket);
        }

        return \PSFS_PASS_ON;
    }
}