SetupTrait::setupiptablesBridgeDirectory() - Code Metrics - Inspection of "Improve code." - terrylinooo/shieldon - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.x ( f11ac1...7015c1 )

by Terry

created 2020-08-06 10:13 UTC

SetupTrait::setupiptablesBridgeDirectory() A

↳ Parent: SetupTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	7
rs	10

<?php
/**
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 * 
 * php version 7.1.0
 * 
 * @category  Web-security
 * @package   Shieldon
 * @author    Terry Lin <[email protected]>
 * @copyright 2019 terrylinooo
 * @license   https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
 * @link      https://github.com/terrylinooo/shieldon
 * @see       https://shieldon.io
 */

declare(strict_types=1);

namespace Shieldon\Firewall\Firewall;

use Psr\Http\Server\MiddlewareInterface;
use Shieldon\Firewall\Firewall\Captcha\CaptchaFactory;
use Shieldon\Firewall\Firewall\Driver\DriverFactory;
use Shieldon\Firewall\Log\ActionLogger;
use Shieldon\Firewall\Middleware\HttpAuthentication;
use function Shieldon\Firewall\get_request;
use function Shieldon\Firewall\get_session;

use RuntimeException;
use function strpos;
use function time;

/*
 * Main Trait for Firwall class.
 */
trait SetupTrait
{
    /**
     * If status is false and then Sheldon will stop working.
     *
     * @var bool
     */
    protected $status = true;

    /**
     * Get options from the configuration file.
     * This method is same as `$this->getConfig()` but returning value from array directly.
     *
     * @param string $option  The option of the section in the the configuration.
     * @param string $section The section in the configuration.
     *
     * @return mixed
     */
    abstract protected function getOption(string $option, string $section = '');

    /**
     * Update configuration file.
     *
     * @return void
     */
    abstract protected function updateConfig(): void;

    /**
     * Set a variable to the configuration.
     *
     * @param string $field The field of the configuration.
     * @param mixed  $value The vale of a field in the configuration.
     *
     * @return void
     */
    abstract public function setConfig(string $field, $value): void;

    /**
     * Add middlewares and use them before going into Shieldon kernal.
     *
     * @param MiddlewareInterface $middleware A PSR-15 middlewares.
     *
     * @return void
     */
    abstract public function add(MiddlewareInterface $middleware): void;

    /**
     * Are database tables created? 
     *
     * @return bool
     */
    abstract protected function hasCheckpoint(): bool;

    /**
     * Are database tables created?
     * 
     * @param bool $create Is create the checkpoint file, or not.
     *
     * @return void
     */
    abstract protected function setCheckpoint(bool $create = true): void;

    /**
     * Set a data driver for the use of Shiedon Firewall.
     * Currently supports File, Redis, MySQL and SQLite.
     *
     * @return void
     */
    protected function setupDriver(): void
    {
        $driverType = $this->getOption('driver_type');
        $driverSetting = $this->getOption($driverType, 'drivers');

        if (isset($driverSetting['directory_path'])) {
            $driverSetting['directory_path'] = $driverSetting['directory_path'] ?: $this->directory . '/data_driver_' . $driverType;
        }

        $driverInstance = DriverFactory::getInstance($driverType, $driverSetting);

        $this->status = false;
        if ($driverInstance !== null) {
            $this->kernel->setDriver($driverInstance);
            $this->status = true;
        }

        if ($this->hasCheckpoint()) {
            $this->kernel->disableDbBuilder();
        } else {
            $this->kernel->driver->init(true);
            $this->setCheckpoint();
        }
    }

