Projekt

Obecné

Profil

Stáhnout (28.7 KB) Statistiky
| Větev: | Tag: | Revize:
1 ed55c677 Jan Pašek
import json
2 5b57121e Captain_Trojan
from datetime import datetime
3
from itertools import chain
4 6422796d Stanislav Král
from json import JSONDecodeError
5
6 5b57121e Captain_Trojan
from flask import request
7 1fa243ca Jan Pašek
from injector import inject
8
9
from src.constants import CA_ID, \
10
    SSL_ID, SIGNATURE_ID, AUTHENTICATION_ID, \
11
    DATETIME_FORMAT, ROOT_CA_ID, INTERMEDIATE_CA_ID, CERTIFICATE_ID  # TODO DATABASE_FILE - not the Controller's
12 f8bd4850 Jan Pašek
from src.controllers.return_codes import *
13 2cecaf70 Jan Pašek
from src.exceptions.database_exception import DatabaseException
14 9cf9a19d Captain_Trojan
from src.exceptions.unknown_exception import UnknownException
15 5b57121e Captain_Trojan
from src.model.subject import Subject
16 2cecaf70 Jan Pašek
from src.services.certificate_service import CertificateService, RevocationReasonInvalidException, \
17 94f8d5cf Jan Pašek
    CertificateStatusInvalidException, CertificateNotFoundException, CertificateAlreadyRevokedException, \
18
    CertificateCannotBeSetToValid
19 1fa243ca Jan Pašek
#  responsibility.
20 5b57121e Captain_Trojan
from src.services.key_service import KeyService
21 5e31b492 David Friesecký
from src.utils.logger import Logger
22
from src.utils.util import dict_to_string
23 5b57121e Captain_Trojan
24 9247d70a Captain_Trojan
TREE_NODE_TYPE_COUNT = 3
25
26 5b57121e Captain_Trojan
FILTERING = "filtering"
27 d0471de8 Captain_Trojan
PAGE = "page"
28
PER_PAGE = "per_page"
29 5b57121e Captain_Trojan
ISSUER = "issuer"
30
US = "usage"
31
NOT_AFTER = "notAfter"
32
NOT_BEFORE = "notBefore"
33
COMMON_NAME = "CN"
34
ID = "id"
35 a767aa70 Captain_Trojan
CA = "CA"
36 9247d70a Captain_Trojan
USAGE = "usage"
37
SUBJECT = "subject"
38
VALIDITY_DAYS = "validityDays"
39 d0471de8 Captain_Trojan
TYPE = "type"
40 afbdc84f Captain_Trojan
ISSUED_BY = "issuedby"
41 2cecaf70 Jan Pašek
STATUS = "status"
42
REASON = "reason"
43 9c704fb1 Jan Pašek
REASON_UNDEFINED = "unspecified"
44 9247d70a Captain_Trojan
45
E_NO_ISSUER_FOUND = {"success": False, "data": "No certificate authority with such unique ID exists."}
46 d53c2fdc Captain_Trojan
E_NO_CERTIFICATES_FOUND = {"success": False, "data": "No such certificate found."}
47 9e6f791a Jan Pašek
E_NO_CERTIFICATE_ALREADY_REVOKED = {"success": False, "data": "Certificate is already revoked."}
48 cfda1725 Stanislav Král
E_NO_CERT_PRIVATE_KEY_FOUND = {"success": False,
49
                               "data": "Internal server error (certificate's private key cannot be found)."}
50 5b57121e Captain_Trojan
E_NOT_JSON_FORMAT = {"success": False, "data": "The request must be JSON-formatted."}
51
E_CORRUPTED_DATABASE = {"success": False, "data": "Internal server error (corrupted database)."}
52
E_GENERAL_ERROR = {"success": False, "data": "Internal server error (unknown origin)."}
53
E_MISSING_PARAMETERS = {"success": False, "data": "Invalid request, missing parameters."}
54
E_WRONG_PARAMETERS = {"success": False, "data": "Invalid request, wrong parameters."}
55
56
57
class CertController:
58 d0471de8 Captain_Trojan
    USAGE_KEY_MAP = {'CA': CA_ID, 'SSL': SSL_ID, 'digitalSignature': SIGNATURE_ID, 'authentication': AUTHENTICATION_ID}
59
    INVERSE_USAGE_KEY_MAP = {k: v for v, k in USAGE_KEY_MAP.items()}
60
    FILTERING_TYPE_KEY_MAP = {'root': ROOT_CA_ID, 'inter': INTERMEDIATE_CA_ID, 'end': CERTIFICATE_ID}
61
    # INVERSE_FILTERING_TYPE_KEY_MAP = {k: v for v, k in FILTERING_TYPE_KEY_MAP.items()}
62
63 5b57121e Captain_Trojan
64 1fa243ca Jan Pašek
    @inject
65
    def __init__(self, certificate_service: CertificateService, key_service: KeyService):
66
        self.certificate_service = certificate_service
