Issues in HideMailto.php (master) - Issues in master - sunnysideup/silverstripe-hidemailto - Measure and Improve Code Quality continuously with Scrutinizer

Issues (26)

Security Analysis not enabled

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

code/HideMailto.php (14 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php


class HideMailto extends SiteTreeExtension
namespace YourVendor;

class YourClass { }
{
    private static $email_field = "Email";

    private static $default_subject = "enquiry";

    private static $replace_characters = array(

        "." => "&#x2e;",
        "@" => "&#x40;",
        "a" => "&#x61;",
        "b" => "&#x62;",
        "c" => "&#x63;",
        "d" => "&#x64;",
        "e" => "&#x65;",
        "f" => "&#x66;",
        "g" => "&#x67;",
        "h" => "&#x68;",
        "i" => "&#x69;"
    );

    /**
     *
     * @param String $email
     * @param String $subject
     * @return Obj (MailTo, Text, Original, Subject)
     */
    public static function convert_email($email, $subject = '')
    {
        $obj = new ViewableData();
        if (!$subject) {
            $subject = self::$default_subject;
        }
        //mailto part
        $mailTo = "mailto:".$email."?subject=".Convert::raw2mailto($subject);
        $mailToConverted = self::string_encoder($mailTo);
        $convertedEmail = self::string_encoder($email);
        $obj->MailTo = $mailToConverted;
        $obj->Text = $convertedEmail;
        $obj->Original = $email;
        $obj->Subject = $subject;
        //$obj->OnClick = "jQuery(this).attr('href', HideMailto2Email('".self::get_dot_replacer()."', '".$array[0]."', '".$array[1]."', '".Convert::raw2mailto($subject)."')); return true;";

        //TO DO: add a JS function that puts the
        Requirements::javascript(THIRDPARTY_DIR."/jquery/jquery.js");
        //Requirements::javascript("hidemailto/javascript/HideMailto2Email.js");

        return $obj;
    }


    /**
     * encodes a string - randomly
     * @param String $string
     * @return String
     */
    private static function string_encoder($string)
    {
        $encodedString = '';
        $nowCodeString = '';
        $originalLength = strlen($string);
        for ($i = 0; $i < $originalLength; $i++) {
            $encodeMode = rand(1, 2);
            switch ($encodeMode) {
                case 1: // Decimal code
                    $nowCodeString = '&#' . ord($string[$i]) . ';';
                    break;
                case 2: // Hexadecimal code
                    $nowCodeString = '&#x' . dechex(ord($string[$i])) . ';';
                    break;
                default:
                    return 'ERROR: wrong encoding mode.';
            }
            $encodedString .= $nowCodeString;
        }
        return $encodedString;
    }

    public function HideMailToObject()
    {
        if ($email = $this->getHiddenEmailData()) {
            $obj = self::convert_email($email);
            return $obj;
        }
    }

    private function getHiddenEmailData()

    {
        if ($field = self::$email_field) {
            if ($email = $this->owner->$field) {
                return $this->isEmail($email);
            }
        }
    }

    private function isEmail($email)

    {
        if (!preg_match("/^([A-Za-z0-9._-])+\@(([A-Za-z0-9-])+\.)+([A-Za-z0-9])+$/", trim($email))) {
            return "";
        } else {
            return $email;
        }
    }
}

class HideMailto_Role extends DataExtension
namespace YourVendor;

class YourClass { }
{

    //member link

    public function HideMailtoLink()
    {
        return "mailto/" . $this->owner->ID;
    }
}

/**
 * Generates obfusticated links, and also holds the method called when /mailto/
 * is called via the URL. As noted above, take a look at the _config.php file to
 * see how mailto/ maps to this class.
 */
class HideMailto_Controller extends ContentController
namespace YourVendor;

class YourClass { }
{
    /**
     * The list of allowed domains to create a mailto: link to. By default, allow
     * all domains.
     *
     * TODO Maybe the default should be to allow the current domain only?
     */
    private static $allowed_domains = '*';

    public function __construct($dataRecord = null)
    {
        parent::__construct($dataRecord);
        return $this->index();
    }

    public function defaultAction($action)
    {
        return $this->index();
    }

    public $url = '';

    /**
     * This is called by default when this controller is executed.
     */
    public function index()
    {
        $member = null;
        $user = '';
        $domain = '';
        $subject = '';
        // We have two situations to deal with, where urlParams['Action'] is an int (assume Member ID), or a string (assume username)
        if (is_numeric($this->getRequest()->param('Name'))) {
            // Action is numeric, assume it's a member ID and optional ID is the email subject
            $member = Member::get()->byID($this->getRequest()->param('Name'));
            if (!$member) {
                user_error("No member found with ID #" . $this->getRequest()->param('Name'), E_USER_ERROR); // No member found with this ID, perhaps we could redirect a user back instead of giving them a 500 error?
            }
            list($user, $domain) = explode('@', $member->Email);
            $subject = $this->getRequest()->param('ID');
        } else {
            // Action is not numeric, assume that Action is the username, ID is the domain and optional OtherID is the email subject
            $user = urldecode($this->getRequest()->param('Name'));
            $domain = urldecode($this->getRequest()->param('URL'));
            $subject = $this->getRequest()->param('Subject');
        }
        $emailString = "mailto: $user@$domain?subject=".$subject;
        // Make sure the domain is in the allowed domains
        if ((is_string(self::$allowed_domains) && self::$allowed_domains == '*') || in_array($domain, self::$allowed_domains)) {
            // Create the redirect
            header("Location: " . $emailString);
            header("Refresh: 0; url=". $emailString);
            echo $this->customise(array("RedirectBackURL" => $this->RedirectBackURL(), "Email" => $this->makeMailtoString($user, $domain, $subject)))->renderWith("HideMailto");
            $emailString = $this->makeMailtoString($user, $domain, $subject);
        } else {
            user_error("We're not allowed to redirect to the domain '$domain', because it's not listed in the _config.php file", E_USER_ERROR);
        }
    }

    public function RedirectBackURL()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_SERVER['HTTP_REFERER'])) {
            $this->redirectBackURL = $_SERVER['HTTP_REFERER'];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        if (!$this->redirectBackURL) {
            $this->redirectBackURL = Director::absoluteBaseURL();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        return $this->redirectBackURL;
    }


    protected function makeMailtoString($user, $domain, $subject = '')
    {
        $target = 'mailto:' . $user . '@' . $domain;
        if ($subject) {
            $target .= '?subject=' . Convert::raw2mailto($subject);
        }
        $target = str_replace(".", "&x2e;", $target);
        $target = str_replace("@", "&x40;", $target);
        return $target;
    }
}


