Device_XML::writeDeviceInfo() - Code Metrics - Inspection of "deleted unused method" - GEANT/CAT - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9af84e...7cf688 )

by Tomasz

created 2017-12-30 15:48 UTC

Device_XML::writeDeviceInfo() A

↳ Parent: Device_XML

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0

<?php
/* 
 *******************************************************************************
 * Copyright 2011-2017 DANTE Ltd. and GÉANT on behalf of the GN3, GN3+, GN4-1 
 * and GN4-2 consortia
 *
 * License: see the web/copyright.php file in the file structure
 *******************************************************************************
 */

/**
 * This file defines an abstract class used for generic XML
 * devices
 * actual modules only define available EAP types.
 *
 * @author Maja Gorecka-Wolniewicz <[email protected]>
 * @author Tomasz Wolniewicz <[email protected]>
 *
 * @package ModuleWriting
 */
namespace devices\xml;
require_once(dirname(__FILE__).'/XML.inc.php');

/**
 * This class implements full functionality of the generic XML device
 * the only fuction of the extenstions of this class is to specify
 * supported EAP methods.
 * Instead of specifying supported EAPS an extension can set $all_eaps to true
 * this will cause the installer to configure all EAP methods supported by 
 * the current profile and declared by the given device.
 */
abstract class Device_XML extends \core\DeviceConfig {

    public function __construct() {
        parent::__construct();
    }

    /**
     * $lang_scope can be 'global' wheb all lang and all lang-specific information
     * is dumped or 'single' when only the selected lang (and defaults) are passed
     * NOTICE: 'global' is not yet supported
     */
    public $langScope;
    public $allEaps = FALSE;
    public $VendorSpecific;

    public function writeDeviceInfo() {
        $out = "<p>";
        $out .= sprintf(_("This is a generic configuration file in the IETF <a href='%s'>EAP Metadata -00</a> XML format."), "https://tools.ietf.org/html/draft-winter-opsawg-eap-metadata-00");
        return $out;
    }

    public function writeInstaller() {
        $attr = $this->attributes;
        $NAMESPACE = 'urn:RFC4282:realm';
//EAPIdentityProvider  begin
        $eapIdp = new EAPIdentityProvider();
//    $eap_idp->setProperty('ValidUntil',$this->getValidUntil());

// ProviderInfo->
        $eapIdp->setProperty('ProviderInfo', $this->getProviderInfo());
// TODO    $eap_idp->setProperty('VendorSpecific',$this->getVendorSpecific());

//AuthenticationMethods
// TODO
//ID attribute
//lang attribute
        $methodList = [];
        $this->loggerInstance->debug(4,"ALLEAP\n");
        $this->loggerInstance->debug(4,$attr['all_eaps']);
        if ($this->allEaps) {
            $eapmethods = [];
            foreach ($attr['all_eaps'] as $eap) {
                if (in_array($eap, $this->supportedEapMethods)) {
                    $eapmethods[] = $eap;
                }
            }
        } else {
            $eapmethods = [$this->selectedEap];
        }
        foreach ($eapmethods as $eap) {
            $methodList[] = $this->getAuthMethod($eap);
        }
        $authMethods = new AuthenticationMethods();
        $authMethods->setProperty('AuthenticationMethods', $methodList);
        $eapIdp->setProperty('AuthenticationMethods', $authMethods);
        if (empty($attr['internal:realm'][0])) {
            $eapIdp->setAttribute('ID', 'undefined');
            $eapIdp->setAttribute('namespace', 'urn:undefined');
        } else {
            $eapIdp->setAttribute('ID', $attr['internal:realm'][0]);
            $eapIdp->setAttribute('namespace', $NAMESPACE);
        }
        if ($this->langScope === 'single') {
            $eapIdp->setAttribute('lang', $this->languageInstance->getLang());
        }
        $eapIdp->setAttribute('version', '1');


// EAPIdentityProvider end
// Generate XML

        $rootname = 'EAPIdentityProviderList';
        $root = new \SimpleXMLElement("<?xml version=\"1.0\" encoding=\"utf-8\" ?><{$rootname} xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"eap-metadata.xsd\"></{$rootname}>");

        marshalObject($root, $eapIdp);
        $dom = dom_import_simplexml($root)->ownerDocument;
        //TODO schema validation makes sense so probably should be used
        $res = $dom->schemaValidate(ROOT . '/devices/xml/eap-metadata.xsd');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        file_put_contents($this->installerBasename . '.eap-config', $dom->saveXML());
        return($this->installerBasename . '.eap-config');
    }