67
        self.key_service = key_service
68
69
    def create_certificate(self):
70 5b57121e Captain_Trojan
        """create new certificate
71
72 9247d70a Captain_Trojan
        Create a new certificate based on given information
73 5b57121e Captain_Trojan
74
        :param body: Certificate data to be created
75
        :type body: dict | bytes
76
77
        :rtype: CreatedResponse
78
        """
79 5e31b492 David Friesecký
80
        Logger.info(f"\n\t{request.referrer}"
81
                    f"\n\t{request.method}   {request.path}   {request.scheme}")
82
83 9247d70a Captain_Trojan
        required_keys = {SUBJECT, USAGE, VALIDITY_DAYS}                             # required fields of the POST req
84 5b57121e Captain_Trojan
85 9247d70a Captain_Trojan
        if request.is_json:                                                         # accept JSON only
86 5b57121e Captain_Trojan
            body = request.get_json()
87 5e31b492 David Friesecký
88
            Logger.info(f"\n\tRequest body:"
89
                        f"\n{dict_to_string(body)}")
90
91 9247d70a Captain_Trojan
            if not all(k in body for k in required_keys):                           # verify that all keys are present
92 5e31b492 David Friesecký
                Logger.error(f"Invalid request, missing parameters")
93 9247d70a Captain_Trojan
                return E_MISSING_PARAMETERS, C_BAD_REQUEST
94 5b57121e Captain_Trojan
95 9247d70a Captain_Trojan
            if not isinstance(body[VALIDITY_DAYS], int):                            # type checking
96 5e31b492 David Friesecký
                Logger.error(f"Invalid request, wrong parameter '{VALIDITY_DAYS}'.")
97 9247d70a Captain_Trojan
                return E_WRONG_PARAMETERS, C_BAD_REQUEST
98 5b57121e Captain_Trojan
99 9247d70a Captain_Trojan
            subject = Subject.from_dict(body[SUBJECT])                              # generate Subject from passed dict
100 5b57121e Captain_Trojan
101 9247d70a Captain_Trojan
            if subject is None:                                                     # if the format is incorrect
102 5e31b492 David Friesecký
                Logger.error(f"Invalid request, wrong parameter '{SUBJECT}'.")
103 9247d70a Captain_Trojan
                return E_WRONG_PARAMETERS, C_BAD_REQUEST
104 5b57121e Captain_Trojan
105 5b6d9513 Captain_Trojan
            usages_dict = {}
106 5b57121e Captain_Trojan
107 9247d70a Captain_Trojan
            if not isinstance(body[USAGE], dict):                                   # type checking
108 5e31b492 David Friesecký
                Logger.error(f"Invalid request, wrong parameter '{USAGE}'.")
109 9247d70a Captain_Trojan
                return E_WRONG_PARAMETERS, C_BAD_REQUEST
110 5b57121e Captain_Trojan
111 9247d70a Captain_Trojan
            for k, v in body[USAGE].items():                                        # for each usage
112 d0471de8 Captain_Trojan
                if k not in CertController.USAGE_KEY_MAP:                                 # check that it is a valid usage
113 5e31b492 David Friesecký
                    Logger.error(f"Invalid request, wrong parameter '{USAGE}'[{k}].")
114 9247d70a Captain_Trojan
                    return E_WRONG_PARAMETERS, C_BAD_REQUEST                        # and throw if it is not
115 d0471de8 Captain_Trojan
                usages_dict[CertController.USAGE_KEY_MAP[k]] = v                          # otherwise translate key and set
116 5b57121e Captain_Trojan
117 1fa243ca Jan Pašek
            key = self.key_service.create_new_key()                                      # TODO pass key
118 5b57121e Captain_Trojan
119 a767aa70 Captain_Trojan
            if CA not in body or body[CA] is None:                                  # if issuer omitted (legal) or none
120 1fa243ca Jan Pašek
                cert = self.certificate_service.create_root_ca(                          # create a root CA
121 5b57121e Captain_Trojan
                    key,
122
                    subject,
123 9247d70a Captain_Trojan
                    usages=usages_dict,                                             # TODO ignoring usages -> discussion
124 5b57121e Captain_Trojan
                    days=body[VALIDITY_DAYS]
125
                )
126
            else:
127 a767aa70 Captain_Trojan
                issuer = self.certificate_service.get_certificate(body[CA])              # get base issuer info
128 5b57121e Captain_Trojan
129 9247d70a Captain_Trojan
                if issuer is None:                                                  # if such issuer does not exist
130 5e31b492 David Friesecký
                    Logger.error(f"No certificate authority with such unique ID exists 'ID = {key.private_key_id}'.")
131 1fa243ca Jan Pašek
                    self.key_service.delete_key(key.private_key_id)                      # free
132 9247d70a Captain_Trojan
                    return E_NO_ISSUER_FOUND, C_BAD_REQUEST                         # and throw
133 5b57121e Captain_Trojan
134 1fa243ca Jan Pašek
                issuer_key = self.key_service.get_key(issuer.private_key_id)             # get issuer's key, which must exist
