Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

12.1 KB
Raw Blame
export { exportArtifact } from "./artifact-export.js";
export type {
  ExportArtifactOptions,
  ArtifactExportResult,
} from "./artifact-export.js";
export { CodexSecurity, createSecurity } from "./api.js";
export {
  runHostedRemediation,
  HostedRemediationInputSchema,
  HostedRemediationPreparationError,
} from "./hosted-remediation.js";
export type {
  HostedRemediationInput,
  HostedRemediationOptions,
  HostedRemediationResult,
  RemediationExecutor,
  RemediationExecutionRequest,
  RemediationExecutionResult,
  RemediationExecutionEvent,
} from "./hosted-remediation.js";
export { runHostedRemediationProtocol } from "./hosted-remediation-protocol.js";
export type { FindingPatch, FindingVerification } from "./remediation.js";
export {
  runHostedScan,
  HostedScanInputSchema,
  HostedScanPreparationError,
} from "./hosted-scan.js";
export type {
  HostedScanInput,
  HostedScanOptions,
  HostedScanResult,
} from "./hosted-scan.js";
export type {
  ScanExecutor,
  ScanExecutionRequest,
  ScanExecutionResult,
  ScanExecutionEvent,
} from "./scan-executor.js";
export { loadProjectConfig, resolveProjectConfig } from "./project-config.js";
export type {
  ResolvedProjectConfig,
  ProjectConfigProvenance,
} from "./project-config.js";
export type {
  ProjectConfigInput,
  ProjectScope,
} from "./project-config-schema.js";
export type { ScanSettings } from "./scan-settings.js";
export type { SeverityRubricSnapshot } from "./severity-rubric.js";
export { classifySeverity } from "./classify-severity.js";
export { suggestOwners, suggestOwnersFromScan } from "./suggest-owners.js";
export type {
  OwnerFinding,
  CodeownerIdentity,
  OwnerIdentity,
  OwnerSuggestion,
  OwnerSuggestions,
  SuggestOwnersOptions,
} from "./suggest-owners.js";
export type {
  ClassifySeverityOptions,
  SeverityClassificationFinding,
  SeverityClassification,
  SeverityAssessment,
} from "./classify-severity.js";
export {
  classifyScanSeverity,
  classifyScanDirectorySeverity,
} from "./classify-scan-severity.js";
export type {
  ClassifyScanSeverityOptions,
  ScanSeverityClassification,
} from "./classify-scan-severity.js";
export { runComponentScans } from "./component-scan.js";
export type {
  ComponentDeduplicationSummary,
  ComponentReceipt,
  ComponentScanOptions,
  ComponentScanEvent,
  ComponentScanResult,
} from "./component-scan.js";
export { normalizeComponentPlan, planComponents } from "./component-plan.js";
export type {
  ComponentPlan,
  ComponentPlanningOptions,
} from "./component-plan.js";
export { estimateScanCost } from "./cost.js";
export type {
  ScanAccountRateLimit,
  ScanAccountRateLimitWindow,
  ScanCost,
  ScanSessionEvent,
  ScanUsageMeasurement,
  ScanUsageObservation,
  ScanWorkerEvent,
} from "./cost.js";
export type { ScanPricingContext, ScanTokenUsage } from "./cost-model.js";
export type { DeepScanProgress } from "./scan-progress.js";
export type { CustomValidationResult } from "./custom-validation.js";
export type { ScanActivity, ScanActivityStatus } from "./scan-activity.js";
export { matchScanFindings } from "./scan-comparison.js";
export type {
  ScanComparisonInput,
  ScanComparisonOptions,
  ScanComparisonProgress,
  ScanComparisonResult,
} from "./scan-comparison.js";
export type {
  CodexSecurityMetadata,
  DeepScanOptions,
  PatchOptions,
  PatchResult,
  ScanAuthMode,
  ScanAuthentication,
  ScanBudget,
  ScanLifecycle,
  ScanOptions,
  ScanPreflight,
  ScanReconnectDetails,
  ScanTrustedAccessStatus,
  ScanWarningDetails,
  ValidationOptions,
  ValidationResult,
} from "./api.js";
export type {
  ScanPhase,
  ScanProgress,
  ScanWorkerPhase,
  ScanWorkerStatus,
} from "./worker-progress.js";
export { CodexLoginHandle } from "./auth.js";
export type { AccountStatus, LoginResult } from "./auth.js";

