Add proxy support for the SSO with OIDC flow. #189
There are no files selected for viewing
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
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,218 @@ | ||
| /** | ||
| * Copyright (c) 2024, WSO2 Inc. (https://www.wso2.com) All Rights Reserved. | ||
| * | ||
| * WSO2 LLC. licenses this file to you 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 org.wso2.carbon.identity.application.authenticator.oidc; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.http.HttpHost; | ||
| import org.apache.http.HttpResponse; | ||
| import org.apache.http.HttpStatus; | ||
| import org.apache.http.auth.AuthScope; | ||
| import org.apache.http.auth.UsernamePasswordCredentials; | ||
| import org.apache.http.client.CredentialsProvider; | ||
| import org.apache.http.client.config.RequestConfig; | ||
| import org.apache.http.client.methods.HttpPost; | ||
| import org.apache.http.config.RegistryBuilder; | ||
| import org.apache.http.conn.socket.ConnectionSocketFactory; | ||
| import org.apache.http.conn.ssl.SSLConnectionSocketFactory; | ||
| import org.apache.http.conn.ssl.SSLContexts; | ||
| import org.apache.http.conn.ssl.SSLSocketFactory; | ||
| import org.apache.http.conn.ssl.X509HostnameVerifier; | ||
| import org.apache.http.entity.ContentType; | ||
| import org.apache.http.entity.StringEntity; | ||
| import org.apache.http.impl.client.BasicCredentialsProvider; | ||
| import org.apache.http.impl.client.HttpClientBuilder; | ||
| import org.apache.http.impl.client.HttpClients; | ||
| import org.apache.http.impl.conn.DefaultProxyRoutePlanner; | ||
| import org.apache.http.impl.conn.PoolingHttpClientConnectionManager; | ||
| import org.apache.http.util.EntityUtils; | ||
| import org.apache.oltu.oauth2.client.HttpClient; | ||
| import org.apache.oltu.oauth2.client.request.OAuthClientRequest; | ||
| import org.apache.oltu.oauth2.client.response.OAuthClientResponse; | ||
| import org.apache.oltu.oauth2.client.response.OAuthClientResponseFactory; | ||
| import org.apache.oltu.oauth2.common.exception.OAuthProblemException; | ||
| import org.apache.oltu.oauth2.common.exception.OAuthSystemException; | ||
| import org.wso2.carbon.identity.application.authenticator.oidc.util.ExtendedProxyRoutePlanner; | ||
| import org.wso2.carbon.identity.core.util.IdentityUtil; | ||
| import org.wso2.carbon.utils.CarbonUtils; | ||
|
|
||
| import javax.net.ssl.HostnameVerifier; | ||
| import javax.net.ssl.SSLContext; | ||
| import javax.net.ssl.SSLSession; | ||
| import java.io.FileInputStream; | ||
| import java.io.IOException; | ||
| import java.net.MalformedURLException; | ||
| import java.security.KeyManagementException; | ||
| import java.security.KeyStore; | ||
| import java.security.KeyStoreException; | ||
| import java.security.NoSuchAlgorithmException; | ||
| import java.security.cert.CertificateException; | ||
| import java.util.Arrays; | ||
| import java.util.Map; | ||
|
|
||
|
|
||
| public class CustomURLConnectionClient implements HttpClient { | ||
| @Override | ||
| public <T extends OAuthClientResponse> T execute(OAuthClientRequest request, Map<String, String> headers, String s, Class<T> responseClass) throws OAuthSystemException, OAuthProblemException { | ||
|
|
||
| org.apache.http.client.HttpClient httpClient = getHttpClient(); | ||
| try { | ||
| HttpPost httpPost = new HttpPost(request.getLocationUri()); | ||
| if (headers != null && !headers.isEmpty()) { | ||
| for (Map.Entry<String, String> header : headers.entrySet()) { | ||
| httpPost.setHeader(header.getKey(), header.getValue()); | ||
| } | ||
| } | ||
| if (request.getHeaders() != null) { | ||
| for (Map.Entry<String, String> header : request.getHeaders().entrySet()) { | ||
| httpPost.setHeader(header.getKey(), header.getValue()); | ||
| } | ||
| } | ||
|
|
||
| String requestBody = request.getBody(); | ||
| StringEntity requestEntity = new StringEntity(requestBody, ContentType.APPLICATION_JSON); | ||
| httpPost.setEntity(requestEntity); | ||
|
|
||
| HttpResponse response = httpClient.execute(httpPost); | ||
| if (HttpStatus.SC_OK == response.getStatusLine().getStatusCode()) { | ||
| String responseString = EntityUtils.toString(response.getEntity(), "UTF-8"); | ||
| return OAuthClientResponseFactory | ||
| .createCustomResponse(responseString, requestEntity.getContentType().toString(), | ||
| response.getStatusLine().getStatusCode(), responseClass); | ||
| } else { | ||
| throw new OAuthSystemException("Error while obtaining the access token through the proxy " + | ||
| EntityUtils.toString(response.getEntity())); | ||
| } | ||
| } catch (IOException e) { | ||
| throw new OAuthSystemException(e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void shutdown() { | ||
| // Nothing to do here | ||
| } | ||
|
|
||
| public static org.apache.http.client.HttpClient getHttpClient() throws OAuthSystemException { | ||
| Boolean proxyEnabled = Boolean.parseBoolean(IdentityUtil.getProperty( | ||
| OIDCAuthenticatorConstants.Proxy.proxyEnable)); | ||
| String proxyProtocol = IdentityUtil.getProperty(OIDCAuthenticatorConstants.Proxy.proxyProtocol); | ||
| String proxyUsername = IdentityUtil.getProperty(OIDCAuthenticatorConstants.Proxy.proxyUsername); | ||
| String proxyPassword = IdentityUtil.getProperty(OIDCAuthenticatorConstants.Proxy.proxyPassword); | ||
| String proxyHost = IdentityUtil.getProperty(OIDCAuthenticatorConstants.Proxy.proxyHost); | ||
| String proxyPort = IdentityUtil.getProperty(OIDCAuthenticatorConstants.Proxy.proxyPort); | ||
| String nonProxyHosts = IdentityUtil.getProperty(OIDCAuthenticatorConstants.Proxy.proxyPort); | ||
|
|
||
| PoolingHttpClientConnectionManager pool = null; | ||
| try { | ||
| pool = getPoolingHttpClientConnectionManager(proxyProtocol); | ||
| } catch (Exception e) { | ||
| throw new OAuthSystemException(e); | ||
| } | ||
|
|
||
| RequestConfig params = RequestConfig.custom().build(); | ||
| HttpClientBuilder clientBuilder = HttpClients.custom().setConnectionManager(pool) | ||
| .setDefaultRequestConfig(params); | ||
|
|
||
| HttpHost host = null; | ||
| if (proxyEnabled) { | ||
| host = new HttpHost(proxyHost, Integer.parseInt(proxyPort), proxyProtocol); | ||
| clientBuilder.setDefaultRequestConfig(RequestConfig.custom().setProxy(host).build()); | ||
| DefaultProxyRoutePlanner routePlanner; | ||
| if (!StringUtils.isBlank(nonProxyHosts)) { | ||
| routePlanner = new ExtendedProxyRoutePlanner(host, nonProxyHosts, proxyHost, proxyPort, proxyProtocol); | ||
| } else { | ||
| routePlanner = new DefaultProxyRoutePlanner(host); | ||
| } | ||
| clientBuilder = clientBuilder.setRoutePlanner(routePlanner); | ||
| if (!StringUtils.isBlank(proxyUsername) && !StringUtils.isBlank(proxyPassword)) { | ||
| CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); | ||
| credentialsProvider.setCredentials(new AuthScope(proxyHost, Integer.parseInt(proxyPort)), | ||
| new UsernamePasswordCredentials(proxyUsername, proxyPassword)); | ||
| clientBuilder = clientBuilder.setDefaultCredentialsProvider(credentialsProvider); | ||
| } | ||
| } | ||
| return clientBuilder.build(); | ||
| } | ||
|
|
||
| /** | ||
| * Return a PoolingHttpClientConnectionManager instance | ||
| * | ||
| * @param protocol- service endpoint protocol. It can be http/https | ||
| * @return PoolManager | ||
| */ | ||
| private static PoolingHttpClientConnectionManager getPoolingHttpClientConnectionManager(String protocol) throws Exception { | ||
|
|
||
| PoolingHttpClientConnectionManager poolManager; | ||
| if (OIDCAuthenticatorConstants.Proxy.HTTPS.equals(protocol)) { | ||
| SSLConnectionSocketFactory socketFactory = createSocketFactory(); | ||
| org.apache.http.config.Registry<ConnectionSocketFactory> socketFactoryRegistry = | ||
| RegistryBuilder.<ConnectionSocketFactory>create() | ||
| .register(OIDCAuthenticatorConstants.Proxy.HTTPS, socketFactory).build(); | ||
| poolManager = new PoolingHttpClientConnectionManager(socketFactoryRegistry); | ||
| } else { | ||
| poolManager = new PoolingHttpClientConnectionManager(); | ||
| } | ||
| return poolManager; | ||
| } | ||
|
|
||
| private static SSLConnectionSocketFactory createSocketFactory() throws OAuthSystemException { | ||
| SSLContext sslContext = null; | ||
| HostnameVerifier hostnameVerifier = null; | ||
| String keyStorePath = CarbonUtils.getServerConfiguration() | ||
| .getFirstProperty(OIDCAuthenticatorConstants.Proxy.trustStoreLocation); | ||
| String keyStorePassword = CarbonUtils.getServerConfiguration() | ||
| .getFirstProperty(OIDCAuthenticatorConstants.Proxy.trustStorePassword); | ||
| try { | ||
| KeyStore trustStore = KeyStore.getInstance("JKS"); | ||
| trustStore.load(new FileInputStream(keyStorePath), keyStorePassword.toCharArray()); | ||
| sslContext = SSLContexts.custom().loadTrustMaterial(trustStore).build(); | ||
|
|
||
| String hostnameVerifierOption = System.getProperty(OIDCAuthenticatorConstants.Proxy.hostNameVerifierSysEnv); | ||
|
|
||
| if (OIDCAuthenticatorConstants.Proxy.ALLOW_ALL_HOSTNAME_VERIFIER.equalsIgnoreCase(hostnameVerifierOption)) { | ||
| hostnameVerifier = SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER; | ||
| } else if (OIDCAuthenticatorConstants.Proxy.STRICT_HOSTNAME_VERIFIER.equalsIgnoreCase(hostnameVerifierOption)) { | ||
| hostnameVerifier = SSLSocketFactory.STRICT_HOSTNAME_VERIFIER; | ||
| } else if (OIDCAuthenticatorConstants.Proxy.DEFAULT_HOSTNAME_VERIFIER.equalsIgnoreCase(hostnameVerifierOption)) { | ||
| hostnameVerifier = new HostnameVerifier() { | ||
| final String[] localhosts = {"::1", "127.0.0.1", "localhost", "localhost.localdomain"}; | ||
|
|
||
| @Override | ||
| public boolean verify(String urlHostName, SSLSession session) { | ||
| return SSLSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER.verify(urlHostName, session) | ||
| || Arrays.asList(localhosts).contains(urlHostName); | ||
| } | ||
| }; | ||
| } else { | ||
| hostnameVerifier = SSLSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER; | ||
| } | ||
| return new SSLConnectionSocketFactory(sslContext, (X509HostnameVerifier) hostnameVerifier); | ||
|
|
||
| } catch (KeyStoreException e) { | ||
| throw new OAuthSystemException(e); | ||
| } catch (IOException e) { | ||
| throw new OAuthSystemException(e); | ||
| } catch (CertificateException e) { | ||
| throw new OAuthSystemException(e); | ||
| } catch (NoSuchAlgorithmException e) { | ||
| throw new OAuthSystemException(e); | ||
| } catch (KeyManagementException e) { | ||
| throw new OAuthSystemException(e); | ||
| } | ||
| } | ||
| } |
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
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
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,118 @@ | ||
| /* | ||
| * Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. | ||
| * | ||
| * WSO2 Inc. licenses this file to you 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 org.wso2.carbon.identity.application.authenticator.oidc.util; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.apache.http.HttpException; | ||
| import org.apache.http.HttpHost; | ||
| import org.apache.http.HttpRequest; | ||
| import org.apache.http.impl.conn.DefaultProxyRoutePlanner; | ||
| import org.apache.http.protocol.HttpContext; | ||
|
|
||
|
|
||
|
|
||
| /** | ||
| * Extended ProxyRoutePlanner class to handle non proxy hosts implementation | ||
| */ | ||
| public class ExtendedProxyRoutePlanner extends DefaultProxyRoutePlanner { | ||
| private static final Log log = LogFactory.getLog(ExtendedProxyRoutePlanner.class); | ||
| String nonProxyHosts; | ||
| String proxyHost; | ||
| String proxyPort; | ||
| String protocol; | ||
|
|
||
| public ExtendedProxyRoutePlanner(HttpHost host, String nonProxyHosts, String proxyHost, String proxyPort, | ||
| String protocol ) { | ||
| super(host); | ||
| this.nonProxyHosts = nonProxyHosts; | ||
| this.proxyHost = proxyHost; | ||
| this.proxyPort = proxyPort; | ||
| this.protocol = protocol; | ||
| } | ||
|
|
||
| private HttpHost getProxy(String scheme) { | ||
| log.debug("Get proxy for scheme: " + scheme); | ||
| String proto = scheme; | ||
|
|
||
| String protoProxyHost = proxyHost; | ||
| if (protoProxyHost == null) { | ||
| return null; | ||
| } | ||
| String proxyPortStr = proxyPort; | ||
| if (proxyPortStr == null) { | ||
| return null; | ||
| } | ||
| int protoProxyPort = -1; | ||
| if (proxyPortStr != null) { | ||
| try { | ||
| protoProxyPort = Integer.valueOf(proxyPortStr); | ||
| } catch (NumberFormatException nfe) { | ||
| log.warn("invalid proxy port: " + proxyPortStr + ". proxy will be ignored"); | ||
| return null; | ||
| } | ||
| } | ||
| if (protoProxyPort < 1) { | ||
| return null; | ||
| } | ||
| log.debug("set " + proto + " proxy '" + protoProxyHost + ":" + protoProxyPort + "'"); | ||
| return new HttpHost(protoProxyHost, protoProxyPort, scheme); | ||
| } | ||
|
|
||
| private String[] getNonProxyHosts() { | ||
| String nonProxyHosts = this.nonProxyHosts; | ||
| if (nonProxyHosts == null) { | ||
| return null; | ||
| } | ||
| return nonProxyHosts.split("\\|"); | ||
| } | ||
|
|
||
| private boolean doesTargetMatchNonProxy(HttpHost target) { | ||
| String uriHost = target.getHostName(); | ||
| String uriScheme = target.getSchemeName(); | ||
| String[] nonProxyHosts = getNonProxyHosts(); | ||
| int nphLength = nonProxyHosts != null ? nonProxyHosts.length : 0; | ||
| if (nonProxyHosts == null || nphLength < 1) { | ||
| log.debug("sheme:'" + uriScheme + "', host:'" + uriHost + "' : DEFAULT (0 non proxy host)"); | ||
| return false; | ||
| } | ||
| for (String nonProxyHost : nonProxyHosts) { | ||
| if (uriHost.matches(nonProxyHost)) { | ||
| log.debug("sheme:'" + uriScheme + "', host:'" + uriHost + "' matches nonProxyHost '" + nonProxyHost + "' : NO PROXY"); | ||
| return true; | ||
| } | ||
| } | ||
| log.debug("sheme:'" + uriScheme + "', host:'" + uriHost + "' : DEFAULT (no match of " + nphLength + " non proxy host)"); | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| protected HttpHost determineProxy(HttpHost target, final HttpRequest request, final HttpContext context) | ||
| throws HttpException { | ||
|
|
||
| if (doesTargetMatchNonProxy(target)) { | ||
| return null; | ||
| } | ||
| if (StringUtils.isNotEmpty(protocol)) { | ||
| return getProxy(protocol); | ||
| } else { | ||
| return getProxy(target.getSchemeName()); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be checking the system properties?