Revize ed35ce72

Re #8570 - Rotating file settings

src/config/configuration.py

@@ -2 +2 @@
 
 import configparser
 import logging
+from logging import handlers
+
 from injector import singleton
 
-from src.constants import DEFAULT_CONNECTION_STRING, TEST_DATABASE_FILE, DEFAULT_SERVER_BASE_URL
+from src.constants import DEFAULT_CONNECTION_STRING, TEST_DATABASE_FILE, DEFAULT_SERVER_BASE_URL, LOG_NAME, \
+    LOG_DIR_LOCATION
 from src.constants import LOG_FILE_LOCATION, LOG_FORMAT
 from src.utils.logger import Logger
 
@@ -70 +73 @@
 
 
 def configure_logging():
-    logging.basicConfig(filename=LOG_FILE_LOCATION.shortest_relative_path(),
-                        filemode='a+',
-                        format=LOG_FORMAT,
-                        level=logging.DEBUG)
+    if not os.path.exists(LOG_DIR_LOCATION.shortest_relative_path()):
+        os.makedirs(LOG_DIR_LOCATION.shortest_relative_path())
+
+    handler = logging.handlers.TimedRotatingFileHandler(
+        LOG_FILE_LOCATION.shortest_relative_path(),
+        when='H', interval=1)
+    formatter = logging.Formatter(LOG_FORMAT)
+    handler.setFormatter(formatter)
+
+    app_logger = logging.getLogger(LOG_NAME)
+    app_logger.setLevel(logging.DEBUG)
+    app_logger.addHandler(handler)
 
     # TODO check is 'valid'
     log = logging.getLogger('werkzeug')

src/constants.py

@@ -6 +6 @@
 DATABASE_FILE_LOCATION = FileAnchor("aswi2021jmsd", DATABASE_FILE)
 DATETIME_FORMAT = "%d.%m.%Y %H:%M:%S"
 
-LOG_FILE = "log/application.log"
+LOG_DIR = "logs"
+LOG_DIR_LOCATION = FileAnchor("aswi2021jmsd", LOG_DIR)
+LOG_FILE = f"{LOG_DIR}/application.log"
 LOG_FILE_LOCATION = FileAnchor("aswi2021jmsd", LOG_FILE)
 LOG_FORMAT = "%(levelname)-8s %(asctime)s - %(message)s"
+LOG_NAME = "app_logger"
 
 REV_REASON_UNSPECIFIED = "unspecified"
 

src/services/crl_ocsp/ca_index_file_line_generator.py

@@ -3 +3 @@
 
 from src.model.certificate import Certificate
 from src.model.subject import Subject
+from src.utils.logger import Logger
 
 SRL_LEN = 8  # number of hex digits in serial number
 TAB_CHAR = "\t"
@@ -11 +12 @@
 
 def get_index_file_time_entry(date: struct_time):
     # convert the time to the format of openssl CA index file
+
+    Logger.debug("Function launched.")
+
     return time.strftime(INDEX_FILE_DATE_ENTRY_FORMAT, date)
 
 
 def get_distinguished_name(subject: Subject):
     # convert subject class instance to the distinguished name in the openssl CA index file format
+
+    Logger.debug("Function launched.")
+
     return "".join([f"/{key}={value}" if value is not None else "" for key, value in subject.to_dict().items()])
 
 
@@ -23 +30 @@
                                    valid_to: struct_time) -> str:
     # converts the given certificate as well as the subject and revocation / valid_to dates to a line of openssl CA
     # index file format
