See #294 Support Alg Deprecated rejection. #295
Merged
Conversation
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
Contributor
pitbulk
commented
Nov 20, 2020
pitbulk
commented
- Set SHA-256 as default alg in settings
- Support Alg Deprecated rejection by the use of a new setting.
- Notify with Logger.info if sha-1 alg used on Signature
…ion. Notify with Logger.info if sha-1 alg used on Signature
amasson88
suggested changes
Nov 20, 2020
| @@ -323,12 +323,14 @@ public boolean isValid(String requestId) { | |||
| String fingerprint = settings.getIdpCertFingerprint(); | |||
| String alg = settings.getIdpCertFingerprintAlgorithm(); | |||
|
|
|||
| if (hasSignedResponse && !Util.validateSign(samlResponseDocument, certList, fingerprint, alg, Util.RESPONSE_SIGNATURE_XPATH)) { | |||
| Boolean rejectDeprecatedAlg = settings.getRejectDeprecatedAlg(); | |||
There was a problem hiding this comment.
I would expect an unboxed, non-nullable (primitive) bool here
| @@ -456,6 +456,17 @@ public Boolean isValid() throws Exception { | |||
| if (signAlg == null || signAlg.isEmpty()) { | |||
| signAlg = Constants.RSA_SHA1; | |||
| } | |||
|
|
|||
| if (signAlg.equals(Constants.RSA_SHA1)) { | |||
| } else { | ||
| LOGGER.info("RSA_SHA1 alg found in a Signature element, consider request a more robust alg"); | ||
| } | ||
| } |
There was a problem hiding this comment.
Maybe hide/share the common logic inside an utility method:
if (Util.mustRejectDeprecatedSignatureAlgo(signAlg, settings.getRejectDeprecatedAlg())
return false;private static final Set<String> DEPRECATED_ALGOS = new HashSet<>(Arrays.asList(
Constants.RSA_SHA1, Constants.DSA_SHA1));
public boolean mustRejectDeprecatedSignatureAlgo(String signAlg, boolean rejectDeprecatedAlg) {
if (DEPRECATED_ALGOS.contains(signAlg) {
boolean rejectDeprecatedAlg = settings.getRejectDeprecatedAlg();
if (rejectDeprecatedAlg) {
LOGGER.error("A deprecated algorithm (xxx_SHA1) found in the Signature element, rejecting it");
return true; // must reject
} else {
LOGGER.info("xxx_SHA1 alg found in a Signature element, consider request a more robust alg");
return false; // can continue
}
}
}| @@ -1073,7 +1139,29 @@ public static Boolean validateMetadataSign(Document doc, X509Certificate cert, S | |||
| * @throws Exception | |||
| */ | |||
| public static Boolean validateSignNode(Node signNode, X509Certificate cert, String fingerprint, String alg) { | |||
| Map<String,Object> signatureData = getSignatureData(signNode, alg); | |||
| return validateSignNode(signNode, cert, fingerprint, alg, false); | |||
| @@ -1026,6 +1063,26 @@ public static Boolean validateMetadataSign(Document doc, X509Certificate cert, S | |||
| * @return True if the sign is valid, false otherwise. | |||
| */ | |||
| private static Map<String,Object> getSignatureData(Node signNode, String alg) { | |||
| return getSignatureData(signNode, alg, false); | |||
There was a problem hiding this comment.
Maybe a bit risky to have an implicit rejectDeprecatedAlg=false no? (the safer flag true could be accidentally ignored)
There was a problem hiding this comment.
I can't set it true, I need to maintain backward compatibility. But notice that in the settings file I added the rejection of deprecated alg as default.
| if (signAlg.equals(Constants.RSA_SHA1)) { | ||
| Boolean rejectDeprecatedAlg = settings.getRejectDeprecatedAlg(); | ||
| if (rejectDeprecatedAlg) { | ||
| LOGGER.error("A deprecated algorithm (RSA_SHA1) found in the Signature element, rejecting it"); |
There was a problem hiding this comment.
I wonder if it can be confusing that there are 2 kinds of rejections, the other being:
if (!isAlgorithmWhitelisted(sigMethodAlg)){
throw new Exception(sigMethodAlg + " is not a valid supported algorithm");
}There was a problem hiding this comment.
Supported by the toolkit vs Acceptable
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.