mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Remove passwords from logged exception stack traces 

* fixed #16318
* create logException in ILogger
* add unit tests
This commit is contained in:
Morris Jobke 2015-09-24 17:01:31 +02:00
parent 846b826867
commit db8e7ce8b9
4 changed files with 77 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
lib/private/log.php
View File

@ -241,4 +241,25 @@ class Log implements ILogger {
call_user_func(array($logger, 'write'), $app, $message, $level); 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);
}
} }

10
lib/public/ilogger.php
View File

@ -122,4 +122,14 @@ interface ILogger {
* @since 7.0.0 * @since 7.0.0
*/ */
public function log($level, $message, array $context = array()); 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());
} }

11
lib/public/util.php
View File

@ -158,17 +158,10 @@ class Util {
* @param \Exception $ex exception to log * @param \Exception $ex exception to log
* @param int $level log level, defaults to \OCP\Util::FATAL * @param int $level log level, defaults to \OCP\Util::FATAL
* @since ....0.0 - parameter $level was added in 7.0.0 * @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 ) { public static function logException( $app, \Exception $ex, $level = \OCP\Util::FATAL ) {
$exception = array( \OC::$server->getLogger()->logException($ex, ['app' => $app]);
'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);
} }
/** /**

44
tests/lib/logger.php
View File

@ -63,4 +63,48 @@ class Logger extends TestCase {
public static function write($app, $message, $level) { public static function write($app, $message, $level) {
self::$logs[]= "$level $message"; self::$logs[]= "$level $message";
} }
public function userAndPasswordData() {
return [
['abc', 'def'],
['mySpecialUsername', 'MySuperSecretPassword'],
['my-user', '324324()#ä234'],
['my-user', ')qwer'],
['my-user', 'qwer)asdf'],
['my-user', 'qwer)'],
['my-user', '(qwer'],
['my-user', 'qwer(asdf'],
['my-user', 'qwer('],
];
}
/**
* @dataProvider userAndPasswordData
*/
public function testDetectlogin($user, $password) {
$e = new \Exception('test');
$this->logger->logException($e);
$logLines = $this->getLogs();
foreach($logLines as $logLine) {
$this->assertNotContains($user, $logLine);
$this->assertNotContains($password, $logLine);
$this->assertContains('login(*** username and password replaced ***)', $logLine);
}
}
/**
* @dataProvider userAndPasswordData
*/
public function testDetectcheckPassword($user, $password) {
$e = new \Exception('test');
$this->logger->logException($e);
$logLines = $this->getLogs();
foreach($logLines as $logLine) {
$this->assertNotContains($user, $logLine);
$this->assertNotContains($password, $logLine);
$this->assertContains('checkPassword(*** username and password replaced ***)', $logLine);
}
}
} }