Merge pull request #2440 from RivinduM/master

Add MTLS Aliases endpoints to the discovery endpoint
wso2-extensions · Apr 30, 2024 · 8411b36 · 8411b36
2 parents 8e6da7b + 5ac2375
commit 8411b36
Show file tree

Hide file tree

Showing 7 changed files with 102 additions and 1 deletion.
diff --git a/...entity.discovery/src/main/java/org/wso2/carbon/identity/discovery/DiscoveryConstants.java b/...entity.discovery/src/main/java/org/wso2/carbon/identity/discovery/DiscoveryConstants.java
@@ -370,4 +370,11 @@ public class DiscoveryConstants {
      * If omitted, the default value is false.
      */
     public static final String TLS_CLIENT_CERTIFICATE_BOUND_ACCESS_TOKEN = "tls_client_certificate_bound_access_tokens";
+
+    /**
+     * mtls_endpoint_aliases
+     * OPTIONAL. JSON Object containing a list of the aliases of the mTLS endpoints supported by the
+     * Authorization Server.
+     */
+    public static final String MTLS_ENDPOINT_ALIASES = "mtls_endpoint_aliases";
 }
diff --git a/...on.identity.discovery/src/main/java/org/wso2/carbon/identity/discovery/DiscoveryUtil.java b/...on.identity.discovery/src/main/java/org/wso2/carbon/identity/discovery/DiscoveryUtil.java
@@ -42,4 +42,5 @@ public static boolean isUseEntityIdAsIssuerInOidcDiscovery() {
         }
         return Boolean.parseBoolean(useEntityIdAsIssuerInDiscovery);
     }
+
 }
diff --git a/...discovery/src/main/java/org/wso2/carbon/identity/discovery/OIDProviderConfigResponse.java b/...discovery/src/main/java/org/wso2/carbon/identity/discovery/OIDProviderConfigResponse.java
@@ -19,6 +19,8 @@
 package org.wso2.carbon.identity.discovery;
 
 
+import org.wso2.carbon.identity.core.util.IdentityUtil;
+
 import java.util.HashMap;
 import java.util.Map;
 
