-
Notifications
You must be signed in to change notification settings - Fork 741
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(proxy): A simple extension point around
ProxyConfig (#1331)
This PR supports bundling of proxy configuration alongside the plugins that require it.
- Loading branch information
Showing
5 changed files
with
289 additions
and
137 deletions.
There are no files selected for viewing
90 changes: 90 additions & 0 deletions
90
gate-api/src/main/java/com/netflix/spinnaker/gate/api/extension/ProxyConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Copyright 2020 Netflix, Inc. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.netflix.spinnaker.gate.api.extension; | ||
|
|
||
| import com.netflix.spinnaker.kork.annotations.Alpha; | ||
| import java.security.KeyStore; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import lombok.Data; | ||
|
|
||
| @Data | ||
| @Alpha | ||
| public class ProxyConfig { | ||
| /** Identifier for this proxy, must be unique. */ | ||
| private String id; | ||
|
|
||
| /** Target uri for this proxy. */ | ||
| private String uri; | ||
|
|
||
| /** Whether ssl hostname verification should be skipped. */ | ||
| private Boolean skipHostnameVerification = false; | ||
|
|
||
| /** Fully qualified path to keystore file. */ | ||
| private String keyStore; | ||
|
|
||
| /** Type of keystore, defaults to {@code KeyStore.getDefaultType()}. */ | ||
| private String keyStoreType = KeyStore.getDefaultType(); | ||
|
|
||
| /** | ||
| * Plain text keystore password. | ||
| * | ||
| * <p>If keyStore is non-null, one of keyStorePassword or keyStorePasswordFile must be supplied. | ||
| */ | ||
| private String keyStorePassword; | ||
|
|
||
| /** | ||
| * Fully qualified path to keystore password file. | ||
| * | ||
| * <p>If keyStore is non-null, one of keyStorePassword or keyStorePasswordFile must be supplied. | ||
| */ | ||
| private String keyStorePasswordFile; | ||
|
|
||
| /** Fully qualified path to truststore file. */ | ||
| private String trustStore; | ||
|
|
||
| /** Type of truststore, defaults to {@code KeyStore.getDefaultType()}. */ | ||
| private String trustStoreType = KeyStore.getDefaultType(); | ||
|
|
||
| /** | ||
| * Plain text truststore password. | ||
| * | ||
| * <p>If trustStore is non-null, one of trustStorePassword or trustStorePasswordFile must be | ||
| * supplied. | ||
| */ | ||
| private String trustStorePassword; | ||
|
|
||
| /** | ||
| * Fully qualified path to truststore password file. | ||
| * | ||
| * <p>If trustStore is non-null, one of trustStorePassword or trustStorePasswordFile must be | ||
| * supplied. | ||
| */ | ||
| private String trustStorePasswordFile; | ||
|
|
||
| /** Supported http methods for this proxy. */ | ||
| private List<String> methods = new ArrayList<>(); | ||
|
|
||
| /** Connection timeout, defaults to 30s. */ | ||
| private Long connectTimeoutMs = 30_000L; | ||
|
|
||
| /** Read timeout, defaults to 59s. */ | ||
| private Long readTimeoutMs = 59_000L; | ||
|
|
||
| /** Write timeout, defaults to 30s. */ | ||
| private Long writeTimeoutMs = 30_000L; | ||
| } |
33 changes: 33 additions & 0 deletions
33
gate-api/src/main/java/com/netflix/spinnaker/gate/api/extension/ProxyConfigProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /* | ||
| * Copyright 2020 Netflix, Inc. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.netflix.spinnaker.gate.api.extension; | ||
|
|
||
| import com.netflix.spinnaker.kork.annotations.Alpha; | ||
| import com.netflix.spinnaker.kork.plugins.api.internal.SpinnakerExtensionPoint; | ||
| import java.util.List; | ||
|
|
||
| /** Extension point for configuring proxy endpoints. */ | ||
| @Alpha | ||
| public interface ProxyConfigProvider extends SpinnakerExtensionPoint { | ||
|
|
||
| /** | ||
| * Provides list of proxy configurations that will be exposed via the ProxyController. | ||
| * | ||
| * @return list of proxy configurations | ||
| */ | ||
| List<? extends ProxyConfig> getProxyConfigs(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
115 changes: 115 additions & 0 deletions
115
gate-proxy/src/main/kotlin/com/netflix/spinnaker/gate/controllers/Proxy.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /* | ||
| * Copyright 2020 Netflix, Inc. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.netflix.spinnaker.gate.controllers | ||
|
|
||
| import com.netflix.spinnaker.gate.api.extension.ProxyConfig | ||
| import com.squareup.okhttp.OkHttpClient | ||
| import org.slf4j.LoggerFactory | ||
| import java.io.File | ||
| import java.security.KeyStore | ||
| import java.security.cert.X509Certificate | ||
| import java.util.concurrent.TimeUnit | ||
| import javax.net.ssl.KeyManagerFactory | ||
| import javax.net.ssl.SSLContext | ||
| import javax.net.ssl.TrustManager | ||
| import javax.net.ssl.TrustManagerFactory | ||
| import javax.net.ssl.X509TrustManager | ||
|
|
||
| internal class Proxy(val config: ProxyConfig) { | ||
| companion object { | ||
| val logger = LoggerFactory.getLogger(ProxyConfig::class.java) | ||
| } | ||
|
|
||
| var okHttpClient = OkHttpClient() | ||
|
|
||
| fun init() { | ||
| with(config) { | ||
| okHttpClient.setConnectTimeout(connectTimeoutMs, TimeUnit.MILLISECONDS) | ||
| okHttpClient.setReadTimeout(readTimeoutMs, TimeUnit.MILLISECONDS) | ||
| okHttpClient.setWriteTimeout(writeTimeoutMs, TimeUnit.MILLISECONDS) | ||
|
|
||
| if (skipHostnameVerification) { | ||
| okHttpClient = okHttpClient.setHostnameVerifier({ hostname, _ -> | ||
| logger.warn("Skipping hostname verification on request to $hostname (id: $id)") | ||
| true | ||
| }) | ||
| } | ||
|
|
||
| if (!keyStore.isNullOrEmpty()) { | ||
| val keyStorePassword = if (!keyStorePassword.isNullOrEmpty()) { | ||
| keyStorePassword | ||
| } else if (!keyStorePasswordFile.isNullOrEmpty()) { | ||
| File(keyStorePasswordFile).readText() | ||
| } else { | ||
| throw IllegalStateException("No `keyStorePassword` or `keyStorePasswordFile` specified (id: $id)") | ||
| } | ||
|
|
||
| val kStore = KeyStore.getInstance(keyStoreType) | ||
|
|
||
| File(this.keyStore).inputStream().use { | ||
| kStore.load(it, keyStorePassword!!.toCharArray()) | ||
| } | ||
|
|
||
| val kmf = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm()) | ||
| kmf.init(kStore, keyStorePassword!!.toCharArray()) | ||
|
|
||
| val keyManagers = kmf.keyManagers | ||
| var trustManagers: Array<TrustManager>? = null | ||
|
|
||
| if (!trustStore.isNullOrEmpty()) { | ||
| if (trustStore.equals("*")) { | ||
| trustManagers = arrayOf(TrustAllTrustManager()) | ||
| } else { | ||
| val trustStorePassword = if (!trustStorePassword.isNullOrEmpty()) { | ||
| trustStorePassword | ||
| } else if (!trustStorePasswordFile.isNullOrEmpty()) { | ||
| File(trustStorePasswordFile).readText() | ||
| } else { | ||
| throw IllegalStateException("No `trustStorePassword` or `trustStorePasswordFile` specified (id: $id)") | ||
| } | ||
|
|
||
| val tStore = KeyStore.getInstance(trustStoreType) | ||
| File(this.trustStore).inputStream().use { | ||
| tStore.load(it, trustStorePassword!!.toCharArray()) | ||
| } | ||
|
|
||
| val tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm()) | ||
| tmf.init(tStore) | ||
|
|
||
| trustManagers = tmf.trustManagers | ||
| } | ||
| } | ||
|
|
||
| val sslContext = SSLContext.getInstance("TLS") | ||
| sslContext.init(keyManagers, trustManagers, null) | ||
|
|
||
| okHttpClient = okHttpClient.setSslSocketFactory(sslContext.socketFactory) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class TrustAllTrustManager : X509TrustManager { | ||
| override fun checkClientTrusted(certs: Array<X509Certificate>, authType: String) { | ||
| // do nothing | ||
| } | ||
| override fun checkServerTrusted(certs: Array<X509Certificate>, authType: String) { | ||
| // do nothing | ||
| } | ||
|
|
||
| override fun getAcceptedIssuers() = null | ||
| } |
Oops, something went wrong.