guardrail-cli 1.0.5 → 2.0.0

package/dist/formatters/sarif.d.ts

@@ -0,0 +1,72 @@
+/**
+ * SARIF (Static Analysis Results Interchange Format) Output
+ * Standard format for GitHub/Azure DevOps security integration
+ * https://sarifweb.azurewebsites.net/
+ */
+export interface SarifResult {
+    $schema: string;
+    version: string;
+    runs: SarifRun[];
+}
+export interface SarifRun {
+    tool: {
+        driver: {
+            name: string;
+            version: string;
+            informationUri: string;
+            rules: SarifRule[];
+        };
+    };
+    results: SarifFinding[];
+    invocations: SarifInvocation[];
+}
+export interface SarifRule {
+    id: string;
+    name: string;
+    shortDescription: {
+        text: string;
+    };
+    fullDescription?: {
+        text: string;
+    };
+    helpUri?: string;
+    defaultConfiguration: {
+        level: 'error' | 'warning' | 'note' | 'none';
+    };
+}
+export interface SarifFinding {
+    ruleId: string;
+    level: 'error' | 'warning' | 'note' | 'none';
+    message: {
+        text: string;
+    };
+    locations: SarifLocation[];
+    fingerprints?: Record<string, string>;
+    properties?: Record<string, any>;
+}
+export interface SarifLocation {
+    physicalLocation: {
+        artifactLocation: {
+            uri: string;
+            uriBaseId?: string;
+        };
+        region?: {
+            startLine: number;
+            startColumn?: number;
+            endLine?: number;
+            endColumn?: number;
+        };
+    };
+}
+export interface SarifInvocation {
+    executionSuccessful: boolean;
+    commandLine?: string;
+    startTimeUtc?: string;
+    endTimeUtc?: string;
+    workingDirectory?: {
+        uri: string;
+    };
+}
+export declare function toSarif(results: any): SarifResult;
+export declare function toSarifVulnerabilities(results: any): SarifResult;
+//# sourceMappingURL=sarif.d.ts.map

package/dist/formatters/sarif.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sarif.d.ts","sourceRoot":"","sources":["../../src/formatters/sarif.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,QAAQ,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE;QACJ,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,cAAc,EAAE,MAAM,CAAC;YACvB,KAAK,EAAE,SAAS,EAAE,CAAC;SACpB,CAAC;KACH,CAAC;IACF,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,WAAW,EAAE,eAAe,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACnC,eAAe,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE;QACpB,KAAK,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;KAC9C,CAAC;CACH;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7C,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1B,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE;QAChB,gBAAgB,EAAE;YAChB,GAAG,EAAE,MAAM,CAAC;YACZ,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,CAAC;QACF,MAAM,CAAC,EAAE;YACP,SAAS,EAAE,MAAM,CAAC;YAClB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CACpC;AAoBD,wBAAgB,OAAO,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW,CAmEjD;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,GAAG,GAAG,WAAW,CAwDhE"}

package/dist/formatters/sarif.js