export {
  AuthenticationRequiredError,
  CodexSecurityError,
  ConfigurationError,
  ContractValidationError,
  DeduplicationReviewError,
  IncompleteScanError,
  InvalidTargetError,
  LocalPluginBootstrapError,
  OutputDirectoryError,
  OutputDirectoryNotEmptyError,
  OutputInsideProtectedRootError,
  PluginBootstrapError,
  PluginPythonUnavailableError,
  SandboxUnavailableError,
  ScanCostLimitExceededError,
  ScanInterruptedError,
} from "./errors.js";
export type {
  DeduplicationReviewFailureCategory,
  DeduplicationReviewFailureMetadata,
  DeduplicationReviewStage,
  ProtectedScanPathKind,
} from "./errors.js";
export {
  DEFAULT_CODEX_CONFIG,
  mergedCodexConfig,
  writeCodexConfig,
} from "./config.js";
export type { CodexSecurityConfig, JsonObject, JsonValue } from "./config.js";
export { loadContract, requireScanFile } from "./contract.js";
export type { LoadedContract, ScanExpectation } from "./contract.js";
export type * from "./models.js";
export {
  resolveSecurityPolicyTarget,
  securityPolicyDiff,
} from "./security-policy.js";
export type {
  SecurityPolicyDraft,
  SecurityPolicyOptions,
  SecurityPolicyPreflight,
  SecurityPolicyStage,
  SecurityPolicyTarget,
} from "./security-policy.js";
export { checkScanPublication, publishScan } from "./publish.js";
export { publishScanToCustom } from "./custom-publish.js";
export type {
  PublishScanToCustomOptions,
  CustomPublicationResult,
} from "./custom-publish.js";
export { deduplicateRecords } from "./deduplication/records.js";
export type {
  DeduplicateRecordsInput,
  DeduplicateRecordsOptions,
  DeduplicateRecordsResult,
} from "./deduplication/records.js";
export type {
  DeduplicationReviewRequest,
  DeduplicationReviewAttribution,
  DeduplicationReviewRunner,
} from "./deduplication/review.js";
export {
  deduplicateScan,
  deduplicateScanDirectory,
} from "./deduplication/scan.js";
export type {
  DeduplicateScanDirectoryOptions,
  DeduplicateScanOptions,
  DeduplicateScanResult,
} from "./deduplication/scan.js";
export type { DeduplicationRefusal } from "./deduplication/deduplication.js";
export type { FindingEmbeddingBinding } from "./deduplication/local.js";
export type {
  PublicationTelemetry,
  PublicationTelemetryObserver,
} from "./publication-telemetry.js";
export type {
  DeduplicationDiagnostic,
  DeduplicationDiagnosticObserver,
} from "./deduplication/diagnostics.js";
export type {
  FindingEmbedder,
  EmbeddingUsageObservation,
  EmbeddingUsageObserver,
} from "./server/embeddings.js";
export {
  ExternalPublicationError,
  prepareExternalPublication,
  prepareNormalizedExternalPublication,
} from "./external-findings-publish.js";
export type {
  ExternalPublicationOptions,
  NormalizedExternalPublicationOptions,
  ExternalPublicationDependencies,
  ExternalPublicationPreview,
  ExternalPublicationProgress,
  ExternalPublicationResult,
  PreparedExternalPublication,
} from "./external-findings-publish.js";
export {
  prepareNormalizedLocalImport,
  listLocalExternalImports,
  listLocalExternalFindings,
  listLocalFindingPublications,
  selectLocalExternalFindings,
} from "./external-findings-local.js";
export type {
  ExternalFindingProvenance,
  LocalExternalFindingSelection,
  SelectedLocalExternalFindings,
  StoredExternalImport,
  StoredFindingPublication,
  StoredExternalFinding,
  NormalizedLocalImportOptions,
  LocalExternalImportDependencies,
  LocalExternalImportPreview,
  LocalExternalImportResult,
  PreparedLocalExternalImport,
} from "./external-findings-local.js";
export {
  NoPublishableFindingsError,
  type ExternalFinding,
  type ExternalFindings,
  type ExternalSourceRepository,
} from "./external-findings.js";
export type {
  ExternalFindingEvidence,
  FindingImportRequest,
  FindingImportReceipt,
  ImportRepository,
  SourceReport,
} from "./external-import-models.js";
export {
  normalizeGitHubCodeScanningAlerts,
  normalizeGitHubAdvisories,
  readGitHubFindings,
} from "./github-findings.js";
export { importGitHubAdvisories } from "./github-advisories.js";
export { normalizeGitHubDependabotAlerts } from "./github-dependabot-findings.js";
export type {
  GitHubAdvisoryImportOptions,
  ImportedGitHubAdvisory,
} from "./github-advisories.js";
export { importGitHubCodeScanningAlerts } from "./github.js";
export type {
  GitHubCodeScanningImportOptions,
  ImportedGitHubCodeScanningAlert,
} from "./github.js";
export type {
  CheckScanPublicationOptions,
  CheckScanPublicationResult,
  PublishScanOptions,
  PublishScanProgress,
  PublishScanResult,
} from "./publish.js";
export { ScanResult } from "./result.js";
export type {
  RepositoryFinding,
  ScanResultOptions,
  TurnResultMetadata,
} from "./result.js";
export {
  bootstrapPlugin,
  bundledPluginRoot,
  cleanupSdkDirectory,
  createIsolatedHome,
  createMarketplace,
  extractPluginZip,
  importAmbientAuth,
  MARKETPLACE_NAME,
  pluginExecutionEnvironment,
  pluginMetadata,
  PLUGIN_NAME,
  prepareOutputDir,
  resolveCodexCommand,
  resolvePluginPath,
  resolvePluginPython,
  validateOutputDir,
} from "./runtime.js";
export type {
  CodexCommand,
  PluginInstall,
  PluginPythonOptions,
  ProcessEnvironment,
} from "./runtime.js";
export {
  DiffTarget,
  normalizeRepository,
  normalizeTarget,
  repositoryRevision,
  validateMode,
} from "./targets.js";
export type { NormalizedTarget, ScanMode, ScanTarget } from "./targets.js";
export type { AbsolutePath } from "./config-path.js";
export { BUNDLED_PLUGIN_VERSION, VERSION } from "./version.js";