1			<?php
2
3
4			class HideMailto extends SiteTreeExtension
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
5			{
6			private static $email_field = "Email";
7
8			private static $default_subject = "enquiry";
9
10			private static $replace_characters = array(
			0 ignored issues – show Unused Code introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `$replace_characters` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
11			"." => ".",
12			"@" => "@",
13			"a" => "a",
14			"b" => "b",
15			"c" => "c",
16			"d" => "d",
17			"e" => "e",
18			"f" => "f",
19			"g" => "g",
20			"h" => "h",
21			"i" => "i"
22			);
23
24			/**
25			*
26			* @param String $email
27			* @param String $subject
28			* @return Obj (MailTo, Text, Original, Subject)
29			*/
30			public static function convert_email($email, $subject = '')
31			{
32			$obj = new ViewableData();
33			if (!$subject) {
34			$subject = self::$default_subject;
35			}
36			//mailto part
37			$mailTo = "mailto:".$email."?subject=".Convert::raw2mailto($subject);
38			$mailToConverted = self::string_encoder($mailTo);
39			$convertedEmail = self::string_encoder($email);
40			$obj->MailTo = $mailToConverted;
41			$obj->Text = $convertedEmail;
42			$obj->Original = $email;
43			$obj->Subject = $subject;
44			//$obj->OnClick = "jQuery(this).attr('href', HideMailto2Email('".self::get_dot_replacer()."', '".$array[0]."', '".$array[1]."', '".Convert::raw2mailto($subject)."')); return true;";
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this `62%` 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...
45			//TO DO: add a JS function that puts the
46			Requirements::javascript(THIRDPARTY_DIR."/jquery/jquery.js");
47			//Requirements::javascript("hidemailto/javascript/HideMailto2Email.js");
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this `72%` 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...
48			return $obj;
49			}
50
51
52			/**
53			* encodes a string - randomly
54			* @param String $string
55			* @return String
56			*/
57			private static function string_encoder($string)
58			{
59			$encodedString = '';
60			$nowCodeString = '';
61			$originalLength = strlen($string);
62			for ($i = 0; $i < $originalLength; $i++) {
63			$encodeMode = rand(1, 2);
64			switch ($encodeMode) {
65			case 1: // Decimal code
66			$nowCodeString = '&#' . ord($string[$i]) . ';';
67			break;
68			case 2: // Hexadecimal code
69			$nowCodeString = '&#x' . dechex(ord($string[$i])) . ';';
70			break;
71			default:
72			return 'ERROR: wrong encoding mode.';
73			}
74			$encodedString .= $nowCodeString;
75			}
76			return $encodedString;
77			}
78
79			public function HideMailToObject()
80			{
81			if ($email = $this->getHiddenEmailData()) {
82			$obj = self::convert_email($email);
83			return $obj;
84			}
85			}
86
87			private function getHiddenEmailData()
			0 ignored issues – show Documentation introduced 2018-02-21 04:08 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
88			{
89			if ($field = self::$email_field) {
90			if ($email = $this->owner->$field) {
91			return $this->isEmail($email);
92			}
93			}
94			}
95
96			private function isEmail($email)
			0 ignored issues – show Documentation introduced 2018-02-21 04:08 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
97			{
98			if (!preg_match("/^([A-Za-z0-9._-])+\@(([A-Za-z0-9-])+\.)+([A-Za-z0-9])+$/", trim($email))) {
99			return "";
100			} else {
101			return $email;
102			}
103			}
104			}
105
106			class HideMailto_Role extends DataExtension
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history... Coding Style Compatibility introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
107			{
108
109			//member link
110
111			public function HideMailtoLink()
112			{
113			return "mailto/" . $this->owner->ID;
114			}
115			}
116
117			/**
118			* Generates obfusticated links, and also holds the method called when /mailto/
119			* is called via the URL. As noted above, take a look at the _config.php file to
120			* see how mailto/ maps to this class.
121			*/
122			class HideMailto_Controller extends ContentController
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history... Coding Style Compatibility introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
123			{
124			/**
125			* The list of allowed domains to create a mailto: link to. By default, allow
126			* all domains.
127			*
128			* TODO Maybe the default should be to allow the current domain only?
129			*/
130			private static $allowed_domains = '*';
131
132			public function __construct($dataRecord = null)
133			{
134			parent::__construct($dataRecord);
135			return $this->index();
136			}
137
138			public function defaultAction($action)
139			{
140			return $this->index();
141			}
142
143			public $url = '';
144
145			/**
146			* This is called by default when this controller is executed.
147			*/
148			public function index()
149			{
150			$member = null;
151			$user = '';
152			$domain = '';
153			$subject = '';
154			// We have two situations to deal with, where urlParams['Action'] is an int (assume Member ID), or a string (assume username)
155			if (is_numeric($this->getRequest()->param('Name'))) {
156			// Action is numeric, assume it's a member ID and optional ID is the email subject
157			$member = Member::get()->byID($this->getRequest()->param('Name'));
158			if (!$member) {
159			user_error("No member found with ID #" . $this->getRequest()->param('Name'), E_USER_ERROR); // No member found with this ID, perhaps we could redirect a user back instead of giving them a 500 error?
160			}
161			list($user, $domain) = explode('@', $member->Email);
162			$subject = $this->getRequest()->param('ID');
163			} else {
164			// Action is not numeric, assume that Action is the username, ID is the domain and optional OtherID is the email subject
165			$user = urldecode($this->getRequest()->param('Name'));
166			$domain = urldecode($this->getRequest()->param('URL'));
167			$subject = $this->getRequest()->param('Subject');
168			}
169			$emailString = "mailto: $user@$domain?subject=".$subject;
170			// Make sure the domain is in the allowed domains
171			if ((is_string(self::$allowed_domains) && self::$allowed_domains == '*') \|\| in_array($domain, self::$allowed_domains)) {
172			// Create the redirect
173			header("Location: " . $emailString);
174			header("Refresh: 0; url=". $emailString);
175			echo $this->customise(array("RedirectBackURL" => $this->RedirectBackURL(), "Email" => $this->makeMailtoString($user, $domain, $subject)))->renderWith("HideMailto");
176			$emailString = $this->makeMailtoString($user, $domain, $subject);
177			} else {
178			user_error("We're not allowed to redirect to the domain '$domain', because it's not listed in the _config.php file", E_USER_ERROR);
179			}
180			}
181
182			public function RedirectBackURL()
			0 ignored issues – show Documentation introduced 2018-02-21 04:08 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history... Coding Style introduced 2018-02-21 04:08 UTC by Report Bug Copy Issue Report Show Similar Issues like this `RedirectBackURL` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
183			{
184			if (isset($_SERVER['HTTP_REFERER'])) {
185			$this->redirectBackURL = $_SERVER['HTTP_REFERER'];
			0 ignored issues – show Documentation introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `redirectBackURL` does not exist on `object<HideMailto_Controller>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
186			}
187			if (!$this->redirectBackURL) {
188			$this->redirectBackURL = Director::absoluteBaseURL();
			0 ignored issues – show Documentation introduced 2017-01-03 01:20 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `redirectBackURL` does not exist on `object<HideMailto_Controller>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
189			}
190			return $this->redirectBackURL;
191			}
192
193
194			protected function makeMailtoString($user, $domain, $subject = '')
195			{
196			$target = 'mailto:' . $user . '@' . $domain;
197			if ($subject) {
198			$target .= '?subject=' . Convert::raw2mailto($subject);
199			}
200			$target = str_replace(".", "&x2e;", $target);
201			$target = str_replace("@", "&x40;", $target);
202			return $target;
203			}
204			}
205

sunnysideup / silverstripe-hidemailto

Issues (26)

Security Analysis not enabled

code/HideMailto.php (14 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like