Issues (33)

Security Analysis    no request data  

This project does not seem to handle request data directly as such no vulnerable execution paths were found.

  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.

src/Http/Guard.php (2 issues)

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

1
<?php
2
namespace Intraxia\Jaxion\Http;
3
4
use Intraxia\Jaxion\Contract\Http\Guard as GuardContract;
5
use Intraxia\Jaxion\Utility\Str;
6
use WP_Error;
7
8
/**
9
 * Class Guard
10
 *
11
 * Protects routes by validating that
12
 * the accessing user has required permissions.
13
 *
14
 * @package Intraxia\Jaxion
15
 * @subpackage Http
16
 */
17
class Guard implements GuardContract {
18
	/**
19
	 * Default options.
20
	 *
21
	 * @var array
22
	 */
23
	protected $defaults = array(
24
		'rule'     => 'public',
25
		'callback' => null,
26
	);
27
28
	/**
29
	 * Guard options.
30
	 *
31
	 * @var array
32
	 */
33
	protected $options;
34
35
	/**
36
	 * Instantiate a new Guard with provided options.
37
	 *
38
	 * @param array $options
39
	 */
40 21
	public function __construct( array $options = array() ) {
41 21
		$this->options = $this->set_defaults( $options );
42 21
	}
43
44
	/**
45
	 * Validates whether the current user is authorized.
46
	 *
47
	 * @return true|WP_Error
48
	 */
49 21
	public function authorized() {
50
		// if the rule is public, always authorized
51 21
		if ( 'public' === $this->options['rule'] ) {
52 3
			return true;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return true; (boolean) is incompatible with the return type documented by Intraxia\Jaxion\Http\Guard::authorized of type Intraxia\Jaxion\Http\true|WP_Error.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
53
		}
54
55
		// enable passing in callback
56 18
		if ( 'callback' === $this->options['rule'] && is_callable( $this->options['callback'] ) ) {
57 3
			return call_user_func( $this->options['callback'] );
58
		}
59
60
		// map rule to method
61 15
		if ( method_exists( $this, $method = $this->options['rule'] ) ) {
62 12
			return $this->{$method}();
63
		}
64
65
		// disable in rule is misconfigused
66
		// @todo set up internal translations
67 3
		return new WP_Error( 'misconfigured_guard', __( 'Misconfigured guard rule', 'jaxion' ), [ 'status' => 500 ] );
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \WP_Error('mi...rray('status' => 500)); (WP_Error) is incompatible with the return type declared by the interface Intraxia\Jaxion\Contract\Http\Guard::authorized of type boolean.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
68
	}
69
70
	/**
71
	 * Checks whether the current user can edit other's posts.
72
	 *
73
	 * @return bool|WP_Error
74
	 */
75 6
	protected function can_edit_others_posts() {
76 6
		return current_user_can( 'edit_others_posts' ) ?: $this->make_error();
77
	}
78
79
	/**
80
	 * Checks whether the user is currently logged in.
81
	 *
82
	 * @return bool|WP_Error
83
	 */
84 6
	protected function user_logged_in() {
85 6
		return is_user_logged_in() ?: $this->make_error();
86
	}
87
88
	/**
89
	 * Checks whether the user can manage the site options.
90
	 *
91
	 * @return bool|WP_Error
92
	 */
93
	protected function can_manage_options() {
94
		return current_user_can( 'manage_options' ) ?: $this->make_error();
95
	}
96
97
	/**
98
	 * Sets the default params for the Guard options.
99
	 *
100
	 * @param array $options
101
	 *
102
	 * @return array
103
	 */
104 21
	protected function set_defaults( $options ) {
105
		// these are the valid options
106 21
		return wp_parse_args( $options, $this->defaults );
107
	}
108
109
	/**
110
	 * Create an unauthorized error object.
111
	 *
112
	 * @return WP_Error
113
	 */
114 6
	protected function make_error() {
115 6
		return new WP_Error( 'unauthorized', __( 'Unauthorized user', 'jaxion' ), array( 'status' => 401 ) );
116
	}
117
}
118