+# -*- coding: utf-8 -*-
+
+# Copyright 2018 Telefonica S.A.
+#
+# 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 yaml
+import logging
+import re
from http import HTTPStatus
from copy import deepcopy
+from Crypto.Cipher import AES
+from base64 import b64decode, b64encode
+from osm_common.common_utils import FakeLock
+from threading import Lock
__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
class DbException(Exception):
def __init__(self, message, http_code=HTTPStatus.NOT_FOUND):
- # TODO change to http.HTTPStatus instead of int that allows .value and .name
self.http_code = http_code
- Exception.__init__(self, "database exception " + message)
+ Exception.__init__(self, "database exception " + str(message))
class DbBase(object):
- def __init__(self):
- pass
+ def __init__(self, logger_name='db', lock=False):
+ """
+ Constructor of dbBase
+ :param logger_name: logging name
+ :param lock: Used to protect simultaneous access to the same instance class by several threads:
+ False, None: Do not protect, this object will only be accessed by one thread
+ True: This object needs to be protected by several threads accessing.
+ Lock object. Use thi Lock for the threads access protection
+ """
+ self.logger = logging.getLogger(logger_name)
+ self.secret_key = None # 32 bytes length array used for encrypt/decrypt
+ if not lock:
+ self.lock = FakeLock()
+ elif lock is True:
+ self.lock = Lock()
+ elif isinstance(lock, Lock):
+ self.lock = lock
+ else:
+ raise ValueError("lock parameter must be a Lock classclass or boolean")
- def db_connect(self, config):
- pass
+ def db_connect(self, config, target_version=None):
+ """
+ Connect to database
+ :param config: Configuration of database. Contains among others:
+ host: database hosst (mandatory)
+ port: database port (mandatory)
+ name: database name (mandatory)
+ user: database username
+ password: database password
+ commonkey: common OSM key used for sensible information encryption
+ materpassword: same as commonkey, for backward compatibility. Deprecated, to be removed in the future
+ :param target_version: if provided it checks if database contains required version, raising exception otherwise.
+ :return: None or raises DbException on error
+ """
+ raise DbException("Method 'db_connect' not implemented")
def db_disconnect(self):
+ """
+ Disconnect from database
+ :return: None
+ """
pass
- def get_list(self, table, filter={}):
+ def get_list(self, table, q_filter=None):
+ """
+ Obtain a list of entries matching q_filter
+ :param table: collection or table
+ :param q_filter: Filter
+ :return: a list (can be empty) with the found entries. Raises DbException on error
+ """
raise DbException("Method 'get_list' not implemented")
- def get_one(self, table, filter={}, fail_on_empty=True, fail_on_more=True):
+ def count(self, table, q_filter=None):
+ """
+ Count the number of entries matching q_filter
+ :param table: collection or table
+ :param q_filter: Filter
+ :return: number of entries found (can be zero)
+ :raise: DbException on error
+ """
+ raise DbException("Method 'count' not implemented")
+
+ def get_one(self, table, q_filter=None, fail_on_empty=True, fail_on_more=True):
+ """
+ Obtain one entry matching q_filter
+ :param table: collection or table
+ :param q_filter: Filter
+ :param fail_on_empty: If nothing matches filter it returns None unless this flag is set tu True, in which case
+ it raises a DbException
+ :param fail_on_more: If more than one matches filter it returns one of then unless this flag is set tu True, so
+ that it raises a DbException
+ :return: The requested element, or None
+ """
raise DbException("Method 'get_one' not implemented")
+ def del_list(self, table, q_filter=None):
+ """
+ Deletes all entries that match q_filter
+ :param table: collection or table
+ :param q_filter: Filter
+ :return: Dict with the number of entries deleted
+ """
+ raise DbException("Method 'del_list' not implemented")
+
+ def del_one(self, table, q_filter=None, fail_on_empty=True):
+ """
+ Deletes one entry that matches q_filter
+ :param table: collection or table
+ :param q_filter: Filter
+ :param fail_on_empty: If nothing matches filter it returns '0' deleted unless this flag is set tu True, in
+ which case it raises a DbException
+ :return: Dict with the number of entries deleted
+ """
+ raise DbException("Method 'del_one' not implemented")
+
def create(self, table, indata):
+ """
+ Add a new entry at database
+ :param table: collection or table
+ :param indata: content to be added
+ :return: database id of the inserted element. Raises a DbException on error
+ """
raise DbException("Method 'create' not implemented")
- def del_list(self, table, filter={}):
- raise DbException("Method 'del_list' not implemented")
+ def set_one(self, table, q_filter, update_dict, fail_on_empty=True, unset=None, pull=None, push=None):
+ """
+ Modifies an entry at database
+ :param table: collection or table
+ :param q_filter: Filter
+ :param update_dict: Plain dictionary with the content to be updated. It is a dot separated keys and a value
+ :param fail_on_empty: If nothing matches filter it returns None unless this flag is set tu True, in which case
+ it raises a DbException
+ :param unset: Plain dictionary with the content to be removed if exist. It is a dot separated keys, value is
+ ignored. If not exist, it is ignored
+ :param pull: Plain dictionary with the content to be removed from an array. It is a dot separated keys and value
+ if exist in the array is removed. If not exist, it is ignored
+ :param push: Plain dictionary with the content to be appended to an array. It is a dot separated keys and value
+ is appended to the end of the array
+ :return: Dict with the number of entries modified. None if no matching is found.
+ """
+ raise DbException("Method 'set_one' not implemented")
- def del_one(self, table, filter={}, fail_on_empty=True):
- raise DbException("Method 'del_one' not implemented")
+ def set_list(self, table, q_filter, update_dict):
+ """
+ Modifies al matching entries at database
+ :param table: collection or table
+ :param q_filter: Filter
+ :param update_dict: Plain dictionary with the content to be updated. It is a dot separated keys and a value
+ :return: Dict with the number of entries modified
+ """
+ raise DbException("Method 'set_list' not implemented")
+
+ def replace(self, table, _id, indata, fail_on_empty=True):
+ """
+ Replace the content of an entry
+ :param table: collection or table
+ :param _id: internal database id
+ :param indata: content to replace
+ :param fail_on_empty: If nothing matches filter it returns None unless this flag is set tu True, in which case
+ it raises a DbException
+ :return: Dict with the number of entries replaced
+ """
+ raise DbException("Method 'replace' not implemented")
+
+ def _join_secret_key(self, update_key):
+ """
+ Returns a xor byte combination of the internal secret_key and the provided update_key.
+ It does not modify the internal secret_key. Used for adding salt, join keys, etc.
+ :param update_key: Can be a string, byte or None. Recommended a long one (e.g. 32 byte length)
+ :return: joined key in bytes with a 32 bytes length. Can be None if both internal secret_key and update_key
+ are None
+ """
+ if not update_key:
+ return self.secret_key
+ elif isinstance(update_key, str):
+ update_key_bytes = update_key.encode()
+ else:
+ update_key_bytes = update_key
+ new_secret_key = bytearray(self.secret_key) if self.secret_key else bytearray(32)
+ for i, b in enumerate(update_key_bytes):
+ new_secret_key[i % 32] ^= b
+ return bytes(new_secret_key)
-def deep_update(dict_to_change, dict_reference, key_list=None):
+ def set_secret_key(self, new_secret_key, replace=False):
+ """
+ Updates internal secret_key used for encryption, with a byte xor
+ :param new_secret_key: string or byte array. It is recommended a 32 byte length
+ :param replace: if True, old value of internal secret_key is ignored and replaced. If false, a byte xor is used
+ :return: None
+ """
+ if replace:
+ self.secret_key = None
+ self.secret_key = self._join_secret_key(new_secret_key)
+
+ def get_secret_key(self):
+ """
+ Get the database secret key in case it is not done when "connect" is called. It can happens when database is
+ empty after an initial install. It should skip if secret is already obtained.
+ """
+ pass
+
+ def encrypt(self, value, schema_version=None, salt=None):
+ """
+ Encrypt a value
+ :param value: value to be encrypted. It is string/unicode
+ :param schema_version: used for version control. If None or '1.0' no encryption is done.
+ If '1.1' symmetric AES encryption is done
+ :param salt: optional salt to be used. Must be str
+ :return: Encrypted content of value
+ """
+ self.get_secret_key()
+ if not self.secret_key or not schema_version or schema_version == '1.0':
+ return value
+ else:
+ secret_key = self._join_secret_key(salt)
+ cipher = AES.new(secret_key)
+ padded_private_msg = value + ('\0' * ((16-len(value)) % 16))
+ encrypted_msg = cipher.encrypt(padded_private_msg)
+ encoded_encrypted_msg = b64encode(encrypted_msg)
+ return encoded_encrypted_msg.decode("ascii")
+
+ def decrypt(self, value, schema_version=None, salt=None):
+ """
+ Decrypt an encrypted value
+ :param value: value to be decrypted. It is a base64 string
+ :param schema_version: used for known encryption method used. If None or '1.0' no encryption has been done.
+ If '1.1' symmetric AES encryption has been done
+ :param salt: optional salt to be used
+ :return: Plain content of value
+ """
+ self.get_secret_key()
+ if not self.secret_key or not schema_version or schema_version == '1.0':
+ return value
+ else:
+ secret_key = self._join_secret_key(salt)
+ encrypted_msg = b64decode(value)
+ cipher = AES.new(secret_key)
+ decrypted_msg = cipher.decrypt(encrypted_msg)
+ try:
+ unpadded_private_msg = decrypted_msg.decode().rstrip('\0')
+ except UnicodeDecodeError:
+ raise DbException("Cannot decrypt information. Are you using same COMMONKEY in all OSM components?",
+ http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
+ return unpadded_private_msg
+
+ def encrypt_decrypt_fields(self, item, action, fields=None, flags=re.I, schema_version=None, salt=None):
+ if not fields:
+ return
+ self.get_secret_key()
+ actions = ['encrypt', 'decrypt']
+ if action.lower() not in actions:
+ raise DbException("Unknown action ({}): Must be one of {}".format(action, actions),
+ http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
+ method = self.encrypt if action.lower() == 'encrypt' else self.decrypt
+
+ def process(item):
+ if isinstance(item, list):
+ for elem in item:
+ process(elem)
+ elif isinstance(item, dict):
+ for key, val in item.items():
+ if any(re.search(f, key, flags) for f in fields) and isinstance(val, str):
+ item[key] = method(val, schema_version, salt)
+ else:
+ process(val)
+
+ process(item)
+
+
+def deep_update_rfc7396(dict_to_change, dict_reference, key_list=None):
"""
Modifies one dictionary with the information of the other following https://tools.ietf.org/html/rfc7396
Basically is a recursive python 'dict_to_change.update(dict_reference)', but a value of None is used to delete.
Nothing happens if no match is found. If the value is None the matched elements are deleted.
$key: val In case a dictionary is passed in yaml format, if looks for all items in the array dict_to_change
that are dictionaries and contains this <key> equal to <val>. Several keys can be used by yaml
- format '{key: val, key: val, ...}'; and all of them mast match. Nothing happens if no match is
+ format '{key: val, key: val, ...}'; and all of them must match. Nothing happens if no match is
found. If value is None the matched items are deleted, otherwise they are edited.
$+val If no match if found (see '$val'), the value is appended to the array. If any match is found nothing
is changed. A value of None has not sense.
elif not isinstance(values_to_edit_delete[index], dict): # NotDict->Anything
array_to_change[index] = deepcopy(values_to_edit_delete[index])
elif isinstance(array_to_change[index], dict): # Dict->Dict
- deep_update(array_to_change[index], values_to_edit_delete[index], _key_list)
+ deep_update_rfc7396(array_to_change[index], values_to_edit_delete[index], _key_list)
else: # Dict->NotDict
if isinstance(array_to_change[index], list): # Dict->List. Check extra array edition
if _deep_update_array(array_to_change[index], values_to_edit_delete[index], _key_list):
continue
array_to_change[index] = deepcopy(values_to_edit_delete[index])
- # calling deep_update to delete the None values
- deep_update(array_to_change[index], values_to_edit_delete[index], _key_list)
+ # calling deep_update_rfc7396 to delete the None values
+ deep_update_rfc7396(array_to_change[index], values_to_edit_delete[index], _key_list)
except IndexError:
raise DbException("Array edition index out of range at '{}'".format(":".join(_key_list)))
_key_list[-1] = str(k)
insert_value_copy = deepcopy(insert_value)
if isinstance(insert_value_copy, dict):
- # calling deep_update to delete the None values
- deep_update(insert_value_copy, insert_value, _key_list)
+ # calling deep_update_rfc7396 to delete the None values
+ deep_update_rfc7396(insert_value_copy, insert_value, _key_list)
array_to_change.append(insert_value_copy)
_key_list.pop()
dict_to_change[k] = deepcopy(dict_reference[k])
elif k not in dict_to_change: # Dict->Empty
dict_to_change[k] = deepcopy(dict_reference[k])
- # calling deep_update to delete the None values
- deep_update(dict_to_change[k], dict_reference[k], key_list)
+ # calling deep_update_rfc7396 to delete the None values
+ deep_update_rfc7396(dict_to_change[k], dict_reference[k], key_list)
elif isinstance(dict_to_change[k], dict): # Dict->Dict
- deep_update(dict_to_change[k], dict_reference[k], key_list)
+ deep_update_rfc7396(dict_to_change[k], dict_reference[k], key_list)
else: # Dict->NotDict
if isinstance(dict_to_change[k], list): # Dict->List. Check extra array edition
if _deep_update_array(dict_to_change[k], dict_reference[k], key_list):
continue
dict_to_change[k] = deepcopy(dict_reference[k])
- # calling deep_update to delete the None values
- deep_update(dict_to_change[k], dict_reference[k], key_list)
+ # calling deep_update_rfc7396 to delete the None values
+ deep_update_rfc7396(dict_to_change[k], dict_reference[k], key_list)
key_list.pop()
+
+
+def deep_update(dict_to_change, dict_reference):
+ """ Maintained for backward compatibility. Use deep_update_rfc7396 instead"""
+ return deep_update_rfc7396(dict_to_change, dict_reference)
projects / osm / common.git / blobdiff