135 5b57121e Captain_Trojan
136 9247d70a Captain_Trojan
                if issuer_key is None:                                              # if it does not
137 5e31b492 David Friesecký
                    Logger.error(f"Internal server error (corrupted database).")
138 1fa243ca Jan Pašek
                    self.key_service.delete_key(key.private_key_id)                      # free
139 9247d70a Captain_Trojan
                    return E_CORRUPTED_DATABASE, C_INTERNAL_SERVER_ERROR            # and throw
140 5b57121e Captain_Trojan
141 1fa243ca Jan Pašek
                f = self.certificate_service.create_ca if CA_ID in usages_dict and usages_dict[CA_ID] else \
142
                    self.certificate_service.create_end_cert
143 5b57121e Captain_Trojan
144 9247d70a Captain_Trojan
                # noinspection PyTypeChecker
145
                cert = f(                                                           # create inter CA or end cert
146
                    key,                                                            # according to whether 'CA' is among
147
                    subject,                                                        # the usages' fields
148 5b57121e Captain_Trojan
                    issuer,
149
                    issuer_key,
150
                    usages=usages_dict,
151
                    days=body[VALIDITY_DAYS]
152
                )
153
154
            if cert is not None:
155
                return {"success": True,
156 9247d70a Captain_Trojan
                        "data": cert.certificate_id}, C_CREATED_SUCCESSFULLY
157
            else:                                                                   # if this fails, then
158 5e31b492 David Friesecký
                Logger.error(f"Internal error: The certificate could not have been created.")
159 1fa243ca Jan Pašek
                self.key_service.delete_key(key.private_key_id)                          # free
160 9247d70a Captain_Trojan
                return {"success": False,                                           # and wonder what the cause is,
161
                        "data": "Internal error: The certificate could not have been created."}, C_BAD_REQUEST
162
                                                                                    # as obj/None carries only one bit
163
                                                                                    # of error information
164 5b57121e Captain_Trojan
        else:
165 5e31b492 David Friesecký
            Logger.error(f"The request must be JSON-formatted.")
166 9247d70a Captain_Trojan
            return E_NOT_JSON_FORMAT, C_BAD_REQUEST                                 # throw in case of non-JSON format
167 5b57121e Captain_Trojan
168 1fa243ca Jan Pašek
    def get_certificate_by_id(self, id):
169 5b57121e Captain_Trojan
        """get certificate by ID
170
171 9247d70a Captain_Trojan
        Get certificate in PEM format by ID
172 5b57121e Captain_Trojan
173
        :param id: ID of a certificate to be queried
174
        :type id: dict | bytes
175
176
        :rtype: PemResponse
177
        """
178 5e31b492 David Friesecký
179
        Logger.info(f"\n\t{request.referrer}"
180
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
181
                    f"\n\tCertificate ID = {id}")
182 fb987403 Captain_Trojan
        try:
183
            v = int(id)
184
        except ValueError:
185 5e31b492 David Friesecký
            Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
186 9247d70a Captain_Trojan
            return E_WRONG_PARAMETERS, C_BAD_REQUEST
187 fb987403 Captain_Trojan
188 1fa243ca Jan Pašek
        cert = self.certificate_service.get_certificate(v)
189 fb987403 Captain_Trojan
190
        if cert is None:
191 5e31b492 David Friesecký
            Logger.error(f"No such certificate found 'ID = {v}'.")
192 9cf9a19d Captain_Trojan
            return E_NO_CERTIFICATES_FOUND, C_NO_DATA
193 fb987403 Captain_Trojan
        else:
194 9247d70a Captain_Trojan
            return {"success": True, "data": cert.pem_data}, C_SUCCESS
195 5b57121e Captain_Trojan
196 1fa243ca Jan Pašek
    def get_certificate_details_by_id(self, id):
197 5b57121e Captain_Trojan
        """get certificate's details by ID
198
199 9247d70a Captain_Trojan
        Get certificate details by ID
200 5b57121e Captain_Trojan
201
        :param id: ID of a certificate whose details are to be queried
202
        :type id: dict | bytes
203
204
        :rtype: CertificateResponse
205
        """
206 5e31b492 David Friesecký
207
        Logger.info(f"\n\t{request.referrer}"
208
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
209
                    f"\n\tCertificate ID = {id}")
210
211 5b6d9513 Captain_Trojan
        try:
212
            v = int(id)
213
        except ValueError:
214 5e31b492 David Friesecký
            Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
215 9247d70a Captain_Trojan
            return E_WRONG_PARAMETERS, C_BAD_REQUEST
216 5b6d9513 Captain_Trojan
217 1fa243ca Jan Pašek
        cert = self.certificate_service.get_certificate(v)
218 5b6d9513 Captain_Trojan
219
        if cert is None:
220 5e31b492 David Friesecký
            Logger.error(f"No such certificate found 'ID = {v}'.")
