Skip to content

Add recommended fields to JSON output for guideline checks #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ic0ns
Copy link
Contributor

@ic0ns ic0ns commented Jun 27, 2025

Summary

  • Added recommended fields alongside existing notRecommended fields in all guideline check results
  • Ensures JSON output includes both what is recommended and what is not recommended by BSI and NIST guidelines
  • Maintains backward compatibility by using overloaded constructors

Test plan

  • Added unit tests for new constructors in CipherSuiteGuidelineCheckResultTest and HashAlgorithmsGuidelineCheckResultTest
  • Added comprehensive JSON serialization tests in GuidelineResultSerializationTest
  • All tests pass (mvn test)
  • Code formatted with spotless (mvn spotless:apply)

Closes

Fixes #115

Fixes #115: Guidelines now include both recommended and notRecommended fields
in the JSON output for better transparency about what configurations are
actually recommended by BSI and NIST guidelines.

Updated guideline check results for:
- CipherSuiteGuidelineCheckResult
- HashAlgorithmsGuidelineCheckResult
- NamedGroupsGuidelineCheckResult
- SignatureAlgorithmsGuidelineCheckResult
- SignatureAndHashAlgorithmsCertificateGuidelineCheckResult
- X509SignatureAlgorithmGuidelineCheckResult

Added comprehensive tests to verify JSON serialization includes the new fields.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Guidelines: Add Recommended to JSON output
1 participant