Skip to content
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

Replace Track*/Track * with Monitor in CISA-based decision model #738

Conversation

ahouseholder
Copy link
Contributor

This PR modifies the "Track *" value in the CISA OutcomeGroup to be "Monitor". Based on feedback received that having two closely-named values "Track" and "Track *" can be a source of confusion for users of that outcome group.

Two incidental changes are also included:

  • Fixed the key values for Attend and Act in the python version of the CISA OutcomeGroup to match the keys found in docs/ssvc-calc/CISA-Coordinator.json
  • Updated the OutcomeGroup base object type hint to reflect actual usage (values are a tuple instead of a list)

CoPilot Summary

This pull request includes several updates to the docs/ssvc-calc and src/ssvc/outcomes directories to standardize terminology and improve code structure. The most important changes include renaming "Track*" to "Monitor" in JSON and HTML files, updating the OutcomeGroup class to use tuples instead of lists, and restructuring outcome groups in the codebase.

Terminology Standardization:

  • docs/ssvc-calc/CISA-Coordinator.json: Renamed "Track*" to "Monitor" in multiple entries to standardize terminology. [1] [2] [3] [4] [5]
  • docs/ssvc-ccalc/findex.html and docs/ssvc-calc/old_index.html: Updated "Track*" to "Monitor" in the vulnerability scoring decisions section. [1] [2]

Code Structure Improvements:

  • src/ssvc/outcomes/base.py: Changed the outcomes attribute in the OutcomeGroup class from a list to a tuple for better immutability and performance.
  • src/ssvc/outcomes/groups.py: Updated the OutcomeGroup instances to use the new "Monitor" terminology and restructured the CISA outcome group. Additionally, added new descriptions and keys for the "Act" outcome. [1] [2] [3] [4] [5] [6]

@ahouseholder ahouseholder requested a review from j--- March 6, 2025 17:22
@ahouseholder ahouseholder self-assigned this Mar 6, 2025
@ahouseholder ahouseholder added the enhancement New feature or request label Mar 6, 2025
@sei-vsarvepalli
Copy link
Contributor

In discussions with CISA to update the following locations in their website related to this content.

https://www.cisa.gov/profiles/cisad8_gov/modules/custom/ssvc/data/schema_examples/CISA-Coordinator-v2.0.3.json
[Earlier JSON scheme version of the Decision Tree full JSON]

https://www.cisa.gov/profiles/cisad8_gov/modules/custom/ssvc/js/ssvc.js?v=2.x

https://www.cisa.gov/sites/default/files/publications/cisa-ssvc-guide%20508c.pdf

https://www.cisa.gov/stakeholder-specific-vulnerability-categorization-ssvc

@ahouseholder ahouseholder changed the title Replace Track* or Track * with Monitor in CISA-based decision model Replace Track*/Track * with Monitor in CISA-based decision model Mar 6, 2025
@ahouseholder ahouseholder marked this pull request as ready for review March 11, 2025 17:41
@ahouseholder ahouseholder merged commit a54f999 into main Mar 11, 2025
4 checks passed
@ahouseholder ahouseholder deleted the 699-change-track-to-monitor-in-our-representation-of-cisas-tree branch March 11, 2025 19:12
@ahouseholder ahouseholder restored the 699-change-track-to-monitor-in-our-representation-of-cisas-tree branch March 11, 2025 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change "Track *" to "Monitor" in our representation of CISA's tree
3 participants