deb-murano/murano/common/helpers/token_sanitizer.py
Ravi Shekhar Jethani f963039bd7 Python3: Replace basestring by six.string_types
The builtin basestring abstract type was removed in python3,
use str instead, we need to use six.string_types to replace
the basestring for py3 compatibility.

This patch was generated by the following tool using 'basestring'
option.

https://github.com/haypo/sixer
Command:
python sixer.py -w basestring murano/

This also adds a check to murano/hacking/checks.py that should
catch this error in the future.

Blueprint murano-python-3-support

Change-Id: I26c236ce6dd2fffd6a4ca50e55ad62deb01bd9dd
2016-01-18 23:48:37 -08:00

65 lines
2.2 KiB
Python

# Copyright (c) 2013 Mirantis Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import six
class TokenSanitizer(object):
"""Helper class for cleaning some object from different passwords/tokens.
Simply searches attribute with `look a like` name as one of
the token and replace it value with message.
"""
def __init__(self, tokens=('token', 'pass', 'trustid'),
message='*** SANITIZED ***'):
"""Init method of TokenSanitizer.
:param tokens: iterable with tokens
:param message: string by which each token going to be replaced
"""
self._tokens = tokens
self._message = message
@property
def tokens(self):
"""Iterable with tokens that should be sanitized."""
return self._tokens
@property
def message(self):
"""String by which each token going to be replaced."""
return self._message
def _contains_token(self, value):
for token in self.tokens:
if token in value.lower():
return True
return False
def sanitize(self, obj):
"""Replaces each token found in object by message.
:param obj: dict, list, tuple, object
:return: Sanitized object
"""
if isinstance(obj, dict):
return dict([self.sanitize(item) for item in six.iteritems(obj)])
elif isinstance(obj, list):
return [self.sanitize(item) for item in obj]
elif isinstance(obj, tuple):
k, v = obj
if self._contains_token(k) and isinstance(v, six.string_types):
return k, self.message
return k, self.sanitize(v)
else:
return obj