    /**
     * Filters
     *
     * (1) Session.
     * (2) Cookie generated by JavaScript code.
     * (3) HTTP referrer information.
     * (4) Pageview frequency.
     *
     * @return void
     */
    protected function setupFilters(): void
    {
        $filters = [
            'session',
            'cookie',
            'referer',
        ];

        $settings = [];
        $filterConfig = [];
        $filterLimit = [];

        foreach ($filters as $filter) {
            $setting = $this->getOption($filter, 'filters');

            $settings[$filter] = $setting;
            $filterConfig[$filter] = $setting['enable'];
            $filterLimit[$filter] = $setting['config']['quota']; // default: 5

            unset($setting);
        }

        $settings['frequency'] = $this->getOption('frequency', 'filters');
        $filterConfig['frequency'] = $settings['frequency']['enable'];

        $this->kernel->setFilters($filterConfig);

        $this->kernel->setProperty(
            'limit_unusual_behavior',
            $filterLimit
        );

        $frequencyQuota = [
            's' => $settings['frequency']['config']['quota_s'],
            'm' => $settings['frequency']['config']['quota_m'],
            'h' => $settings['frequency']['config']['quota_h'],
            'd' => $settings['frequency']['config']['quota_d'],
        ];

        $this->kernel->setProperty('time_unit_quota', $frequencyQuota);

        $this->kernel->setProperty(
            'cookie_name',
            $settings['cookie']['config']['cookie_name'] // default: ssjd
        );

        $this->kernel->setProperty(
            'cookie_domain',
            $settings['cookie']['config']['cookie_domain'] // default: ''
        );

        $this->kernel->setProperty(
            'cookie_value',
            $settings['cookie']['config']['cookie_value'] // default: 1
        );

        $this->kernel->setProperty(
            'interval_check_referer',
            $settings['referer']['config']['time_buffer']
        );

        $this->kernel->setProperty(
            'interval_check_session',
            $settings['referer']['config']['time_buffer']
        );
    }

    /**
     * Components
     * 
     * (1) Ip
     * (2) Rdns
     * (3) Header
     * (4) User-agent
     * (5) Trusted bot
     *
     * @return void
     */
    protected function setupComponents(): void
    {
        $componentConfig = [
            'Ip'         => $this->getOption('ip', 'components'),
            'Rdns'       => $this->getOption('rdns', 'components'),
            'Header'     => $this->getOption('header', 'components'),
            'UserAgent'  => $this->getOption('user_agent', 'components'),
            'TrustedBot' => $this->getOption('trusted_bot', 'components'),
        ];

        foreach ($componentConfig as $className => $config) {
            $class = 'Shieldon\Firewall\Component\\' . $className;

            if ($config['enable']) {
                $componentInstance = new $class();

                if ($className === 'Ip') {
                    $this->kernel->setComponent($componentInstance);

                    // Need Ip component to be loaded before calling this method.
                    $this->setupAndApplyComponentIpManager();
                } else {
                    $componentInstance->setStrict($config['strict_mode']);
                    $this->kernel->setComponent($componentInstance);
                }
            }
        }
    }

    /**
     * Captcha modules.
     * 
     * (1) Google ReCaptcha
     * (2) Simple image captcha.
     *
     * @return void
     */
    protected function setupCaptchas(): void
    {
        $captchaList = [
            'recaptcha',
            'image',
        ];

        foreach ($captchaList as $captcha) {
            $setting = (array) $this->getOption($captcha, 'captcha_modules');

            // Initialize messenger instances from the factory/
            if (CaptchaFactory::check($setting)) {

                $this->kernel->setCaptcha(
                    CaptchaFactory::getInstance(
                        // The ID of the captcha module in the configuration.
                        $captcha, 
                        // The settings of the captcha module in the configuration.
                        $setting    
                    )
                );
            }

            unset($setting);
        }
    }

    /**
     * Set up the action logger.
     *
     * @return void
     */
    protected function setupLogger(): void
    {
        $loggerSetting = $this->getOption('action', 'loggers');

        if ($loggerSetting['enable']) {
            if (!empty($loggerSetting['config']['directory_path'])) {
                $this->kernel->setLogger(
                    new ActionLogger($loggerSetting['config']['directory_path'])
                );
            }
        }
    }