    private $AttributeNames = [
        'support:email' => 'EmailAddress',
        'support:url' => 'WebAddress',
        'support:phone' => 'Phone',
        'profile:description' => 'Description',
        'support:info_file' => 'TermsOfUse',
        'general:logo_file' => 'ProviderLogo',
    ];

    /**
     * 
     * @param string $attrName
     * @return array of values for this attribute
     */
    private function getSimpleMLAttribute($attrName) {
        if ((!isset($this->attributes[$attrName][0]) || !$this->attributes[$attrName][0])) {
            return '';
        }

        $attributeList = $this->attributes[$attrName];
        if (!isset($this->AttributeNames[$attrName])) {
            $this->loggerInstance->debug(4, "Missing class definition for $attrName\n");
            return;
        }
        $className = "\devices\xml\\" . $this->AttributeNames[$attrName];
        $objs = [];
        if ($this->langScope === 'global') {
            foreach ($attributeList['langs'] as $language => $value) {
                $language = ( $language === 'C' ? 'any' : $language );
                $obj = new $className();
                $obj->setValue($value);
                $obj->setAttributes(['lang' => $language]);
                $objs[] = $obj;
            }
        } else {
            $obj = new $className();
            $obj->setValue($attributeList[0]);
            $objs[] = $obj;
        }

        return($objs);
    }

    private function getDisplayName() {
        $attr = $this->attributes;
        $objs = [];
        if ($this->langScope === 'global') {
            $instNameLangs = $attr['general:instname']['langs'];
            if ($attr['internal:profile_count'][0] > 1) {
                $profileNameLangs = $attr['profile:name']['langs'];
            }
            foreach ($instNameLangs as $language => $value) {
                $language = ( $language === 'C' ? 'any' : $language );
                $displayname = new DisplayName();
                if (isset($profileNameLangs)) {
                    $langOrC = isset($profileNameLangs[$language]) ? $profileNameLangs[$language] : $profileNameLangs['C'];
                    $value .= ' - ' . $langOrC;
                }
                $displayname->setValue($value);
                $displayname->setAttributes(['lang' => $language]);
                $objs[] = $displayname;
            }
        } else {
            $displayname = new DisplayName();
            $value = $attr['general:instname'][0];
            if ($attr['internal:profile_count'][0] > 1) {
                $value .= ' - ' . $attr['profile:name'][0];
            }
            $displayname->setValue($value);
            $objs[] = $displayname;
        }
        return $objs;
    }

    private function getProviderLogo() {
        $attr = $this->attributes;
        if (isset($attr['general:logo_file'][0])) {
            $logoString = base64_encode($attr['general:logo_file'][0]);
            $logoMime = 'image/' . $attr['internal:logo_file'][0]['mime'];
            $providerlogo = new ProviderLogo();
            $providerlogo->setAttributes(['mime' => $logoMime, 'encoding' => 'base64']);
            $providerlogo->setValue($logoString);
            return $providerlogo;
        }
    }

    private function getProviderInfo() {
        $providerinfo = new ProviderInfo();
        $providerinfo->setProperty('DisplayName', $this->getDisplayName());
        $providerinfo->setProperty('Description', $this->getSimpleMLAttribute('profile:description'));
        $providerinfo->setProperty('ProviderLocation', $this->getProvideLocation());
        $providerinfo->setProperty('ProviderLogo', $this->getProviderLogo());
        $providerinfo->setProperty('TermsOfUse', $this->getSimpleMLAttribute('support:info_file'));
        $providerinfo->setProperty('Helpdesk', $this->getHelpdesk());
        return $providerinfo;
    }

    private function getProvideLocation() {
        $attr = $this->attributes;
        if (isset($attr['general:geo_coordinates'])) {
            $attrCoordinates = $attr['general:geo_coordinates'];
            if (count($attrCoordinates) > 1) {
                $location = [];
                foreach ($attrCoordinates as $a) {
                    $providerlocation = new ProviderLocation();
                    $b = json_decode($a, true);
                    $providerlocation->setProperty('Longitude', $b['lon']);
                    $providerlocation->setProperty('Latitude', $b['lat']);
                    $location[] = $providerlocation;
                }
            } else {
                $providerlocation = new ProviderLocation();
                $b = json_decode($attrCoordinates[0], true);
                $providerlocation->setProperty('Longitude', $b['lon']);
                $providerlocation->setProperty('Latitude', $b['lat']);
                $location = $providerlocation;
            }
            return $location;
        }
    }