221 a53e5aef Jan Pašek
            return E_NO_CERTIFICATES_FOUND, C_NOT_FOUND
222
223
        data = self.cert_to_dict_full(cert)
224
        if data is None:
225
            return E_CORRUPTED_DATABASE, C_INTERNAL_SERVER_ERROR
226
227
        try:
228
            state = self.certificate_service.get_certificate_state(v)
229
            data["status"] = state
230
        except CertificateNotFoundException:
231 53b0c8bc Jan Pašek
            Logger.error(f"No such certificate found 'ID = {id}'.")
232 a53e5aef Jan Pašek
233
        return {"success": True, "data": data}, C_SUCCESS
234 5b57121e Captain_Trojan
235 1fa243ca Jan Pašek
    def get_certificate_list(self):
236 5b57121e Captain_Trojan
        """get list of certificates
237
238 9247d70a Captain_Trojan
        Lists certificates based on provided filtering options
239 5b57121e Captain_Trojan
240
        :param filtering: Filter certificate type to be queried
241
        :type filtering: dict | bytes
242
243
        :rtype: CertificateListResponse
244
        """
245 5e31b492 David Friesecký
246
        Logger.info(f"\n\t{request.referrer}"
247
                    f"\n\t{request.method}   {request.path}   {request.scheme}")
248
249 ed55c677 Jan Pašek
250
        # the filtering parameter can be read as URL argument or as a request body
251 d0471de8 Captain_Trojan
        if request.is_json:
252
            data = request.get_json()
253
        else:
254
            data = {}
255 6422796d Stanislav Král
256 d0471de8 Captain_Trojan
        if FILTERING in request.args.keys():
257
            try:
258
                data[FILTERING] = json.loads(request.args[FILTERING])
259
            except JSONDecodeError:
260
                Logger.error(f"The request must be JSON-formatted.")
261
                return E_NOT_JSON_FORMAT, C_BAD_REQUEST
262
263
        if PAGE in request.args.keys():
264
            try:
265
                data[PAGE] = json.loads(request.args[PAGE])
266
            except JSONDecodeError:
267
                Logger.error(f"The request must be JSON-formatted.")
268
                return E_NOT_JSON_FORMAT, C_BAD_REQUEST
269
270
        if PER_PAGE in request.args.keys():
271
            try:
272
                data[PER_PAGE] = json.loads(request.args[PER_PAGE])
273
            except JSONDecodeError:
274
                Logger.error(f"The request must be JSON-formatted.")
275
                return E_NOT_JSON_FORMAT, C_BAD_REQUEST
276
277
        Logger.info(f"\n\tRequest body:"
278
                    f"\n{dict_to_string(data)}")
279
280
        target_types = {ROOT_CA_ID, INTERMEDIATE_CA_ID, CERTIFICATE_ID}
281
        target_usages = {v for v in CertController.INVERSE_USAGE_KEY_MAP.keys()}
282
        target_cn_substring = None
283
        issuer_id = -1
284 a767aa70 Captain_Trojan
285
        unfiltered = True
286
287 d0471de8 Captain_Trojan
        if PER_PAGE in data:
288 a767aa70 Captain_Trojan
            unfiltered = False
289 d0471de8 Captain_Trojan
            page = data.get(PAGE, 0)
290
            per_page = data[PER_PAGE]
291
        else:
292
            page = None
293
            per_page = None
294
295
        if FILTERING in data:                                                   # if the 'filtering' field exists
296 a767aa70 Captain_Trojan
            unfiltered = False
297 d0471de8 Captain_Trojan
            if isinstance(data[FILTERING], dict):                               # and it is also a 'dict'
298
299
                # noinspection DuplicatedCode
300
                if TYPE in data[FILTERING]:                                     # containing 'type'
301
                    if isinstance(data[FILTERING][TYPE], list):                 # which is a 'list',
302
                                                                                # map every field to id
303
                        try:
304
                            target_types = {CertController.FILTERING_TYPE_KEY_MAP[v] for v in data[FILTERING][TYPE]}
305
                        except KeyError as e:
306
                            Logger.error(f"Invalid request, wrong parameters '{FILTERING}.{TYPE}' - '{e}'.")
307 9247d70a Captain_Trojan
                            return E_WRONG_PARAMETERS, C_BAD_REQUEST
308 d0471de8 Captain_Trojan
                    else:
309
                        Logger.error(f"Invalid request, wrong parameters '{FILTERING}.{TYPE}'.")
310
                        return E_WRONG_PARAMETERS, C_BAD_REQUEST
311
312
                # noinspection DuplicatedCode
313
                if USAGE in data[FILTERING]:                                    # containing 'usage'
314
                    if isinstance(data[FILTERING][USAGE], list):                # which is a 'list',
315
                                                                                # map every field to id
316
                        try:
317
                            target_usages = {CertController.USAGE_KEY_MAP[v] for v in data[FILTERING][USAGE]}
318
                        except KeyError as e:
