X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osm_common%2Fdbbase.py;h=8d694a270ec0aefdeffd5107ddca60f34af20cf3;hb=refs%2Fchanges%2F60%2F9760%2F3;hp=b418079e6677dd1f9f6dc95c7c217c76ba8a92c1;hpb=eef7cb7a4f704bf0d29e6d8ece5195dc3faabb69;p=osm%2Fcommon.git diff --git a/osm_common/dbbase.py b/osm_common/dbbase.py index b418079..8d694a2 100644 --- a/osm_common/dbbase.py +++ b/osm_common/dbbase.py @@ -17,6 +17,7 @@ import yaml import logging +import re from http import HTTPStatus from copy import deepcopy from Crypto.Cipher import AES @@ -60,7 +61,7 @@ class DbBase(object): """ Connect to database :param config: Configuration of database. Contains among others: - host: database hosst (mandatory) + host: database host (mandatory) port: database port (mandatory) name: database name (mandatory) user: database username @@ -88,6 +89,16 @@ class DbBase(object): """ raise DbException("Method 'get_list' not implemented") + 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 @@ -126,11 +137,22 @@ class DbBase(object): 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 + :return: database '_id' of the inserted element. Raises a DbException on error """ raise DbException("Method 'create' not implemented") - def set_one(self, table, q_filter, update_dict, fail_on_empty=True): + def create_list(self, table, indata_list): + """ + Add several entries at once + :param table: collection or table + :param indata_list: list of elements to insert. Each element must be a dictionary. + An '_id' key based on random uuid is added at each element if missing + :return: list of inserted '_id's. Exception on error + """ + raise DbException("Method 'create_list' not implemented") + + def set_one(self, table, q_filter, update_dict, fail_on_empty=True, unset=None, pull=None, push=None, + push_list=None, pull_list=None): """ Modifies an entry at database :param table: collection or table @@ -138,16 +160,34 @@ class DbBase(object): :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 + :param pull_list: Same as pull but values are arrays where each item is removed from the array + :param push_list: Same as push but values are arrays where each item is and appended instead of appending the + whole array :return: Dict with the number of entries modified. None if no matching is found. """ raise DbException("Method 'set_one' not implemented") - def set_list(self, table, q_filter, update_dict): + def set_list(self, table, q_filter, update_dict, unset=None, pull=None, push=None, push_list=None, pull_list=None): """ 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 + :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 + :param pull_list: Same as pull but values are arrays where each item is removed from the array + :param push_list: Same as push but values are arrays where each item is and appended instead of appending the + whole array :return: Dict with the number of entries modified """ raise DbException("Method 'set_list' not implemented") @@ -195,6 +235,13 @@ class DbBase(object): 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 @@ -204,6 +251,7 @@ class DbBase(object): :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: @@ -223,6 +271,7 @@ class DbBase(object): :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: @@ -230,9 +279,38 @@ class DbBase(object): encrypted_msg = b64decode(value) cipher = AES.new(secret_key) decrypted_msg = cipher.decrypt(encrypted_msg) - unpadded_private_msg = decrypted_msg.decode().rstrip('\0') + 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=None, 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 + if flags is None: + flags = re.I + + def process(_item): + if isinstance(_item, list): + for elem in _item: + process(elem) + elif isinstance(_item, dict): + for key, val in _item.items(): + if isinstance(val, str): + if any(re.search(f, key, flags) for f in fields): + _item[key] = method(val, schema_version, salt) + else: + process(val) + process(item) + def deep_update_rfc7396(dict_to_change, dict_reference, key_list=None): """ @@ -249,7 +327,7 @@ def deep_update_rfc7396(dict_to_change, dict_reference, key_list=None): 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 equal to . 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.