    private function getHelpdesk() {
        $helpdesk = new Helpdesk();
        $helpdesk->setProperty('EmailAddress', $this->getSimpleMLAttribute('support:email'));
        $helpdesk->setProperty('WebAddress', $this->getSimpleMLAttribute('support:url'));
        $helpdesk->setProperty('Phone', $this->getSimpleMLAttribute('support:phone'));
        return $helpdesk;
    }

/* This function is not currently used.

 * 
 *     private function getCompatibleUses() {
        $ssids = $this->attributes['internal:SSID'];
        $compatibleuses = new CompatibleUses();
        $ieee80211s = [];
        foreach ($ssids as $ssid => $ciph) {
            $ieee80211 = new IEEE80211();
            $ieee80211->setProperty('SSID', $ssid);
            $ieee80211->setProperty('MinRSNProto', $ciph == 'AES' ? 'CCMP' : 'TKIP');
            $ieee80211s[] = $ieee80211;
        }
        $compatibleuses->setProperty('IEEE80211', $ieee80211s);
        return($compatibleuses);
    }

*/
    private function getAuthenticationMethodParams($eap) {
        $inner = \core\common\EAP::innerAuth($eap);
        $outerMethod = $eap["OUTER"];

        if (isset($inner["METHOD"]) && $inner["METHOD"]) {
            $innerauthmethod = new InnerAuthenticationMethod();
            $typeOfInner = "\devices\xml\\" . ($inner["EAP"] ? 'EAPMethod' : 'NonEAPAuthMethod');
            $eapmethod = new $typeOfInner();
            $eaptype = new Type();
            $eaptype->setValue($inner['METHOD']);
            $eapmethod->setProperty('Type', $eaptype);
            $innerauthmethod->setProperty($typeOfInner, $eapmethod);
            return ['inner_method' => $innerauthmethod, 'methodID' => $outerMethod, 'inner_methodID' => $inner['METHOD']];
        } else {
            return ['inner_method' => 0, 'methodID' => $outerMethod, 'inner_methodID' => 0];
        }
    }

    private function setServerSideCredentials($eaptype) {
        $attr = $this->attributes;
        $serversidecredential = new ServerSideCredential();
// Certificates and server names
        $cAlist = [];
        $attrCaList = $attr['internal:CAs'][0];
        foreach ($attrCaList as $ca) {
            $caObject = new CA();
            $caObject->setValue(base64_encode($ca['der']));
            $caObject->setAttributes(['format' => 'X.509', 'encoding' => 'base64']);
            $cAlist[] = $caObject;
        }
        $serverids = [];
        $servers = $attr['eap:server_name'];
        foreach ($servers as $server) {
            $serverid = new ServerID();
            $serverid->setValue($server);
            $serverids[] = $serverid;
        }
        $serversidecredential->setProperty('EAPType', $eaptype->getValue());
        $serversidecredential->setProperty('CA', $cAlist);
        $serversidecredential->setProperty('ServerID', $serverids);
        return($serversidecredential);
    }
    
    private function setClientSideCredentials($eapParams) {
        $attr = $this->attributes;
        $clientsidecredential = new ClientSideCredential();
// OuterIdentity 
        if ($attr['internal:use_anon_outer'] [0]) {
            $clientsidecredential->setProperty('OuterIdentity', $attr['internal:anon_local_value'][0] . '@' . $attr['internal:realm'][0]);
        }
        $clientsidecredential->setProperty('EAPType', $eapParams['inner_methodID'] ? $eapParams['inner_methodID'] : $eapParams['methodID']);
        
        // Client Certificate
        if ($this->selectedEap == \core\common\EAP::EAPTYPE_SILVERBULLET) {
            $clientCertificateObject = new ClientCertificate();
            $clientCertificateObject->setValue(base64_encode($this->clientCert["certdata"]));
            $clientCertificateObject->setAttributes(['format' => 'PKCS12', 'encoding' => 'base64']);
            $clientsidecredential->setProperty('ClientCertificate',$clientCertificateObject);
        }
        return($clientsidecredential);
    }
    
