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.

Sign up for GitHub

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

Add support for code suppression fields #192

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+20,448 −7
Open

Add support for code suppression fields #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6,745 changes: 6,745 additions & 0 deletions sample-data/code-consistent-ignores.sarif
View file
Open in desktop

Large diffs are not rendered by default.

6,732 changes: 6,732 additions & 0 deletions sample-data/code-upload-v1.sarif
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions src/handlebars-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
const Handlebars = require('handlebars');
import { firstInitial, formatDate } from './lib/codeutil';

export function registerHandlebarsHelpers() {
Handlebars.registerHelper('firstInitial', firstInitial);
Handlebars.registerHelper('formatDate', formatDate);
}
49 changes: 44 additions & 5 deletions src/lib/codeutil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,17 @@ export async function processSourceCode(dataArray){
const rulesArray = dataArray[0].runs[0].tool.driver.rules;
for (const issue of dataArray[0].runs[0].results){
issue.severitytext = codeSeverityMap[issue.level];
findSeverityIndex = codeSeverityCounter.findIndex(
(f) => f.severity === issue.severitytext,
);
codeSeverityCounter[findSeverityIndex].counter++;

// Only count non-suppressed issues
if (!issue.suppressions || issue.suppressions.length === 0) {
findSeverityIndex = codeSeverityCounter.findIndex(
(f) => f.severity === issue.severitytext,
);
if (findSeverityIndex !== -1) {
codeSeverityCounter[findSeverityIndex].counter++;
}
}

//add the code snippet here...
issue.locations[0].physicalLocation.codeString = await readCodeSnippet(
issue.locations[0],
Expand Down Expand Up @@ -149,4 +156,36 @@ export async function processSourceCode(dataArray){
};
});
return OrderedIssuesArray;
}
}

export function processSuppression(suppression: any) {
if (!suppression) return null;

return {
justification: suppression.justification,
category: suppression.properties?.category || 'unknown',
expiration: suppression.properties?.expiration,
ignoredOn: suppression.properties?.ignoredOn || {
date: 'unknown',
reason: 'unknown',
},
ignoredBy: suppression.properties?.ignoredBy || {
name: 'unknown',
email: '?'
},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: We should add explicit fallback values here for each of the optional values. This would be particularly useful for the ignoredBy property which is an object we use in templates. For example:

ignoredBy: suppression.properties?.ignoredBy || {
  name: 'unknown',
  email: '?'
}

Alternatively we could return null for ignoredBy and then the templates should guard against this scenario by gating each ignoredBy.propertyName lookup with a #if suppression.ignoredBy

};
}

export function firstInitial(email: string | null | undefined): string {
if (!email || typeof email !== 'string') {
return '?'; // Return a placeholder if email is null, undefined, or not a string
}
return email.charAt(0).toUpperCase();
}

export function formatDate(date: string | null | undefined): string {
if (!date) {
return 'Unknown date';
}
return new Date(date).toISOString().slice(0, 19).replace('T', ' ') + ' GMT';
}
39 changes: 39 additions & 0 deletions src/lib/snyk-to-html.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ import path = require('path');
import { addIssueDataToPatch, getUpgrades, severityMap, IacProjectType } from './vuln';
import {
processSourceCode,
processSuppression,
} from './codeutil';
import { registerHandlebarsHelpers } from '../handlebars-config';