export {
  classifySeverityRecords,
  classifySeverityRecordsInputSchema,
} from "./classify-severity-records.js";
export type {
  ClassifySeverityRecordsInput,
  ClassifySeverityRecordsOptions,
  ClassifySeverityRecordsResult,
  CanonicalSeverityAssessment,
  SeverityClassificationReviewRequest,
} from "./classify-severity-records.js";
export { validateRecords } from "./validation-records.js";
export type {
  ValidateRecordsInput,
  ValidateRecordsOptions,
  ValidationReviewRequest,
} from "./validation-records.js";

export {
  readOperationTelemetry,
  summarizeOperationTelemetry,
} from "./operation-telemetry.js";
export type {
  OperationTelemetryEvent,
  OperationOutcome,
  OperationFailureCategory,
} from "./operation-telemetry.js";

export {
  prepareLocalExternalImport,
  type LocalExternalImportOptions,
} from "./external-findings-import.js";
export {
  prepareStoredFindingsPublication,
  type StoredFindingsPublication,
  type StoredFindingsPublicationGroup,
} from "./stored-findings-publication.js";
export { readTenableFindings } from "./tenable-findings.js";
export { readCrowdStrikeFindings } from "./crowdstrike-findings.js";
export {
  normalizeOpenGrepFindings,
  readOpenGrepFindings,
  type OpenGrepImportOptions,
} from "./opengrep-findings.js";
export { readSonarFindings, type SonarCapture } from "./sonar-findings.js";
export {
  collectSonarIssues,
  type SonarCollectionOptions,
} from "./sonar-collector.js";
export {
  normalizeVeracodeFindings,
  readVeracodeFindings,
} from "./veracode-findings.js";
export { normalizeTrivyFindings, readTrivyFindings } from "./trivy-findings.js";
export {
  normalizeBlackDuckFindings,
  readBlackDuckFindings,
} from "./blackduck-findings.js";
export {
  normalizeContinuumFindings,
  readContinuumFindings,
} from "./continuum-findings.js";
export { readCheckmarxFindings } from "./checkmarx-findings.js";
export {
  normalizeInspectorFindings,
  readInspectorFindings,
} from "./inspector-findings.js";
export {
  normalizeSnykFindingsExport,
  normalizeSnykJson,
  normalizeSnykSarif,
  readSnykFindings,
} from "./snyk-findings.js";
export {
  collectSnykIssues,
  normalizeSnykIssues,
  SNYK_REST_ISSUES_FORMAT,
  type CollectSnykIssuesOptions,
  type SnykIssuesExport,
  type SnykIssuesFindings,
  type SnykIssuesProduct,
} from "./snyk-rest-findings.js";
export {
  normalizeSemgrepFindings,
  normalizeSemgrepSarif,
  readSemgrepFindings,
  type SemgrepImportOptions,
} from "./semgrep-findings.js";
export { collectSemgrepPlatformFindings } from "./semgrep-platform-collector.js";
export { collectSelectedSemgrepGuardianFindings } from "./semgrep-guardian-findings.js";
export type {
  SemgrepPlatformOptions,
  SemgrepPlatformReport,
} from "./semgrep-platform-collector.js";
export type { HostedScannerHttpOptions } from "./hosted-scanner-http.js";
export {
  normalizeSelectedSemgrepPlatformFindings,
  selectSemgrepPlatformFindings,
  normalizeSemgrepPlatformFindings,
  type SemgrepPlatformSelection,
} from "./semgrep-platform-findings.js";
export {
  normalizeEndorFindings,
  normalizeEndorSarif,
  readEndorFindings,
} from "./endor-findings.js";