WinZipAesEncryptionStreamFilter::filter() - Code Metrics - Inspection of "Merge branch 'release/3.2.0'" - Ne-Lexa/php-zip - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3b7697...25d5dd )

by Alexey

created 2020-01-09 14:46 UTC

WinZipAesEncryptionStreamFilter::filter() C

↳ Parent: WinZipAesEncryptionStreamFilter

Complexity

Conditions	13
Paths	43

Size

Total Lines	79
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	13
eloc	45
c	1
b	0
f	1
nc	43
nop	4
dl	0
loc	79
rs	6.6166

How to fix Long Method Complexity

<?php

namespace PhpZip\IO\Filter\Cipher\WinZipAes;

use PhpZip\Exception\RuntimeException;
use PhpZip\Model\Extra\Fields\WinZipAesExtraField;
use PhpZip\Model\ZipEntry;

/**
 * Encrypt WinZip AES stream.
 */
class WinZipAesEncryptionStreamFilter extends \php_user_filter
{
    const FILTER_NAME = 'phpzip.encryption.winzipaes';

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

    /** @var int */
    private $remaining = 0;

    /** @var ZipEntry */
    private $entry;

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

    /** @var WinZipAesContext|null */
    private $context;

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

    /**
     * @return bool
     *
     * @noinspection DuplicatedCode
     */
    public function onCreate()
    {
        if (!isset($this->params['entry'])) {
            return false;
        }

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

        if (
            $this->entry->getPassword() === null ||
            !$this->entry->isEncrypted() ||
            !$this->entry->hasExtraField(WinZipAesExtraField::HEADER_ID)
        ) {
            return false;
        }

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

        return true;
    }

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

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

            $encryptionText = '';

            // write header
            if ($this->context === null) {
                /**
                 * @var WinZipAesExtraField|null $winZipExtra
                 */
                $winZipExtra = $this->entry->getExtraField(WinZipAesExtraField::HEADER_ID);

                if ($winZipExtra === null) {
                    throw new RuntimeException('$winZipExtra is null');
                }
                $saltSize = $winZipExtra->getSaltSize();

                try {
                    $salt = random_bytes($saltSize);
                } catch (\Exception $e) {
                    throw new \RuntimeException('Oops, our server is bust and cannot generate any random data.', 1, $e);
                }
                $password = $this->entry->getPassword();

                if ($password === null) {
                    throw new RuntimeException('$password is null');
                }
                $this->context = new WinZipAesContext(
                    $winZipExtra->getEncryptionStrength(),
                    $password,
                    $salt
                );

                $encryptionText .= $salt . $this->context->getPasswordVerifier();
            }

            // encrypt data
            $offset = 0;
            $len = \strlen($this->buffer);
            $remaining = $this->remaining - $this->size;

            if ($remaining >= WinZipAesContext::BLOCK_SIZE && $len < WinZipAesContext::BLOCK_SIZE) {
                return \PSFS_FEED_ME;
            }
            $limit = max($len, $remaining);

            if ($remaining > $limit && ($limit % WinZipAesContext::BLOCK_SIZE) !== 0) {
                $limit -= ($limit % WinZipAesContext::BLOCK_SIZE);
            }

            while ($offset < $limit) {
                $this->context->updateIv();
                $length = min(WinZipAesContext::BLOCK_SIZE, $limit - $offset);
                $encryptionText .= $this->context->encrypt(
                    substr($this->buffer, 0, $length)
                );
                $offset += $length;
                $this->buffer = substr($this->buffer, $length);
            }

            if ($remaining === 0) {
                $encryptionText .= $this->context->getHmac();
            }

            $bucket->data = $encryptionText;
            $consumed += $bucket->datalen;

            stream_bucket_append($out, $bucket);
        }

        return \PSFS_PASS_ON;
    }
}