319 a767aa70 Captain_Trojan
                            Logger.error(f"Invalid request, wrong parameters '{FILTERING}.{USAGE}' - '{e}'.")
320 d0471de8 Captain_Trojan
                            return E_WRONG_PARAMETERS, C_BAD_REQUEST
321
                    else:
322
                        Logger.error(f"Invalid request, wrong parameters '{FILTERING}.{USAGE}'.")
323
                        return E_WRONG_PARAMETERS, C_BAD_REQUEST
324 5b57121e Captain_Trojan
325 d0471de8 Captain_Trojan
                if COMMON_NAME in data[FILTERING]:                              # containing 'CN'
326
                    if isinstance(data[FILTERING][COMMON_NAME], str):           # which is a 'str'
327
                        target_cn_substring = data[FILTERING][COMMON_NAME]
328
                    else:
329
                        Logger.error(f"Invalid request, wrong parameters '{FILTERING}.{COMMON_NAME}'.")
330
                        return E_WRONG_PARAMETERS, C_BAD_REQUEST
331 5b57121e Captain_Trojan
332 d0471de8 Captain_Trojan
                if ISSUED_BY in data[FILTERING]:                                # containing 'issuedby'
333
                    if isinstance(data[FILTERING][ISSUED_BY], int):             # which is an 'int'
334
                        issuer_id = data[FILTERING][ISSUED_BY]                  # then get its children only
335 9247d70a Captain_Trojan
336 d0471de8 Captain_Trojan
            else:
337
                Logger.error(f"Invalid request, wrong parameters '{FILTERING}'.")
338
                return E_WRONG_PARAMETERS, C_BAD_REQUEST
339
340 a767aa70 Captain_Trojan
        if unfiltered:                                                      # if not filtering
341
            certs = self.certificate_service.get_certificates()
342
        elif issuer_id >= 0:                                                # if filtering by an issuer
343
            try:
344
                                                                            # get his children, filtered
345
                certs = self.certificate_service.get_certificates_issued_by_filter(
346
                    issuer_id=issuer_id,
347 d0471de8 Captain_Trojan
                    target_types=target_types,
348
                    target_usages=target_usages,
349
                    target_cn_substring=target_cn_substring,
350
                    page=page,
351
                    per_page=per_page
352
                )
353 a767aa70 Captain_Trojan
            except CertificateNotFoundException:                            # if id does not exist
354
                Logger.error(f"No such certificate found 'ID = {issuer_id}'.")
355
                return E_NO_CERTIFICATES_FOUND, C_NOT_FOUND                 # throw
356 afbdc84f Captain_Trojan
        else:
357 a767aa70 Captain_Trojan
            certs = self.certificate_service.get_certificates_filter(
358
                target_types=target_types,
359
                target_usages=target_usages,
360
                target_cn_substring=target_cn_substring,
361
                page=page,
362
                per_page=per_page
363
            )
364 5b57121e Captain_Trojan
365
        if certs is None:
366 5e31b492 David Friesecký
            Logger.error(f"Internal server error (unknown origin).")
367 9247d70a Captain_Trojan
            return E_GENERAL_ERROR, C_INTERNAL_SERVER_ERROR
368 5b57121e Captain_Trojan
        elif len(certs) == 0:
369 5e31b492 David Friesecký
            # TODO check log level
370
            Logger.warning(f"No such certificate found (empty list).")
371 a767aa70 Captain_Trojan
            return {"success": True, "data": []}, C_SUCCESS
372 5b57121e Captain_Trojan
        else:
373
            ret = []
374
            for c in certs:
375 1fa243ca Jan Pašek
                data = self.cert_to_dict_partial(c)
376 5b6d9513 Captain_Trojan
                if data is None:
377 5e31b492 David Friesecký
                    Logger.error(f"Internal server error (corrupted database).")
378 9247d70a Captain_Trojan
                    return E_CORRUPTED_DATABASE, C_INTERNAL_SERVER_ERROR
379 5b57121e Captain_Trojan
                ret.append(
380 5b6d9513 Captain_Trojan
                    data
381 5b57121e Captain_Trojan
                )
382 9247d70a Captain_Trojan
            return {"success": True, "data": ret}, C_SUCCESS
383 5b57121e Captain_Trojan
384 1fa243ca Jan Pašek
    def get_certificate_root_by_id(self, id):
385 5b57121e Captain_Trojan
        """get certificate's root of trust chain by ID
386
387 9247d70a Captain_Trojan
        Get certificate's root of trust chain in PEM format by ID
388 5b57121e Captain_Trojan
389
        :param id: ID of a child certificate whose root is to be queried
390
        :type id: dict | bytes
391
392
        :rtype: PemResponse
393
        """
394 5e31b492 David Friesecký
395
        Logger.info(f"\n\t{request.referrer}"
396
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
397
                    f"\n\tCertificate ID = {id}")
398
399 d53c2fdc Captain_Trojan
        try:
400
            v = int(id)
401
        except ValueError:
