Add diagnosis to /pv

ProjectInfinity · ProjectInfinity · commit 91b7e95a3451 · 2017-05-24T00:26:49.000+02:00
diff --git a/src/ProjectInfinity/PocketVote/cmd/PocketVoteCommand.php b/src/ProjectInfinity/PocketVote/cmd/PocketVoteCommand.php
@@ -8,6 +8,7 @@
 use pocketmine\utils\TextFormat;
 use ProjectInfinity\PocketVote\PocketVote;
 use ProjectInfinity\PocketVote\task\guru\SetLinkNameTask;
+use ProjectInfinity\PocketVote\task\DiagnoseTask;
 
 class PocketVoteCommand extends Command implements PluginIdentifiableCommand {
 
@@ -24,7 +25,7 @@ public function execute(CommandSender $sender, $commandLabel, array $args) {
             return true;
         }
         if(count($args) === 0) {
-            $sender->sendMessage(TextFormat::AQUA.'Specify an action: SECRET, IDENTITY, CMD, CMDO');
+            $sender->sendMessage(TextFormat::AQUA.'Specify an action: SECRET, IDENTITY, DIAGNOSE, CMD, CMDO, LINK');
             return true;
         }
         switch(strtoupper($args[0])) {
@@ -59,6 +60,11 @@ public function execute(CommandSender $sender, $commandLabel, array $args) {
                 $this->plugin->saveConfig();
                 break;
 
+            case 'DIAGNOSE':
+                $sender->sendMessage(TextFormat::GREEN.'Scheduling a diagnosis...');
+                $this->plugin->getServer()->getScheduler()->scheduleAsyncTask(new DiagnoseTask($this->plugin->getDescription()->getVersion(), $sender->getName()));
+                break;
+
             case 'CMD':
                 if(count($args) < 2) {
                     $sender->sendMessage(TextFormat::RED.'You need to specify a command. Variables: %player, %ip, %site');
@@ -176,7 +182,7 @@ public function execute(CommandSender $sender, $commandLabel, array $args) {
                 break;
 
             default:
-                $sender->sendMessage(TextFormat::RED.'Invalid option. Specify SECRET, IDENTITY, CMD or CMDO.');
+                $sender->sendMessage(TextFormat::RED.'Invalid option. Specify SECRET, IDENTITY, DIAGNOSE, CMD, CMDO or LINK.');
         }
         return true;
     }
diff --git a/src/ProjectInfinity/PocketVote/lib/Firebase/JWT.php b/src/ProjectInfinity/PocketVote/lib/Firebase/JWT.php
@@ -29,6 +29,14 @@ class JWT
      */
     public static $leeway = 0;
 
+    /**
+     * Allow the current timestamp to be specified.
+     * Useful for fixing a value within unit testing.
+     *
+     * Will default to PHP time() value if null.
+     */
+    public static $timestamp = null;
+
     public static $supported_algs = array(
         'HS256' => array('hash_hmac', 'SHA256'),
         'HS512' => array('hash_hmac', 'SHA512'),
@@ -39,15 +47,14 @@ class JWT
     /**
      * Decodes a JWT string into a PHP object.
      *
-     * @param string            $jwt            The JWT
-     * @param string|array|null $key            The key, or map of keys.
-     *                                          If the algorithm used is asymmetric, this is the public key
-     * @param array             $allowed_algs   List of supported verification algorithms
-     *                                          Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
+     * @param string        $jwt            The JWT
+     * @param string|array  $key            The key, or map of keys.
+     *                                      If the algorithm used is asymmetric, this is the public key
+     * @param array         $allowed_algs   List of supported verification algorithms
+     *                                      Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
      *
      * @return object The JWT's payload as a PHP object
      *
-     * @throws DomainException              Algorithm was not provided
      * @throws UnexpectedValueException     Provided JWT was invalid
      * @throws SignatureInvalidException    Provided JWT was invalid because the signature verification failed
      * @throws BeforeValidException         Provided JWT is trying to be used before it's eligible as defined by 'nbf'
@@ -59,47 +66,52 @@ class JWT
      */
     public static function decode($jwt, $key, $allowed_algs = array())
     {
+        $timestamp = is_null(static::$timestamp) ? time() : static::$timestamp;
+
         if (empty($key)) {
             throw new InvalidArgumentException('Key may not be empty');
         }
+        if (!is_array($allowed_algs)) {
+            throw new InvalidArgumentException('Algorithm not allowed');
+        }
         $tks = explode('.', $jwt);
         if (count($tks) != 3) {
             throw new UnexpectedValueException('Wrong number of segments');
         }
         list($headb64, $bodyb64, $cryptob64) = $tks;
-        if (null === ($header = JWT::jsonDecode(JWT::urlsafeB64Decode($headb64)))) {
+        if (null === ($header = static::jsonDecode(static::urlsafeB64Decode($headb64)))) {
             throw new UnexpectedValueException('Invalid header encoding');
         }
-        if (null === $payload = JWT::jsonDecode(JWT::urlsafeB64Decode($bodyb64))) {
+        if (null === $payload = static::jsonDecode(static::urlsafeB64Decode($bodyb64))) {
             throw new UnexpectedValueException('Invalid claims encoding');
         }
-        $sig = JWT::urlsafeB64Decode($cryptob64);
-        
+        $sig = static::urlsafeB64Decode($cryptob64);
+
         if (empty($header->alg)) {
-            throw new DomainException('Empty algorithm');
+            throw new UnexpectedValueException('Empty algorithm');
         }
-        if (empty(self::$supported_algs[$header->alg])) {
-            throw new DomainException('Algorithm not supported');
+        if (empty(static::$supported_algs[$header->alg])) {
+            throw new UnexpectedValueException('Algorithm not supported');
         }
-        if (!is_array($allowed_algs) || !in_array($header->alg, $allowed_algs)) {
-            throw new DomainException('Algorithm not allowed');
+        if (!in_array($header->alg, $allowed_algs)) {
+            throw new UnexpectedValueException('Algorithm not allowed');
         }
         if (is_array($key) || $key instanceof \ArrayAccess) {
             if (isset($header->kid)) {
                 $key = $key[$header->kid];
             } else {
-                throw new DomainException('"kid" empty, unable to lookup correct key');
+                throw new UnexpectedValueException('"kid" empty, unable to lookup correct key');
             }
         }
 
         // Check the signature
-        if (!JWT::verify("$headb64.$bodyb64", $sig, $key, $header->alg)) {
+        if (!static::verify("$headb64.$bodyb64", $sig, $key, $header->alg)) {
             throw new SignatureInvalidException('Signature verification failed');
         }
 
         // Check if the nbf if it is defined. This is the time that the
         // token can actually be used. If it's not yet that time, abort.
-        if (isset($payload->nbf) && $payload->nbf > (time() + self::$leeway)) {
+        if (isset($payload->nbf) && $payload->nbf > ($timestamp + static::$leeway)) {
             throw new BeforeValidException(
                 'Cannot handle token prior to ' . date(DateTime::ISO8601, $payload->nbf)
             );
@@ -108,14 +120,14 @@ public static function decode($jwt, $key, $allowed_algs = array())
         // Check that this token has been created before 'now'. This prevents
         // using tokens that have been created for later use (and haven't
         // correctly used the nbf claim).
-        if (isset($payload->iat) && $payload->iat > (time() + self::$leeway)) {
+        if (isset($payload->iat) && $payload->iat > ($timestamp + static::$leeway)) {
             throw new BeforeValidException(
                 'Cannot handle token prior to ' . date(DateTime::ISO8601, $payload->iat)
             );
         }
 
         // Check if this token has expired.
-        if (isset($payload->exp) && (time() - self::$leeway) >= $payload->exp) {
+        if (isset($payload->exp) && ($timestamp - static::$leeway) >= $payload->exp) {
             throw new ExpiredException('Expired token');
         }
 
@@ -130,6 +142,7 @@ public static function decode($jwt, $key, $allowed_algs = array())
      *                                  If the algorithm used is asymmetric, this is the private key
      * @param string        $alg        The signing algorithm.
      *                                  Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
+     * @param mixed         $keyId
      * @param array         $head       An array with header elements to attach
      *
      * @return string A signed JWT
@@ -147,12 +160,12 @@ public static function encode($payload, $key, $alg = 'HS256', $keyId = null, $he
             $header = array_merge($head, $header);
         }
         $segments = array();
-        $segments[] = JWT::urlsafeB64Encode(JWT::jsonEncode($header));
-        $segments[] = JWT::urlsafeB64Encode(JWT::jsonEncode($payload));
+        $segments[] = static::urlsafeB64Encode(static::jsonEncode($header));
+        $segments[] = static::urlsafeB64Encode(static::jsonEncode($payload));
         $signing_input = implode('.', $segments);
 
-        $signature = JWT::sign($signing_input, $key, $alg);
-        $segments[] = JWT::urlsafeB64Encode($signature);
+        $signature = static::sign($signing_input, $key, $alg);
+        $segments[] = static::urlsafeB64Encode($signature);
 
         return implode('.', $segments);
     }
@@ -171,10 +184,10 @@ public static function encode($payload, $key, $alg = 'HS256', $keyId = null, $he
      */
     public static function sign($msg, $key, $alg = 'HS256')
     {
-        if (empty(self::$supported_algs[$alg])) {
+        if (empty(static::$supported_algs[$alg])) {
             throw new DomainException('Algorithm not supported');
         }
-        list($function, $algorithm) = self::$supported_algs[$alg];
+        list($function, $algorithm) = static::$supported_algs[$alg];
         switch($function) {
             case 'hash_hmac':
                 return hash_hmac($algorithm, $msg, $key, true);
@@ -204,11 +217,11 @@ public static function sign($msg, $key, $alg = 'HS256')
      */
     private static function verify($msg, $signature, $key, $alg)
     {
-        if (empty(self::$supported_algs[$alg])) {
+        if (empty(static::$supported_algs[$alg])) {
             throw new DomainException('Algorithm not supported');
         }
 
-        list($function, $algorithm) = self::$supported_algs[$alg];
+        list($function, $algorithm) = static::$supported_algs[$alg];
         switch($function) {
             case 'openssl':
                 $success = openssl_verify($msg, $signature, $key, $algorithm);
@@ -223,13 +236,13 @@ private static function verify($msg, $signature, $key, $alg)
                 if (function_exists('hash_equals')) {
                     return hash_equals($signature, $hash);
                 }
-                $len = min(self::safeStrlen($signature), self::safeStrlen($hash));
+                $len = min(static::safeStrlen($signature), static::safeStrlen($hash));
 
                 $status = 0;
                 for ($i = 0; $i < $len; $i++) {
                     $status |= (ord($signature[$i]) ^ ord($hash[$i]));
                 }
-                $status |= (self::safeStrlen($signature) ^ self::safeStrlen($hash));
+                $status |= (static::safeStrlen($signature) ^ static::safeStrlen($hash));
 
                 return ($status === 0);
         }
@@ -263,7 +276,7 @@ public static function jsonDecode($input)
         }
 
         if (function_exists('json_last_error') && $errno = json_last_error()) {
-            JWT::handleJsonError($errno);
+            static::handleJsonError($errno);
         } elseif ($obj === null && $input !== 'null') {
             throw new DomainException('Null result with non-null input');
         }
@@ -283,7 +296,7 @@ public static function jsonEncode($input)
     {
         $json = json_encode($input);
         if (function_exists('json_last_error') && $errno = json_last_error()) {
-            JWT::handleJsonError($errno);
+            static::handleJsonError($errno);
         } elseif ($json === 'null' && $input !== null) {
             throw new DomainException('Null result with non-null input');
         }
@@ -335,8 +348,8 @@ private static function handleJsonError($errno)
         );
         throw new DomainException(
             isset($messages[$errno])
-            ? $messages[$errno]
-            : 'Unknown JSON error: ' . $errno
+                ? $messages[$errno]
+                : 'Unknown JSON error: ' . $errno
         );
     }
 
@@ -354,4 +367,4 @@ private static function safeStrlen($str)
         }
         return strlen($str);
     }
-}
+}
diff --git a/src/ProjectInfinity/PocketVote/task/DiagnoseTask.php b/src/ProjectInfinity/PocketVote/task/DiagnoseTask.php
@@ -0,0 +1,97 @@
+<?php
+
+namespace ProjectInfinity\PocketVote\task;
+
+use pocketmine\command\ConsoleCommandSender;
+use pocketmine\scheduler\AsyncTask;
+use pocketmine\Server;
+use pocketmine\utils\TextFormat;
+use ProjectInfinity\PocketVote\lib\Firebase\JWT;
+use ProjectInfinity\PocketVote\PocketVote;
+
+class DiagnoseTask extends AsyncTask {
+    public $identity;
+    public $isDev;
+    public $cert;
+    public $secret;
+    public $version;
+    public $player;
+
+    public function __construct($version, $player) {
+        $this->identity = PocketVote::getPlugin()->getConfig()->get('identity', null);
+        $this->secret = PocketVote::getPlugin()->getConfig()->get('secret', null);
+        $this->isDev = PocketVote::$dev;
+        $this->cert = PocketVote::$cert;
+        $this->version = $version;
+        $this->player = $player;
+    }
+
+    public function onRun() {
+
+        if($this->identity === null) return;
+
+        $curl = curl_init($this->isDev ? 'http://127.0.0.1/v2/diagnose' : 'https://api.pocketvote.io/v2/diagnose');
+
+        curl_setopt_array($curl, [
+            CURLOPT_RETURNTRANSFER => 1,
+            CURLOPT_PORT => $this->isDev ? 9000 : 443,
+            CURLOPT_HEADER => false,
+            CURLOPT_SSL_VERIFYPEER => true,
+            CURLOPT_SSL_VERIFYHOST => 2,
+            CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
+            CURLOPT_CAINFO => $this->cert,
+            CURLOPT_USERAGENT => 'PocketVote v'.$this->version,
+            CURLOPT_HTTPHEADER => ['Identity: '.$this->identity],
+        ]);
+
+        $res = curl_exec($curl);
+
+        if($res === false) {
+            $this->setResult((object)['success' => false, 'error' => curl_error($curl)]);
+            curl_close($curl);
+            return;
+        }
+
+        curl_close($curl);
+        $this->setResult(json_decode($res));
+    }
+
+    public function onCompletion(Server $server) {
+        $player = $this->player === 'CONSOLE' ? new ConsoleCommandSender() : $server->getPlayer($this->player);
+        if($player === null) return;
+
+        if(!$this->hasResult()) {
+            $player->sendMessage(TextFormat::RED.'Failed to diagnose PocketVote. Try again later.');
+            return;
+        }
+
+        $result = $this->getResult();
+
+        if(!$result->success && isset($result->error)) {
+            $player->sendMessage(TextFormat::RED.'An error occurred while contacting the PocketVote servers, please try again later.');
+            $server->getLogger()->error('[PocketVote] curl error occurred during DiagnoseTask: '.$result->error);
+            return;
+        }
+
+        if(isset($result->payload)) {
+            $player->sendMessage(($result->payload->foundServer ? TextFormat::GREEN.'✔' : TextFormat::RED.'✖').' Found server');
+            $player->sendMessage(($result->payload->hasVotes ? TextFormat::GREEN.'✔' : TextFormat::RED.'✖').' Has votes (trivial)');
+
+            try {
+                $token = JWT::decode($result->payload->voteSample, $this->secret, array('HS256'));
+                if($token->player === 'PocketVoteSample' && $token->ip === '127.0.0.1' && $token->site === 'PocketVote.io') {
+                    $player->sendMessage((TextFormat::GREEN.'✔').' Decode sample vote');
+                } else {
+                    throw new \ErrorException('Token did not meet expectations');
+                }
+            } catch(\Exception $e) {
+                $player->sendMessage((TextFormat::RED.'✖').' Decode sample vote');
+                $player->sendMessage(TextFormat::YELLOW.'Reason: '.$e->getMessage());
+            }
+
+            $player->sendMessage(TextFormat::YELLOW.'A test vote will be dispatched momentarily. If more than a couple of minutes passes the dispatch has failed.');
+        } else {
+            $player->sendMessage(TextFormat::RED.'Please wait before trying to use this command again.');
+        }
+    }
+}
diff --git a/src/ProjectInfinity/PocketVote/task/TopVoterTask.php b/src/ProjectInfinity/PocketVote/task/TopVoterTask.php
@@ -39,9 +39,11 @@ public function onRun() {
 
         if($res === false) {
             $this->setResult((object)['success' => false, 'error' => curl_error($curl)]);
+            curl_close($curl);
             return;
         }
 
+        curl_close($curl);
         $this->setResult(json_decode($res));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,11 @@ public function onRun() {`
`39`	`39`
`40`	`40`	`if($res === false) {`
`41`	`41`	`$this->setResult((object)['success' => false, 'error' => curl_error($curl)]);`
	`42`	`+ curl_close($curl);`
`42`	`43`	`return;`
`43`	`44`	`}`
`44`	`45`
	`46`	`+ curl_close($curl);`
`45`	`47`	`$this->setResult(json_decode($res));`
`46`	`48`	`}`
`47`	`49`