Correctly encode PURLs in SBOM output

Author: eoftedal

node/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [5.2.2]
+
+### Bugfix
+
+- Encode purls correctly in SBOM
+
 ## [5.2.1]
 
 ### Bugfix

node/lib/retire.js

@@ -4,7 +4,7 @@
  */
 
 var exports = exports || {};
-exports.version = '5.2.1';
+exports.version = '5.2.2';
 
 function isDefined(o) {
   return typeof o !== 'undefined';

node/package-lock.json

@@ -2,7 +2,7 @@
   "author": "Erlend Oftedal <erlend@oftedal.no>",
   "name": "retire",
   "description": "Retire is a tool for detecting use of vulnerable libraries",
-  "version": "5.2.1",
+  "version": "5.2.2",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

node/package.json

@@ -0,0 +1,16 @@
+import { should } from 'chai';
+import 'mocha';
+should();
+import { generatePURL } from '../../lib/reporters/utils';
+
+describe('purl encoding', () => {
+  it('should not touch a simple string', () => {
+    generatePURL({ component: 'jquery', version: '1.2.3' }).should.equal('pkg:npm/jquery@1.2.3');
+  });
+  it('should encode @ in package scopes', () => {
+    generatePURL({ component: '@angular/core', version: '1.2.3' }).should.equal('pkg:npm/%40angular/core@1.2.3');
+  });
+  it('should not doulbe encode', () => {
+    generatePURL({ component: '%40angular/core', version: '1.2.3' }).should.equal('pkg:npm/%40angular/core@1.2.3');
+  });
+});

node/spec/tests/purl.spec.ts

@@ -104,7 +104,7 @@ export function validateRepository(
         bowername: z.array(z.string().regex(/^[a-z0-9.-]+$/i)).optional(),
         basePurl: z
           .string()
-          .regex(/^pkg:[a-z0-9/]+$/i)
+          .regex(/^pkg:[a-z0-9%.-/]+$/i)
           .optional(),
         npmname: z
           .string()

node/src/repo.ts

@@ -1,9 +1,18 @@
 import { Component } from '../types';
 
+function encodePURLchars(str: string): string {
+  return str.replace(
+    /[^A-Za-z0-9.+/=-%]/g,
+    (match) => '%' + ('0' + match.charCodeAt(0).toString(16).toUpperCase()).slice(-2),
+  );
+}
+
 export function generatePURL(component: Component): string {
   if (component.basePurl) {
-    return component.basePurl + '@' + component.version;
+    const [pType, ...rest] = component.basePurl.split(':');
+    const pathElements = rest.join(':').split('/').map(encodePURLchars).join('/');
+    return `${pType}:${pathElements}@${encodePURLchars(component.version)}`;
   }
   const compName = component.npmname || component.component;
-  return `pkg:npm/${compName}@${component.version}`;
+  return `pkg:npm/${encodePURLchars(compName)}@${encodePURLchars(component.version)}`;
 }