Fix certificate field in IDP export-import with json #1042
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ jobs: | |
|
|
||
| strategy: | ||
| matrix: | ||
| java-version: [ 11, 17 ] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
|
|
||
This file contains hidden or 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 hidden or 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,74 @@ | ||
| /* | ||
| * Copyright (c) 2025, WSO2 LLC. (http://www.wso2.com). | ||
| * | ||
| * 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.api.server.idp.v1.model; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.wso2.carbon.identity.application.common.model.IdentityProvider; | ||
|
|
||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * Identity Provider Export Response model. | ||
| */ | ||
| public class IdentityProviderExportResponse extends IdentityProvider { | ||
|
|
||
| private static final long serialVersionUID = 1L; | ||
| private static final Log log = LogFactory.getLog(IdentityProviderExportResponse.class); | ||
|
|
||
| private Certificate certificate; | ||
|
|
||
| @JsonProperty("certificate") | ||
| public Certificate getCertificates() { | ||
|
|
||
| if (log.isDebugEnabled()) { | ||
| log.debug("Retrieving certificate from IdentityProviderExportResponse"); | ||
| } | ||
| return certificate; | ||
| } | ||
|
|
||
| @JsonProperty("certificate") | ||
| public void setCertificate(Certificate certificate) { | ||
|
|
||
| if (log.isDebugEnabled()) { | ||
| log.debug("Setting certificate in IdentityProviderExportResponse"); | ||
| } | ||
| this.certificate = certificate; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
|
|
||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| if (!super.equals(o)) { | ||
| return false; | ||
| } | ||
| IdentityProviderExportResponse that = (IdentityProviderExportResponse) o; | ||
| return Objects.equals(certificate, that.certificate); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
|
|
||
| return Objects.hash(super.hashCode(), certificate); | ||
| } | ||
| } |
This file contains hidden or 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,131 @@ | ||||||||||
| /* | ||||||||||
| * Copyright (c) 2025, WSO2 LLC. (http://www.wso2.com). | ||||||||||
| * | ||||||||||
| * 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.api.server.idp.v1.util; | ||||||||||
|
|
||||||||||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||||||||||
| import com.fasterxml.jackson.databind.node.ArrayNode; | ||||||||||
| import org.apache.commons.logging.Log; | ||||||||||
| import org.apache.commons.logging.LogFactory; | ||||||||||
| import org.wso2.carbon.identity.api.server.idp.v1.model.Certificate; | ||||||||||
| import org.wso2.carbon.idp.mgt.IdentityProviderManagementClientException; | ||||||||||
|
|
||||||||||
| import java.nio.charset.StandardCharsets; | ||||||||||
| import java.security.MessageDigest; | ||||||||||
| import java.security.NoSuchAlgorithmException; | ||||||||||
| import java.util.Base64; | ||||||||||
| import java.util.List; | ||||||||||
| import java.util.regex.Matcher; | ||||||||||
| import java.util.regex.Pattern; | ||||||||||
|
|
||||||||||
| /** | ||||||||||
| * Utility class for Certificate related operations. | ||||||||||
| */ | ||||||||||
|
There was a problem hiding this comment. Log Improvement Suggestion No: 5
Suggested change
|
||||||||||
| public final class CertificateUtil { | ||||||||||
|
|
||||||||||
| private static final ObjectMapper MAPPER = new ObjectMapper(); | ||||||||||
| private static final Pattern PEM_INNER_BASE64 = | ||||||||||
| Pattern.compile("-----BEGIN CERTIFICATE-----(.*?)-----END CERTIFICATE-----", Pattern.DOTALL); | ||||||||||
| private static final Log log = LogFactory.getLog(CertificateUtil.class); | ||||||||||
|
|
||||||||||
| /** | ||||||||||
| * Convert incoming `Certificate` model (containing certificates list) to a JSON array string | ||||||||||
| * of objects with certValue and thumbPrint (sha-256 hex). | ||||||||||
| * <p> | ||||||||||
| * Example return: | ||||||||||
| * [ {"certValue":"...","thumbPrint":"..."}, {"certValue":"...","thumbPrint":"..."} ] | ||||||||||
| * | ||||||||||
| * @param certificate incoming Certificate model object | ||||||||||
| * @return JSON array string | ||||||||||
| * @throws IdentityProviderManagementClientException on digest errors | ||||||||||
| */ | ||||||||||
| public static String convertCertificateJsonString(Certificate certificate) | ||||||||||
| throws IdentityProviderManagementClientException { | ||||||||||
|
|
||||||||||
| if (log.isDebugEnabled()) { | ||||||||||
| log.debug("Converting certificate to JSON string format"); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| if (certificate == null) { | ||||||||||
| return "[]"; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| List<String> certificates = certificate.getCertificates(); | ||||||||||
| if (certificates == null || certificates.isEmpty()) { | ||||||||||
| return "[]"; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| ArrayNode resultArray = MAPPER.createArrayNode(); | ||||||||||
|
|
||||||||||
| for (String certValue : certificates) { | ||||||||||
| if (certValue == null) { | ||||||||||
| continue; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| byte[] outerDecoded; | ||||||||||
| try { | ||||||||||
| outerDecoded = Base64.getDecoder().decode(certValue); | ||||||||||
| } catch (IllegalArgumentException iae) { | ||||||||||
| outerDecoded = certValue.getBytes(StandardCharsets.UTF_8); | ||||||||||
| } | ||||||||||
|
Comment on lines
+80
to
+85
There was a problem hiding this comment. Clarify the base64 decoding fallback behavior. The fallback to UTF-8 bytes when base64 decoding fails could lead to processing non-certificate data and computing incorrect thumbprints. If certificates can legitimately arrive in multiple formats (base64-encoded vs. raw), this should be explicitly documented and validated. Otherwise, the silent fallback may hide data quality issues. Consider one of the following approaches:
- byte[] outerDecoded;
- try {
- outerDecoded = Base64.getDecoder().decode(certValue);
- } catch (IllegalArgumentException iae) {
- outerDecoded = certValue.getBytes(StandardCharsets.UTF_8);
- }
+ byte[] outerDecoded;
+ try {
+ outerDecoded = Base64.getDecoder().decode(certValue);
+ } catch (IllegalArgumentException e) {
+ throw new IdentityProviderManagementClientException(
+ "Invalid base64-encoded certificate value", e);
+ }
byte[] outerDecoded;
try {
outerDecoded = Base64.getDecoder().decode(certValue);
} catch (IllegalArgumentException iae) {
+ // Log or document: treating as raw certificate data
outerDecoded = certValue.getBytes(StandardCharsets.UTF_8);
}🤖 Prompt for AI Agents |
||||||||||
|
|
||||||||||
| String pemText = new String(outerDecoded, StandardCharsets.UTF_8); | ||||||||||
| byte[] derBytes = getDerBytesFromPem(pemText); | ||||||||||
| if (derBytes.length == 0) { | ||||||||||
| derBytes = outerDecoded; | ||||||||||
| } | ||||||||||
|
Comment on lines
+87
to
+91
There was a problem hiding this comment. Validate certificate format before computing thumbprints. When PEM parsing fails (returns empty array), the code falls back to using Consider adding explicit validation or error handling: String pemText = new String(outerDecoded, StandardCharsets.UTF_8);
byte[] derBytes = getDerBytesFromPem(pemText);
if (derBytes.length == 0) {
- derBytes = outerDecoded;
+ // Attempt to use outerDecoded as raw DER, but validate first
+ // or throw an exception if certificate format cannot be determined
+ if (!isValidDerCertificate(outerDecoded)) {
+ throw new IdentityProviderManagementClientException(
+ "Cannot extract DER bytes from certificate value. " +
+ "Expected PEM format or raw DER encoding.");
+ }
+ derBytes = outerDecoded;
}Alternatively, if the fallback is intentional to support raw DER-encoded certificates, document this behavior clearly in the method's Javadoc.
|
||||||||||
| String thumbPrint; | ||||||||||
| try { | ||||||||||
| thumbPrint = sha256Hex(derBytes); | ||||||||||
| } catch (NoSuchAlgorithmException e) { | ||||||||||
| throw new IdentityProviderManagementClientException("Error while generating certificate thumbprint.", | ||||||||||
| e); | ||||||||||
| } | ||||||||||
| resultArray.addObject() | ||||||||||
| .put("certValue", certValue) | ||||||||||
| .put("thumbPrint", thumbPrint); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| return resultArray.toString(); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| private static byte[] getDerBytesFromPem(String pemText) { | ||||||||||
|
|
||||||||||
| Matcher m = PEM_INNER_BASE64.matcher(pemText); | ||||||||||
| if (m.find()) { | ||||||||||
| String innerBase64 = m.group(1); | ||||||||||
| innerBase64 = innerBase64.replaceAll("\\s+", ""); | ||||||||||
| try { | ||||||||||
| return Base64.getDecoder().decode(innerBase64); | ||||||||||
| } catch (IllegalArgumentException ignored) { | ||||||||||
| } | ||||||||||
| } | ||||||||||
| return new byte[0]; | ||||||||||
| } | ||||||||||
|
|
||||||||||
| private static String sha256Hex(byte[] data) throws NoSuchAlgorithmException { | ||||||||||
|
|
||||||||||
| MessageDigest md = MessageDigest.getInstance("SHA-256"); | ||||||||||
| byte[] digest = md.digest(data); | ||||||||||
| StringBuilder sb = new StringBuilder(digest.length * 2); | ||||||||||
| for (byte b : digest) { | ||||||||||
| sb.append(String.format("%02x", b & 0xff)); | ||||||||||
| } | ||||||||||
| return sb.toString(); | ||||||||||
| } | ||||||||||
| } | ||||||||||
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.
Log Improvement Suggestion No: 2