@cdxgen/cdxgen 0.0.1 → 13.0.0

package/lib/ecosystems/utils.js

@@ -0,0 +1,575 @@
+/**
+ * Deprecated re-export barrel.
+ *
+ * `utils.js` declares nothing of its own. It re-exports the 261 public names that
+ * used to live here so existing imports keep working for one major version. Each
+ * implementation, and its JSDoc, now lives in the leaf module it was moved to
+ * (`purl.js`, `spdx.js`, `deps.js`, `ecosystems.js`, `parsers-*.js`, `core-*.js`,
+ * `state.js`, `paths.js`).
+ *
+ * New code should import from the specific module instead. See MIGRATING-TO-V13.md.
+ */
+import {
+  BLOCKED_HOST_ERROR_CODE,
+  cdxgenAgent,
+  createBlockedHostError,
+  createDryRunError,
+  DEBUG_MODE,
+  DRY_RUN_ERROR_CODE,
+  getRecordedActivities,
+  hasDangerousUnicode,
+  isAllowedHttpHost,
+  isDryRun,
+  isDryRunError,
+  isSecureMode,
+  isSensitiveEnvironmentVariableName,
+  readEnvironmentVariable,
+  recordActivity,
+  recordDecisionActivity,
+  recordDiscoveryActivity,
+  recordEnvironmentRead,
+  recordObservedActivity,
+  recordPolicyActivity,
+  recordSensitiveFileRead,
+  recordSymlinkResolution,
+  remoteHostsAccessed,
+  resetActivityContext,
+  resetRecordedActivities,
+  setActivityContext,
+  setDryRunMode,
+} from "../core/activity.js";
+import {
+  CARGO_CMD,
+  CDXGEN_SPDX_CREATED_BY,
+  CDXGEN_TEMP_DIR,
+  CLJ_CMD,
+  DOTNET_CMD,
+  extractPathEnv,
+  FETCH_LICENSE,
+  GCC_CMD,
+  GO_CMD,
+  getJavaCommand,
+  getPythonCommand,
+  hasAnyProjectType,
+  includeMavenTestScope,
+  isBun,
+  isDeno,
+  isFeatureEnabled,
+  isNode,
+  isPackageManagerAllowed,
+  JAVA_CMD,
+  LEIN_CMD,
+  NODE_CMD,
+  NPM_CMD,
+  PACKAGE_MANAGER_ALIASES,
+  PREFER_MAVEN_DEPS_TREE,
+  PROJECT_TYPE_ALIASES,
+  PYTHON_CMD,
+  PYTHON_EXCLUDED_COMPONENTS,
+  parseMavenArgs,
+  RUBY_CMD,
+  RUSTC_CMD,
+  SEARCH_MAVEN_ORG,
+  SWIFT_CMD,
+  shouldFetchLicense,
+  shouldFetchPackageMetadata,
+  shouldFetchVCS,
+  shouldRunPredictiveBomAudit,
+  TABLE_BORDER_STYLE,
+  YARN_CMD,
+} from "../core/env.js";
+import {
+  checksumFile,
+  commandsExecuted,
+  getAllFiles,
+  getAllFilesWithIgnore,
+  getTimestamp,
+  getTmpDir,
+  MAX_BUFFER,
+  multiChecksumFile,
+  safeCopyFileSync,
+  safeExistsSync,
+  safeExtractArchive,
+  safeMkdirSync,
+  safeMkdtempSync,
+  safeRmSync,
+  safeSpawnSync,
+  safeUnlinkSync,
+  safeWriteSync,
+  TIMEOUT_MS,
+} from "../core/fs.js";
+import {
+  dirNameStr,
+  isMac,
+  isValidDriveRoot,
+  isWin,
+  toCamel,
+} from "../core/paths.js";
+import { CDXGEN_VERSION, frameworksList } from "../core/state.js";
+import {
+  executeAtom,
+  findAppModules,
+  getAtomCommand,
+} from "../inventory/atomUtils.js";
+import { getDefaultBomAuditCategories } from "../inventory/auditCategories.js";
+import {
+  collectJarNS,
+  collectMvnDependencies,
+  componentSorter,
+  convertJarNSToPackages,
+  getJarClasses,
+  getPomPropertiesFromMavenDir,
+  inferJarGroupFromManifest,
+  parseJarManifest,
+  parsePomProperties,
+  parsePomXml,
+  readZipEntry,
+  trimJarGroupSuffix,
+} from "../inventory/deps.js";
+import { isPartialTree, recomputeScope } from "../inventory/depsUtils.js";
+import {
+  getRuntimeInformation,
+  retrieveCdxgenPluginVersion,
+  retrieveCdxgenVersion,
+} from "../inventory/envcontext.js";
+import {
+  addEvidenceForDotnet,
+  attachIdentityTools,
+  convertOSQueryResults,
+  extractToolRefs,
+} from "../inventory/evidenceUtils.js";
+
+export { getCppModules } from "./cppEvidence.js";
+export { addEvidenceForImports } from "./jsEvidence.js";
+
+import {
+  collectExecutables,
+  collectSharedLibs,
+  getOSPackageForFile,
+} from "../inventory/osPackageResolver.js";
+import {
+  encodeForPurl,
+  locateGenericPackage,
+  mapConanPkgRefToPurlStringAndNameAndVersion,
+  purlFromUrlString,
+} from "../inventory/purl.js";
+import {
+  addLicenseText,
+  adjustLicenseInformation,
+  findLicenseId,
+  getKnownLicense,
+  getLicenses,
+  guessLicenseId,
+  isSpdxLicenseExpression,
+  readLicenseText,
+} from "../inventory/spdx.js";
+import { isValidIriReference } from "../parsers/iri.js";
+import {
+  composePomXmlUrl,
+  extractJarArchive,
+  extractLicenseCommentFromPomXml,
+  fetchPomXml,
+  fetchPomXmlAsJson,
+  findLocalMvnArtifact,
+  getCratesMetadata,
+  getDartMetadata,
+  getGithubUrlParts,
+  getGoPkgLicense,
+  getMvnMetadata,
+  getNpmMetadata,
+  getNugetMetadata,
+  getPyMetadata,
+  getRepoLicense,
+  getSwiftPackageMetadata,
+  guessPypiMatchingVersion,
+  metadata_cache,
+  parseBdistMetadata,
+  parseLicenseEntryOrArrayFromPomXml,
+  repoMetadataToGitHubApiUrl,
+  toGitHubApiUrl,
+} from "./ecosystems.js";
+import { getMavenCommand, getMillCommand } from "./gradleutils.js";
+import { createNpmWorkspacePurl } from "./npmutils.js";
+import {
+  getPropertyGroupTextNodes,
+  parseCsPkgData,
+  parseCsPkgLockData,
+  parseCsProjAssetsData,
+  parseCsProjData,
+  parseNupkg,
+  parseNuspecData,
+  parsePaketLockData,
+} from "./parsers-dotnet.js";
+import {
+  getGoPkgComponent,
+  parseGoListDep,
+  parseGoModData,
+  parseGoModGraph,
+  parseGoModulesTxt,
+  parseGoModWhy,
+  parseGopkgData,
+  parseGosumData,
+  parseGoVersionData,
+} from "./parsers-go.js";
+import {
+  findPnpmPackagePath,
+  getVersionNumPnpm,
+  parseBowerJson,
+  parseMinJs,
+  parseNodeShrinkwrap,
+  parsePackageJsonName,
+  parsePkgJson,
+  parsePkgLock,
+  parsePnpmLock,
+  parsePnpmWorkspace,
+  parseYarnLock,
+  parseYarnWorkspace,
+  pnpmMetadata,
+  splitCommandArgs,
+  yarnLockToIdentMap,
+} from "./parsers-js.js";
+import {
+  parseBazelActionGraph,
+  parseBazelBuild,
+  parseBazelSkyframe,
+  parseCljDep,
+  parseEdnData,
+  parseKVDep,
+  parseLeinDep,
+  parseLeiningenData,
+  parseLeinMap,
+  parseMavenTree,
+  parseMavenTreeJson,
+  parseMillDependency,
+  parsePom,
+} from "./parsers-jvm.js";
+import {
+  buildObjectForCocoaPod,
+  executeAlpmList,
+  executeApkList,
+  executeDpkgList,
+  executeEqueryList,
+  executePodCommand,
+  executeRpmList,
+  identifyFlow,
+  parseBitbucketPipelinesFile,
+  parseCabalData,
+  parseCloudBuildData,
+  parseCmakeDotFile,
+  parseCmakeLikeFile,
+  parseCocoaDependency,
+  parseColliderLockData,
+  parseComposerJson,
+  parseComposerLock,
+  parseConanData,
+  parseConanLockData,
+  parseContainerFile,
+  parseContainerSpecData,
+  parseCUsageSlice,
+  parseFlakeLock,
+  parseFlakeNix,
+  parseGitHubWorkflowData,
+  parseHelmYamlData,
+  parseMakeDFile,
+  parseMixLockData,
+  parseOpenapiSpecData,
+  parsePodfileLock,
+  parsePodfileTargets,
+  parsePrivadoFile,
+  parsePubLockData,
+  parsePubYamlData,
+  parseSwiftJsonTree,
+  parseSwiftJsonTreeObject,
+  parseSwiftResolved,
+  recurseImageNameLookup,
+} from "./parsers-misc.js";
+import {
+  derivePythonLockMetadataFileName,
+  generatePixiLockFile,
+  parseMojoProject,
+  parsePiplockData,
+  parsePixiLockFile,
+  parsePixiTomlFile,
+  parsePyLockData,
+  parsePyProjectTomlFile,
+  parsePyRequiresDist,
+  parseReqEnvMarkers,
+  parseReqFile,
+  parseSetupPyFile,
+} from "./parsers-python.js";
+import {
+  parseCargoAuditableData,
+  parseCargoData,
+  parseCargoDependencyData,
+  parseCargoManifestDependencyData,
+  parseCargoTomlData,
+} from "./parsers-rust.js";
+import {
+  createUVLock,
+  getPipFrozenTree,
+  getPipTreeForPackages,
+  getPyModules,
+} from "./pythonutils.js";
+
+export {
+  addEvidenceForDotnet,
+  addLicenseText,
+  adjustLicenseInformation,
+  attachIdentityTools,
+  BLOCKED_HOST_ERROR_CODE,
+  buildObjectForCocoaPod,
+  CARGO_CMD,
+  CDXGEN_SPDX_CREATED_BY,
+  CDXGEN_TEMP_DIR,
+  CDXGEN_VERSION,
+  CLJ_CMD,
+  cdxgenAgent,
+  checksumFile,
+  collectExecutables,
+  collectJarNS,
+  collectMvnDependencies,
+  collectSharedLibs,
+  commandsExecuted,
+  componentSorter,
+  composePomXmlUrl,
+  convertJarNSToPackages,
+  convertOSQueryResults,
+  createBlockedHostError,
+  createDryRunError,
+  createNpmWorkspacePurl,
+  createUVLock,
+  DEBUG_MODE,
+  DOTNET_CMD,
+  DRY_RUN_ERROR_CODE,
+  derivePythonLockMetadataFileName,
+  dirNameStr,
+  encodeForPurl,
+  executeAlpmList,
+  executeApkList,
+  executeAtom,
+  executeDpkgList,
+  executeEqueryList,
+  executePodCommand,
+  executeRpmList,
+  extractJarArchive,
+  extractLicenseCommentFromPomXml,
+  extractPathEnv,
+  extractToolRefs,
+  FETCH_LICENSE,
+  fetchPomXml,
+  fetchPomXmlAsJson,
+  findAppModules,
+  findLicenseId,
+  findLocalMvnArtifact,
+  findPnpmPackagePath,
+  frameworksList,
+  GCC_CMD,
+  GO_CMD,
+  generatePixiLockFile,
+  getAllFiles,
+  getAllFilesWithIgnore,
+  getAtomCommand,
+  getCratesMetadata,
+  getDartMetadata,
+  getDefaultBomAuditCategories,
+  getGithubUrlParts,
+  getGoPkgComponent,
+  getGoPkgLicense,
+  getJarClasses,
+  getJavaCommand,
+  getKnownLicense,
+  getLicenses,
+  getMavenCommand,
+  getMillCommand,
+  getMvnMetadata,
+  getNpmMetadata,
+  getNugetMetadata,
+  getOSPackageForFile,
+  getPipFrozenTree,
+  getPipTreeForPackages,
+  getPomPropertiesFromMavenDir,
+  getPropertyGroupTextNodes,
+  getPyMetadata,
+  getPyModules,
+  getPythonCommand,
+  getRecordedActivities,
+  getRepoLicense,
+  getRuntimeInformation,
+  getSwiftPackageMetadata,
+  getTimestamp,
+  getTmpDir,
+  getVersionNumPnpm,
+  guessLicenseId,
+  guessPypiMatchingVersion,
+  hasAnyProjectType,
+  hasDangerousUnicode,
+  identifyFlow,
+  includeMavenTestScope,
+  inferJarGroupFromManifest,
+  isAllowedHttpHost,
+  isBun,
+  isDeno,
+  isDryRun,
+  isDryRunError,
+  isFeatureEnabled,
+  isMac,
+  isNode,
+  isPackageManagerAllowed,
+  isPartialTree,
+  isSecureMode,
+  isSensitiveEnvironmentVariableName,
+  isSpdxLicenseExpression,
+  isValidDriveRoot,
+  isValidIriReference,
+  isWin,
+  JAVA_CMD,
+  LEIN_CMD,
+  locateGenericPackage,
+  MAX_BUFFER,
+  mapConanPkgRefToPurlStringAndNameAndVersion,
+  metadata_cache,
+  multiChecksumFile,
+  NODE_CMD,
+  NPM_CMD,
+  PACKAGE_MANAGER_ALIASES,
+  PREFER_MAVEN_DEPS_TREE,
+  PROJECT_TYPE_ALIASES,
+  PYTHON_CMD,
+  PYTHON_EXCLUDED_COMPONENTS,
+  parseBazelActionGraph,
+  parseBazelBuild,
+  parseBazelSkyframe,
+  parseBdistMetadata,
+  parseBitbucketPipelinesFile,
+  parseBowerJson,
+  parseCabalData,
+  parseCargoAuditableData,
+  parseCargoData,
+  parseCargoDependencyData,
+  parseCargoManifestDependencyData,
+  parseCargoTomlData,
+  parseCljDep,
+  parseCloudBuildData,
+  parseCmakeDotFile,
+  parseCmakeLikeFile,
+  parseCocoaDependency,
+  parseColliderLockData,
+  parseComposerJson,
+  parseComposerLock,
+  parseConanData,
+  parseConanLockData,
+  parseContainerFile,
+  parseContainerSpecData,
+  parseCsPkgData,
+  parseCsPkgLockData,
+  parseCsProjAssetsData,
+  parseCsProjData,
+  parseCUsageSlice,
+  parseEdnData,
+  parseFlakeLock,
+  parseFlakeNix,
+  parseGitHubWorkflowData,
+  parseGoListDep,
+  parseGoModData,
+  parseGoModGraph,
+  parseGoModulesTxt,
+  parseGoModWhy,
+  parseGopkgData,
+  parseGosumData,
+  parseGoVersionData,
+  parseHelmYamlData,
+  parseJarManifest,
+  parseKVDep,
+  parseLeinDep,
+  parseLeiningenData,
+  parseLeinMap,
+  parseLicenseEntryOrArrayFromPomXml,
+  parseMakeDFile,
+  parseMavenArgs,
+  parseMavenTree,
+  parseMavenTreeJson,
+  parseMillDependency,
+  parseMinJs,
+  parseMixLockData,
+  parseMojoProject,
+  parseNodeShrinkwrap,
+  parseNupkg,
+  parseNuspecData,
+  parseOpenapiSpecData,
+  parsePackageJsonName,
+  parsePaketLockData,
+  parsePiplockData,
+  parsePixiLockFile,
+  parsePixiTomlFile,
+  parsePkgJson,
+  parsePkgLock,
+  parsePnpmLock,
+  parsePnpmWorkspace,
+  parsePodfileLock,
+  parsePodfileTargets,
+  parsePom,
+  parsePomProperties,
+  parsePomXml,
+  parsePrivadoFile,
+  parsePubLockData,
+  parsePubYamlData,
+  parsePyLockData,
+  parsePyProjectTomlFile,
+  parsePyRequiresDist,
+  parseReqEnvMarkers,
+  parseReqFile,
+  parseSetupPyFile,
+  parseSwiftJsonTree,
+  parseSwiftJsonTreeObject,
+  parseSwiftResolved,
+  parseYarnLock,
+  parseYarnWorkspace,
+  pnpmMetadata,
+  purlFromUrlString,
+  RUBY_CMD,
+  RUSTC_CMD,
+  readEnvironmentVariable,
+  readLicenseText,
+  readZipEntry,
+  recomputeScope,
+  recordActivity,
+  recordDecisionActivity,
+  recordDiscoveryActivity,
+  recordEnvironmentRead,
+  recordObservedActivity,
+  recordPolicyActivity,
+  recordSensitiveFileRead,
+  recordSymlinkResolution,
+  recurseImageNameLookup,
+  remoteHostsAccessed,
+  repoMetadataToGitHubApiUrl,
+  resetActivityContext,
+  resetRecordedActivities,
+  retrieveCdxgenPluginVersion,
+  retrieveCdxgenVersion,
+  SEARCH_MAVEN_ORG,
+  SWIFT_CMD,
+  safeCopyFileSync,
+  safeExistsSync,
+  safeExtractArchive,
+  safeMkdirSync,
+  safeMkdtempSync,
+  safeRmSync,
+  safeSpawnSync,
+  safeUnlinkSync,
+  safeWriteSync,
+  setActivityContext,
+  setDryRunMode,
+  shouldFetchLicense,
+  shouldFetchPackageMetadata,
+  shouldFetchVCS,
+  shouldRunPredictiveBomAudit,
+  splitCommandArgs,
+  TABLE_BORDER_STYLE,
+  TIMEOUT_MS,
+  toCamel,
+  toGitHubApiUrl,
+  trimJarGroupSuffix,
+  YARN_CMD,
+  yarnLockToIdentMap,
+};