SecurityConfigurationFactory::__construct() - Code Metrics - Inspection of "Some minor bugfixes for newinternal" - enwikipedia-acc/waca - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — newinternal (#285)

by Simon

created 2017-03-11 17:09 UTC

SecurityConfigurationFactory::__construct() A

↳ Parent: SecurityConfigurationFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
ccs	0
cts	4
cp	0
crap	2
rs	10
c	1
b	0
f	0

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Security;

final class SecurityConfigurationFactory
{
    /**
     * @var bool
     */
    private $forceIdentified;

    /**
     * Security constructor.
     *
     * @param bool $forceIdentified
     */
    public function __construct($forceIdentified)
    {
        $this->forceIdentified = $forceIdentified;
    }

    /**
     * Returns a pre-built security configuration for an internal page.
     *
     * @category Security-Critical
     * @return SecurityConfiguration
     */
    public function asInternalPage()
    {
        $config = new SecurityConfiguration();
        $config->setAdmin(SecurityConfiguration::ALLOW)
            ->setUser(SecurityConfiguration::ALLOW);

        $config->setRequireIdentified($this->forceIdentified);

        return $config;
    }

    /**
     * Returns a pre-built security configuration for a tool admin only page.
     *
     * @category Security-Critical
     * @return SecurityConfiguration
     */
    public function asAdminPage()
    {
        $config = new SecurityConfiguration();
        $config->setAdmin(SecurityConfiguration::ALLOW);

        $config->setRequireIdentified($this->forceIdentified);

        return $config;
    }

    /**
     * Returns a pre-built security configuration for a page accessible to *ALL* logged in users, including suspended
     * and new users. This probably isn't the setting you want.
     *
     * @category Security-Critical
     * @return SecurityConfiguration
     */
    public function asAllLoggedInUsersPage()
    {
        $config = new SecurityConfiguration();
        $config->setAdmin(SecurityConfiguration::ALLOW)
            ->setUser(SecurityConfiguration::ALLOW)
            ->setDeclined(SecurityConfiguration::ALLOW)
            ->setNew(SecurityConfiguration::ALLOW)
            ->setSuspended(SecurityConfiguration::ALLOW);

        $config->setRequireIdentified($this->forceIdentified);

        return $config;
    }

    /**
     * @return SecurityConfiguration
     * @category Security-Critical
     */
    public function asCheckUserData()
    {
        $config = new SecurityConfiguration();
        $config->setCheckuser(SecurityConfiguration::ALLOW)
            ->setCommunity(SecurityConfiguration::DENY)
            ->setSuspended(SecurityConfiguration::DENY)
            ->setDeclined(SecurityConfiguration::DENY)
            ->setNew(SecurityConfiguration::DENY);

        $config->setRequireIdentified($this->forceIdentified);

        return $config;
    }

    /**
     * Returns a pre-built security configuration for a public page.
     *
     * @category Security-Critical
     * @return SecurityConfiguration
     */
    public function asPublicPage()

    {
        $config = new SecurityConfiguration();
        $config->setAdmin(SecurityConfiguration::ALLOW)
            ->setUser(SecurityConfiguration::ALLOW)
            ->setCheckuser(SecurityConfiguration::ALLOW)
            ->setCommunity(SecurityConfiguration::ALLOW)
            ->setSuspended(SecurityConfiguration::ALLOW)
            ->setDeclined(SecurityConfiguration::ALLOW)
            ->setNew(SecurityConfiguration::ALLOW);

        // Public pages shouldn't be inaccessible to logged-in, unidentified users.
        // Otherwise, logged in but unidentified users can't even log out.
        $config->setRequireIdentified(false);

        return $config;
    }

    /**
     * Special case for zoom page private data.
     *
     * This will only return true if you are either a checkuser or a tool admin, taking special note of disabled
     * accounts which happen to be check users
     *
     * @return SecurityConfiguration
     */
    public function asGeneralPrivateDataAccess()

    {
        $config = new SecurityConfiguration();
        $config
            // Basic configuration, admins and check users allowed
            ->setAdmin(SecurityConfiguration::ALLOW)
            ->setCheckuser(SecurityConfiguration::ALLOW)
            // Deny these, even if they were allowed by the above
            ->setCommunity(SecurityConfiguration::DENY)
            ->setSuspended(SecurityConfiguration::DENY)
            ->setDeclined(SecurityConfiguration::DENY)
            ->setNew(SecurityConfiguration::DENY);

        // You must also be identified to access this data
        $config->setRequireIdentified($this->forceIdentified);

        return $config;
    }

    /**
     * @category Security-Critical
     * @return SecurityConfiguration
     */
    public function asNone()
    {
        $config = new SecurityConfiguration();

        return $config;
    }
}

1		<?php
2		/******************************************************************************
3		* Wikipedia Account Creation Assistance tool *
4		* *
5		* All code in this file is released into the public domain by the ACC *
6		* Development Team. Please see team.json for a list of contributors. *
7		******************************************************************************/
8
9		namespace Waca\Security;
10
11		final class SecurityConfigurationFactory
12		{
13		/**
14		* @var bool
15		*/
16		private $forceIdentified;
17
18		/**
19		* Security constructor.
20		*
21		* @param bool $forceIdentified
22		*/
23		public function __construct($forceIdentified)
24		{
25		$this->forceIdentified = $forceIdentified;
26		}
27
28		/**
29		* Returns a pre-built security configuration for an internal page.
30		*
31		* @category Security-Critical
32		* @return SecurityConfiguration
33		*/
34		public function asInternalPage()
35		{
36		$config = new SecurityConfiguration();
37		$config->setAdmin(SecurityConfiguration::ALLOW)
38		->setUser(SecurityConfiguration::ALLOW);
39
40		$config->setRequireIdentified($this->forceIdentified);
41
42		return $config;
43		}
44
45		/**
46		* Returns a pre-built security configuration for a tool admin only page.
47		*
48		* @category Security-Critical
49		* @return SecurityConfiguration
50		*/
51		public function asAdminPage()
52		{
53		$config = new SecurityConfiguration();
54		$config->setAdmin(SecurityConfiguration::ALLOW);
55
56		$config->setRequireIdentified($this->forceIdentified);
57
58		return $config;
59		}
60
61		/**
62		* Returns a pre-built security configuration for a page accessible to ALL logged in users, including suspended
63		* and new users. This probably isn't the setting you want.
64		*
65		* @category Security-Critical
66		* @return SecurityConfiguration
67		*/
68		public function asAllLoggedInUsersPage()
69		{
70		$config = new SecurityConfiguration();
71		$config->setAdmin(SecurityConfiguration::ALLOW)
72		->setUser(SecurityConfiguration::ALLOW)
73		->setDeclined(SecurityConfiguration::ALLOW)
74		->setNew(SecurityConfiguration::ALLOW)
75		->setSuspended(SecurityConfiguration::ALLOW);
76
77		$config->setRequireIdentified($this->forceIdentified);
78
79		return $config;
80		}
81
82		/**
83		* @return SecurityConfiguration
84		* @category Security-Critical
85		*/
86		public function asCheckUserData()
87		{
88		$config = new SecurityConfiguration();
89		$config->setCheckuser(SecurityConfiguration::ALLOW)
90		->setCommunity(SecurityConfiguration::DENY)
91		->setSuspended(SecurityConfiguration::DENY)
92		->setDeclined(SecurityConfiguration::DENY)
93		->setNew(SecurityConfiguration::DENY);
94
95		$config->setRequireIdentified($this->forceIdentified);
96
97		return $config;
98		}
99
100		/**
101		* Returns a pre-built security configuration for a public page.
102		*
103		* @category Security-Critical
104		* @return SecurityConfiguration
105		*/
106	View Code Duplication	public function asPublicPage()
		0 ignored issues – show Duplication introduced 2016-04-08 00:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
107		{
108		$config = new SecurityConfiguration();
109		$config->setAdmin(SecurityConfiguration::ALLOW)
110		->setUser(SecurityConfiguration::ALLOW)
111		->setCheckuser(SecurityConfiguration::ALLOW)
112		->setCommunity(SecurityConfiguration::ALLOW)
113		->setSuspended(SecurityConfiguration::ALLOW)
114		->setDeclined(SecurityConfiguration::ALLOW)
115		->setNew(SecurityConfiguration::ALLOW);
116
117		// Public pages shouldn't be inaccessible to logged-in, unidentified users.
118		// Otherwise, logged in but unidentified users can't even log out.
119		$config->setRequireIdentified(false);
120
121		return $config;
122		}
123
124		/**
125		* Special case for zoom page private data.
126		*
127		* This will only return true if you are either a checkuser or a tool admin, taking special note of disabled
128		* accounts which happen to be check users
129		*
130		* @return SecurityConfiguration
131		*/
132	View Code Duplication	public function asGeneralPrivateDataAccess()
		0 ignored issues – show Duplication introduced 2016-04-08 00:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
133		{
134		$config = new SecurityConfiguration();
135		$config
136		// Basic configuration, admins and check users allowed
137		->setAdmin(SecurityConfiguration::ALLOW)
138		->setCheckuser(SecurityConfiguration::ALLOW)
139		// Deny these, even if they were allowed by the above
140		->setCommunity(SecurityConfiguration::DENY)
141		->setSuspended(SecurityConfiguration::DENY)
142		->setDeclined(SecurityConfiguration::DENY)
143		->setNew(SecurityConfiguration::DENY);
144
145		// You must also be identified to access this data
146		$config->setRequireIdentified($this->forceIdentified);
147
148		return $config;
149		}
150
151		/**
152		* @category Security-Critical
153		* @return SecurityConfiguration
154		*/
155		public function asNone()
156		{
157		$config = new SecurityConfiguration();
158
159		return $config;
160		}
161		}

enwikipedia-acc / waca

Pull Request — newinternal (#285)

SecurityConfigurationFactory::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like