aboutsummaryrefslogtreecommitdiffstats
path: root/hv-collector-ssl/src/test/kotlin/org/onap/dcae/collectors/veshv/ssl/boundary/ServerSslContextFactoryTest.kt
blob: b4d72353373a2ceab7646194d1e5f47b33191cfd (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
 * ============LICENSE_START=======================================================
 * dcaegen2-collectors-veshv
 * ================================================================================
 * Copyright (C) 2018 NOKIA
 * ================================================================================
 * 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.dcae.collectors.veshv.ssl.boundary

import arrow.core.Left
import arrow.core.Option
import arrow.core.Right
import arrow.core.Some
import arrow.core.toOption
import io.netty.handler.ssl.ClientAuth
import io.netty.handler.ssl.JdkSslContext
import io.netty.handler.ssl.ReferenceCountedOpenSslContext
import io.netty.handler.ssl.SslContextBuilder
import org.assertj.core.api.Assertions
import org.assertj.core.api.Assertions.assertThat
import org.jetbrains.spek.api.Spek
import org.jetbrains.spek.api.dsl.describe
import org.jetbrains.spek.api.dsl.given
import org.jetbrains.spek.api.dsl.it
import org.jetbrains.spek.api.dsl.on
import org.onap.dcae.collectors.veshv.domain.JdkKeys
import org.onap.dcae.collectors.veshv.domain.OpenSslKeys
import org.onap.dcae.collectors.veshv.domain.SecurityConfiguration
import java.nio.file.Paths
import kotlin.test.assertTrue

/**
 * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
 * @since June 2018
 */
object ServerSslContextFactoryTest : Spek({
    val PASSWORD = "onap"

    describe("SslContextFactory (OpenSSL)") {
        val keys = OpenSslKeys(
                privateKey = Paths.get("/", "tmp", "pk.pem"),
                cert = Paths.get("/", "tmp", "cert.crt"),
                trustedCert = Paths.get("/", "tmp", "clientCa.crt"))

        given("config with security enabled") {
            val sampleConfig = SecurityConfiguration(keys = Some(keys))

            val cut = object : ServerSslContextFactory() {
                override fun createSslContextWithConfiguredCerts(secConfig: SecurityConfiguration) =
                    SslContextBuilder.forServer(resource("/ssl/ca.crt"), resource("/ssl/server.key")).toOption()

                private fun resource(path: String) = ServerSslContextFactoryTest.javaClass.getResourceAsStream(path)
            }

            on("creation of SSL context") {
                val result = cut.createSslContext(sampleConfig)

                it("should be server context") {
                    assertTrue(result.exists {
                        it.isServer
                    })
                }

                it("should use OpenSSL provider") {
                    assertTrue(result.isDefined())
                }

                /*
                 * It is too important to leave it untested on unit level.
                 * Because of the Netty API design we need to do it this way.
                 */
                it("should turn on client authentication") {
                    val clientAuth: ClientAuth = ReferenceCountedOpenSslContext::class.java
                            .getDeclaredField("clientAuth")
                            .run {
                                isAccessible = true
                                get(result.orNull()) as ClientAuth
                            }
                    Assertions.assertThat(clientAuth).isEqualTo(ClientAuth.REQUIRE)
                }
            }
        }

        given("config with SSL disabled") {
            val securityConfiguration = SecurityConfiguration(
                    sslDisable = true,
                    keys = Some(keys)
            )
            val cut = ServerSslContextFactory()

            on("creation of SSL context") {
                val result = cut.createSslContext(securityConfiguration)

                it("should not create any SSL context ") {
                    assertThat(result.isDefined()).isFalse()
                }
            }
        }
    }

    describe("SslContextFactory (JDK)") {
        val keys = JdkKeys(
                keyStore = resourceStreamProvider("/ssl/server.ks.pkcs12"),
                keyStorePassword = PASSWORD.toCharArray(),
                trustStore = resourceStreamProvider("/ssl/trust.pkcs12"),
                trustStorePassword = PASSWORD.toCharArray()
        )

        given("config without disabled SSL") {
            val sampleConfig = SecurityConfiguration(keys = Some(keys))
            val cut = ServerSslContextFactory()

            on("creation of SSL context") {
                val result = cut.createSslContext(sampleConfig)

                it("should work") {
                    assertTrue(result.isDefined())
                }

                it("should be server context") {
                    assertTrue(result.exists {
                        it.isServer
                    })
                }

                /*
                 * It is too important to leave it untested on unit level.
                 * Because of the Netty API design we need to do it this way.
                 */
                it("should turn on client authentication") {
                    val clientAuth: ClientAuth = JdkSslContext::class.java
                            .getDeclaredField("clientAuth")
                            .run {
                                isAccessible = true
                                get(result.orNull()) as ClientAuth
                            }
                    Assertions.assertThat(clientAuth).isEqualTo(ClientAuth.REQUIRE)
                }

                it("should clear passwords so heap dumps won't contain them") {
                    val xedPassword = PASSWORD.toCharArray()
                    xedPassword.fill('x')
                    Assertions.assertThat(keys.keyStorePassword).isEqualTo(xedPassword)
                    Assertions.assertThat(keys.trustStorePassword).isEqualTo(xedPassword)
                }
            }
        }
    }
})

fun resourceStreamProvider(resource: String) = { ServerSslContextFactoryTest::class.java.getResourceAsStream(resource) }