    private function setEapMethod($eaptype) {
        $attr = $this->attributes;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $eapmethod = new EAPMethod();
        $eapmethod->setProperty('Type', $eaptype);
        if (isset($this->VendorSpecific)) {
            $vendorspecifics = [];
            foreach ($this->VendorSpecific as $vs) {
                $vendorspecific = new VendorSpecific();
                $vs['value']->addAttribute('xsi:noNamespaceSchemaLocation', "xxx.xsd");
                $vendorspecific->setValue($vs['value']);
                $vendorspecific->setAttributes(['vendor' => $vs['vendor']]);
                $vendorspecifics[] = $vendorspecific;
            }
            $eapmethod->setProperty('VendorSpecific', $vendorspecifics);
        }
        return($eapmethod);
    }
    
    private function getAuthMethod($eap) {
 //       $attr = $this->attributes;

        $authmethod = new AuthenticationMethod();
        $eapParams = $this->getAuthenticationMethodParams($eap);
        $eaptype = new Type();
        $eaptype->setValue($eapParams['methodID']);
// Type
        $authmethod->setProperty('EAPMethod', $this->setEapMethod($eaptype));

// ServerSideCredentials
        $authmethod->setProperty('ServerSideCredential', $this->setServerSideCredentials($eaptype));

// ClientSideCredentials
        $authmethod->setProperty('ClientSideCredential', $this->setClientSideCredentials($eapParams));
        
        if ($eapParams['inner_method']) {
            $authmethod->setProperty('InnerAuthenticationMethod', $eapParams['inner_method']);
        }
        return $authmethod;


    }
    


}


