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

Jump to bottom

Added project for Vaadin core SBOM checks #7001

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Added project for Vaadin core SBOM checks #7001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
30c8c0d
Added project for Vaadin core SBOM checks
edler-san Nov 14, 2024
cc4509c
Merge branch 'main' into vaadin-core-license-check
edler-san Nov 14, 2024
8440327
Integrated core license check into the generateAndCheckSBOM script
edler-san Nov 19, 2024
128fba2
Generalised license check, added missing printout for core license ch…
edler-san Nov 20, 2024
5b66707
Merge branch 'main' into vaadin-core-license-check
manolo Nov 22, 2024
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
1 change: 1 addition & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
<id>sbom</id>
<modules>
<module>vaadin-platform-sbom</module>
<module>vaadin-core-sbom</module>
</modules>
</profile>
<profile>
Expand Down
41 changes: 36 additions & 5 deletions scripts/generateAndCheckSBOM.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const path = require('path');
const VAADIN_LICENSE = 'https://vaadin.com/commercial-license-and-service-terms';
const SBOM_URL = 'https://github.com/vaadin/platform/releases/download/%%VERSION%%/Software.Bill.Of.Materials.json'
const testProject = path.resolve('vaadin-platform-sbom');
const coreProject = path.resolve('vaadin-core-sbom');
edler-san marked this conversation as resolved.
Show resolved Hide resolved
const licenseWhiteList = [
'ISC',
'MIT',
Expand Down Expand Up @@ -49,6 +50,8 @@ const licenseWhiteList = [
'https://opensource.org/licenses/MIT'
];

const coreLicensesWhiteList = licenseWhiteList.toSpliced(licenseWhiteList.indexOf(VAADIN_LICENSE),1);

const cveWhiteList = {
'pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.15.4' : {
cves: ['CVE-2023-35116'],
Expand Down Expand Up @@ -89,7 +92,7 @@ pre[b] {border: solid 1px darkgrey}
</style>`;

const cmd = {
useBomber: true, useOSV: true, useOWASP: true,
useBomber: true, useOSV: true, useOWASP: true, checkCoreLicenses : true,
hasOssToken: !!(process.env.OSSINDEX_USER && process.env.OSSINDEX_TOKEN)
};
for (let i = 2, l = process.argv.length; i < l; i++) {
Expand All @@ -102,9 +105,10 @@ for (let i = 2, l = process.argv.length; i < l; i++) {
case '--version': cmd.version = process.argv[++i]; break;
case '--compare': cmd.org = process.argv[++i]; break;
case '--quick': cmd.quick = true; break;
case '--skip-check-core-licenses' : cmd.checkCoreLicenses = false; break;
default:
console.log(`Usage: ${path.relative('.', process.argv[1])}
[--useSnapshots] [--disable-bomber] [--disable-osv-scan] [--disable-owasp] [--enable-full-owasp] [--version x.x.x] [--quick]`);
[--useSnapshots] [--disable-bomber] [--disable-osv-scan] [--disable-owasp] [--enable-full-owasp] [--version x.x.x] [--quick] [--skip-check-core-licenses]`);
process.exit(1);
}
}
Expand Down Expand Up @@ -387,10 +391,10 @@ function sumarizeOWASP(f, summary) {
return summary;
}

function checkLicenses(licenses) {
function checkLicenses(licenses, whiteList) {
let ret = "";
Object.keys(licenses).forEach(lic => {
if (licenseWhiteList.indexOf(lic) < 0) {
if (whiteList.indexOf(lic) < 0) {
ret += ` - Invalid license '${lic}' in: ${licenses[lic].join(' and ')}\n`;
}
});
Expand Down Expand Up @@ -539,6 +543,16 @@ async function main() {
log(`cd ${testProject}`);
process.chdir(testProject);

let coreLicensesResult=undefined;
let coreLicenses=undefined;

if(cmd.checkCoreLicenses){
log(`generating Core SBOM`);
await run('mvn -ntp -B org.cyclonedx:cyclonedx-maven-plugin:makeAggregateBom -q -f ' + coreProject);
coreLicenses = sumarizeLicenses(coreProject+'/target/bom.json');
coreLicensesResult = checkLicenses(coreLicenses, coreLicensesWhiteList);
}

if (!cmd.quick) {
// Ensure package.json and node_modules are empty
await run('rm -rf package.json node_modules frontend src');
Expand Down Expand Up @@ -590,7 +604,9 @@ async function main() {
sumarizeOWASP('target/dependency-check-report.json', vulnerabilities);
}

const errLic = checkLicenses(licenses);


const errLic = checkLicenses(licenses, licenseWhiteList);
const errVul = checkVunerabilities(vulnerabilities).err;
const msgVul = checkVunerabilities(vulnerabilities).msg;
let md = "";
Expand All @@ -617,6 +633,21 @@ async function main() {
md += `\n### 🔒 No Vulnerabilities\n`;
html += `\n<h3>🔒 No Vulnerabilities</h3>\n`;
}

if (cmd.checkCoreLicenses) {
if (coreLicensesResult) {
md += `\n### 🚫 Found Core License Issues\n`;
html += `\n<h3>>🚫 Found Core License Issues</h3>\n`;
errMsg += `- 📔 Found Core License Issues:\n` + coreLicensesResult+`\n`;
md += reportLicenses(coreLicenses).md;
html += reportLicenses(coreLicenses).html;
} else {
errMsg += `- 📔 No Core License Issues\n`;
md += `\n### 📔 CoreLicenses\n`;
html += `\n<h3>📔 Core Licenses</h3>\n`;
}
}

if (errLic) {
md += `\n### 🚫 Found License Issues\n`;
html += `\n<h3>>🚫 Found License Issues</h3>\n`;
Expand Down
44 changes: 44 additions & 0 deletions vaadin-core-sbom/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
edler-san marked this conversation as resolved.
Show resolved Hide resolved
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.vaadin</groupId>
<artifactId>vaadin-platform-parent</artifactId>
<version>24.6-SNAPSHOT</version>
</parent>
<artifactId>vaadin-core-sbom</artifactId>
<packaging>jar</packaging>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>vaadin-bom</artifactId>
<version>${project.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>vaadin-core</artifactId>
</dependency>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>vaadin-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>flow-webpush</artifactId>
</dependency>
</dependencies>
</project>
Loading