aboutsummaryrefslogtreecommitdiffstats
path: root/certService/src/main/java/org/onap/oom/certservice/api/CertificationController.java
blob: 987d56eaf0e3e252757cce21db089eae0e66afcb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
 * ============LICENSE_START=======================================================
 * Cert Service
 * ================================================================================
 * Copyright (C) 2020-2021 Nokia. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.onap.oom.certservice.api;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.onap.oom.certservice.certification.CertificationResponseModelFactory;
import org.onap.oom.certservice.certification.exception.DecryptionException;
import org.onap.oom.certservice.certification.exception.ErrorResponseModel;
import org.onap.oom.certservice.certification.model.CertificateUpdateModel;
import org.onap.oom.certservice.certification.model.CertificationResponseModel;
import org.onap.oom.certservice.cmpv2client.exceptions.CmpClientException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;


@RestController
@Tag(name = "CertificationService")
public class CertificationController {

    private static final Logger LOGGER = LoggerFactory.getLogger(CertificationController.class);

    private final CertificationResponseModelFactory certificationResponseModelFactory;

    @Autowired
    CertificationController(CertificationResponseModelFactory certificationResponseModelFactory) {
        this.certificationResponseModelFactory = certificationResponseModelFactory;
    }

    /**
     * Request for signing certificate by given CA.
     *
     * @param caName            the name of Certification Authority that will sign root certificate
     * @param encodedCsr        Certificate Sign Request encoded in Base64 form
     * @param encodedPrivateKey Private key for CSR, needed for PoP, encoded in Base64 form
     * @return JSON containing trusted certificates and certificate chain
     */
    @GetMapping(value = "v1/certificate/{caName}", produces = "application/json")
    @ApiResponses(value = {
            @ApiResponse(responseCode = "200", description = "Certificate successfully signed"),
            @ApiResponse(responseCode = "400", description = "Given CSR or/and PK is incorrect",
                    content = @Content(schema = @Schema(implementation = ErrorResponseModel.class))),
            @ApiResponse(responseCode = "404", description = "CA not found for given name",
                    content = @Content(schema = @Schema(implementation = ErrorResponseModel.class))),
            @ApiResponse(responseCode = "500", description = "Something went wrong during connectiion to CMPv2 server",
                    content = @Content(schema = @Schema(implementation = ErrorResponseModel.class)))
    })
    @Operation(
            summary = "initialize certificate",
            description = "Web endpoint for requesting certificate initialization. Used by system components to gain certificate signed by CA.",
            tags = {"CertificationService"})
    public ResponseEntity<CertificationResponseModel> signCertificate(
            @Parameter(description = "Name of certification authority that will sign CSR.")
            @PathVariable String caName,
            @Parameter(description = "Certificate initialization request in form of PEM object encoded in Base64 (with header and footer).")
            @RequestHeader("CSR") String encodedCsr,
            @Parameter(description = "Private key in form of PEM object encoded in Base64 (with header and footer).")
            @RequestHeader("PK") String encodedPrivateKey
    ) throws DecryptionException, CmpClientException {
        caName = replaceWhiteSpaceChars(caName);
        LOGGER.info("Received certificate initialization request for CA named: {}", caName);
        CertificationResponseModel certificationResponseModel = certificationResponseModelFactory
                .provideCertificationModelFromInitialRequest(encodedCsr, encodedPrivateKey, caName);
        return new ResponseEntity<>(certificationResponseModel, HttpStatus.OK);
    }

    /**
     * Request for updating certificate by given CA.
     *
     * @param caName                the name of Certification Authority that will sign root certificate
     * @param encodedCsr            Certificate Sign Request encoded in Base64 form
     * @param encodedPrivateKey     Private key for CSR, needed for PoP, encoded in Base64 form
     * @param encodedOldCert        Certificate (signed by Certification Authority) that should be renewed
     * @param encodedOldPrivateKey  Old private key corresponding with old certificate
     * @return JSON containing trusted certificates and certificate chain
     */
    @GetMapping(value = "v1/certificate-update/{caName}", produces = "application/json")
    public ResponseEntity<CertificationResponseModel> updateCertificate(
            @PathVariable String caName,
            @RequestHeader("CSR") String encodedCsr,
            @RequestHeader("PK") String encodedPrivateKey,
            @RequestHeader("OLD_CERT") String encodedOldCert,
            @RequestHeader("OLD_PK") String encodedOldPrivateKey
    ) throws DecryptionException, CmpClientException {
        caName = replaceWhiteSpaceChars(caName);
        LOGGER.info("Received certificate update request for CA named: {}", caName);
        CertificateUpdateModel certificateUpdateModel = new CertificateUpdateModel.CertificateUpdateModelBuilder()
                .setEncodedCsr(encodedCsr)
                .setEncodedPrivateKey(encodedPrivateKey)
                .setEncodedOldCert(encodedOldCert)
                .setEncodedOldPrivateKey(encodedOldPrivateKey)
                .setCaName(caName)
                .build();
        CertificationResponseModel certificationResponseModel = certificationResponseModelFactory
                .provideCertificationModelFromUpdateRequest(certificateUpdateModel);
        return new ResponseEntity<>(certificationResponseModel, HttpStatus.OK);
    }

    private String replaceWhiteSpaceChars(String text) {
        return text.replaceAll("[\n\r\t]", "_");
    }
}