Revize b3c80ccb

Re #8570 - Added logs

src/services/certificate_service.py

@@ -16 +16 @@
 
 import time
 
+from src.utils.logger import Logger
+
 VALID_FROM_TO_DATE_FORMAT = "%d.%m.%Y %H:%M:%S"
 CA_EXTENSIONS = "basicConstraints=critical,CA:TRUE"
 CRL_EXTENSION = "crlDistributionPoints=URI:"
@@ -47 +49 @@
         :param days: Number of days for which the generated cert. will be considered valid
         :return: An instance of Certificate class representing the generated root CA cert
         """
+
+        Logger.debug("Function launched.")
+
         if usages is None:
             usages = {}
 
@@ -81 +86 @@
         :param cert_type: Type of this certificate (see constants.py)
         :return: An instance of the Certificate class wrapping the values passed  via method parameters
         """
+
+        Logger.debug("Function launched.")
+
         # parse the generated pem for subject and notBefore/notAfter fields
         # TODO this could be improved in the future in such way that calling openssl is not required to parse the dates
         subj, not_before, not_after = self.cryptography_service.parse_cert_pem(cert_pem)
@@ -108 +116 @@
         :param days: Number of days for which the generated cert. will be considered valid
         :return: An instance of Certificate class representing the generated intermediate CA cert
         """
+
+        Logger.debug("Function launched.")
+
         if usages is None:
             usages = {}
 
@@ -168 +179 @@
         :param days: Number of days for which the generated cert. will be considered valid
         :return: An instance of Certificate class representing the generated cert
         """
+
+        Logger.debug("Function launched.")
+
         if usages is None:
             usages = {}
 
@@ -204 +218 @@
         :return: Instance of the Certificate class containing a certificate with the given id or `None` if such
         certificate is not found
         """
+
+        Logger.debug("Function launched.")
+
         return self.certificate_repository.read(unique_id)
 
     def get_certificates(self, cert_type=None) -> List[Certificate]:
@@ -214 +231 @@
         :return: List of instances of the Certificate class representing all certificates present in the certificate
         repository. An empty list is returned when no certificates are found.
         """
+
+        Logger.debug("Function launched.")
+
         return self.certificate_repository.read_all(cert_type)
 
     def get_chain_of_trust(self, from_id: int, to_id: int = -1, exclude_root=True) -> List[Certificate]:
@@ -226 +246 @@
         :return: a list of certificates representing the chain of trust starting with the certificate given by `from_id`
         ID
         """
+
+        Logger.debug("Function launched.")
+
         # read the first certificate of the chain
         start_cert = self.certificate_repository.read(from_id)
 
@@ -273 +296 @@
         :param unique_id: ID of specific certificate
         """
 
+        Logger.debug("Function launched.")
+
         to_delete = self.certificate_repository.get_all_descendants_of(unique_id)
         if to_delete is None:
+            Logger.error(f"No such certificate found 'ID = {unique_id}'.")
             raise CertificateNotFoundException(unique_id)
 
         for cert in to_delete:
             try:
                 self.set_certificate_revocation_status(cert.certificate_id, STATUS_REVOKED)
             except CertificateAlreadyRevokedException:
+                Logger.info(f"Certificate already revoked 'ID = {unique_id}'.")
                 # TODO log as an info/debug, not warning or above <-- perfectly legal
                 pass
 
-            self.certificate_repository.delete(cert.certificate_id)
-            # TODO log if not successfully deleted
+            if not self.certificate_repository.delete(cert.certificate_id):
+                Logger.error(f"The certificate has not been deleted 'ID = {cert.certificate_id}'.")
+
 
     def get_certificates_issued_by(self, unique_id):
         """
@@ -294 +322 @@
         :param unique_id: target certificate ID
         :return: children of unique_id
         """
+
+        Logger.debug("Function launched.")
+
         try:
             if self.certificate_repository.read(unique_id) is None:
+                Logger.error(f"No such certificate found 'ID = {unique_id}'.")
                 raise CertificateNotFoundException(unique_id)
         except DatabaseException:
+            Logger.error(f"No such certificate found 'ID = {unique_id}'.")
             raise CertificateNotFoundException(unique_id)
 
         return self.certificate_repository.get_all_issued_by(unique_id)
@@ -310 +343 @@
         :param id: identifier of the certificate whose status is to be changed
         :param status: new status of the certificate
         """
+
+        Logger.debug("Function launched.")
+
         if status not in CERTIFICATE_STATES:
+            Logger.error(f"Wrong parameter, invalid status '{status}'.")
             raise CertificateStatusInvalidException(status)
         if reason not in CERTIFICATE_REVOCATION_REASONS:
+            Logger.error(f"Wrong parameter, invalid reason '{reason}'.")
             raise RevocationReasonInvalidException(reason)
 
         # check whether the certificate exists
         certificate = self.certificate_repository.read(id)
         if certificate is None:
+            Logger.error(f"No such certificate found 'ID = {id}'.")
             raise CertificateNotFoundException(id)
 
         updated = False
@@ -327 +366 @@
             # check if the certificate is not revoked already
             revoked = self.certificate_repository.get_all_revoked_by(certificate.parent_id)
             if certificate.certificate_id in [x.certificate_id for x in revoked]:
+                Logger.error(f"Certificate already revoked 'ID = {id}'.")
                 raise CertificateAlreadyRevokedException(id)
 
             revocation_timestamp = int(time.time())
             updated = self.certificate_repository.set_certificate_revoked(id, str(revocation_timestamp), reason)
 
         if not updated:
-            # TODO log this
+            Logger.error(f"Repository returned 'false' from clear_certificate_revocation() "
+                         f"or set_certificate_revoked().")
             raise UnknownException("Repository returned 'false' from clear_certificate_revocation() "
                                    "or set_certificate_revoked().")
 
@@ -343 +384 @@
         :param certificate: certificate instance whose Subject shall be parsed
         :return: instance of Subject class containing resulting distinguished name
         """
+
+        Logger.debug("Function launched.")
+
         (subject, _, _) = self.cryptography_service.parse_cert_pem(certificate.pem_data)
         return subject
 
@@ -353 +397 @@
         should be extracted.
         :return: a string containing the extracted public key in PEM format
         """
+
+        Logger.debug("Function launched.")
+
         return self.cryptography_service.extract_public_key_from_certificate(certificate.pem_data)
 
     def __get_crl_endpoint(self, ca_identifier: int) -> str:
@@ -363 +410 @@
         :param ca_identifier: ID of issuing authority
         :return: CRL endpoint for the given CA
         """
+
+        Logger.debug("Function launched.")
+
         return self.configuration.base_server_url + "/api/crl/" + str(ca_identifier)
 
     def __get_ocsp_endpoint(self, ca_identifier: int) -> str:
@@ -373 +423 @@
         :param ca_identifier: ID of issuing authority
         :return: OCSP endpoint for the given CA
         """
+
+        Logger.debug("Function launched.")
+
         return self.configuration.base_server_url + "/api/ocsp/" + str(ca_identifier)