|
| 1 | +Tutorial 8 - Vulnerability Triage |
| 2 | +================================= |
| 3 | + |
| 4 | +Your DejaCode administrator has set up triage rulesets for your Dataspace, and one or |
| 5 | +more of them have been assigned to the product you want to review. This tutorial walks |
| 6 | +you through discovering triage recommendations on a product, understanding what they |
| 7 | +mean, recording your vulnerability analysis, and tracking the associated requests. |
| 8 | + |
| 9 | +.. seealso:: |
| 10 | + Refer to :ref:`reference_vulnerability_triage` for a complete description of all |
| 11 | + available rules, actions, and triage record lifecycle. If you are an administrator |
| 12 | + and need to create or configure rulesets, refer to :ref:`how_to_7`. |
| 13 | + |
| 14 | +Sign into DejaCode. |
| 15 | + |
| 16 | +1. Open the Vulnerabilities Tab |
| 17 | +------------------------------- |
| 18 | + |
| 19 | +1. From the main navigation, browse to the product you want to review. |
| 20 | +2. Open the product detail page and navigate to the :guilabel:`Vulnerabilities` tab. |
| 21 | + |
| 22 | +The tab lists all packages in the product that have known vulnerabilities. Each package |
| 23 | +row expands to show the individual vulnerabilities that affect it, along with their |
| 24 | +risk scores and exploitability indicators. Hover the info icon next to a vulnerability |
| 25 | +ID for a quick summary of its aliases, description, exploitability, and risk score. |
| 26 | + |
| 27 | +When triage rulesets are assigned to the product, a :guilabel:`Recommendation` column |
| 28 | +appears between the vulnerability ID and the analysis status columns. If you do not |
| 29 | +see this column, no ruleset is assigned to this product yet: refer to |
| 30 | +:ref:`how_to_7_assign_rulesets` for how to assign one. |
| 31 | + |
| 32 | +2. Read the Recommendation Column |
| 33 | +--------------------------------- |
| 34 | + |
| 35 | +Each row in the Recommendation column can show up to four pieces of information: |
| 36 | + |
| 37 | +- **Action badge**: the remediation action recommended by the highest-precedence |
| 38 | + ruleset that matched this vulnerability (e.g., **Upgrade Package**, |
| 39 | + **Reachability Analysis**, **Notify**). |
| 40 | +- **Ruleset name**: the name of the ruleset that produced the recommendation. |
| 41 | +- **Since**: the date when the triage engine first detected this vulnerability for |
| 42 | + this product. |
| 43 | +- **Request link**: if a DejaCode request was opened automatically for this |
| 44 | + vulnerability, a link appears here. Click it to open the request in a new tab. |
| 45 | + |
| 46 | +If a vulnerability row has no recommendation badge, no enabled ruleset currently |
| 47 | +matches it for this product. |
| 48 | + |
| 49 | +3. Filter and Prioritize |
| 50 | +------------------------ |
| 51 | + |
| 52 | +Use the filter controls at the top of the Vulnerabilities tab to narrow down the list: |
| 53 | + |
| 54 | +- Filter by **Triage action** to focus on vulnerabilities requiring a specific |
| 55 | + remediation (e.g., show only those flagged for an upgrade). |
| 56 | +- Filter by **Risk score** to surface the most critical vulnerabilities first. |
| 57 | +- Filter by **Analysis state** to identify vulnerabilities not yet triaged. |
| 58 | + |
| 59 | +4. Record a Vulnerability Analysis |
| 60 | +---------------------------------- |
| 61 | + |
| 62 | +The Recommendation column tells you what action to take. To record your analysis |
| 63 | +findings: |
| 64 | + |
| 65 | +1. In the vulnerability row, click the edit icon on the right side of the row. |
| 66 | +2. An analysis modal opens for that package and vulnerability combination. |
| 67 | +3. Fill in the fields that apply to your findings: |
| 68 | + |
| 69 | + - **State**: select the analysis state that reflects your conclusion (e.g., |
| 70 | + *In Triage*, *Resolved*, *Not Affected*). |
| 71 | + - **Justification**: select the reason for your conclusion if applicable. |
| 72 | + - **Responses**: select one or more response actions you are taking. |
| 73 | + - **Is Reachable**: indicate whether the vulnerability is reachable in this |
| 74 | + product's runtime context. |
| 75 | + - **Detail**: add any free-text notes for your team. |
| 76 | + |
| 77 | +4. Click :guilabel:`Save`. The analysis values appear in the row immediately. |
| 78 | + |
| 79 | +.. seealso:: |
| 80 | + Refer to :ref:`how_to_4` for a detailed guide on vulnerability analysis fields |
| 81 | + and their meaning. |
| 82 | + |
| 83 | +.. note:: |
| 84 | + If an Analysis Preset was configured for the ruleset, some fields may already be |
| 85 | + pre-filled when you open the modal. An "Auto-applied" indicator with the preset |
| 86 | + name appears in the row for these analyses instead of the usual last-modified-by |
| 87 | + information. You can modify any pre-filled value. Once you save, the analysis |
| 88 | + becomes yours and the engine will not overwrite it. |
| 89 | + |
| 90 | +5. Track Open Requests |
| 91 | +---------------------- |
| 92 | + |
| 93 | +When the administrator has configured a Request Template on the ruleset, the engine |
| 94 | +opens one request per matched vulnerability automatically. The request link appears in |
| 95 | +the Recommendation column below the detection date. |
| 96 | + |
| 97 | +To work with the request: |
| 98 | + |
| 99 | +1. Click the :guilabel:`Request #<id>` link in the Recommendation column. |
| 100 | +2. The request opens in a new tab with the full workflow context. |
| 101 | +3. Use the request to coordinate remediation with your team, add comments, and |
| 102 | + record the resolution outcome. |
| 103 | + |
| 104 | +The linked request is not automatically closed when the triage record is cleared. This |
| 105 | +allows you to track remediation progress independently of the triage state. |
| 106 | + |
| 107 | +6. Recommendations Update Automatically |
| 108 | +--------------------------------------- |
| 109 | + |
| 110 | +There is no manual re-evaluation step: recommendations are recalculated immediately |
| 111 | +whenever something relevant changes, and the refreshed result is there on your next |
| 112 | +page reload. |
| 113 | + |
| 114 | +- Saving your own vulnerability analysis re-evaluates the product right away. |
| 115 | +- A package being added to or removed from the product re-evaluates it too. |
| 116 | + |
| 117 | +Vulnerabilities whose conditions are no longer met by any active ruleset rule will have |
| 118 | +their recommendation cleared from the column. |
0 commit comments