Skip to content

SSLMode support for MysqlConnectionFactoryProvider #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oshai merged 1 commit into from
Jan 12, 2023
Merged

SSLMode support for MysqlConnectionFactoryProvider #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion r2dbc-mysql/src/main/java/MysqlConnectionFactoryProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ class MysqlConnectionFactoryProvider : ConnectionFactoryProvider {
database = connectionFactoryOptions.getValue(DATABASE) as String?,
applicationName = connectionFactoryOptions.getValue(APPLICATION_NAME) as String?,
connectionTimeout = (connectionFactoryOptions.getValue(CONNECT_TIMEOUT) as Duration?)?.toMillis()?.toInt() ?: 5000,
queryTimeout = connectionFactoryOptions.getValue(STATEMENT_TIMEOUT) as Duration?
queryTimeout = connectionFactoryOptions.getValue(STATEMENT_TIMEOUT) as Duration?,
ssl = MysqlSSLConfigurationFactory.create(connectionFactoryOptions)
)
return JasyncConnectionFactory(MySQLConnectionFactory(configuration))
}
Expand Down
33 changes: 33 additions & 0 deletions r2dbc-mysql/src/main/java/MysqlSSLConfigurationFactory.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package com.github.jasync.r2dbc.mysql

import com.github.jasync.sql.db.SSLConfiguration
import com.github.jasync.sql.db.SSLConfiguration.Mode.Disable
import com.github.jasync.sql.db.SSLConfiguration.Mode.Prefer
import com.github.jasync.sql.db.SSLConfiguration.Mode.Require
import com.github.jasync.sql.db.SSLConfiguration.Mode.VerifyCA
import com.github.jasync.sql.db.SSLConfiguration.Mode.VerifyFull
import io.r2dbc.spi.ConnectionFactoryOptions
import io.r2dbc.spi.Option

object MysqlSSLConfigurationFactory {

private val SSL_MODE_OPTION = Option.valueOf<String>("sslMode")
private val SSL_MODE_MAP = mapOf(
"disabled" to Disable,
"preferred" to Prefer,
"required" to Require,
"verify_ca" to VerifyCA,
"verify_identity" to VerifyFull
)

fun create(options: ConnectionFactoryOptions): SSLConfiguration {
if (!options.hasOption(ConnectionFactoryOptions.SSL)) {
return SSLConfiguration(mode = Disable)
}
if (!options.hasOption(SSL_MODE_OPTION)) {
return SSLConfiguration(mode = Prefer)
}
val sslMode = options.getValue(SSL_MODE_OPTION) as String
return SSLConfiguration(mode = SSL_MODE_MAP.getOrDefault(sslMode.lowercase(), Prefer))
}
}
31 changes: 31 additions & 0 deletions ...c-mysql/src/test/java/com/github/jasync/r2dbc/mysql/MysqlConnectionFactoryProviderTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package com.github.jasync.r2dbc.mysql

import com.github.jasync.sql.db.SSLConfiguration
import io.mockk.every
import io.mockk.mockkObject
import io.mockk.verify
import io.r2dbc.spi.ConnectionFactoryOptions
import org.junit.Test

internal class MysqlConnectionFactoryProviderTest {

private val provider = MysqlConnectionFactoryProvider()

@Test
fun shouldCreateMysqlConnectionWithMysqlSSLConfigurationFactory() {
// given
mockkObject(MysqlSSLConfigurationFactory)
every { MysqlSSLConfigurationFactory.create(any()) } returns SSLConfiguration()

val options =
ConnectionFactoryOptions.parse("r2dbc:mysql://user@host:443/")

// when
provider.create(options)

// then
verify {
MysqlSSLConfigurationFactory.create(options)
}
}
}
116 changes: 116 additions & 0 deletions r2dbc-mysql/src/test/java/com/github/jasync/r2dbc/mysql/MysqlSSLConfigurationFactoryTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
package com.github.jasync.r2dbc.mysql

import com.github.jasync.sql.db.SSLConfiguration
import com.github.jasync.sql.db.SSLConfiguration.Mode.Disable
import com.github.jasync.sql.db.SSLConfiguration.Mode.Prefer
import com.github.jasync.sql.db.SSLConfiguration.Mode.Require
import com.github.jasync.sql.db.SSLConfiguration.Mode.VerifyCA
import com.github.jasync.sql.db.SSLConfiguration.Mode.VerifyFull
import io.r2dbc.spi.ConnectionFactoryOptions
import io.r2dbc.spi.ConnectionFactoryOptions.SSL
import io.r2dbc.spi.Option
import org.junit.Test
import org.junit.runner.RunWith
import org.junit.runners.Parameterized
import kotlin.test.assertEquals

@RunWith(Parameterized::class)
internal class MysqlSSLConfigurationFactoryTest(
private val options: ConnectionFactoryOptions,
private val expectedSSLConfiguration: SSLConfiguration,
private val message: String
) {

companion object {

private val SSL_MODE_OPTION = Option.valueOf<String>("sslMode")

@JvmStatic
@Parameterized.Parameters
fun data() = listOf(
createTestParams(
options = ConnectionFactoryOptions.builder().build(),
expected = SSLConfiguration(),
message = "sslMode should be 'disabled' for non-secure protocol"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.build(),
expected = SSLConfiguration(mode = Prefer),
message = "sslMode should be 'preferred' by default"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.option(SSL_MODE_OPTION, "invalid")
.build(),
expected = SSLConfiguration(mode = Prefer),
message = "sslMode should be 'preferred' for invalid value"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.option(SSL_MODE_OPTION, "REQUIRED")
.build(),
expected = SSLConfiguration(mode = Require),
message = "sslMode should be case insensitive"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.option(SSL_MODE_OPTION, "disabled")
.build(),
expected = SSLConfiguration(mode = Disable),
message = "sslMode should be 'disabled'"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.option(SSL_MODE_OPTION, "preferred")
.build(),
expected = SSLConfiguration(mode = Prefer),
message = "sslMode should be 'preferred'"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.option(SSL_MODE_OPTION, "required")
.build(),
expected = SSLConfiguration(mode = Require),
message = "sslMode should be 'required'"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.option(SSL_MODE_OPTION, "verify_ca")
.build(),
expected = SSLConfiguration(mode = VerifyCA),
message = "sslMode should be 'verify_ca'"
),
createTestParams(
options = ConnectionFactoryOptions.builder()
.option(SSL, true)
.option(SSL_MODE_OPTION, "verify_identity")
.build(),
expected = SSLConfiguration(mode = VerifyFull),
message = "sslMode should be 'verify_identity'"
),
)

private fun createTestParams(
options: ConnectionFactoryOptions,
expected: SSLConfiguration,
message: String
) = arrayOf(options, expected, message)
}

@Test
fun shouldCreateProperSSLConfiguration() {
// when
val result = MysqlSSLConfigurationFactory.create(options)

// then
assertEquals(expectedSSLConfiguration, result, message)
}
}