Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions src/core/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/**
* Core modules containing pure, reusable logic that can be imported
* by external tools like the e18e GitHub Action.
*/
export * from './trust.js';
161 changes: 161 additions & 0 deletions src/core/trust.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
/**
* Trust level computation for npm packages based on provenance attestations.
*
* This module provides pure functions for computing trust levels without
* making network calls. The actual package metadata must be fetched separately.
*/

/**
* The provenance status of a package, indicating its level of trust.
*
* - `trusted-with-provenance`: Published by a trusted publisher with provenance attestations
* - `provenance`: Has provenance attestations but not from a trusted publisher
* - `none`: No provenance attestations
*/
export type ProvenanceStatus =
| 'trusted-with-provenance'
| 'provenance'
| 'none';

/**
* Metadata about an npm package version, containing provenance information.
* This is a subset of the full npm registry metadata.
*/
export interface PackageProvenanceMetadata {
name: string;
version: string;
dist?: {
attestations?: {
url: string;
provenance?: unknown;
};
};
_npmUser?: {
name: string;
email: string;
trustedPublisher?: unknown;
};
}

/**
* Result of computing the minimum trust level across a set of packages.
*/
export interface MinTrustLevelResult {
level: number;
status: ProvenanceStatus;
}

/**
* Summary of trust levels across a set of dependencies.
*/
export interface TrustSummary {
trusted: number;
provenance: number;
untrusted: number;
total: number;
}

/**
* Determines the provenance status of a package from its metadata.
*
* @param meta - Package metadata from the npm registry
* @returns The provenance status of the package
*/
export function getProvenance(
meta: PackageProvenanceMetadata
): ProvenanceStatus {
if (meta._npmUser?.trustedPublisher) {
return 'trusted-with-provenance';
}
if (meta.dist?.attestations?.provenance) {
return 'provenance';
}
return 'none';
}

/**
* Converts a provenance status to a numeric trust level.
*
* Higher numbers indicate higher trust:
* - 2: trusted-with-provenance
* - 1: provenance
* - 0: none
*
* @param status - The provenance status
* @returns The numeric trust level (0-2)
*/
export function getTrustLevel(status: ProvenanceStatus): number {
switch (status) {
case 'trusted-with-provenance':
return 2;
case 'provenance':
return 1;
case 'none':
return 0;
default:
return 0;
}
}

/**
* Finds the minimum trust level across a set of provenance statuses.
*
* This is useful for determining the overall trust level of a dependency tree,
* where the weakest link determines the overall security.
*
* @param statuses - An iterable of provenance statuses
* @returns The minimum trust level and its corresponding status
*/
export function getMinTrustLevel(
statuses: Iterable<ProvenanceStatus>
): MinTrustLevelResult {
let result: MinTrustLevelResult | null = null;

for (const status of statuses) {
const level = getTrustLevel(status);
if (result === null || level < result.level) {
result = {level, status};
}
}

if (!result) {
return {level: 0, status: 'none'};
}

return result;
}

/**
* Computes a summary of trust levels from a collection of provenance statuses.
*
* @param statuses - An iterable of provenance statuses
* @returns A summary with counts for each trust category
*/
export function computeTrustSummary(
statuses: Iterable<ProvenanceStatus>
): TrustSummary {
let trusted = 0;
let provenance = 0;
let untrusted = 0;

for (const status of statuses) {
switch (status) {
case 'trusted-with-provenance':
trusted++;
break;
case 'provenance':
provenance++;
break;
case 'none':
untrusted++;
break;
}
}

return {
trusted,
provenance,
untrusted,
total: trusted + provenance + untrusted
};
}
3 changes: 3 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ import type {PackageModuleType} from './compute-type.js';
export type {Message, Options, PackageModuleType, Stat};

export {report} from './analyze/report.js';

// Core modules - reusable logic for external tools
export * from './core/index.js';
Loading