+
+    Logger.debug("Function launched.")
+
     items = [
         # certificate status flag (R stands for revoked)
         "R",
@@ -43 +53 @@
 def create_index_file_valid_line(certificate: Certificate, subject: Subject, valid_to: struct_time) -> str:
     # converts the given certificate as well as the subject and revocation / valid_to dates to a line of openssl CA
     # index file format
+
+    Logger.debug("Function launched.")
+
     items = [
         # certificate status flag (R stands for revoked)
         "V",
@@ -61 +74 @@
     return TAB_CHAR.join(items)
 
 def __get_serial(cert_id) -> str:
+
+    Logger.debug("Function launched.")
+
     srl = hex(cert_id).replace("0x", "")
     srl = "0"*(SRL_LEN - len(srl)) + srl  # generate exactly SRL_LEN digits
     return srl.upper()

src/services/crl_ocsp/crl_ocsp_service.py

@@ -8 +8 @@
 from src.exceptions.unknown_exception import UnknownException
 from src.services.crl_ocsp.ca_index_file_line_generator import create_index_file_revoked_line, create_index_file_valid_line
 from src.services.cryptography import CryptographyService
+from src.utils.logger import Logger
 from src.utils.temporary_file import TemporaryFile
 
 
@@ -30 +31 @@
         :param ca_id: ID of the CA whose revoked certificates should be put into the index file
         :return: a str representing the content of a CA index file
         """
+
+        Logger.debug("Function launched.")
+
         # get issuing certificate
         certificate = self.certificate_repository.read(ca_id)
         if certificate is None:
+            Logger.error(f"No such certificate found 'ID = {ca_id}'.")
             raise CertificateNotFoundException(ca_id)
 
         # get subject and notAfter of the issuer
@@ -64 +69 @@
         :param ca_id: ID of the CA whose issued (=child) certificates should be put into the index file
         :return: a str representing the content of a CA index file
         """
+
+        Logger.debug("Function launched.")
+
         # get issuing certificate
         certificate = self.certificate_repository.read(ca_id)
         if certificate is None:
+            Logger.error(f"No such certificate found 'ID = {ca_id}'.")
             raise CertificateNotFoundException(ca_id)
 
         # get subject and notAfter of the issuer
@@ -101 +110 @@
         :param ca_id: ID of a CA whose CRL shall be generated
         :return: CRL in PEM format
         """
+
+        Logger.debug("Function launched.")
+
         # get cert and check if the requested CA exists and if not throw an exception
         cert, key = self.check_ca_and_key(ca_id)
 
@@ -117 +129 @@
         :param der_ocsp_request: DER encoded OCSP Request
         :return: DER encoded OCSP Response
         """
+
+        Logger.debug("Function launched.")
+
         cert, key = self.check_ca_and_key(ca_id)
 
         # Create an index file and call cryptography service to generate the OCSP response
@@ -132 +147 @@
         :param ca_id: certificate authority ID
         :return: certificate data & associated key
         """
+
+        Logger.debug("Function launched.")
+
         # get cert and check if the requested CA exists and if not throw an exception
         cert = self.certificate_repository.read(ca_id)
         if cert is None:
@@ -139 +157 @@
         # get key and check if it exists
         key = self.key_repository.read(cert.private_key_id)
         if key is None:
+            Logger.error("Corrupted database, expected PrivateKey not found.")
             raise UnknownException("Corrupted database, expected PrivateKey not found.")
-            # TODO log this
         return cert, key

src/utils/logger.py

@@ -2 +2 @@
 import logging
 from pathlib import Path
 
+from src.constants import LOG_NAME
+
 
 class Logger:
 
@@ -20 +22 @@
     @staticmethod
     def debug(message: str):
         names = Logger.get_names()
-        logging.debug(f'{Path(names[0]).name}[{names[1]}{names[2]}()]: {message}')
+        app_logger = logging.getLogger(LOG_NAME)
+        app_logger.debug(f'{Path(names[0]).name}[{names[1]}{names[2]}()]: {message}')
 
     @staticmethod
     def info(message: str):
         names = Logger.get_names()
-        logging.info(f'{Path(names[0]).name}[{names[1]}{names[2]}()]: {message}')
+        app_logger = logging.getLogger(LOG_NAME)
+        app_logger.info(f'{Path(names[0]).name}[{names[1]}{names[2]}()]: {message}')
 
     @staticmethod
     def warning(message: str):
         names = Logger.get_names()
-        logging.warning(f'{Path(names[0]).name}[{names[1]}{names[2]}()]: {message}')
+        app_logger = logging.getLogger(LOG_NAME)
+        app_logger.warning(f'{Path(names[0]).name}[{names[1]}{names[2]}()]: {message}')
 
     @staticmethod
     def error(message: str):
         names = Logger.get_names()
-        logging.error(f'{Path(names[0]).name}[{names[1]}.{names[2]}()]: {message}')
+        app_logger = logging.getLogger(LOG_NAME)
+        app_logger.error(f'{Path(names[0]).name}[{names[1]}.{names[2]}()]: {message}')
 
     @staticmethod
     def critical(message: str):
         names = Logger.get_names()
-        logging.critical(f'{Path(names[0]).name}[{names[1]}.{names[2]}()]: {message}')
+        app_logger = logging.getLogger(LOG_NAME)
+        app_logger.critical(f'{Path(names[0]).name}[{names[1]}.{names[2]}()]: {message}')