Projekt

Obecné

Profil

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