1			<?php
2			/*
3			*******************************************************************************
4			* Copyright 2011-2017 DANTE Ltd. and GÉANT on behalf of the GN3, GN3+, GN4-1
5			* and GN4-2 consortia
6			*
7			* License: see the web/copyright.php file in the file structure
8			*******************************************************************************
9			*/
10
11			/**
12			* This file defines an abstract class used for generic XML
13			* devices
14			* actual modules only define available EAP types.
15			*
16			* @author Maja Gorecka-Wolniewicz <[email protected]>
17			* @author Tomasz Wolniewicz <[email protected]>
18			*
19			* @package ModuleWriting
20			*/
21			namespace devices\xml;
22			require_once(dirname(__FILE__).'/XML.inc.php');
23
24			/**
25			* This class implements full functionality of the generic XML device
26			* the only fuction of the extenstions of this class is to specify
27			* supported EAP methods.
28			* Instead of specifying supported EAPS an extension can set $all_eaps to true
29			* this will cause the installer to configure all EAP methods supported by
30			* the current profile and declared by the given device.
31			*/
32			abstract class Device_XML extends \core\DeviceConfig {
33
34			public function __construct() {
35			parent::__construct();
36			}
37
38			/**
39			* $lang_scope can be 'global' wheb all lang and all lang-specific information
40			* is dumped or 'single' when only the selected lang (and defaults) are passed
41			* NOTICE: 'global' is not yet supported
42			*/
43			public $langScope;
44			public $allEaps = FALSE;
45			public $VendorSpecific;
46
47			public function writeDeviceInfo() {
48			$out = "<p>";
49			$out .= sprintf(_("This is a generic configuration file in the IETF <a href='%s'>EAP Metadata -00</a> XML format."), "https://tools.ietf.org/html/draft-winter-opsawg-eap-metadata-00");
50			return $out;
51			}
52
53			public function writeInstaller() {
54			$attr = $this->attributes;
55			$NAMESPACE = 'urn:RFC4282:realm';
56			//EAPIdentityProvider begin
57			$eapIdp = new EAPIdentityProvider();
58			// $eap_idp->setProperty('ValidUntil',$this->getValidUntil());
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-23 14:00 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
59			// ProviderInfo->
60			$eapIdp->setProperty('ProviderInfo', $this->getProviderInfo());
61			// TODO $eap_idp->setProperty('VendorSpecific',$this->getVendorSpecific());
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-23 14:00 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
62			//AuthenticationMethods
63			// TODO
64			//ID attribute
65			//lang attribute
66			$methodList = [];
67			$this->loggerInstance->debug(4,"ALLEAP\n");
68			$this->loggerInstance->debug(4,$attr['all_eaps']);
69			if ($this->allEaps) {
70			$eapmethods = [];
71			foreach ($attr['all_eaps'] as $eap) {
72			if (in_array($eap, $this->supportedEapMethods)) {
73			$eapmethods[] = $eap;
74			}
75			}
76			} else {
77			$eapmethods = [$this->selectedEap];
78			}
79			foreach ($eapmethods as $eap) {
80			$methodList[] = $this->getAuthMethod($eap);
81			}
82			$authMethods = new AuthenticationMethods();
83			$authMethods->setProperty('AuthenticationMethods', $methodList);
84			$eapIdp->setProperty('AuthenticationMethods', $authMethods);
85			if (empty($attr['internal:realm'][0])) {
86			$eapIdp->setAttribute('ID', 'undefined');
87			$eapIdp->setAttribute('namespace', 'urn:undefined');
88			} else {
89			$eapIdp->setAttribute('ID', $attr['internal:realm'][0]);
90			$eapIdp->setAttribute('namespace', $NAMESPACE);
91			}
92			if ($this->langScope === 'single') {
93			$eapIdp->setAttribute('lang', $this->languageInstance->getLang());
94			}
95			$eapIdp->setAttribute('version', '1');
96
97
98			// EAPIdentityProvider end
99			// Generate XML
100
101			$rootname = 'EAPIdentityProviderList';
102			$root = new \SimpleXMLElement("<?xml version=\"1.0\" encoding=\"utf-8\" ?><{$rootname} xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"eap-metadata.xsd\"></{$rootname}>");
103
104			marshalObject($root, $eapIdp);
105			$dom = dom_import_simplexml($root)->ownerDocument;
106			//TODO schema validation makes sense so probably should be used
107			$res = $dom->schemaValidate(ROOT . '/devices/xml/eap-metadata.xsd');
			0 ignored issues – show Unused Code introduced 2016-08-23 14:00 UTC by Report Bug Copy Issue Report `$res` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
108			file_put_contents($this->installerBasename . '.eap-config', $dom->saveXML());
109			return($this->installerBasename . '.eap-config');
110			}
111
112			private $AttributeNames = [
113			'support:email' => 'EmailAddress',
114			'support:url' => 'WebAddress',
115			'support:phone' => 'Phone',
116			'profile:description' => 'Description',
117			'support:info_file' => 'TermsOfUse',
118			'general:logo_file' => 'ProviderLogo',
119			];
120
121			/**
122			*
123			* @param string $attrName
124			* @return array of values for this attribute
125			*/
126			private function getSimpleMLAttribute($attrName) {
127			if ((!isset($this->attributes[$attrName][0]) \|\| !$this->attributes[$attrName][0])) {
128			return '';
129			}
130
131			$attributeList = $this->attributes[$attrName];
132			if (!isset($this->AttributeNames[$attrName])) {
133			$this->loggerInstance->debug(4, "Missing class definition for $attrName\n");
134			return;
135			}
136			$className = "\devices\xml\\" . $this->AttributeNames[$attrName];
137			$objs = [];
138			if ($this->langScope === 'global') {
139			foreach ($attributeList['langs'] as $language => $value) {
140			$language = ( $language === 'C' ? 'any' : $language );
141			$obj = new $className();
142			$obj->setValue($value);
143			$obj->setAttributes(['lang' => $language]);
144			$objs[] = $obj;
145			}
146			} else {
147			$obj = new $className();
148			$obj->setValue($attributeList[0]);
149			$objs[] = $obj;
150			}
151
152			return($objs);
153			}
154
155			private function getDisplayName() {
156			$attr = $this->attributes;
157			$objs = [];
158			if ($this->langScope === 'global') {
159			$instNameLangs = $attr['general:instname']['langs'];
160			if ($attr['internal:profile_count'][0] > 1) {
161			$profileNameLangs = $attr['profile:name']['langs'];
162			}
163			foreach ($instNameLangs as $language => $value) {
164			$language = ( $language === 'C' ? 'any' : $language );
165			$displayname = new DisplayName();
166			if (isset($profileNameLangs)) {
167			$langOrC = isset($profileNameLangs[$language]) ? $profileNameLangs[$language] : $profileNameLangs['C'];
168			$value .= ' - ' . $langOrC;
169			}
170			$displayname->setValue($value);
171			$displayname->setAttributes(['lang' => $language]);
172			$objs[] = $displayname;
173			}
174			} else {
175			$displayname = new DisplayName();
176			$value = $attr['general:instname'][0];
177			if ($attr['internal:profile_count'][0] > 1) {
178			$value .= ' - ' . $attr['profile:name'][0];
179			}
180			$displayname->setValue($value);
181			$objs[] = $displayname;
182			}
183			return $objs;
184			}
185
186			private function getProviderLogo() {
187			$attr = $this->attributes;
188			if (isset($attr['general:logo_file'][0])) {
189			$logoString = base64_encode($attr['general:logo_file'][0]);
190			$logoMime = 'image/' . $attr['internal:logo_file'][0]['mime'];
191			$providerlogo = new ProviderLogo();
192			$providerlogo->setAttributes(['mime' => $logoMime, 'encoding' => 'base64']);
193			$providerlogo->setValue($logoString);
194			return $providerlogo;
195			}
196			}
197
198			private function getProviderInfo() {
199			$providerinfo = new ProviderInfo();
200			$providerinfo->setProperty('DisplayName', $this->getDisplayName());
201			$providerinfo->setProperty('Description', $this->getSimpleMLAttribute('profile:description'));
202			$providerinfo->setProperty('ProviderLocation', $this->getProvideLocation());
203			$providerinfo->setProperty('ProviderLogo', $this->getProviderLogo());
204			$providerinfo->setProperty('TermsOfUse', $this->getSimpleMLAttribute('support:info_file'));
205			$providerinfo->setProperty('Helpdesk', $this->getHelpdesk());
206			return $providerinfo;
207			}
208
209			private function getProvideLocation() {
210			$attr = $this->attributes;
211			if (isset($attr['general:geo_coordinates'])) {
212			$attrCoordinates = $attr['general:geo_coordinates'];
213			if (count($attrCoordinates) > 1) {
214			$location = [];
215			foreach ($attrCoordinates as $a) {
216			$providerlocation = new ProviderLocation();
217			$b = json_decode($a, true);
218			$providerlocation->setProperty('Longitude', $b['lon']);
219			$providerlocation->setProperty('Latitude', $b['lat']);
220			$location[] = $providerlocation;
221			}
222			} else {
223			$providerlocation = new ProviderLocation();
224			$b = json_decode($attrCoordinates[0], true);
225			$providerlocation->setProperty('Longitude', $b['lon']);
226			$providerlocation->setProperty('Latitude', $b['lat']);
227			$location = $providerlocation;
228			}
229			return $location;
230			}
231			}
232
233			private function getHelpdesk() {
234			$helpdesk = new Helpdesk();
235			$helpdesk->setProperty('EmailAddress', $this->getSimpleMLAttribute('support:email'));
236			$helpdesk->setProperty('WebAddress', $this->getSimpleMLAttribute('support:url'));
237			$helpdesk->setProperty('Phone', $this->getSimpleMLAttribute('support:phone'));
238			return $helpdesk;
239			}
240
241			/* This function is not currently used.
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-12-13 14:32 UTC by Report Bug Copy Issue Report `53%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
242			*
243			* private function getCompatibleUses() {
244			$ssids = $this->attributes['internal:SSID'];
245			$compatibleuses = new CompatibleUses();
246			$ieee80211s = [];
247			foreach ($ssids as $ssid => $ciph) {
248			$ieee80211 = new IEEE80211();
249			$ieee80211->setProperty('SSID', $ssid);
250			$ieee80211->setProperty('MinRSNProto', $ciph == 'AES' ? 'CCMP' : 'TKIP');
251			$ieee80211s[] = $ieee80211;
252			}
253			$compatibleuses->setProperty('IEEE80211', $ieee80211s);
254			return($compatibleuses);
255			}
256
257			*/
258			private function getAuthenticationMethodParams($eap) {
259			$inner = \core\common\EAP::innerAuth($eap);
260			$outerMethod = $eap["OUTER"];
261
262			if (isset($inner["METHOD"]) && $inner["METHOD"]) {
263			$innerauthmethod = new InnerAuthenticationMethod();
264			$typeOfInner = "\devices\xml\\" . ($inner["EAP"] ? 'EAPMethod' : 'NonEAPAuthMethod');
265			$eapmethod = new $typeOfInner();
266			$eaptype = new Type();
267			$eaptype->setValue($inner['METHOD']);
268			$eapmethod->setProperty('Type', $eaptype);
269			$innerauthmethod->setProperty($typeOfInner, $eapmethod);
270			return ['inner_method' => $innerauthmethod, 'methodID' => $outerMethod, 'inner_methodID' => $inner['METHOD']];
271			} else {
272			return ['inner_method' => 0, 'methodID' => $outerMethod, 'inner_methodID' => 0];
273			}
274			}
275
276			private function setServerSideCredentials($eaptype) {
277			$attr = $this->attributes;
278			$serversidecredential = new ServerSideCredential();
279			// Certificates and server names
280			$cAlist = [];
281			$attrCaList = $attr['internal:CAs'][0];
282			foreach ($attrCaList as $ca) {
283			$caObject = new CA();
284			$caObject->setValue(base64_encode($ca['der']));
285			$caObject->setAttributes(['format' => 'X.509', 'encoding' => 'base64']);
286			$cAlist[] = $caObject;
287			}
288			$serverids = [];
289			$servers = $attr['eap:server_name'];
290			foreach ($servers as $server) {
291			$serverid = new ServerID();
292			$serverid->setValue($server);
293			$serverids[] = $serverid;
294			}
295			$serversidecredential->setProperty('EAPType', $eaptype->getValue());
296			$serversidecredential->setProperty('CA', $cAlist);
297			$serversidecredential->setProperty('ServerID', $serverids);
298			return($serversidecredential);
299			}
300
301			private function setClientSideCredentials($eapParams) {
302			$attr = $this->attributes;
303			$clientsidecredential = new ClientSideCredential();
304			// OuterIdentity
305			if ($attr['internal:use_anon_outer'] [0]) {
306			$clientsidecredential->setProperty('OuterIdentity', $attr['internal:anon_local_value'][0] . '@' . $attr['internal:realm'][0]);
307			}
308			$clientsidecredential->setProperty('EAPType', $eapParams['inner_methodID'] ? $eapParams['inner_methodID'] : $eapParams['methodID']);
309
310			// Client Certificate
311			if ($this->selectedEap == \core\common\EAP::EAPTYPE_SILVERBULLET) {
312			$clientCertificateObject = new ClientCertificate();
313			$clientCertificateObject->setValue(base64_encode($this->clientCert["certdata"]));
314			$clientCertificateObject->setAttributes(['format' => 'PKCS12', 'encoding' => 'base64']);
315			$clientsidecredential->setProperty('ClientCertificate',$clientCertificateObject);
316			}
317			return($clientsidecredential);
318			}
319
320			private function setEapMethod($eaptype) {
321			$attr = $this->attributes;
			0 ignored issues – show Unused Code introduced 2017-12-29 14:39 UTC by Report Bug Copy Issue Report `$attr` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
322			$eapmethod = new EAPMethod();
323			$eapmethod->setProperty('Type', $eaptype);
324			if (isset($this->VendorSpecific)) {
325			$vendorspecifics = [];
326			foreach ($this->VendorSpecific as $vs) {
327			$vendorspecific = new VendorSpecific();
328			$vs['value']->addAttribute('xsi:noNamespaceSchemaLocation', "xxx.xsd");
329			$vendorspecific->setValue($vs['value']);
330			$vendorspecific->setAttributes(['vendor' => $vs['vendor']]);
331			$vendorspecifics[] = $vendorspecific;
332			}
333			$eapmethod->setProperty('VendorSpecific', $vendorspecifics);
334			}
335			return($eapmethod);
336			}
337
338			private function getAuthMethod($eap) {
339			// $attr = $this->attributes;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-12-29 14:39 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
340			$authmethod = new AuthenticationMethod();
341			$eapParams = $this->getAuthenticationMethodParams($eap);
342			$eaptype = new Type();
343			$eaptype->setValue($eapParams['methodID']);
344			// Type
345			$authmethod->setProperty('EAPMethod', $this->setEapMethod($eaptype));
346
347			// ServerSideCredentials
348			$authmethod->setProperty('ServerSideCredential', $this->setServerSideCredentials($eaptype));
349
350			// ClientSideCredentials
351			$authmethod->setProperty('ClientSideCredential', $this->setClientSideCredentials($eapParams));
352
353			if ($eapParams['inner_method']) {
354			$authmethod->setProperty('InnerAuthenticationMethod', $eapParams['inner_method']);
355			}
356			return $authmethod;
357
358
359			}
360
361
362
363			}
364

GEANT / CAT

Push — master ( 9af84e...7cf688 )

Device_XML::writeDeviceInfo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like