nextcloud / server

lib/private/Log/ExceptionSerializer.php

Indentation +264 added lines, -264 removed lines

@@ -42,268 +42,268 @@
 use OCP\HintException;
 
 class ExceptionSerializer {
-	public const SENSITIVE_VALUE_PLACEHOLDER = '*** sensitive parameters replaced ***';
-
-	public const methodsWithSensitiveParameters = [
-		// Session/User
-		'completeLogin',
-		'login',
-		'checkPassword',
-		'checkPasswordNoLogging',
-		'loginWithPassword',
-		'updatePrivateKeyPassword',
-		'validateUserPass',
-		'loginWithToken',
-		'{closure}',
-		'createSessionToken',
-
-		// Provisioning
-		'addUser',
-
-		// TokenProvider
-		'getToken',
-		'isTokenPassword',
-		'getPassword',
-		'decryptPassword',
-		'logClientIn',
-		'generateToken',
-		'validateToken',
-
-		// TwoFactorAuth
-		'solveChallenge',
-		'verifyChallenge',
-
-		// ICrypto
-		'calculateHMAC',
-		'encrypt',
-		'decrypt',
-
-		// LoginController
-		'tryLogin',
-		'confirmPassword',
-
-		// LDAP
-		'bind',
-		'areCredentialsValid',
-		'invokeLDAPMethod',
-
-		// Encryption
-		'storeKeyPair',
-		'setupUser',
-		'checkSignature',
-
-		// files_external: OCA\Files_External\MountConfig
-		'getBackendStatus',
-
-		// files_external: UserStoragesController
-		'update',
-
-		// Preview providers, don't log big data strings
-		'imagecreatefromstring',
-
-		// text: PublicSessionController, SessionController and ApiService
-		'create',
-		'close',
-		'push',
-		'sync',
-		'updateSession',
-		'mention',
-		'loginSessionUser',
-
-	];
-
-	/** @var SystemConfig */
-	private $systemConfig;
-
-	public function __construct(SystemConfig $systemConfig) {
-		$this->systemConfig = $systemConfig;
-	}
-
-	protected array $methodsWithSensitiveParametersByClass = [
-		SetupController::class => [
-			'run',
-			'display',
-			'loadAutoConfig',
-		],
-		Setup::class => [
-			'install'
-		],
-		Key::class => [
-			'__construct'
-		],
-		\Redis::class => [
-			'auth'
-		],
-		\RedisCluster::class => [
-			'__construct'
-		],
-		Crypt::class => [
-			'symmetricEncryptFileContent',
-			'encrypt',
-			'generatePasswordHash',
-			'encryptPrivateKey',
-			'decryptPrivateKey',
-			'isValidPrivateKey',
-			'symmetricDecryptFileContent',
-			'checkSignature',
-			'createSignature',
-			'decrypt',
-			'multiKeyDecrypt',
-			'multiKeyEncrypt',
-		],
-		RecoveryController::class => [
-			'adminRecovery',
-			'changeRecoveryPassword'
-		],
-		SettingsController::class => [
-			'updatePrivateKeyPassword',
-		],
-		Encryption::class => [
-			'encrypt',
-			'decrypt',
-		],
-		KeyManager::class => [
-			'checkRecoveryPassword',
-			'storeKeyPair',
-			'setRecoveryKey',
-			'setPrivateKey',
-			'setFileKey',
-			'setAllFileKeys',
-		],
-		Session::class => [
-			'setPrivateKey',
-			'prepareDecryptAll',
-		],
-		\OCA\Encryption\Users\Setup::class => [
-			'setupUser',
-		],
-		UserHooks::class => [
-			'login',
-			'postCreateUser',
-			'postDeleteUser',
-			'prePasswordReset',
-			'postPasswordReset',
-			'preSetPassphrase',
-			'setPassphrase',
-		],
-	];
-
-	private function editTrace(array &$sensitiveValues, array $traceLine): array {
-		if (isset($traceLine['args'])) {
-			$sensitiveValues = array_merge($sensitiveValues, $traceLine['args']);
-		}
-		$traceLine['args'] = [self::SENSITIVE_VALUE_PLACEHOLDER];
-		return $traceLine;
-	}
-
-	private function filterTrace(array $trace) {
-		$sensitiveValues = [];
-		$trace = array_map(function (array $traceLine) use (&$sensitiveValues) {
-			$className = $traceLine['class'] ?? '';
-			if ($className && isset($this->methodsWithSensitiveParametersByClass[$className])
-				&& in_array($traceLine['function'], $this->methodsWithSensitiveParametersByClass[$className], true)) {
-				return $this->editTrace($sensitiveValues, $traceLine);
-			}
-			foreach (self::methodsWithSensitiveParameters as $sensitiveMethod) {
-				if (strpos($traceLine['function'], $sensitiveMethod) !== false) {
-					return $this->editTrace($sensitiveValues, $traceLine);
-				}
-			}
-			return $traceLine;
-		}, $trace);
-		return array_map(function (array $traceLine) use ($sensitiveValues) {
-			if (isset($traceLine['args'])) {
-				$traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues);
-			}
-			return $traceLine;
-		}, $trace);
-	}
-
-	private function removeValuesFromArgs($args, $values) {
-		$workArgs = [];
-		foreach ($args as $arg) {
-			if (in_array($arg, $values, true)) {
-				$arg = self::SENSITIVE_VALUE_PLACEHOLDER;
-			} elseif (is_array($arg)) {
-				$arg = $this->removeValuesFromArgs($arg, $values);
-			}
-			$workArgs[] = $arg;
-		}
-		return $workArgs;
-	}
-
-	private function encodeTrace($trace) {
-		$trace = array_map(function (array $line) {
-			if (isset($line['args'])) {
-				$line['args'] = array_map([$this, 'encodeArg'], $line['args']);
-			}
-			return $line;
-		}, $trace);
-		return $this->filterTrace($trace);
-	}
-
-	private function encodeArg($arg, $nestingLevel = 5) {
-		if (is_object($arg)) {
-			if ($nestingLevel === 0) {
-				return [
-					'__class__' => get_class($arg),
-					'__properties__' => 'Encoding skipped as the maximum nesting level was reached',
-				];
-			}
-
-			$objectInfo = [ '__class__' => get_class($arg) ];
-			$objectVars = get_object_vars($arg);
-			return array_map(function ($arg) use ($nestingLevel) {
-				return $this->encodeArg($arg, $nestingLevel - 1);
-			}, array_merge($objectInfo, $objectVars));
-		}
-
-		if (is_array($arg)) {
-			if ($nestingLevel === 0) {
-				return ['Encoding skipped as the maximum nesting level was reached'];
-			}
-
-			// Only log the first 5 elements of an array unless we are on debug
-			if ((int)$this->systemConfig->getValue('loglevel', 2) !== 0) {
-				$elemCount = count($arg);
-				if ($elemCount > 5) {
-					$arg = array_slice($arg, 0, 5);
-					$arg[] = 'And ' . ($elemCount - 5) . ' more entries, set log level to debug to see all entries';
-				}
-			}
-			return array_map(function ($e) use ($nestingLevel) {
-				return $this->encodeArg($e, $nestingLevel - 1);
-			}, $arg);
-		}
-
-		return $arg;
-	}
-
-	public function serializeException(\Throwable $exception) {
-		$data = [
-			'Exception' => get_class($exception),
-			'Message' => $exception->getMessage(),
-			'Code' => $exception->getCode(),
-			'Trace' => $this->encodeTrace($exception->getTrace()),
-			'File' => $exception->getFile(),
-			'Line' => $exception->getLine(),
-		];
-
-		if ($exception instanceof HintException) {
-			$data['Hint'] = $exception->getHint();
-		}
-
-		if ($exception->getPrevious()) {
-			$data['Previous'] = $this->serializeException($exception->getPrevious());
-		}
-
-		return $data;
-	}
-
-	public function enlistSensitiveMethods(string $class, array $methods): void {
-		if (!isset($this->methodsWithSensitiveParametersByClass[$class])) {
-			$this->methodsWithSensitiveParametersByClass[$class] = [];
-		}
-		$this->methodsWithSensitiveParametersByClass[$class] = array_merge($this->methodsWithSensitiveParametersByClass[$class], $methods);
-	}
+    public const SENSITIVE_VALUE_PLACEHOLDER = '*** sensitive parameters replaced ***';
+
+    public const methodsWithSensitiveParameters = [
+        // Session/User
+        'completeLogin',
+        'login',
+        'checkPassword',
+        'checkPasswordNoLogging',
+        'loginWithPassword',
+        'updatePrivateKeyPassword',
+        'validateUserPass',
+        'loginWithToken',
+        '{closure}',
+        'createSessionToken',
+
+        // Provisioning
+        'addUser',
+
+        // TokenProvider
+        'getToken',
+        'isTokenPassword',
+        'getPassword',
+        'decryptPassword',
+        'logClientIn',
+        'generateToken',
+        'validateToken',
+
+        // TwoFactorAuth
+        'solveChallenge',
+        'verifyChallenge',
+
+        // ICrypto
+        'calculateHMAC',
+        'encrypt',
+        'decrypt',
+
+        // LoginController
+        'tryLogin',
+        'confirmPassword',
+
+        // LDAP
+        'bind',
+        'areCredentialsValid',
+        'invokeLDAPMethod',
+
+        // Encryption
+        'storeKeyPair',
+        'setupUser',
+        'checkSignature',
+
+        // files_external: OCA\Files_External\MountConfig
+        'getBackendStatus',
+
+        // files_external: UserStoragesController
+        'update',
+
+        // Preview providers, don't log big data strings
+        'imagecreatefromstring',
+
+        // text: PublicSessionController, SessionController and ApiService
+        'create',
+        'close',
+        'push',
+        'sync',
+        'updateSession',
+        'mention',
+        'loginSessionUser',
+
+    ];
+
+    /** @var SystemConfig */
+    private $systemConfig;
+
+    public function __construct(SystemConfig $systemConfig) {
+        $this->systemConfig = $systemConfig;
+    }
+
+    protected array $methodsWithSensitiveParametersByClass = [
+        SetupController::class => [
+            'run',
+            'display',
+            'loadAutoConfig',
+        ],
+        Setup::class => [
+            'install'
+        ],
+        Key::class => [
+            '__construct'
+        ],
+        \Redis::class => [
+            'auth'
+        ],
+        \RedisCluster::class => [
+            '__construct'
+        ],
+        Crypt::class => [
+            'symmetricEncryptFileContent',
+            'encrypt',
+            'generatePasswordHash',
+            'encryptPrivateKey',
+            'decryptPrivateKey',
+            'isValidPrivateKey',
+            'symmetricDecryptFileContent',
+            'checkSignature',
+            'createSignature',
+            'decrypt',
+            'multiKeyDecrypt',
+            'multiKeyEncrypt',
+        ],
+        RecoveryController::class => [
+            'adminRecovery',
+            'changeRecoveryPassword'
+        ],
+        SettingsController::class => [
+            'updatePrivateKeyPassword',
+        ],
+        Encryption::class => [
+            'encrypt',
+            'decrypt',
+        ],
+        KeyManager::class => [
+            'checkRecoveryPassword',
+            'storeKeyPair',
+            'setRecoveryKey',
+            'setPrivateKey',
+            'setFileKey',
+            'setAllFileKeys',
+        ],
+        Session::class => [
+            'setPrivateKey',
+            'prepareDecryptAll',
+        ],
+        \OCA\Encryption\Users\Setup::class => [
+            'setupUser',
+        ],
+        UserHooks::class => [
+            'login',
+            'postCreateUser',
+            'postDeleteUser',
+            'prePasswordReset',
+            'postPasswordReset',
+            'preSetPassphrase',
+            'setPassphrase',
+        ],
+    ];
+
+    private function editTrace(array &$sensitiveValues, array $traceLine): array {
+        if (isset($traceLine['args'])) {
+            $sensitiveValues = array_merge($sensitiveValues, $traceLine['args']);
+        }
+        $traceLine['args'] = [self::SENSITIVE_VALUE_PLACEHOLDER];
+        return $traceLine;
+    }
+
+    private function filterTrace(array $trace) {
+        $sensitiveValues = [];
+        $trace = array_map(function (array $traceLine) use (&$sensitiveValues) {
+            $className = $traceLine['class'] ?? '';
+            if ($className && isset($this->methodsWithSensitiveParametersByClass[$className])
+                && in_array($traceLine['function'], $this->methodsWithSensitiveParametersByClass[$className], true)) {
+                return $this->editTrace($sensitiveValues, $traceLine);
+            }
+            foreach (self::methodsWithSensitiveParameters as $sensitiveMethod) {
+                if (strpos($traceLine['function'], $sensitiveMethod) !== false) {
+                    return $this->editTrace($sensitiveValues, $traceLine);
+                }
+            }
+            return $traceLine;
+        }, $trace);
+        return array_map(function (array $traceLine) use ($sensitiveValues) {
+            if (isset($traceLine['args'])) {
+                $traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues);
+            }
+            return $traceLine;
+        }, $trace);
+    }
+
+    private function removeValuesFromArgs($args, $values) {
+        $workArgs = [];
+        foreach ($args as $arg) {
+            if (in_array($arg, $values, true)) {
+                $arg = self::SENSITIVE_VALUE_PLACEHOLDER;
+            } elseif (is_array($arg)) {
+                $arg = $this->removeValuesFromArgs($arg, $values);
+            }
+            $workArgs[] = $arg;
+        }
+        return $workArgs;
+    }
+
+    private function encodeTrace($trace) {
+        $trace = array_map(function (array $line) {
+            if (isset($line['args'])) {
+                $line['args'] = array_map([$this, 'encodeArg'], $line['args']);
+            }
+            return $line;
+        }, $trace);
+        return $this->filterTrace($trace);
+    }
+
+    private function encodeArg($arg, $nestingLevel = 5) {
+        if (is_object($arg)) {
+            if ($nestingLevel === 0) {
+                return [
+                    '__class__' => get_class($arg),
+                    '__properties__' => 'Encoding skipped as the maximum nesting level was reached',
+                ];
+            }
+
+            $objectInfo = [ '__class__' => get_class($arg) ];
+            $objectVars = get_object_vars($arg);
+            return array_map(function ($arg) use ($nestingLevel) {
+                return $this->encodeArg($arg, $nestingLevel - 1);
+            }, array_merge($objectInfo, $objectVars));
+        }
+
+        if (is_array($arg)) {
+            if ($nestingLevel === 0) {
+                return ['Encoding skipped as the maximum nesting level was reached'];
+            }
+
+            // Only log the first 5 elements of an array unless we are on debug
+            if ((int)$this->systemConfig->getValue('loglevel', 2) !== 0) {
+                $elemCount = count($arg);
+                if ($elemCount > 5) {
+                    $arg = array_slice($arg, 0, 5);
+                    $arg[] = 'And ' . ($elemCount - 5) . ' more entries, set log level to debug to see all entries';
+                }
+            }
+            return array_map(function ($e) use ($nestingLevel) {
+                return $this->encodeArg($e, $nestingLevel - 1);
+            }, $arg);
+        }
+
+        return $arg;
+    }
+
+    public function serializeException(\Throwable $exception) {
+        $data = [
+            'Exception' => get_class($exception),
+            'Message' => $exception->getMessage(),
+            'Code' => $exception->getCode(),
+            'Trace' => $this->encodeTrace($exception->getTrace()),
+            'File' => $exception->getFile(),
+            'Line' => $exception->getLine(),
+        ];
+
+        if ($exception instanceof HintException) {
+            $data['Hint'] = $exception->getHint();
+        }
+
+        if ($exception->getPrevious()) {
+            $data['Previous'] = $this->serializeException($exception->getPrevious());
+        }
+
+        return $data;
+    }
+
+    public function enlistSensitiveMethods(string $class, array $methods): void {
+        if (!isset($this->methodsWithSensitiveParametersByClass[$class])) {
+            $this->methodsWithSensitiveParametersByClass[$class] = [];
+        }
+        $this->methodsWithSensitiveParametersByClass[$class] = array_merge($this->methodsWithSensitiveParametersByClass[$class], $methods);
+    }
 }