    /**
     * Apply the denied list and the allowed list to Ip Component.
     * 
     * @return void
     */
    protected function setupAndApplyComponentIpManager(): void
    {
        $ipList = (array) $this->getOption('ip_manager');

        $allowedList = [];
        $deniedList = [];

        foreach ($ipList as $ip) {

            if (0 === strpos($this->kernel->getCurrentUrl(), $ip['url']) ) {

                if ('allow' === $ip['rule']) {
                    $allowedList[] = $ip['ip'];
                }

                if ('deny' === $ip['rule']) {
                    $deniedList[] = $ip['ip'];
                }
            }
        }

        /** @scrutinizer ignore-call */ 
        $this->kernel->component['Ip']->setAllowedItems($allowedList);

        /** @scrutinizer ignore-call */ 
        $this->kernel->component['Ip']->setDeniedItems($deniedList);
    }

    /**
     * If you use CDN, please choose the real IP source.
     *
     * @return void
     */
    protected function setupIpSource(): void
    {
        $ipSourceType = $this->getOption('ip_variable_source');
        $serverParams = get_request()->getServerParams();

        /**
         * REMOTE_ADDR: general
         * HTTP_CF_CONNECTING_IP: Cloudflare
         * HTTP_X_FORWARDED_FOR: Google Cloud CDN, Google Load-balancer, AWS.
         * HTTP_X_FORWARDED_HOST: KeyCDN, or other CDN providers not listed here.
         */
        $key = array_search(true, $ipSourceType);
        $ip = $serverParams[$key];

        if (empty($ip)) {

            // @codeCoverageIgnoreStart
            throw new RuntimeException(
                'IP source is not set correctly.'
            );
            // @codeCoverageIgnoreEnd
        }

        $this->kernel->setIp($ip);
    }

    /**
     * Set deny attempts.
     *
     * @return void
     */
    protected function setupDenyTooManyAttempts(): void
    {
        $setting = $this->getOption('failed_attempts_in_a_row', 'events');

        $this->kernel->setProperty(
            'deny_attempt_enable',
            [
                'data_circle'     => $setting['data_circle']['enable'],     // false   
                'system_firewall' => $setting['system_firewall']['enable'], // false   
            ]
        );

        $this->kernel->setProperty(
            'deny_attempt_buffer',
            [
                'data_circle'     => $setting['data_circle']['buffer'],     // 10
                'system_firewall' => $setting['system_firewall']['buffer'], // 10
            ]
        );

        // Check the time of the last failed attempt.
        $recordAttempt = $this->getOption('record_attempt');

        $this->kernel->setProperty(
            'record_attempt_detection_period',
            $recordAttempt['detection_period'] // 5
        ); 

        $this->kernel->setProperty(
            'reset_attempt_counter',
            $recordAttempt['time_to_reset'] // 1800
        );  
    }

    /**
     * Set iptables working folder.
     *
     * @return void
     */
    protected function setupiptablesBridgeDirectory(): void
    {
        $iptablesSetting = $this->getOption('config', 'iptables');

        $this->kernel->setProperty(
            'iptables_watching_folder',
            $iptablesSetting['watching_folder']
        );
    }

    /**
     * Set the online session limit.
     *
     * @return void
     */
    protected function setupLimitSession(): void
    {
        $sessionLimitSetting = $this->getOption('online_session_limit');

        if ($sessionLimitSetting['enable']) {

            $onlineUsers = $sessionLimitSetting['config']['count'];       // default: 100
            $alivePeriod = $sessionLimitSetting['config']['period'];      // default: 300
            $isUniqueIp  = $sessionLimitSetting['config']['unique_only']; // false

            $this->kernel->limitSession($onlineUsers, $alivePeriod, $isUniqueIp);
        }
    }

    /**
     * Set the cron job.
     * This is triggered by the pageviews, not system cron job.
     *
     * @return void
     */
    protected function setupCronJob(): void 
    {
        $cronjobSetting = $this->getOption('reset_circle', 'cronjob');

        if ($cronjobSetting['enable']) {

            $nowTime = time();

            $lastResetTime = $cronjobSetting['config']['last_update'];

            if (!empty($lastResetTime) ) {
                $lastResetTime = strtotime($lastResetTime);
            } else {
                // @codeCoverageIgnoreStart

                $lastResetTime = strtotime(date('Y-m-d 00:00:00'));

                // @codeCoverageIgnoreEnd
            }

            if (($nowTime - $lastResetTime) > $cronjobSetting['config']['period']) {

                $updateResetTime = date('Y-m-d 00:00:00');

                // Update new reset time.
                $this->setConfig(
                    'cronjob.reset_circle.config.last_update',
                    $updateResetTime
                );

                $this->updateConfig();

                // Remove all logs.
                /** @scrutinizer ignore-call */ 
                $this->kernel->driver->rebuild();
            }
        }
    }