402 5e31b492 David Friesecký
            Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
403 9247d70a Captain_Trojan
            return E_WRONG_PARAMETERS, C_BAD_REQUEST
404 d53c2fdc Captain_Trojan
405 1fa243ca Jan Pašek
        cert = self.certificate_service.get_certificate(v)
406 d53c2fdc Captain_Trojan
407
        if cert is None:
408 5e31b492 David Friesecký
            Logger.error(f"No such certificate found 'ID = {v}'.")
409 11a90594 Jan Pašek
            return E_NO_CERTIFICATES_FOUND, C_NO_DATA
410 d53c2fdc Captain_Trojan
411 1fa243ca Jan Pašek
        trust_chain = self.certificate_service.get_chain_of_trust(cert.parent_id, exclude_root=False)
412
        if trust_chain is None or len(trust_chain) == 0:
413 5e31b492 David Friesecký
            Logger.error(f"No such certificate found (empty list).")
414 11a90594 Jan Pašek
            return E_NO_CERTIFICATES_FOUND, C_NO_DATA
415 d53c2fdc Captain_Trojan
416 11a90594 Jan Pašek
        return {"success": True, "data": trust_chain[-1].pem_data}, C_SUCCESS
417 5b57121e Captain_Trojan
418 1fa243ca Jan Pašek
    def get_certificate_trust_chain_by_id(self, id):
419 61fb67b4 Jan Pašek
        """get certificate's trust chain by ID (including root certificate)
420 5b57121e Captain_Trojan
421 9247d70a Captain_Trojan
        Get certificate trust chain in PEM format by ID
422 5b57121e Captain_Trojan
423
        :param id: ID of a child certificate whose chain is to be queried
424
        :type id: dict | bytes
425
426
        :rtype: PemResponse
427
        """
428
429 5e31b492 David Friesecký
        Logger.info(f"\n\t{request.referrer}"
430
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
431
                    f"\n\tCertificate ID = {id}")
432
433 aa740737 Captain_Trojan
        try:
434
            v = int(id)
435
        except ValueError:
436 5e31b492 David Friesecký
            Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
437 9247d70a Captain_Trojan
            return E_WRONG_PARAMETERS, C_BAD_REQUEST
438 aa740737 Captain_Trojan
439 1fa243ca Jan Pašek
        cert = self.certificate_service.get_certificate(v)
440 aa740737 Captain_Trojan
441
        if cert is None:
442 5e31b492 David Friesecký
            Logger.error(f"No such certificate found 'ID = {v}'.")
443 9cf9a19d Captain_Trojan
            return E_NO_CERTIFICATES_FOUND, C_NO_DATA
444 aa740737 Captain_Trojan
445 11a90594 Jan Pašek
        if cert.parent_id is None:
446 5e31b492 David Friesecký
            Logger.error(f"Parent ID is empty in certificate 'ID = {v}'.")
447 11a90594 Jan Pašek
            return E_NO_CERTIFICATES_FOUND, C_NO_DATA
448 aa740737 Captain_Trojan
449 61fb67b4 Jan Pašek
        trust_chain = self.certificate_service.get_chain_of_trust(cert.parent_id, exclude_root=False)
450 11a90594 Jan Pašek
451
        ret = []
452
        for intermediate in trust_chain:
453
            ret.append(intermediate.pem_data)
454 5b6d9513 Captain_Trojan
455 9247d70a Captain_Trojan
        return {"success": True, "data": "".join(ret)}, C_SUCCESS
456 5b6d9513 Captain_Trojan
457 2cecaf70 Jan Pašek
    def set_certificate_status(self, id):
458
        """
459
        Revoke a certificate given by ID
460
            - revocation request may contain revocation reason
461
            - revocation reason is verified based on the possible predefined values
462
            - if revocation reason is not specified 'undefined' value is used
463
        :param id: Identifier of the certificate to be revoked
464
        :type id: int
465
466
        :rtype: SuccessResponse | ErrorResponse (see OpenAPI definition)
467
        """
468
469 5e31b492 David Friesecký
        Logger.info(f"\n\t{request.referrer}"
470
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
471
                    f"\n\tCertificate ID = {id}")
472
473
        required_keys = {STATUS}  # required keys
474 2cecaf70 Jan Pašek
475
        # check if the request contains a JSON body
476
        if request.is_json:
477
            request_body = request.get_json()
478 5e31b492 David Friesecký
479
            Logger.info(f"\n\tRequest body:"
480
                        f"\n{dict_to_string(request_body)}")
481
482
            # try to parse certificate identifier -> if it is not int return error 400
483
            try:
484
                identifier = int(id)
485
            except ValueError:
486
                Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
487
                return E_WRONG_PARAMETERS, C_BAD_REQUEST
488
489 2cecaf70 Jan Pašek
            # verify that all required keys are present
490
            if not all(k in request_body for k in required_keys):
491 5e31b492 David Friesecký
                Logger.error(f"Invalid request, missing parameters.")