@@ -81,6 +83,10 @@ public class OIDProviderConfigResponse {
     private String deviceAuthorizationEndpoint;
     private String webFingerEndpoint;
     private Boolean tlsClientCertificateBoundAccessTokens;
+    private String mtlsTokenEndpoint;
+    private String mtlsPushedAuthorizationRequestEndpoint;
+
+    private static final String MUTUAL_TLS_ALIASES_ENABLED = "OAuth.MutualTLSAliases.Enabled";
 
     public String getIssuer() {
         return issuer;
@@ -514,6 +520,16 @@ public void setTlsClientCertificateBoundAccessTokens(Boolean tlsClientCertificat
         this.tlsClientCertificateBoundAccessTokens = tlsClientCertificateBoundAccessTokens;
     }
 
+    public void setMtlsTokenEndpoint(String mtlsTokenEndpoint) {
+
+        this.mtlsTokenEndpoint = mtlsTokenEndpoint;
+    }
+
+    public void setMtlsPushedAuthorizationRequestEndpoint(String mtlsPushedAuthorizationRequestEndpoint) {
+
+        this.mtlsPushedAuthorizationRequestEndpoint = mtlsPushedAuthorizationRequestEndpoint;
+    }
+
     public Map<String, Object> getConfigMap() {
         Map<String, Object> configMap = new HashMap<String, Object>();
         configMap.put(DiscoveryConstants.ISSUER.toLowerCase(), this.issuer);
@@ -581,6 +597,13 @@ public Map<String, Object> getConfigMap() {
         configMap.put(DiscoveryConstants.WEBFINGER_ENDPOINT.toLowerCase(), this.webFingerEndpoint);
         configMap.put(DiscoveryConstants.TLS_CLIENT_CERTIFICATE_BOUND_ACCESS_TOKEN.toLowerCase(),
                 this.tlsClientCertificateBoundAccessTokens);
+        if (Boolean.parseBoolean(IdentityUtil.getProperty(MUTUAL_TLS_ALIASES_ENABLED))) {
+            Map<String, String> mtlsAliases = new HashMap<String, String>();
+            mtlsAliases.put(DiscoveryConstants.TOKEN_ENDPOINT.toLowerCase(), this.mtlsTokenEndpoint);
+            mtlsAliases.put(DiscoveryConstants.PUSHED_AUTHORIZATION_REQUEST_ENDPOINT.toLowerCase(),
+                    this.mtlsPushedAuthorizationRequestEndpoint);
+            configMap.put(DiscoveryConstants.MTLS_ENDPOINT_ALIASES, mtlsAliases);
+        }
         return configMap;
     }
 }
diff --git a/...very/src/main/java/org/wso2/carbon/identity/discovery/builders/ProviderConfigBuilder.java b/...very/src/main/java/org/wso2/carbon/identity/discovery/builders/ProviderConfigBuilder.java
@@ -148,6 +148,8 @@ public OIDProviderConfigResponse buildOIDProviderConfig(OIDProviderRequest reque
         providerConfig.setWebFingerEndpoint(OAuth2Util.OAuthURL.getOidcWebFingerEPUrl());
         providerConfig.setTlsClientCertificateBoundAccessTokens(OAuth2Util.getSupportedTokenBindingTypes()
                 .contains(OAuth2Constants.TokenBinderType.CERTIFICATE_BASED_TOKEN_BINDER));
+        providerConfig.setMtlsTokenEndpoint(OAuth2Util.OAuthURL.getOAuth2MTLSTokenEPUrl());
+        providerConfig.setMtlsPushedAuthorizationRequestEndpoint(OAuth2Util.OAuthURL.getOAuth2MTLSParEPUrl());
         return providerConfig;
     }
 }
diff --git a/...tity.oauth.common/src/main/java/org/wso2/carbon/identity/oauth/common/OAuthConstants.java b/...tity.oauth.common/src/main/java/org/wso2/carbon/identity/oauth/common/OAuthConstants.java
@@ -242,6 +242,7 @@ public static SubjectType fromValue(String text) {
     public static final String RENEW_TOKEN_WITHOUT_REVOKING_EXISTING_ENABLE_CONFIG =
             "OAuth.JWT.RenewTokenWithoutRevokingExisting.Enable";
     public static final String OAUTH_BUILD_ISSUER_WITH_HOSTNAME = "OAuth.BuildIssuerWithHostname";
+    public static final String MTLS_HOSTNAME = "OAuth.MutualTLSAliases.Hostname";
 
     public static final String REQUEST_BINDING_TYPE = "request";
     public static final String ORG_ID = "org_id";

diff --git a/....carbon.identity.oauth/src/main/java/org/wso2/carbon/identity/oauth2/util/OAuth2Util.java b/....carbon.identity.oauth/src/main/java/org/wso2/carbon/identity/oauth2/util/OAuth2Util.java
@@ -1466,6 +1466,18 @@ public static String getOAuth2TokenEPUrl() {
             return buildUrl(OAUTH2_TOKEN_EP_URL, OAuthServerConfiguration.getInstance()::getOAuth2TokenEPUrl);
         }
 
+        public static String getOAuth2MTLSParEPUrl() {
+
+            return buildUrlWithHostname(OAUTH2_PAR_EP_URL, OAuthServerConfiguration.getInstance()::getOAuth2ParEPUrl,
+                    IdentityUtil.getProperty(OAuthConstants.MTLS_HOSTNAME));
+        }
+
+        public static String getOAuth2MTLSTokenEPUrl() {
+
+            return buildUrlWithHostname(OAUTH2_TOKEN_EP_URL, OAuthServerConfiguration.getInstance()::
+                    getOAuth2TokenEPUrl, IdentityUtil.getProperty(OAuthConstants.MTLS_HOSTNAME));
+        }
+
         /**
          * This method is used to get the resolved URL for the OAuth2 Registration Endpoint.
          *
@@ -1642,6 +1654,28 @@ private static String buildUrl(String defaultContext, Supplier<String> getValueF
         return buildServiceUrl(defaultContext, oauth2EndpointURLInFile);
     }
 
+    /**
+     * Builds a URL with a given context in both the tenant-qualified url supported mode and the legacy mode.
+     * Returns the absolute URL build from the default context in the tenant-qualified url supported mode. Gives
+     * precedence to the file configurations in the legacy mode and returns the absolute url build from file
+     * configuration context.
+     *
+     * @param defaultContext              Default URL context.
+     * @param getValueFromFileBasedConfig File-based Configuration.
+     * @param hostname                    hostname of the service
+     * @return Absolute URL.
+     */
+    private static String buildUrlWithHostname(String defaultContext, Supplier<String> getValueFromFileBasedConfig,
+                                               String hostname) {
+
+        String oauth2EndpointURLInFile = null;
+        if (getValueFromFileBasedConfig != null) {
+            oauth2EndpointURLInFile = getValueFromFileBasedConfig.get();
+        }
+        return hostname != null ? buildServiceUrlWithHostname(defaultContext, oauth2EndpointURLInFile, hostname) :
+                buildServiceUrl(defaultContext, oauth2EndpointURLInFile);
+    }
+
     /**
      * Returns the public service url given the default context and the url picked from the configuration based on
      * the 'tenant_context.enable_tenant_qualified_urls' mode set in deployment.toml.
@@ -1673,6 +1707,39 @@ public static String buildServiceUrl(String defaultContext, String oauth2Endpoin
         }
     }
 
+    /**
+     * Returns the public service url given the default context and the url picked from the configuration based on
+     * the 'tenant_context.enable_tenant_qualified_urls' mode set in deployment.toml.
+     *
+     * @param defaultContext          default url context path
+     * @param oauth2EndpointURLInFile url picked from the file configuration
+     * @param hostname                hostname of the service
+     * @return absolute public url of the service if 'enable_tenant_qualified_urls' is 'true', else returns the url
+     * from the file config
+     */
+    public static String buildServiceUrlWithHostname(String defaultContext, String oauth2EndpointURLInFile,
+                                                     String hostname) {
+
+        if (IdentityTenantUtil.isTenantQualifiedUrlsEnabled()) {
+            try {
+                String organizationId = PrivilegedCarbonContext.getThreadLocalCarbonContext().getOrganizationId();
+                return ServiceURLBuilder.create().addPath(defaultContext).setOrganization(organizationId)
+                        .build(hostname).getAbsolutePublicURL();
+            } catch (URLBuilderException e) {
+                throw new OAuthRuntimeException("Error while building url for context: " + defaultContext, e);
+            }
+        } else if (StringUtils.isNotBlank(oauth2EndpointURLInFile)) {
+            // Use the value configured in the file.
+            return oauth2EndpointURLInFile;
+        }
+        // Use the default context.
+        try {
+            return ServiceURLBuilder.create().addPath(defaultContext).build(hostname).getAbsolutePublicURL();
+        } catch (URLBuilderException e) {
+            throw new OAuthRuntimeException("Error while building url for context: " + defaultContext, e);
+        }
+    }
+
     private static boolean isNotSuperTenant(String tenantDomain) {
 
         return (StringUtils.isNotBlank(tenantDomain) &&

diff --git a/pom.xml b/pom.xml
@@ -901,7 +901,7 @@
         <carbon.kernel.registry.imp.pkg.version.range>[1.0.1, 2.0.0)</carbon.kernel.registry.imp.pkg.version.range>
 
         <!-- Carbon Identity Framework version -->
-        <carbon.identity.framework.version>7.1.42</carbon.identity.framework.version>
+        <carbon.identity.framework.version>7.1.45</carbon.identity.framework.version>
         <carbon.identity.framework.imp.pkg.version.range>[5.25.234, 8.0.0)
         </carbon.identity.framework.imp.pkg.version.range>
-Original file line number
+Diff line change
@@ Expand Up @@
             }
             return Boolean.parseBoolean(useEntityIdAsIssuerInDiscovery);
         }
     }