diff options
author | Morris Jobke <hey@morrisjobke.de> | 2015-09-24 17:01:31 +0200 |
---|---|---|
committer | Morris Jobke <hey@morrisjobke.de> | 2015-09-24 20:01:30 +0200 |
commit | db8e7ce8b95c882c876f932296f25ec08883a1d3 (patch) | |
tree | 807952698b4a0704172285f989563ac572df2762 /lib | |
parent | 846b8268672df2c626616fec5f71e15570005e84 (diff) | |
download | nextcloud-server-db8e7ce8b95c882c876f932296f25ec08883a1d3.tar.gz nextcloud-server-db8e7ce8b95c882c876f932296f25ec08883a1d3.zip |
Remove passwords from logged exception stack traces
* fixed #16318
* create logException in ILogger
* add unit tests
Diffstat (limited to 'lib')
-rw-r--r-- | lib/private/log.php | 21 | ||||
-rw-r--r-- | lib/public/ilogger.php | 10 | ||||
-rw-r--r-- | lib/public/util.php | 11 |
3 files changed, 33 insertions, 9 deletions
diff --git a/lib/private/log.php b/lib/private/log.php index 3c0e7b45d1b..1b26ece7624 100644 --- a/lib/private/log.php +++ b/lib/private/log.php @@ -241,4 +241,25 @@ class Log implements ILogger { call_user_func(array($logger, 'write'), $app, $message, $level); } } + + /** + * Logs an exception very detailed + * + * @param \Exception $exception + * @param array $context + * @return void + * @since 8.2.0 + */ + public function logException(\Exception $exception, array $context = array()) { + $exception = array( + 'Exception' => get_class($exception), + 'Message' => $exception->getMessage(), + 'Code' => $exception->getCode(), + 'Trace' => $exception->getTraceAsString(), + 'File' => $exception->getFile(), + 'Line' => $exception->getLine(), + ); + $exception['Trace'] = preg_replace('!(login|checkPassword)\(.*\)!', '$1(*** username and password replaced ***)', $exception['Trace']); + $this->error('Exception: ' . json_encode($exception), $context); + } } diff --git a/lib/public/ilogger.php b/lib/public/ilogger.php index 43b1ef70e5b..27a5d63dfdb 100644 --- a/lib/public/ilogger.php +++ b/lib/public/ilogger.php @@ -122,4 +122,14 @@ interface ILogger { * @since 7.0.0 */ public function log($level, $message, array $context = array()); + + /** + * Logs an exception very detailed + * + * @param \Exception $exception + * @param array $context + * @return void + * @since 8.2.0 + */ + public function logException(\Exception $exception, array $context = array()); } diff --git a/lib/public/util.php b/lib/public/util.php index c32668b14a8..652df5192cf 100644 --- a/lib/public/util.php +++ b/lib/public/util.php @@ -158,17 +158,10 @@ class Util { * @param \Exception $ex exception to log * @param int $level log level, defaults to \OCP\Util::FATAL * @since ....0.0 - parameter $level was added in 7.0.0 + * @deprecated 8.2.0 use logException of \OCP\ILogger */ public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) { - $exception = array( - 'Exception' => get_class($ex), - 'Message' => $ex->getMessage(), - 'Code' => $ex->getCode(), - 'Trace' => $ex->getTraceAsString(), - 'File' => $ex->getFile(), - 'Line' => $ex->getLine(), - ); - \OCP\Util::writeLog($app, 'Exception: ' . json_encode($exception), $level); + \OC::$server->getLogger()->logException($ex, ['app' => $app]); } /** |