Firefly III: a personal finances manager
PHP accountingbudgetbudgetingbudgetscash-flowcashflowcredit-carddockerexpensesfinancefinancesfinanciallinuxmoneypaycheckpersonal-financephpphp7
Better validation for webhook URLs
Sander Dorigo25ba87babb1d
diff --git a/app/Api/V1/Requests/Models/Webhook/CreateRequest.php b/app/Api/V1/Requests/Models/Webhook/CreateRequest.phpindex 9de2224782..d2eb9f6380 100644--- a/app/Api/V1/Requests/Models/Webhook/CreateRequest.php+++ b/app/Api/V1/Requests/Models/Webhook/CreateRequest.php@@ -27,6 +27,7 @@ namespace FireflyIII\Api\V1\Requests\Models\Webhook;use FireflyIII\Exceptions\FireflyException;use FireflyIII\Models\Webhook;use FireflyIII\Rules\IsBoolean;+use FireflyIII\Rules\Webhook\IsValidWebhookUrl;use FireflyIII\Support\Facades\FireflyConfig;use FireflyIII\Support\Request\ChecksLogin;use FireflyIII\Support\Request\ConvertsDataTypes;@@ -83,7 +84,7 @@ class CreateRequest extends FormRequest'delivery' => 'prohibited','deliveries' => 'required|array|min:1|max:1','deliveries.*' => sprintf('required|in:%s', $deliveries),- 'url' => ['required', sprintf('url:%s', $validProtocols)],+ 'url' => ['required', sprintf('url:%s', $validProtocols), new IsValidWebhookUrl()],];}}diff --git a/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php b/app/Api/V1/Requests/Models/Webhook/UpdateRequest.phpindex 01ee3c5dd2..4097bb00d3 100644--- a/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php+++ b/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php@@ -27,6 +27,7 @@ namespace FireflyIII\Api\V1\Requests\Models\Webhook;use FireflyIII\Exceptions\FireflyException;use FireflyIII\Models\Webhook;use FireflyIII\Rules\IsBoolean;+use FireflyIII\Rules\Webhook\IsValidWebhookUrl;use FireflyIII\Support\Facades\FireflyConfig;use FireflyIII\Support\Request\ChecksLogin;use FireflyIII\Support\Request\ConvertsDataTypes;@@ -87,7 +88,7 @@ class UpdateRequest extends FormRequest'delivery' => 'prohibited','deliveries' => 'required|array|min:1|max:1','deliveries.*' => sprintf('required|in:%s', $deliveries),- 'url' => [sprintf('url:%s', $validProtocols), sprintf('uniqueExistingWebhook:%d', $webhook->id)],+ 'url' => [sprintf('url:%s', $validProtocols), sprintf('uniqueExistingWebhook:%d', $webhook->id), new IsValidWebhookUrl()],];}}diff --git a/app/Rules/Webhook/IsValidWebhookUrl.php b/app/Rules/Webhook/IsValidWebhookUrl.phpnew file mode 100644index 0000000000..269c0e639f--- /dev/null+++ b/app/Rules/Webhook/IsValidWebhookUrl.php@@ -0,0 +1,45 @@+<?php++namespace FireflyIII\Rules\Webhook;++use Closure;+use FireflyIII\Support\Facades\FireflyConfig;+use Illuminate\Contracts\Validation\ValidationRule;+use Illuminate\Support\Facades\Log;+use Symfony\Component\HttpFoundation\IpUtils;++class IsValidWebhookUrl implements ValidationRule+{+ /**+ * @SuppressWarnings("PHPMD.UnusedFormalParameter")+ */+ public function validate(string $attribute, mixed $value, Closure $fail): void+ {+ $value = (string)$value;+ $resolved = gethostbyname(parse_url($value, PHP_URL_HOST));+ Log::debug(sprintf('Now validating URL "%s" with IP "%s".', $value, $resolved));++ // IPv4 is allowed to be in 127 range.+ if(filter_var($resolved, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) && IpUtils::checkIp4($resolved, '127.0.0.0/8')) {+ Log::debug(sprintf('Local IP "%s" is allowed', $resolved));+ return;+ }++ if (false === filter_var($resolved, FILTER_VALIDATE_IP, FILTER_FLAG_NO_RES_RANGE)) {+ Log::error(sprintf('The resolved IP address "%s" is invalid.', $resolved));+ $fail('validation.no_reserved_ip')->translate();+ }+ $validProtocols = FireflyConfig::get('valid_url_protocols', config('firefly.valid_url_protocols'))->data;+ $parts = explode(',', $validProtocols);+ $valid = false;+ foreach($parts as $part) {+ if(str_starts_with($value, $part)) {+ $valid = true;+ }+ }+ if(false === $valid) {+ $fail('validation.bad_url_prefix')->translate();+ }+ }+}+diff --git a/app/Services/Webhook/StandardWebhookSender.php b/app/Services/Webhook/StandardWebhookSender.phpindex 4df8038a84..f50561a008 100644--- a/app/Services/Webhook/StandardWebhookSender.php+++ b/app/Services/Webhook/StandardWebhookSender.php@@ -28,11 +28,13 @@ use FireflyIII\Exceptions\FireflyException;use FireflyIII\Helpers\Webhook\SignatureGeneratorInterface;use FireflyIII\Models\WebhookAttempt;use FireflyIII\Models\WebhookMessage;+use FireflyIII\Rules\Webhook\IsValidWebhookUrl;use GuzzleHttp\Client;use GuzzleHttp\Exception\ConnectException;use GuzzleHttp\Exception\GuzzleException;use GuzzleHttp\Exception\RequestException;use Illuminate\Support\Facades\Log;+use Illuminate\Support\Facades\Validator;use JsonException;use function Safe\json_encode;@@ -63,6 +65,16 @@ class StandardWebhookSender implements WebhookSenderInterface$this->message->sent = true;$this->message->save();+ // validate the webhook URL.+ $data = [+ 'url' => $this->message->webhook->url+ ];+ $rules = [+ 'url' => [new IsValidWebhookUrl()]+ ];+ $res=Validator::make($data, $rules)->validate();+ Log::debug('Result of res', $res);+try {$signature = $signatureGenerator->generate($this->message);} catch (FireflyException $e) {@@ -113,6 +125,7 @@ class StandardWebhookSender implements WebhookSenderInterface];$client = new Client();+try {$res = $client->request('POST', $this->message->webhook->url, $options);} catch (ConnectException|RequestException $e) {diff --git a/resources/lang/en_US/validation.php b/resources/lang/en_US/validation.phpindex f54cc992c7..e48fa63962 100644--- a/resources/lang/en_US/validation.php+++ b/resources/lang/en_US/validation.php@@ -139,6 +139,8 @@ return ['in' => 'The selected :attribute is invalid.','integer' => 'The :attribute must be an integer.','ip' => 'The :attribute must be a valid IP address.',+ 'no_reserved_ip' => 'The URL must point to a valid IP address.',+ 'bad_url_prefix' => 'This URL is invalid.','json' => 'The :attribute must be a valid JSON string.','max.numeric' => 'The :attribute may not be greater than :max.','max.file' => 'The :attribute may not be greater than :max kilobytes.',