    /**
     * Set the URLs that want to be excluded from Shieldon protection.
     *
     * @return void
     */
    protected function setupExcludedUrls(): void
    {
        $excludedUrls = $this->getOption('excluded_urls');

        if (!empty($excludedUrls)) {
            $list = array_column($excludedUrls, 'url');

            $this->kernel->setExcludedList($list);
        }
    }

    /**
     * WWW-Athentication.
     *
     * @return void
     */
    protected function setupPageAuthentication(): void
    {
        $authenticateList = $this->getOption('www_authenticate');

        if (is_array($authenticateList)) {
            $this->add(
                new HttpAuthentication($authenticateList)
            );
        }
    }

    /**
     * Set dialog UI.
     *
     * @return void
     */
    protected function setupDialogUserInterface()
    {
        $ui = $this->getOption('dialog_ui');

        if (!empty($ui)) {
            get_session()->set('shieldon_ui_lang', $ui['lang']);
            $this->kernel->setDialog($this->getOption('dialog_ui'));
        }
    }
}


1			<?php
2			/**
3			* This file is part of the Shieldon package.
4			*
5			* (c) Terry L. <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*
10			* php version 7.1.0
11			*
12			* @category Web-security
13			* @package Shieldon
14			* @author Terry Lin <[email protected]>
15			* @copyright 2019 terrylinooo
16			* @license https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
17			* @link https://github.com/terrylinooo/shieldon
18			* @see https://shieldon.io
19			*/
20
21			declare(strict_types=1);
22
23			namespace Shieldon\Firewall\Firewall;
24
25			use Psr\Http\Server\MiddlewareInterface;
26			use Shieldon\Firewall\Firewall\Captcha\CaptchaFactory;
27			use Shieldon\Firewall\Firewall\Driver\DriverFactory;
28			use Shieldon\Firewall\Log\ActionLogger;
29			use Shieldon\Firewall\Middleware\HttpAuthentication;
30			use function Shieldon\Firewall\get_request;
31			use function Shieldon\Firewall\get_session;
32
33			use RuntimeException;
34			use function strpos;
35			use function time;
36
37			/*
38			* Main Trait for Firwall class.
39			*/
40			trait SetupTrait
41			{
42			/**
43			* If status is false and then Sheldon will stop working.
44			*
45			* @var bool
46			*/
47			protected $status = true;
48
49			/**
50			* Get options from the configuration file.
51			* This method is same as `$this->getConfig()` but returning value from array directly.
52			*
53			* @param string $option The option of the section in the the configuration.
54			* @param string $section The section in the configuration.
55			*
56			* @return mixed
57			*/
58			abstract protected function getOption(string $option, string $section = '');
59
60			/**
61			* Update configuration file.
62			*
63			* @return void
64			*/
65			abstract protected function updateConfig(): void;
66
67			/**
68			* Set a variable to the configuration.
69			*
70			* @param string $field The field of the configuration.
71			* @param mixed $value The vale of a field in the configuration.
72			*
73			* @return void
74			*/
75			abstract public function setConfig(string $field, $value): void;
76
77			/**
78			* Add middlewares and use them before going into Shieldon kernal.
79			*
80			* @param MiddlewareInterface $middleware A PSR-15 middlewares.
81			*
82			* @return void
83			*/
84			abstract public function add(MiddlewareInterface $middleware): void;
85
86			/**
87			* Are database tables created?
88			*
89			* @return bool
90			*/
91			abstract protected function hasCheckpoint(): bool;
92
93			/**
94			* Are database tables created?
95			*
96			* @param bool $create Is create the checkpoint file, or not.
97			*
98			* @return void
99			*/
100			abstract protected function setCheckpoint(bool $create = true): void;
101
102			/**
103			* Set a data driver for the use of Shiedon Firewall.
104			* Currently supports File, Redis, MySQL and SQLite.
105			*
106			* @return void
107			*/
108			protected function setupDriver(): void
109			{
110			$driverType = $this->getOption('driver_type');
111			$driverSetting = $this->getOption($driverType, 'drivers');
112
113			if (isset($driverSetting['directory_path'])) {
114			$driverSetting['directory_path'] = $driverSetting['directory_path'] ?: $this->directory . '/data_driver_' . $driverType;
115			}
116
117			$driverInstance = DriverFactory::getInstance($driverType, $driverSetting);
118
119			$this->status = false;
120			if ($driverInstance !== null) {
121			$this->kernel->setDriver($driverInstance);
122			$this->status = true;
123			}
124
125			if ($this->hasCheckpoint()) {
126			$this->kernel->disableDbBuilder();
127			} else {
128			$this->kernel->driver->init(true);
129			$this->setCheckpoint();
130			}
131			}
132
133			/**
134			* Filters
135			*
136			* (1) Session.
137			* (2) Cookie generated by JavaScript code.
138			* (3) HTTP referrer information.
139			* (4) Pageview frequency.
140			*
141			* @return void
142			*/
143			protected function setupFilters(): void
144			{
145			$filters = [
146			'session',
147			'cookie',
148			'referer',
149			];
150
151			$settings = [];
152			$filterConfig = [];
153			$filterLimit = [];
154
155			foreach ($filters as $filter) {
156			$setting = $this->getOption($filter, 'filters');
157
158			$settings[$filter] = $setting;
159			$filterConfig[$filter] = $setting['enable'];
160			$filterLimit[$filter] = $setting['config']['quota']; // default: 5
161
162			unset($setting);
163			}
164
165			$settings['frequency'] = $this->getOption('frequency', 'filters');
166			$filterConfig['frequency'] = $settings['frequency']['enable'];
167
168			$this->kernel->setFilters($filterConfig);
169
170			$this->kernel->setProperty(
171			'limit_unusual_behavior',
172			$filterLimit
173			);
174
175			$frequencyQuota = [
176			's' => $settings['frequency']['config']['quota_s'],
177			'm' => $settings['frequency']['config']['quota_m'],
178			'h' => $settings['frequency']['config']['quota_h'],
179			'd' => $settings['frequency']['config']['quota_d'],
180			];
181
182			$this->kernel->setProperty('time_unit_quota', $frequencyQuota);
183
184			$this->kernel->setProperty(
185			'cookie_name',
186			$settings['cookie']['config']['cookie_name'] // default: ssjd
187			);
188
189			$this->kernel->setProperty(
190			'cookie_domain',
191			$settings['cookie']['config']['cookie_domain'] // default: ''
192			);
193
194			$this->kernel->setProperty(
195			'cookie_value',
196			$settings['cookie']['config']['cookie_value'] // default: 1
197			);
198
199			$this->kernel->setProperty(
200			'interval_check_referer',
201			$settings['referer']['config']['time_buffer']
202			);
203
204			$this->kernel->setProperty(
205			'interval_check_session',
206			$settings['referer']['config']['time_buffer']
207			);
208			}
209
210			/**
211			* Components
212			*
213			* (1) Ip
214			* (2) Rdns
215			* (3) Header
216			* (4) User-agent
217			* (5) Trusted bot
218			*
219			* @return void
220			*/
221			protected function setupComponents(): void
222			{
223			$componentConfig = [
224			'Ip' => $this->getOption('ip', 'components'),
225			'Rdns' => $this->getOption('rdns', 'components'),
226			'Header' => $this->getOption('header', 'components'),
227			'UserAgent' => $this->getOption('user_agent', 'components'),
228			'TrustedBot' => $this->getOption('trusted_bot', 'components'),
229			];
230
231			foreach ($componentConfig as $className => $config) {
232			$class = 'Shieldon\Firewall\Component\\' . $className;
233
234			if ($config['enable']) {
235			$componentInstance = new $class();
236
237			if ($className === 'Ip') {
238			$this->kernel->setComponent($componentInstance);
239
240			// Need Ip component to be loaded before calling this method.
241			$this->setupAndApplyComponentIpManager();
242			} else {
243			$componentInstance->setStrict($config['strict_mode']);
244			$this->kernel->setComponent($componentInstance);
245			}
246			}
247			}
248			}
249
250			/**
251			* Captcha modules.
252			*
253			* (1) Google ReCaptcha
254			* (2) Simple image captcha.
255			*
256			* @return void
257			*/
258			protected function setupCaptchas(): void
259			{
260			$captchaList = [
261			'recaptcha',
262			'image',
263			];
264
265			foreach ($captchaList as $captcha) {
266			$setting = (array) $this->getOption($captcha, 'captcha_modules');
267
268			// Initialize messenger instances from the factory/
269			if (CaptchaFactory::check($setting)) {
270
271			$this->kernel->setCaptcha(
272			CaptchaFactory::getInstance(
273			// The ID of the captcha module in the configuration.
274			$captcha,
275			// The settings of the captcha module in the configuration.
276			$setting
277			)
278			);
279			}
280
281			unset($setting);
282			}
283			}
284
285			/**
286			* Set up the action logger.
287			*
288			* @return void
289			*/
290			protected function setupLogger(): void
291			{
292			$loggerSetting = $this->getOption('action', 'loggers');
293
294			if ($loggerSetting['enable']) {
295			if (!empty($loggerSetting['config']['directory_path'])) {
296			$this->kernel->setLogger(
297			new ActionLogger($loggerSetting['config']['directory_path'])
298			);
299			}
300			}
301			}
302
303			/**
304			* Apply the denied list and the allowed list to Ip Component.
305			*
306			* @return void
307			*/
308			protected function setupAndApplyComponentIpManager(): void
309			{
310			$ipList = (array) $this->getOption('ip_manager');
311
312			$allowedList = [];
313			$deniedList = [];
314
315			foreach ($ipList as $ip) {
316
317			if (0 === strpos($this->kernel->getCurrentUrl(), $ip['url']) ) {
318
319			if ('allow' === $ip['rule']) {
320			$allowedList[] = $ip['ip'];
321			}
322
323			if ('deny' === $ip['rule']) {
324			$deniedList[] = $ip['ip'];
325			}
326			}
327			}
328
329			/** @scrutinizer ignore-call */
330			$this->kernel->component['Ip']->setAllowedItems($allowedList);
331
332			/** @scrutinizer ignore-call */
333			$this->kernel->component['Ip']->setDeniedItems($deniedList);
334			}
335
336			/**
337			* If you use CDN, please choose the real IP source.
338			*
339			* @return void
340			*/
341			protected function setupIpSource(): void
342			{
343			$ipSourceType = $this->getOption('ip_variable_source');
344			$serverParams = get_request()->getServerParams();
345
346			/**
347			* REMOTE_ADDR: general
348			* HTTP_CF_CONNECTING_IP: Cloudflare
349			* HTTP_X_FORWARDED_FOR: Google Cloud CDN, Google Load-balancer, AWS.
350			* HTTP_X_FORWARDED_HOST: KeyCDN, or other CDN providers not listed here.
351			*/
352			$key = array_search(true, $ipSourceType);
353			$ip = $serverParams[$key];
354
355			if (empty($ip)) {
356
357			// @codeCoverageIgnoreStart
358			throw new RuntimeException(
359			'IP source is not set correctly.'
360			);
361			// @codeCoverageIgnoreEnd
362			}
363
364			$this->kernel->setIp($ip);
365			}
366
367			/**
368			* Set deny attempts.
369			*
370			* @return void
371			*/
372			protected function setupDenyTooManyAttempts(): void
373			{
374			$setting = $this->getOption('failed_attempts_in_a_row', 'events');
375
376			$this->kernel->setProperty(
377			'deny_attempt_enable',
378			[
379			'data_circle' => $setting['data_circle']['enable'], // false
380			'system_firewall' => $setting['system_firewall']['enable'], // false
381			]
382			);
383
384			$this->kernel->setProperty(
385			'deny_attempt_buffer',
386			[
387			'data_circle' => $setting['data_circle']['buffer'], // 10
388			'system_firewall' => $setting['system_firewall']['buffer'], // 10
389			]
390			);
391
392			// Check the time of the last failed attempt.
393			$recordAttempt = $this->getOption('record_attempt');
394
395			$this->kernel->setProperty(
396			'record_attempt_detection_period',
397			$recordAttempt['detection_period'] // 5
398			);
399
400			$this->kernel->setProperty(
401			'reset_attempt_counter',
402			$recordAttempt['time_to_reset'] // 1800
403			);
404			}
405
406			/**
407			* Set iptables working folder.
408			*
409			* @return void
410			*/
411			protected function setupiptablesBridgeDirectory(): void
412			{
413			$iptablesSetting = $this->getOption('config', 'iptables');
414
415			$this->kernel->setProperty(
416			'iptables_watching_folder',
417			$iptablesSetting['watching_folder']
418			);
419			}
420
421			/**
422			* Set the online session limit.
423			*
424			* @return void
425			*/
426			protected function setupLimitSession(): void
427			{
428			$sessionLimitSetting = $this->getOption('online_session_limit');
429
430			if ($sessionLimitSetting['enable']) {
431
432			$onlineUsers = $sessionLimitSetting['config']['count']; // default: 100
433			$alivePeriod = $sessionLimitSetting['config']['period']; // default: 300
434			$isUniqueIp = $sessionLimitSetting['config']['unique_only']; // false
435
436			$this->kernel->limitSession($onlineUsers, $alivePeriod, $isUniqueIp);
437			}
438			}
439
440			/**
441			* Set the cron job.
442			* This is triggered by the pageviews, not system cron job.
443			*
444			* @return void
445			*/
446			protected function setupCronJob(): void
447			{
448			$cronjobSetting = $this->getOption('reset_circle', 'cronjob');
449
450			if ($cronjobSetting['enable']) {
451
452			$nowTime = time();
453
454			$lastResetTime = $cronjobSetting['config']['last_update'];
455
456			if (!empty($lastResetTime) ) {
457			$lastResetTime = strtotime($lastResetTime);
458			} else {
459			// @codeCoverageIgnoreStart
460
461			$lastResetTime = strtotime(date('Y-m-d 00:00:00'));
462
463			// @codeCoverageIgnoreEnd
464			}
465
466			if (($nowTime - $lastResetTime) > $cronjobSetting['config']['period']) {
467
468			$updateResetTime = date('Y-m-d 00:00:00');
469
470			// Update new reset time.
471			$this->setConfig(
472			'cronjob.reset_circle.config.last_update',
473			$updateResetTime
474			);
475
476			$this->updateConfig();
477
478			// Remove all logs.
479			/** @scrutinizer ignore-call */
480			$this->kernel->driver->rebuild();
481			}
482			}
483			}
484
485			/**
486			* Set the URLs that want to be excluded from Shieldon protection.
487			*
488			* @return void
489			*/
490			protected function setupExcludedUrls(): void
491			{
492			$excludedUrls = $this->getOption('excluded_urls');
493
494			if (!empty($excludedUrls)) {
495			$list = array_column($excludedUrls, 'url');
496
497			$this->kernel->setExcludedList($list);
498			}
499			}
500
501			/**
502			* WWW-Athentication.
503			*
504			* @return void
505			*/
506			protected function setupPageAuthentication(): void
507			{
508			$authenticateList = $this->getOption('www_authenticate');
509
510			if (is_array($authenticateList)) {
511			$this->add(
512			new HttpAuthentication($authenticateList)
513			);
514			}
515			}
516
517			/**
518			* Set dialog UI.
519			*
520			* @return void
521			*/
522			protected function setupDialogUserInterface()
523			{
524			$ui = $this->getOption('dialog_ui');
525
526			if (!empty($ui)) {
527			get_session()->set('shieldon_ui_lang', $ui['lang']);
528			$this->kernel->setDialog($this->getOption('dialog_ui'));
529			}
530			}
531			}
532

terrylinooo / shieldon

Push — 2.x ( f11ac1...7015c1 )

SetupTrait::setupiptablesBridgeDirectory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like