registerHandlebarsHelpers();
import {
formatDateTime
} from './dateutil';
Expand Down Expand Up @@ -347,6 +351,32 @@ async function processCodeData(

const OrderedIssuesArray = await processSourceCode(dataArray);

// Process suppressions
OrderedIssuesArray.forEach(project => {
let hasSuppressedVulns = false;
const projectVulns = project.vulnerabilities.map(vuln => {
if (vuln.suppressions && vuln.suppressions.length > 0) {
hasSuppressedVulns = true;
vuln.suppression = processSuppression(vuln.suppressions[0]);
}
return vuln;
});

if (!hasSuppressedVulns) {
project.vulnerabilities = projectVulns;
return; // Early return if no suppressions
}

// Sort only if necessary
projectVulns.sort((a, b) => {
if (a.suppression && !b.suppression) return 1;
if (!a.suppression && b.suppression) return -1;
return 0;
});

project.vulnerabilities = projectVulns;
});

const totalIssues = dataArray[0].runs[0].results.length;
const processedData = {
projects: OrderedIssuesArray,
Expand Down Expand Up @@ -443,3 +473,12 @@ const hh = {
};

Object.keys(hh).forEach(k => Handlebars.registerHelper(k, hh[k]));

function getIssueCountsBySeverity(issuesGroupedBySeverity: any) {
const counts: { [key: string]: number } = {};
Object.keys(issuesGroupedBySeverity).forEach((severity) => {
counts[severity] = issuesGroupedBySeverity[severity].filter((issue: any) => !issue.suppression).length;
});
return counts;
}

39 changes: 38 additions & 1 deletion template/code/test-report.code-snip.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div class="card card--vuln disclosure--not-new severity--{{severitytext}}" data-snyk-test="{{severitytext}}">
<div class="card card--vuln disclosure--not-new severity--{{severitytext}} {{#if suppression}}suppressed{{/if}}" data-snyk-test="{{severitytext}}">
<header class="card__header">
<div class="card__header__main">
<div class="severity-icon severity-icon--{{severitytext}}"></div>
Expand Down Expand Up @@ -36,6 +36,43 @@
<h2 class="card__panel__heading"><span class="heading-char">✓</span> Fix Analysis</h2>
<div class="card__panel__markdown">{{{markdown ruleiddesc.help.markdown}}}</div>
</div>
{{#if suppression}}
<div class="suppression-card">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: This gating is good and will ensure our other customers do not get the information.

<div class="suppression-card__container">
<ul class="suppression-card__items">
<li class="suppression-card__item">
<div class="suppression-card__item__key">Ignored at {{formatDate suppression.ignoredOn}} by</div>
<div class="suppression-card__item__value">
<span class="supression-card__user-initial">{{firstInitial suppression.ignoredBy.name}}</span>
{{#if suppression.ignoredBy.name}} {{ suppression.ignoredBy.name }} {{/if}} {{#if suppression.ignoredBy.email}} &lt;{{suppression.ignoredBy.email}}&gt;{{/if}}
</div>
</li>
<li class="suppression-card__item">
<div class="suppression-card__item__key">Type</div>
<div class="suppression-card__item__value">
{{suppression.category}}
</div>
</li>
<li class="suppression-card__item">
<div class="suppression-card__item__key">Reason</div>
<div class="suppression-card__item__value">
{{suppression.justification}}
</div>
</li>
</ul>
<ul class="suppression-card__items">
<li class="suppression-card__item">
</li>
<li class="suppression-card__item">
<div class="suppression-card__item__key">Expires</div>
<div class="suppression-card__item__value">
{{#if suppression.expiration}}{{formatDate suppression.expiration}}{{else}}Never{{/if}}
</div>
</li>
</ul>
</div>
</div>
{{/if}}
{{/unless}}
</div>
</div>
2 changes: 1 addition & 1 deletion template/code/test-report.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@
</main>
</body>
{{> inline-js }}
</html>
</html>
73 changes: 73 additions & 0 deletions template/code/test-report.inline-css.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,72 @@
}


.suppressed {
opacity: 0.7;
border-left: 5px solid #888;
}

.suppression-card {
border: 1px solid #e0e0e0;
border-radius: 4px;
padding: 10px;
margin-bottom: 20px;
background-color: #fff7e6;
}

.suppression-card__container {
display: flex;
flex-wrap: wrap;
}

.suppression-card__items {
flex: 1 1 50%;
list-style: none;
padding: 0;
margin: 0;
}

.suppression-card__item {
margin-bottom: 10px;
}

.suppression-card__item__key {
font-weight: bold;
color: #b35900;
margin-bottom: 2px;
}

.suppression-card__item__value {
color: #333;
}

.supression-card__user-initial {
display: inline-block;
width: 24px;
height: 24px;
border-radius: 50%;
background-color: #6666cc;
color: white;
text-align: center;
line-height: 24px;
margin-right: 5px;
font-weight: bold;
}

.suppression-card table {
width: 100%;
border-collapse: collapse;
}

.suppression-card td {
padding: 5px;
vertical-align: top;
}

.suppression-card strong {
color: #b35900;
}

/* Layout */

[class*=layout-container] {
Expand Down Expand Up @@ -358,4 +424,11 @@
.marker { border:1px solid #555; margin:-1px 0; background: transparent }
}

.suppression-card__path {
word-break: break-all;
}

</style>



Loading
Loading