492 2cecaf70 Jan Pašek
                return E_MISSING_PARAMETERS, C_BAD_REQUEST
493
494
            # get status and reason from the request
495
            status = request_body[STATUS]
496
            reason = request_body.get(REASON, REASON_UNDEFINED)
497
            try:
498
                # set certificate status using certificate_service
499 9c704fb1 Jan Pašek
                self.certificate_service.set_certificate_revocation_status(identifier, status, reason)
500 9e6f791a Jan Pašek
            except (RevocationReasonInvalidException, CertificateStatusInvalidException):
501 2cecaf70 Jan Pašek
                # these exceptions are thrown in case invalid status or revocation reason is passed to the controller
502 5e31b492 David Friesecký
                Logger.error(f"Invalid request, wrong parameters.")
503 2cecaf70 Jan Pašek
                return E_WRONG_PARAMETERS, C_BAD_REQUEST
504 9e6f791a Jan Pašek
            except CertificateAlreadyRevokedException:
505 5e31b492 David Friesecký
                Logger.error(f"Certificate is already revoked 'ID = {identifier}'.")
506 9e6f791a Jan Pašek
                return E_NO_CERTIFICATE_ALREADY_REVOKED, C_BAD_REQUEST
507
            except CertificateNotFoundException:
508 5e31b492 David Friesecký
                Logger.error(f"No such certificate found 'ID = {identifier}'.")
509 9e6f791a Jan Pašek
                return E_NO_CERTIFICATES_FOUND, C_NOT_FOUND
510 94f8d5cf Jan Pašek
            except CertificateCannotBeSetToValid as e:
511
                return {"success": False, "data": str(e)}, C_BAD_REQUEST
512 2cecaf70 Jan Pašek
            return {"success": True,
513 9c704fb1 Jan Pašek
                    "data": "Certificate status updated successfully."}, C_SUCCESS
514 2cecaf70 Jan Pašek
        # throw an error in case the request does not contain a json body
515
        else:
516 5e31b492 David Friesecký
            Logger.error(f"The request must be JSON-formatted.")
517 2cecaf70 Jan Pašek
            return E_NOT_JSON_FORMAT, C_BAD_REQUEST
518
519 1fa243ca Jan Pašek
    def cert_to_dict_partial(self, c):
520 9247d70a Captain_Trojan
        """
521
        Dictionarizes a certificate directly fetched from the database. Contains partial information.
522
        :param c: target cert
523
        :return: certificate dict (compliant with some parts of the REST API)
524
        """
525 5e31b492 David Friesecký
526
        # TODO check log
527
        Logger.debug(f"Function launched.")
528
529 1fa243ca Jan Pašek
        c_issuer = self.certificate_service.get_certificate(c.parent_id)
530 5b6d9513 Captain_Trojan
        if c_issuer is None:
531
            return None
532
533
        return {
534
            ID: c.certificate_id,
535
            COMMON_NAME: c.common_name,
536
            NOT_BEFORE: datetime.strptime(c.valid_from, DATETIME_FORMAT).date(),
537
            NOT_AFTER: datetime.strptime(c.valid_to, DATETIME_FORMAT).date(),
538 d0471de8 Captain_Trojan
            USAGE: {CertController.INVERSE_USAGE_KEY_MAP[k]: v for k, v in c.usages.items()},
539 5b6d9513 Captain_Trojan
            ISSUER: {
540
                ID: c_issuer.certificate_id,
541
                COMMON_NAME: c_issuer.common_name
542
            }
543
        }
544
545 1fa243ca Jan Pašek
    def cert_to_dict_full(self, c):
546 9247d70a Captain_Trojan
        """
547
        Dictionarizes a certificate directly fetched from the database, but adds subject info.
548
        Contains full information.
549
        :param c: target cert
550
        :return: certificate dict (compliant with some parts of the REST API)
551
        """
552 5e31b492 David Friesecký
553
        Logger.info(f"Function launched.")
554
555 1fa243ca Jan Pašek
        subj = self.certificate_service.get_subject_from_certificate(c)
556
        c_issuer = self.certificate_service.get_certificate(c.parent_id)
557 5b6d9513 Captain_Trojan
        if c_issuer is None:
558
            return None
559
560
        return {
561
            SUBJECT: subj.to_dict(),
562
            NOT_BEFORE: datetime.strptime(c.valid_from, DATETIME_FORMAT).date(),
563
            NOT_AFTER: datetime.strptime(c.valid_to, DATETIME_FORMAT).date(),
564 d0471de8 Captain_Trojan
            USAGE: {CertController.INVERSE_USAGE_KEY_MAP[k]: v for k, v in c.usages.items()},
565 a767aa70 Captain_Trojan
            CA: c_issuer.certificate_id
566 5b6d9513 Captain_Trojan
        }
567 cfda1725 Stanislav Král
568 ce8b9aaf Stanislav Král
    def get_private_key_of_a_certificate(self, id):