@@ -0,0 +1,146 @@
+"use strict";
+/**
+ * SARIF (Static Analysis Results Interchange Format) Output
+ * Standard format for GitHub/Azure DevOps security integration
+ * https://sarifweb.azurewebsites.net/
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toSarif = toSarif;
+exports.toSarifVulnerabilities = toSarifVulnerabilities;
+function riskToLevel(risk) {
+    switch (risk) {
+        case 'high': return 'error';
+        case 'medium': return 'warning';
+        case 'low': return 'note';
+        default: return 'warning';
+    }
+}
+function getVersion() {
+    try {
+        const pkg = require('../../package.json');
+        return pkg.version || '1.0.0';
+    }
+    catch {
+        return '1.0.0';
+    }
+}
+function toSarif(results) {
+    const version = getVersion();
+    const ruleMap = new Map();
+    // Build rules from unique finding types
+    for (const finding of results.findings || []) {
+        if (!ruleMap.has(finding.type)) {
+            ruleMap.set(finding.type, {
+                id: finding.type,
+                name: finding.type.replace(/_/g, ' ').replace(/\b\w/g, (c) => c.toUpperCase()),
+                shortDescription: { text: `Detected ${finding.type.replace(/_/g, ' ')}` },
+                fullDescription: { text: finding.recommendation?.reason || `Potential ${finding.type} detected in source code` },
+                helpUri: 'https://guardrail.dev/docs/secrets',
+                defaultConfiguration: { level: riskToLevel(finding.risk) },
+            });
+        }
+    }
+    const sarifResults = (results.findings || []).map((f) => ({
+        ruleId: f.type,
+        level: riskToLevel(f.risk),
+        message: {
+            text: `${f.type}: ${f.match}${f.isTest ? ' (in test file)' : ''}`,
+        },
+        locations: [{
+                physicalLocation: {
+                    artifactLocation: {
+                        uri: f.file.replace(/\\/g, '/'),
+                        uriBaseId: '%SRCROOT%',
+                    },
+                    region: {
+                        startLine: f.line,
+                        startColumn: 1,
+                    },
+                },
+            }],
+        fingerprints: {
+            'guardrail/v1': `${f.type}:${f.file}:${f.line}`,
+        },
+        properties: {
+            confidence: f.confidence,
+            entropy: f.entropy,
+            isTest: f.isTest,
+            remediation: f.recommendation?.remediation,
+        },
+    }));
+    return {
+        $schema: 'https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json',
+        version: '2.1.0',
+        runs: [{
+                tool: {
+                    driver: {
+                        name: 'guardrail-cli',
+                        version,
+                        informationUri: 'https://guardrail.dev',
+                        rules: Array.from(ruleMap.values()),
+                    },
+                },
+                results: sarifResults,
+                invocations: [{
+                        executionSuccessful: true,
+                        startTimeUtc: new Date().toISOString(),
+                        workingDirectory: { uri: results.projectPath?.replace(/\\/g, '/') || '.' },
+                    }],
+            }],
+    };
+}
+function toSarifVulnerabilities(results) {
+    const version = getVersion();
+    const rules = [{
+            id: 'vulnerable-dependency',
+            name: 'Vulnerable Dependency',
+            shortDescription: { text: 'Known vulnerability in dependency' },
+            helpUri: 'https://guardrail.dev/docs/vulnerabilities',
+            defaultConfiguration: { level: 'error' },
+        }];
+    const sarifResults = (results.findings || []).map((f) => ({
+        ruleId: 'vulnerable-dependency',
+        level: riskToLevel(f.severity),
+        message: {
+            text: `${f.cve}: ${f.title} in ${f.package}@${f.version}. Fix: upgrade to ${f.fixedIn}`,
+        },
+        locations: [{
+                physicalLocation: {
+                    artifactLocation: {
+                        uri: 'package.json',
+                        uriBaseId: '%SRCROOT%',
+                    },
+                    region: { startLine: 1 },
+                },
+            }],
+        fingerprints: {
+            'guardrail/v1': `${f.cve}:${f.package}:${f.version}`,
+        },
+        properties: {
+            cve: f.cve,
+            package: f.package,
+            version: f.version,
+            fixedIn: f.fixedIn,
+        },
+    }));
+    return {
+        $schema: 'https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json',
+        version: '2.1.0',
+        runs: [{
+                tool: {
+                    driver: {
+                        name: 'guardrail-cli',
+                        version,
+                        informationUri: 'https://guardrail.dev',
+                        rules,
+                    },
+                },
+                results: sarifResults,
+                invocations: [{
+                        executionSuccessful: true,
+                        startTimeUtc: new Date().toISOString(),
+                    }],
+            }],
+    };
+}
+//# sourceMappingURL=sarif.js.map

package/dist/formatters/sarif.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sarif.js","sourceRoot":"","sources":["../../src/formatters/sarif.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAkFH,0BAmEC;AAED,wDAwDC;AA/ID,SAAS,WAAW,CAAC,IAAY;IAC/B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC;QAC5B,KAAK,QAAQ,CAAC,CAAC,OAAO,SAAS,CAAC;QAChC,KAAK,KAAK,CAAC,CAAC,OAAO,MAAM,CAAC;QAC1B,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;IAC5B,CAAC;AACH,CAAC;AAED,SAAS,UAAU;IACjB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1C,OAAO,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,SAAgB,OAAO,CAAC,OAAY;IAClC,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAC;IAE7C,wCAAwC;IACxC,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE;gBACxB,EAAE,EAAE,OAAO,CAAC,IAAI;gBAChB,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;gBACtF,gBAAgB,EAAE,EAAE,IAAI,EAAE,YAAY,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE;gBACzE,eAAe,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,IAAI,aAAa,OAAO,CAAC,IAAI,0BAA0B,EAAE;gBAChH,OAAO,EAAE,oCAAoC;gBAC7C,oBAAoB,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;aAC3D,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,YAAY,GAAmB,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;QAC7E,MAAM,EAAE,CAAC,CAAC,IAAI;QACd,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1B,OAAO,EAAE;YACP,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,EAAE;SAClE;QACD,SAAS,EAAE,CAAC;gBACV,gBAAgB,EAAE;oBAChB,gBAAgB,EAAE;wBAChB,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;wBAC/B,SAAS,EAAE,WAAW;qBACvB;oBACD,MAAM,EAAE;wBACN,SAAS,EAAE,CAAC,CAAC,IAAI;wBACjB,WAAW,EAAE,CAAC;qBACf;iBACF;aACF,CAAC;QACF,YAAY,EAAE;YACZ,cAAc,EAAE,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE;SAChD;QACD,UAAU,EAAE;YACV,UAAU,EAAE,CAAC,CAAC,UAAU;YACxB,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,WAAW,EAAE,CAAC,CAAC,cAAc,EAAE,WAAW;SAC3C;KACF,CAAC,CAAC,CAAC;IAEJ,OAAO;QACL,OAAO,EAAE,gGAAgG;QACzG,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,CAAC;gBACL,IAAI,EAAE;oBACJ,MAAM,EAAE;wBACN,IAAI,EAAE,eAAe;wBACrB,OAAO;wBACP,cAAc,EAAE,uBAAuB;wBACvC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;qBACpC;iBACF;gBACD,OAAO,EAAE,YAAY;gBACrB,WAAW,EAAE,CAAC;wBACZ,mBAAmB,EAAE,IAAI;wBACzB,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBACtC,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,GAAG,EAAE;qBAC3E,CAAC;aACH,CAAC;KACH,CAAC;AACJ,CAAC;AAED,SAAgB,sBAAsB,CAAC,OAAY;IACjD,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAE7B,MAAM,KAAK,GAAgB,CAAC;YAC1B,EAAE,EAAE,uBAAuB;YAC3B,IAAI,EAAE,uBAAuB;YAC7B,gBAAgB,EAAE,EAAE,IAAI,EAAE,mCAAmC,EAAE;YAC/D,OAAO,EAAE,4CAA4C;YACrD,oBAAoB,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;SACzC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAmB,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;QAC7E,MAAM,EAAE,uBAAuB;QAC/B,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC9B,OAAO,EAAE;YACP,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,qBAAqB,CAAC,CAAC,OAAO,EAAE;SACxF;QACD,SAAS,EAAE,CAAC;gBACV,gBAAgB,EAAE;oBAChB,gBAAgB,EAAE;wBAChB,GAAG,EAAE,cAAc;wBACnB,SAAS,EAAE,WAAW;qBACvB;oBACD,MAAM,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;iBACzB;aACF,CAAC;QACF,YAAY,EAAE;YACZ,cAAc,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,EAAE;SACrD;QACD,UAAU,EAAE;YACV,GAAG,EAAE,CAAC,CAAC,GAAG;YACV,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,OAAO,EAAE,CAAC,CAAC,OAAO;YAClB,OAAO,EAAE,CAAC,CAAC,OAAO;SACnB;KACF,CAAC,CAAC,CAAC;IAEJ,OAAO;QACL,OAAO,EAAE,gGAAgG;QACzG,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,CAAC;gBACL,IAAI,EAAE;oBACJ,MAAM,EAAE;wBACN,IAAI,EAAE,eAAe;wBACrB,OAAO;wBACP,cAAc,EAAE,uBAAuB;wBACvC,KAAK;qBACN;iBACF;gBACD,OAAO,EAAE,YAAY;gBACrB,WAAW,EAAE,CAAC;wBACZ,mBAAmB,EAAE,IAAI;wBACzB,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;qBACvC,CAAC;aACH,CAAC;KACH,CAAC;AACJ,CAAC"}