Merge pull request #31540 from nextcloud/backport/31454/stable23

[stable23] Fix the logger that is imported for critical actions

apps/admin_audit/composer/composer/autoload_classmap.php

@@ -19,6 +19,8 @@
     'OCA\\AdminAudit\\Actions\\UserManagement' => $baseDir . '/../lib/Actions/UserManagement.php',
     'OCA\\AdminAudit\\Actions\\Versions' => $baseDir . '/../lib/Actions/Versions.php',
     'OCA\\AdminAudit\\AppInfo\\Application' => $baseDir . '/../lib/AppInfo/Application.php',
+    'OCA\\AdminAudit\\AuditLogger' => $baseDir . '/../lib/AuditLogger.php',
     'OCA\\AdminAudit\\BackgroundJobs\\Rotate' => $baseDir . '/../lib/BackgroundJobs/Rotate.php',
+    'OCA\\AdminAudit\\IAuditLogger' => $baseDir . '/../lib/IAuditLogger.php',
     'OCA\\AdminAudit\\Listener\\CriticalActionPerformedEventListener' => $baseDir . '/../lib/Listener/CriticalActionPerformedEventListener.php',
 );

apps/admin_audit/composer/composer/autoload_static.php

@@ -34,7 +34,9 @@ class ComposerStaticInitAdminAudit
         'OCA\\AdminAudit\\Actions\\UserManagement' => __DIR__ . '/..' . '/../lib/Actions/UserManagement.php',
         'OCA\\AdminAudit\\Actions\\Versions' => __DIR__ . '/..' . '/../lib/Actions/Versions.php',
         'OCA\\AdminAudit\\AppInfo\\Application' => __DIR__ . '/..' . '/../lib/AppInfo/Application.php',
+        'OCA\\AdminAudit\\AuditLogger' => __DIR__ . '/..' . '/../lib/AuditLogger.php',
         'OCA\\AdminAudit\\BackgroundJobs\\Rotate' => __DIR__ . '/..' . '/../lib/BackgroundJobs/Rotate.php',
+        'OCA\\AdminAudit\\IAuditLogger' => __DIR__ . '/..' . '/../lib/IAuditLogger.php',
         'OCA\\AdminAudit\\Listener\\CriticalActionPerformedEventListener' => __DIR__ . '/..' . '/../lib/Listener/CriticalActionPerformedEventListener.php',
     );
 

apps/admin_audit/lib/Actions/Action.php

@@ -28,13 +28,13 @@
  */
 namespace OCA\AdminAudit\Actions;
 