569 cfda1725 Stanislav Král
        """
570
        Get a private key used to sign a certificate in PEM format specified by certificate's ID
571
572 ce8b9aaf Stanislav Král
        :param id: ID of a certificate whose private key is to be queried
573
        :type id: dict | bytes
574
575
        :rtype: PemResponse
576
        """
577
578 5e31b492 David Friesecký
        Logger.info(f"\n\t{request.referrer}"
579
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
580
                    f"\n\tCertificate ID = {id}")
581
582 ce8b9aaf Stanislav Král
        # try to parse the supplied ID
583
        try:
584
            v = int(id)
585
        except ValueError:
586 5e31b492 David Friesecký
            Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
587 ce8b9aaf Stanislav Král
            return E_WRONG_PARAMETERS, C_BAD_REQUEST
588
589 eade7427 Stanislav Král
        # find a certificate using the given ID
590 ce8b9aaf Stanislav Král
        cert = self.certificate_service.get_certificate(v)
591
592
        if cert is None:
593 5e31b492 David Friesecký
            Logger.error(f"No such certificate found 'ID = {v}'.")
594 ce8b9aaf Stanislav Král
            return E_NO_CERTIFICATES_FOUND, C_NOT_FOUND
595
        else:
596
            # certificate exists, fetch it's private key
597
            private_key = self.key_service.get_key(cert.private_key_id)
598
            if cert is None:
599 5e31b492 David Friesecký
                Logger.error(f"Internal server error (certificate's private key cannot be found).")
600 ce8b9aaf Stanislav Král
                return E_NO_CERT_PRIVATE_KEY_FOUND, C_INTERNAL_SERVER_ERROR
601
            else:
602
                return {"success": True, "data": private_key.private_key}, C_SUCCESS
603
604
    def get_public_key_of_a_certificate(self, id):
605
        """
606
        Get a public key of a certificate in PEM format specified by certificate's ID
607
608 cfda1725 Stanislav Král
        :param id: ID of a certificate whose public key is to be queried
609
        :type id: dict | bytes
610
611
        :rtype: PemResponse
612
        """
613
614 5e31b492 David Friesecký
        Logger.info(f"\n\t{request.referrer}"
615
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
616
                    f"\n\tCertificate ID = {id}")
617
618 cfda1725 Stanislav Král
        # try to parse the supplied ID
619
        try:
620
            v = int(id)
621
        except ValueError:
622 5e31b492 David Friesecký
            Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
623 cfda1725 Stanislav Král
            return E_WRONG_PARAMETERS, C_BAD_REQUEST
624
625 eade7427 Stanislav Král
        # find a certificate using the given ID
626 cfda1725 Stanislav Král
        cert = self.certificate_service.get_certificate(v)
627
628
        if cert is None:
629 5e31b492 David Friesecký
            Logger.error(f"No such certificate found 'ID = {v}'.")
630 cfda1725 Stanislav Král
            return E_NO_CERTIFICATES_FOUND, C_NOT_FOUND
631
        else:
632 d3bfacfc Stanislav Král
            return {"success": True, "data": self.certificate_service.get_public_key_from_certificate(cert)}, C_SUCCESS
633 9cf9a19d Captain_Trojan
634
    def delete_certificate(self, id):
635
        """
636
        Deletes a certificate identified by ID, including its corresponding subtree (all descendants).
637
        :param id: target certificate ID
638
        :rtype: DeleteResponse
639
        """
640 5e31b492 David Friesecký
641
        Logger.info(f"\n\t{request.referrer}"
642
                    f"\n\t{request.method}   {request.path}   {request.scheme}"
643
                    f"\n\tCertificate ID = {id}")
644
645 9cf9a19d Captain_Trojan
        try:
646
            v = int(id)
647
        except ValueError:
648 5e31b492 David Friesecký
            Logger.error(f"Invalid request, wrong parameters 'id'[{id}].")
649 9cf9a19d Captain_Trojan
            return E_WRONG_PARAMETERS, C_BAD_REQUEST
650
651
        try:
652
            self.certificate_service.delete_certificate(v)
653
        except CertificateNotFoundException:
654 5e31b492 David Friesecký
            Logger.error(f"No such certificate found 'ID = {v}'.")
655 9cf9a19d Captain_Trojan
            return E_NO_CERTIFICATES_FOUND, C_NOT_FOUND
656
        except DatabaseException:
657 5e31b492 David Friesecký
            Logger.error(f"Internal server error (corrupted database).")
658 9cf9a19d Captain_Trojan
            return E_CORRUPTED_DATABASE, C_INTERNAL_SERVER_ERROR
659
        except CertificateStatusInvalidException or RevocationReasonInvalidException or UnknownException:
660 5e31b492 David Friesecký
            Logger.error(f"Internal server error (unknown origin).")
661 9cf9a19d Captain_Trojan
            return E_GENERAL_ERROR, C_INTERNAL_SERVER_ERROR
662
663
        return {"success": True, "data": "The certificate and its descendants have been successfully deleted."}