openstack
/
cinder
Code Issues Proposed changes

Fix password masking result 

This patch fixes an issue where the method tracing was returning the
masked password, instead of the original return result.

Closes-Bug: 1616527
Change-Id: I524347d9c9b7640d9bb5b8fe5f6a04b901e45e6c
This commit is contained in:
Walter A. Boring IV 2016-08-24 08:56:43 -07:00
parent 112a25c82d
commit 7d84ee9085
2 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
cinder/tests/unit/test_utils.py
View File

@ -1264,8 +1264,10 @@ class LogTracingTestCase(test.TestCase):
self.assertEqual(2, mock_log.debug.call_count)
def test_utils_trace_method_with_password_dict(self):
mock_log = self.patch('cinder.utils.logging.getLogger')
mock_log().isEnabledFor.return_value = True
mock_logging = self.mock_object(utils, 'logging')
mock_log = mock.Mock()
mock_log.isEnabledFor = lambda x: True
mock_logging.getLogger = mock.Mock(return_value=mock_log)
@utils.trace_method
def _trace_test_method(*args, **kwargs):
@ -1273,28 +1275,33 @@ class LogTracingTestCase(test.TestCase):
'password': 'Now you see me'}
utils.setup_tracing(['method'])
result = _trace_test_method(self)
expected_unmasked_dict = {'something': 'test',
'password': 'Now you see me'}
expected_masked_dict = {'password': '***', 'something': 'test'}
self.assertEqual(expected_masked_dict, result)
self.assertEqual(expected_unmasked_dict, result)
self.assertEqual(2, mock_log.debug.call_count)
self.assertIn("'password': '***'",
str(mock_log.debug.call_args_list[1]))
def test_utils_trace_method_with_password_str(self):
mock_log = self.patch('cinder.utils.logging.getLogger')
mock_log().isEnabledFor.return_value = True
mock_logging = self.mock_object(utils, 'logging')
mock_log = mock.Mock()
mock_log.isEnabledFor = lambda x: True
mock_logging.getLogger = mock.Mock(return_value=mock_log)
@utils.trace_method
def _trace_test_method(*args, **kwargs):
return "'adminPass': 'Now you see me'"
utils.setup_tracing(['method'])
result = _trace_test_method(self)
expected_unmasked_str = "'adminPass': 'Now you see me'"
expected_masked_str = "'adminPass': '***'"
self.assertEqual(expected_masked_str, result)
self.assertEqual(expected_unmasked_str, result)
self.assertEqual(2, mock_log.debug.call_count)
self.assertIn("'adminPass': '***'",
str(mock_log.debug.call_args_list[1]))
def test_utils_calculate_virtual_free_capacity_with_thick(self):
host_stat = {'total_capacity_gb': 30.01,

8
cinder/utils.py
View File

@ -856,14 +856,16 @@ def trace(f):
total_time = int(round(time.time() * 1000)) - start_time
if isinstance(result, dict):
result = strutils.mask_dict_password(result)
mask_result = strutils.mask_dict_password(result)
elif isinstance(result, six.string_types):
result = strutils.mask_password(result)
mask_result = strutils.mask_password(result)
else:
mask_result = result
logger.debug('<== %(func)s: return (%(time)dms) %(result)r',
{'func': func_name,
'time': total_time,
'result': result})
'result': mask_result})
return result
return trace_logging_wrapper