T11699: Create a job to automate CNAME checks

extension.json

@@ -38,6 +38,16 @@
 		"request-ssl",
 		"view-private-ssl-requests"
 	],
+	"JobClasses": {
+		"DomainCheckJob": {
+			"class": "Miraheze\\RequestSSL\\Jobs\\DomainCheckJob",
+			"services": [
+				"ConfigFactory",
+				"RequestSSLManager"
+			],
+			"needsPage": false
+		}
+	},
 	"LogActionsHandlers": {
 		"requestssl/*": "LogFormatter",
 		"requestsslprivate/*": "LogFormatter"
@@ -81,6 +91,7 @@
 			"services": [
 				"CreateWikiHookRunner",
 				"DBLoadBalancerFactory",
+				"JobQueueGroup",
 				"MimeAnalyzer",
 				"RepoGroup",
 				"UserFactory"
@@ -144,6 +155,10 @@
 			"value": "",
 			"description": "If set, only allow users to request a SSL certificate on this wiki."
 		},
+		"RequestSSLDomainCheckCNAME": {
+			"value": "",
+			"description": "String. Specifies the CNAME record that RequestSSL will look for on automatic domain checks. If a domain has this CNAME record, it is considered to be pointed"
+		},
 		"RequestSSLHelpUrl": {
 			"value": "",
 			"description": "Full URL. If set, adds a help URL to Special:RequestSSL."

includes/Jobs/DomainCheckJob.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Miraheze\RequestSSL\Jobs;
+
+use Config;
+use ConfigFactory;
+use GenericParameterJob;
+use Job;
+use Miraheze\RequestSSL\RequestSSLManager;
+use MediaWiki\User\User;
+
+class DomainCheckJob extends Job implements GenericParameterJob {
+
+	/** @var Config */
+	private $config;
+
+	/** @var int */
+	private $requestID;
+
+	/** @var RequestSSLManager */
+	private $requestSslManager;
+
+	/**
+	 * @param array $params
+	 * @param ConfigFactory $configFactory
+	 * @param RequestSSLManager $requestSslManager
+	*/
+	public function __construct(
+		array $params,
+		ConfigFactory $configFactory,
+		RequestSSLManager $requestSslManager
+	) {
+		parent::__construct( 'DomainCheckJob', $params );
+		$this->requestID = $params['requestID'];
+		$this->config = $configFactory->makeConfig( 'RequestSSL' );
+		$this->requestSslManager = $requestSslManager;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function run() {
+		$this->requestSslManager->fromID( $this->requestID );
+		$customDomain = parse_url( $this->requestSslManager->getCustomDomain(), PHP_URL_HOST );
+		if ( !$customDomain ) {
+			// Custom domain does not have a hostname, bail out.
+			$this->setLastError( 'Custom domain does not have a hostname.' );
+			return true;
+		}
+		$cname = $this->config->get( 'RequestSSLDomainCheckCNAME' );
+		// TODO: Support rDNS and NS checks
+		// CNAME check
+		$dnsCNAMEData = dns_get_record( $customDomain, DNS_CNAME );
+		if ( !$dnsCNAMEData ) {
+			$this->requestSslManager->addComment( 'RequestSSL could not determine whether or not this domain is pointed: DNS returned no data during CNAME check.', User::newSystemUser( 'RequestSSL Extension' ) );
+		} else {
+			if ( $dnsCNAMEData[0]['type'] === 'CNAME' && $dnsCNAMEData[0]['target'] === $cname ) {
+				$this->requestSslManager->addComment( 'Domain is pointed via CNAME.', User::newSystemUser( 'RequestSSL Extension' ) );
+			} else {
+				$this->requestSslManager->addComment( 'Domain is not pointed via CNAME. It is possible it is pointed via other means.', User::newSystemUser( 'RequestSSL Extension' ) );
+			}
+		}
+		return true;
+	}
+}

includes/Specials/SpecialRequestSSL.php

@@ -7,7 +7,9 @@
 use ExtensionRegistry;
 use FormSpecialPage;
 use Html;
+use JobSpecification;
 use ManualLogEntry;
+use JobQueueGroup;
 use MediaWiki\User\UserFactory;
 use Message;
 use MimeAnalyzer;
@@ -30,6 +32,9 @@ class SpecialRequestSSL extends FormSpecialPage {
 	/** @var ILBFactory */
 	private $dbLoadBalancerFactory;
 
+	/** @var JobQueueGroup */
+	private $jobQueueGroup;
+
 	/** @var MimeAnalyzer */
 	private $mimeAnalyzer;
 
@@ -42,13 +47,15 @@ class SpecialRequestSSL extends FormSpecialPage {
 	/**
 	 * @param CreateWikiHookRunner $createWikiHookRunner
 	 * @param ILBFactory $dbLoadBalancerFactory
+	 * @param JobQueueGroup $jobQueueGroup
 	 * @param MimeAnalyzer $mimeAnalyzer
 	 * @param RepoGroup $repoGroup
 	 * @param UserFactory $userFactory
 	 */
 	public function __construct(
 		CreateWikiHookRunner $createWikiHookRunner,
 		ILBFactory $dbLoadBalancerFactory,
+		JobQueueGroup $jobQueueGroup,
 		MimeAnalyzer $mimeAnalyzer,
 		RepoGroup $repoGroup,
 		UserFactory $userFactory
@@ -57,6 +64,7 @@ public function __construct(
 
 		$this->createWikiHookRunner = $createWikiHookRunner;
 		$this->dbLoadBalancerFactory = $dbLoadBalancerFactory;
+		$this->jobQueueGroup = $jobQueueGroup;
 		$this->mimeAnalyzer = $mimeAnalyzer;
 		$this->repoGroup = $repoGroup;
 		$this->userFactory = $userFactory;
@@ -222,6 +230,9 @@ public function onSubmit( array $data ) {
 			$this->sendNotifications( $data['reason'], $this->getUser()->getName(), $requestID, $data['target'] );
 		}
 
+		$domainCheckJob = new JobSpecification( 'DomainCheckJob', ['requestID' => $requestID] );
+		$this->jobQueueGroup->lazyPush( $domainCheckJob );
+
 		return Status::newGood();
 	}