1			<?php
2
3			namespace PhpZip\IO\Filter\Cipher\WinZipAes;
4
5			use PhpZip\Exception\RuntimeException;
6			use PhpZip\Model\Extra\Fields\WinZipAesExtraField;
7			use PhpZip\Model\ZipEntry;
8
9			/**
10			* Encrypt WinZip AES stream.
11			*/
12			class WinZipAesEncryptionStreamFilter extends \php_user_filter
13			{
14			const FILTER_NAME = 'phpzip.encryption.winzipaes';
15
16			/** @var string */
17			private $buffer;
18
19			/** @var int */
20			private $remaining = 0;
21
22			/** @var ZipEntry */
23			private $entry;
24
25			/** @var int */
26			private $size;
27
28			/** @var WinZipAesContext\|null */
29			private $context;
30
31			/**
32			* @return bool
33			*/
34			public static function register()
35			{
36			return stream_filter_register(self::FILTER_NAME, __CLASS__);
37			}
38
39			/**
40			* @return bool
41			*
42			* @noinspection DuplicatedCode
43			*/
44			public function onCreate()
45			{
46			if (!isset($this->params['entry'])) {
47			return false;
48			}
49
50			if (!($this->params['entry'] instanceof ZipEntry)) {
51			throw new \RuntimeException('ZipEntry expected');
52			}
53			$this->entry = $this->params['entry'];
54
55			if (
56			$this->entry->getPassword() === null \|\|
57			!$this->entry->isEncrypted() \|\|
58			!$this->entry->hasExtraField(WinZipAesExtraField::HEADER_ID)
59			) {
60			return false;
61			}
62
63			$this->size = (int) $this->params['size'];
64			$this->context = null;
65			$this->buffer = '';
66
67			return true;
68			}
69
70			/**
71			* @param resource $in
72			* @param resource $out
73			* @param int $consumed
74			* @param bool $closing
75			*
76			* @return int
77			*/
78			public function filter($in, $out, &$consumed, $closing)
79			{
80			while ($bucket = stream_bucket_make_writeable($in)) {
81			$this->buffer .= $bucket->data;
82			$this->remaining += $bucket->datalen;
83
84			if ($this->remaining > $this->size) {
85			$this->buffer = substr($this->buffer, 0, $this->size - $this->remaining);
86			$this->remaining = $this->size;
87			}
88
89			$encryptionText = '';
90
91			// write header
92			if ($this->context === null) {
93			/**
94			* @var WinZipAesExtraField\|null $winZipExtra
95			*/
96			$winZipExtra = $this->entry->getExtraField(WinZipAesExtraField::HEADER_ID);
97
98			if ($winZipExtra === null) {
99			throw new RuntimeException('$winZipExtra is null');
100			}
101			$saltSize = $winZipExtra->getSaltSize();
102
103			try {
104			$salt = random_bytes($saltSize);
105			} catch (\Exception $e) {
106			throw new \RuntimeException('Oops, our server is bust and cannot generate any random data.', 1, $e);
107			}
108			$password = $this->entry->getPassword();
109
110			if ($password === null) {
111			throw new RuntimeException('$password is null');
112			}
113			$this->context = new WinZipAesContext(
114			$winZipExtra->getEncryptionStrength(),
115			$password,
116			$salt
117			);
118
119			$encryptionText .= $salt . $this->context->getPasswordVerifier();
120			}
121
122			// encrypt data
123			$offset = 0;
124			$len = \strlen($this->buffer);
125			$remaining = $this->remaining - $this->size;
126
127			if ($remaining >= WinZipAesContext::BLOCK_SIZE && $len < WinZipAesContext::BLOCK_SIZE) {
128			return \PSFS_FEED_ME;
129			}
130			$limit = max($len, $remaining);
131
132			if ($remaining > $limit && ($limit % WinZipAesContext::BLOCK_SIZE) !== 0) {
133			$limit -= ($limit % WinZipAesContext::BLOCK_SIZE);
134			}
135
136			while ($offset < $limit) {
137			$this->context->updateIv();
138			$length = min(WinZipAesContext::BLOCK_SIZE, $limit - $offset);
139			$encryptionText .= $this->context->encrypt(
140			substr($this->buffer, 0, $length)
141			);
142			$offset += $length;
143			$this->buffer = substr($this->buffer, $length);
144			}
145
146			if ($remaining === 0) {
147			$encryptionText .= $this->context->getHmac();
148			}
149
150			$bucket->data = $encryptionText;
151			$consumed += $bucket->datalen;
152
153			stream_bucket_append($out, $bucket);
154			}
155
156			return \PSFS_PASS_ON;
157			}
158			}
159

Ne-Lexa / php-zip

Push — master ( 3b7697...25d5dd )

WinZipAesEncryptionStreamFilter::filter() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like