-use Psr\Log\LoggerInterface;
+use OCA\AdminAudit\IAuditLogger;
 
 class Action {
-	/** @var LoggerInterface */
+	/** @var IAuditLogger */
 	private $logger;
 
-	public function __construct(LoggerInterface $logger) {
+	public function __construct(IAuditLogger $logger) {
 		$this->logger = $logger;
 	}
 

apps/admin_audit/lib/AppInfo/Application.php

@@ -48,6 +48,8 @@
 use OCA\AdminAudit\Actions\Trashbin;
 use OCA\AdminAudit\Actions\UserManagement;
 use OCA\AdminAudit\Actions\Versions;
+use OCA\AdminAudit\AuditLogger;
+use OCA\AdminAudit\IAuditLogger;
 use OCA\AdminAudit\Listener\CriticalActionPerformedEventListener;
 use OCP\App\ManagerEvent;
 use OCP\AppFramework\App;
@@ -65,6 +67,7 @@
 use OCP\Log\ILogFactory;
 use OCP\Share;
 use OCP\Util;
+use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\GenericEvent;
@@ -79,14 +82,16 @@ public function __construct() {
 	}
 
 	public function register(IRegistrationContext $context): void {
+		$context->registerService(IAuditLogger::class, function (ContainerInterface $c) {
+			return new AuditLogger($c->get(ILogFactory::class), $c->get(Iconfig::class));
+		});
+
 		$context->registerEventListener(CriticalActionPerformedEvent::class, CriticalActionPerformedEventListener::class);
 	}
 
 	public function boot(IBootContext $context): void {
-		/** @var LoggerInterface $logger */
-		$logger = $context->injectFn(
-			Closure::fromCallable([$this, 'getLogger'])
-		);
+		/** @var IAuditLogger $logger */
+		$logger = $context->getAppContainer()->get(IAuditLogger::class);
 
 		/*
 		 * TODO: once the hooks are migrated to lazy events, this should be done
@@ -95,26 +100,10 @@ public function boot(IBootContext $context): void {
 		$this->registerHooks($logger, $context->getServerContainer());
 	}
 
-	private function getLogger(IConfig $config,
-							   ILogFactory $logFactory): LoggerInterface {
-		$auditType = $config->getSystemValueString('log_type_audit', 'file');
-		$defaultTag = $config->getSystemValueString('syslog_tag', 'Nextcloud');
-		$auditTag = $config->getSystemValueString('syslog_tag_audit', $defaultTag);
-		$logFile = $config->getSystemValueString('logfile_audit', '');
-
-		if ($auditType === 'file' && !$logFile) {
-			$default = $config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/audit.log';
-			// Legacy way was appconfig, now it's paralleled with the normal log config
-			$logFile = $config->getAppValue('admin_audit', 'logfile', $default);
-		}
-
-		return $logFactory->getCustomPsrLogger($logFile, $auditType, $auditTag);
-	}
-
 	/**
 	 * Register hooks in order to log them
 	 */
-	private function registerHooks(LoggerInterface $logger,
+	private function registerHooks(IAuditLogger $logger,
 									 IServerContainer $serverContainer): void {
 		$this->userManagementHooks($logger, $serverContainer->get(IUserSession::class));
 		$this->groupHooks($logger, $serverContainer->get(IGroupManager::class));
@@ -134,7 +123,7 @@ private function registerHooks(LoggerInterface $logger,
 		$this->securityHooks($logger, $eventDispatcher);
 	}
 
-	private function userManagementHooks(LoggerInterface $logger,
+	private function userManagementHooks(IAuditLogger $logger,
 										 IUserSession $userSession): void {
 		$userActions = new UserManagement($logger);
 
@@ -148,7 +137,7 @@ private function userManagementHooks(LoggerInterface $logger,
 		$userSession->listen('\OC\User', 'postUnassignedUserId', [$userActions, 'unassign']);
 	}
 
-	private function groupHooks(LoggerInterface $logger,
+	private function groupHooks(IAuditLogger $logger,
 								IGroupManager $groupManager): void {
 		$groupActions = new GroupManagement($logger);
 
@@ -159,7 +148,7 @@ private function groupHooks(LoggerInterface $logger,
 		$groupManager->listen('\OC\Group', 'postCreate', [$groupActions, 'createGroup']);
 	}
 
-	private function sharingHooks(LoggerInterface $logger): void {
+	private function sharingHooks(IAuditLogger $logger): void {
 		$shareActions = new Sharing($logger);
 
 		Util::connectHook(Share::class, 'post_shared', $shareActions, 'shared');
@@ -171,15 +160,15 @@ private function sharingHooks(LoggerInterface $logger): void {
 		Util::connectHook(Share::class, 'share_link_access', $shareActions, 'shareAccessed');
 	}
 
-	private function authHooks(LoggerInterface $logger): void {
+	private function authHooks(IAuditLogger $logger): void {
 		$authActions = new Auth($logger);
 
 		Util::connectHook('OC_User', 'pre_login', $authActions, 'loginAttempt');
 		Util::connectHook('OC_User', 'post_login', $authActions, 'loginSuccessful');
 		Util::connectHook('OC_User', 'logout', $authActions, 'logout');
 	}
 
-	private function appHooks(LoggerInterface $logger,
+	private function appHooks(IAuditLogger $logger,
 							  EventDispatcherInterface $eventDispatcher): void {
 		$eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE, function (ManagerEvent $event) use ($logger) {
 			$appActions = new AppManagement($logger);
@@ -195,15 +184,15 @@ private function appHooks(LoggerInterface $logger,
 		});
 	}
 
-	private function consoleHooks(LoggerInterface $logger,
+	private function consoleHooks(IAuditLogger $logger,
 								  EventDispatcherInterface $eventDispatcher): void {
 		$eventDispatcher->addListener(ConsoleEvent::EVENT_RUN, function (ConsoleEvent $event) use ($logger) {
 			$appActions = new Console($logger);
 			$appActions->runCommand($event->getArguments());
 		});
 	}
 
-	private function fileHooks(LoggerInterface $logger,
+	private function fileHooks(IAuditLogger $logger,
 							   EventDispatcherInterface $eventDispatcher): void {
 		$fileActions = new Files($logger);
 		$eventDispatcher->addListener(
@@ -265,19 +254,19 @@ function (GenericEvent $event) use ($fileActions) {
 		);
 	}
 
-	private function versionsHooks(LoggerInterface $logger): void {
+	private function versionsHooks(IAuditLogger $logger): void {
 		$versionsActions = new Versions($logger);
 		Util::connectHook('\OCP\Versions', 'rollback', $versionsActions, 'rollback');
 		Util::connectHook('\OCP\Versions', 'delete', $versionsActions, 'delete');
 	}
 
-	private function trashbinHooks(LoggerInterface $logger): void {
+	private function trashbinHooks(IAuditLogger $logger): void {
 		$trashActions = new Trashbin($logger);
 		Util::connectHook('\OCP\Trashbin', 'preDelete', $trashActions, 'delete');
 		Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', $trashActions, 'restore');
 	}
 
-	private function securityHooks(LoggerInterface $logger,
+	private function securityHooks(IAuditLogger $logger,
 								   EventDispatcherInterface $eventDispatcher): void {
 		$eventDispatcher->addListener(IProvider::EVENT_SUCCESS, function (GenericEvent $event) use ($logger) {
 			$security = new Security($logger);

apps/admin_audit/lib/AuditLogger.php

@@ -0,0 +1,88 @@
+<?php
+/**
+ * @copyright Copyright (c) 2022 Carl Schwan <carl@carlschwan.eu>
+ *
+ * @author Carl Schwan <carl@carlschwan.eu>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\AdminAudit;
+
+use OCP\IConfig;
+use OCP\Log\ILogFactory;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Logger that logs in the audit log file instead of the normal log file
+ */
+class AuditLogger implements IAuditLogger {
+
+	/** @var LoggerInterface */
+	private $parentLogger;
+
+	public function __construct(ILogFactory $logFactory, IConfig $config) {
+		$auditType = $config->getSystemValueString('log_type_audit', 'file');
+		$defaultTag = $config->getSystemValueString('syslog_tag', 'Nextcloud');
+		$auditTag = $config->getSystemValueString('syslog_tag_audit', $defaultTag);
+		$logFile = $config->getSystemValueString('logfile_audit', '');
+
+		if ($auditType === 'file' && !$logFile) {
+			$default = $config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/audit.log';
+			// Legacy way was appconfig, now it's paralleled with the normal log config
+			$logFile = $config->getAppValue('admin_audit', 'logfile', $default);
+		}
+
+		$this->parentLogger = $logFactory->getCustomPsrLogger($logFile, $auditType, $auditTag);
+	}
+
+	public function emergency($message, array $context = array()) {
+		$this->parentLogger->emergency($message, $context);
+	}
+
+	public function alert($message, array $context = array()) {
+		$this->parentLogger->alert($message, $context);
+	}
+
+	public function critical($message, array $context = array()) {
+		$this->parentLogger->critical($message, $context);
+	}
+
+	public function error($message, array $context = array()) {
+		$this->parentLogger->error($message, $context);
+	}
+
+	public function warning($message, array $context = array()) {
+		$this->parentLogger->warning($message, $context);
+	}
+
+	public function notice($message, array $context = array()) {
+		$this->parentLogger->notice($message, $context);
+	}
+
+	public function info($message, array $context = array()) {
+		$this->parentLogger->info($message, $context);
+	}
+
+	public function debug($message, array $context = array()) {
+		$this->parentLogger->debug($message, $context);
+	}
+
+	public function log($level, $message, array $context = array()) {
+		$this->parentLogger->log($level, $message, $context);
+	}
+}

apps/admin_audit/lib/IAuditLogger.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * @copyright Copyright (c) 2022 Carl Schwan <carl@carlschwan.eu>
+ *
+ * @author Carl Schwan <carl@carlschwan.eu>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\AdminAudit;
+
+use Psr\Log\LoggerInterface;
+
+/**
+ * Interface for a logger that logs in the audit log file instead of the normal log file
+ */
+interface IAuditLogger extends LoggerInterface {
+}

apps/admin_audit/tests/Actions/SecurityTest.php

@@ -44,7 +44,7 @@ class SecurityTest extends TestCase {
 	protected function setUp(): void {
 		parent::setUp();
 
-		$this->logger = $this->createMock(LoggerInterface::class);
+		$this->logger = $this->createMock(AuditLogger::class);
 		$this->security = new Security($this->logger);
 
 		$this->user = $this->createMock(IUser::class);