import {z} from 'zod' export type GetApiIndexVulncheckNvd2Args = {page?: number | undefined, limit?: number | undefined, cursor?: string | undefined, start_cursor?: 'true' | undefined, order?: ('asc' | 'desc') | undefined, sort?: string | undefined, cve?: string | undefined, alias?: string | undefined, iava?: string | undefined, jvndb?: string | undefined, ilvn?: string | undefined, threat_actor?: string | undefined, mitre_id?: string | undefined, misp_id?: string | undefined, ransomware?: string | undefined, botnet?: string | undefined, published?: string | undefined, date?: string | undefined, updatedAtStartDate?: string | undefined, updatedAtEndDate?: string | undefined, lastModStartDate?: string | undefined, lastModEndDate?: string | undefined, pubStartDate?: string | undefined, pubEndDate?: string | undefined}; export type GetApiIndexVulncheckNvd2Options = {baseUrl: string, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const paginateMatch = z.object({field: z.string().optional(), value: z.string().optional()}); export const paginateParam = z.object({filtering: z.string().optional(), format: z.string().optional(), name: z.string().optional()}); export const paginatePagination = z.object({cursor: z.string().optional(), first_item: z.number().int().optional(), index: z.string().optional(), last_item: z.number().int().optional(), limit: z.number().int().optional(), matches: z.array(paginateMatch).optional(), max_pages: z.number().int().optional(), next_cursor: z.string().optional(), opensearch_query: z.object({}).optional(), order: z.string().optional(), page: z.number().int().optional(), pages: z.array(z.string()).optional(), parameters: z.array(paginateParam).optional(), show_pages: z.boolean().optional(), show_query: z.boolean().optional(), sort: z.string().optional(), timestamp: z.string().optional(), total_documents: z.number().int().optional(), total_pages: z.number().int().optional(), truncated: z.boolean().optional(), warnings: z.array(z.string()).optional()}); export const apiNVD20AffectedProgramRoutine = z.object({name: z.string().optional()}); export const apiNVD20AffectedVersionChange = z.object({at: z.string().optional(), status: z.string().optional()}); export const apiNVD20AffectedVersion = z.object({changes: z.array(apiNVD20AffectedVersionChange).optional(), lessThan: z.string().optional(), lessThanOrEqual: z.string().optional(), status: z.string().optional(), version: z.string().optional(), versionType: z.string().optional()}); export const apiNVD20AffectedProduct = z.object({collectionURL: z.string().optional(), cpes: z.array(z.string()).optional(), defaultStatus: z.string().optional(), modules: z.array(z.string()).optional(), packageName: z.string().optional(), packageURL: z.string().optional(), platforms: z.array(z.string()).optional(), product: z.string().optional(), programFiles: z.array(z.string()).optional(), programRoutines: z.array(apiNVD20AffectedProgramRoutine).optional(), repo: z.string().optional(), vendor: z.string().optional(), versions: z.array(apiNVD20AffectedVersion).optional()}); export const apiNVD20Affected = z.object({affectedData: z.array(apiNVD20AffectedProduct).optional(), source: z.string().optional()}); export const apiCategorizationExtended = z.object({tags: z.array(z.string()).optional()}); export const advisoryNVD20CVECPEMatch = z.object({criteria: z.string().optional(), matchCriteriaId: z.string().optional(), versionEndExcluding: z.string().optional(), versionEndIncluding: z.string().optional(), versionStartExcluding: z.string().optional(), versionStartIncluding: z.string().optional(), vulnerable: z.boolean().optional()}); export const advisoryNVD20Node = z.object({cpeMatch: z.array(advisoryNVD20CVECPEMatch).optional(), negate: z.boolean().optional(), operator: z.string().optional()}); export const advisoryNVD20Configuration = z.object({negate: z.boolean().optional(), nodes: z.array(advisoryNVD20Node).optional(), operator: z.string().optional()}); export const apiNVD20CVETag = z.object({sourceIdentifier: z.string().optional(), tags: z.array(z.string()).optional()}); export const apiNVD20Description = z.object({lang: z.string().optional(), value: z.string().optional()}); export const apiNVD20CvssDataV2 = z.object({accessComplexity: z.string().optional(), accessVector: z.string().optional(), authentication: z.string().optional(), availabilityImpact: z.string().optional(), availabilityRequirement: z.string().optional(), baseScore: z.number().optional(), collateralDamagePotential: z.string().optional(), confidentialityImpact: z.string().optional(), confidentialityRequirement: z.string().optional(), environmentalScore: z.number().optional(), exploitability: z.string().optional(), integrityImpact: z.string().optional(), integrityRequirement: z.string().optional(), remediationLevel: z.string().optional(), reportConfidence: z.string().optional(), targetDistribution: z.string().optional(), temporalScore: z.number().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const apiNVD20CvssMetricV2 = z.object({acInsufInfo: z.boolean().optional(), baseSeverity: z.string().optional(), cvssData: apiNVD20CvssDataV2.optional(), exploitabilityScore: z.number().optional(), impactScore: z.number().optional(), obtainAllPrivilege: z.boolean().optional(), obtainOtherPrivilege: z.boolean().optional(), obtainUserPrivilege: z.boolean().optional(), source: z.string().optional(), type: z.string().optional(), userInteractionRequired: z.boolean().optional()}); export const apiNVD20CvssDataV3 = z.object({attackComplexity: z.string().optional(), attackVector: z.string().optional(), availabilityImpact: z.string().optional(), availabilityRequirement: z.string().optional(), baseScore: z.number().optional(), baseSeverity: z.string().optional(), confidentialityImpact: z.string().optional(), confidentialityRequirement: z.string().optional(), environmentalScore: z.number().optional(), environmentalSeverity: z.string().optional(), exploitCodeMaturity: z.string().optional(), integrityImpact: z.string().optional(), integrityRequirement: z.string().optional(), modifiedAttackComplexity: z.string().optional(), modifiedAttackVector: z.string().optional(), modifiedAvailabilityImpact: z.string().optional(), modifiedConfidentialityImpact: z.string().optional(), modifiedIntegrityImpact: z.string().optional(), modifiedPrivilegesRequired: z.string().optional(), modifiedScope: z.string().optional(), modifiedUserInteraction: z.string().optional(), privilegesRequired: z.string().optional(), remediationLevel: z.string().optional(), reportConfidence: z.string().optional(), scope: z.string().optional(), temporalScore: z.number().optional(), temporalSeverity: z.string().optional(), userInteraction: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const apiNVD20CvssMetricV3 = z.object({cvssData: apiNVD20CvssDataV3.optional(), exploitabilityScore: z.number().optional(), impactScore: z.number().optional(), source: z.string().optional(), type: z.string().optional()}); export const advisoryCVSSV40 = z.object({Automatable: z.string().optional(), Recovery: z.string().optional(), Safety: z.string().optional(), attackComplexity: z.string().optional(), attackRequirements: z.string().optional(), attackVector: z.string().optional(), availabilityRequirement: z.string().optional(), baseScore: z.number().optional(), baseSeverity: z.string().optional(), confidentialityRequirement: z.string().optional(), exploitMaturity: z.string().optional(), integrityRequirement: z.string().optional(), modifiedAttackComplexity: z.string().optional(), modifiedAttackRequirements: z.string().optional(), modifiedAttackVector: z.string().optional(), modifiedPrivilegesRequired: z.string().optional(), modifiedSubAvailabilityImpact: z.string().optional(), modifiedSubConfidentialityImpact: z.string().optional(), modifiedSubIntegrityImpact: z.string().optional(), modifiedUserInteraction: z.string().optional(), modifiedVulnAvailabilityImpact: z.string().optional(), modifiedVulnConfidentialityImpact: z.string().optional(), modifiedVulnIntegrityImpact: z.string().optional(), privilegesRequired: z.string().optional(), providerUrgency: z.string().optional(), subAvailabilityImpact: z.string().optional(), subConfidentialityImpact: z.string().optional(), subIntegrityImpact: z.string().optional(), userInteraction: z.string().optional(), valueDensity: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional(), vulnAvailabilityImpact: z.string().optional(), vulnConfidentialityImpact: z.string().optional(), vulnIntegrityImpact: z.string().optional(), vulnerabilityResponseEffort: z.string().optional()}); export const apiNVD20CvssMetricV40 = z.object({cvssData: advisoryCVSSV40.optional(), source: z.string().optional(), type: z.string().optional()}); export const apiEPSS = z.object({epss_percentile: z.number().optional(), epss_score: z.number().optional(), last_modified: z.string().optional()}); export const apiSSVC = z.object({automatable: z.string().optional(), exploitation: z.string().optional(), source: z.string().optional(), technicalImpact: z.string().optional()}); export const apiNVD20TemporalAssociatedBaseMetric = z.object({baseScore: z.number().optional(), source: z.string().optional(), type: z.string().optional()}); export const apiNVD20TemporalCVSSV2 = z.object({associatedBaseMetricV2: apiNVD20TemporalAssociatedBaseMetric.optional(), exploitability: z.string().optional(), remediationLevel: z.string().optional(), reportConfidence: z.string().optional(), temporalScore: z.number().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const apiNVD20TemporalCVSSV3 = z.object({associatedBaseMetricV3: apiNVD20TemporalAssociatedBaseMetric.optional(), exploitCodeMaturity: z.string().optional(), remediationLevel: z.string().optional(), reportConfidence: z.string().optional(), temporalScore: z.number().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const apiNVD20ThreatAssociatedBaseMetric = z.object({baseScore: z.number().optional(), source: z.string().optional(), type: z.string().optional()}); export const apiNVD20ThreatCVSSV40 = z.object({associatedBaseMetricV40: apiNVD20ThreatAssociatedBaseMetric.optional(), baseThreatScore: z.number().optional(), baseThreatSeverity: z.string().optional(), exploitMaturity: z.string().optional()}); export const apiNVD20MetricExtended = z.object({cvssMetricV2: z.array(apiNVD20CvssMetricV2).optional(), cvssMetricV30: z.array(apiNVD20CvssMetricV3).optional(), cvssMetricV31: z.array(apiNVD20CvssMetricV3).optional(), cvssMetricV40: z.array(apiNVD20CvssMetricV40).optional(), epss: apiEPSS.optional(), ssvc: z.array(apiSSVC).optional(), temporalCVSSV2: apiNVD20TemporalCVSSV2.optional(), temporalCVSSV2Secondary: z.array(apiNVD20TemporalCVSSV2).optional(), temporalCVSSV30: apiNVD20TemporalCVSSV3.optional(), temporalCVSSV30Secondary: z.array(apiNVD20TemporalCVSSV3).optional(), temporalCVSSV31: apiNVD20TemporalCVSSV3.optional(), temporalCVSSV31Secondary: z.array(apiNVD20TemporalCVSSV3).optional(), threatCVSSV40: apiNVD20ThreatCVSSV40.optional(), threatCVSSV40Secondary: z.array(apiNVD20ThreatCVSSV40).optional()}); export const advisoryMitreD3fendTechnique = z.object({id: z.string().optional(), url: z.string().optional()}); export const apiMitreMitigation2D3fendMapping = z.object({d3fendtechniques: z.array(advisoryMitreD3fendTechnique).optional(), id: z.string().optional()}); export const apiMitreDetectionTech = z.object({datacomponent: z.string().optional(), datasource: z.string().optional(), detects: z.string().optional(), id: z.string().optional()}); export const apiMitreMitigationTech = z.object({description: z.string().optional(), id: z.string().optional(), mitigation_url: z.string().optional()}); export const apiMitreAttackTech = z.object({d3fendmapping: z.array(apiMitreMitigation2D3fendMapping).optional(), detections: z.array(apiMitreDetectionTech).optional(), domain: z.string().optional(), id: z.string().optional(), mitigations: z.array(apiMitreMitigationTech).optional(), name: z.string().optional(), subtechnique: z.boolean().optional(), tactics: z.array(z.string()).optional(), url: z.string().optional()}); export const apiNVD20ReferenceExtended = z.object({date_added: z.string().optional(), external_id: z.string().optional(), lang: z.string().optional(), name: z.string().optional(), previous_url: z.string().optional(), refsource: z.string().optional(), source: z.string().optional(), status: z.string().optional(), tags: z.array(z.string()).optional(), url: z.string().optional()}); export const apiRelatedAttackPattern = z.object({capec_id: z.string().optional(), capec_name: z.string().optional(), capec_url: z.string().optional(), lang: z.string().optional()}); export const apiNVD20VendorComment = z.object({comment: z.string().optional(), lastModified: z.string().optional(), organization: z.string().optional()}); export const apiNVD20WeaknessDescExtended = z.object({lang: z.string().optional(), name: z.string().optional(), url: z.string().optional(), value: z.string().optional()}); export const apiNVD20WeaknessExtended = z.object({description: z.array(apiNVD20WeaknessDescExtended).optional(), source: z.string().optional(), type: z.string().optional()}); export const apiNVD20CVEExtended = z.object({ALIAS: z.string().optional(), STATUS: z.string().optional(), _timestamp: z.string().optional(), affected: z.array(apiNVD20Affected).optional(), categorization: apiCategorizationExtended.optional(), cisaActionDue: z.string().optional(), cisaExploitAdd: z.string().optional(), cisaRequiredAction: z.string().optional(), cisaVulnerabilityName: z.string().optional(), configurations: z.array(advisoryNVD20Configuration).optional(), cveTags: z.array(apiNVD20CVETag).optional(), date_added: z.string().optional(), descriptions: z.array(apiNVD20Description).optional(), documentGenerationDate: z.string().optional(), evaluatorComment: z.string().optional(), evaluatorImpact: z.string().optional(), evaluatorSolution: z.string().optional(), id: z.string().optional(), lastModified: z.string().optional(), metrics: apiNVD20MetricExtended.optional(), mitreAttackTechniques: z.array(apiMitreAttackTech).optional(), published: z.string().optional(), references: z.array(apiNVD20ReferenceExtended).optional(), relatedAttackPatterns: z.array(apiRelatedAttackPattern).optional(), sourceIdentifier: z.string().optional(), vcConfigurations: z.array(advisoryNVD20Configuration).optional(), vcConfigurationsWithPlatforms: z.array(advisoryNVD20Configuration).optional(), vcVulnerableCPEs: z.array(z.string()).optional(), vendorComments: z.array(apiNVD20VendorComment).optional(), vulnStatus: z.string().optional(), vulncheckKEVExploitAdd: z.string().optional(), vulnerableCPEs: z.array(z.string()).optional(), weaknesses: z.array(apiNVD20WeaknessExtended).optional()}); export const renderResponseWithMetadataArrayApiNVD20CVEExtendedPaginatePagination = z.object({_benchmark: z.number().optional(), _meta: paginatePagination.optional(), data: z.array(apiNVD20CVEExtended).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Return vulnerability data stored in index "vulncheck-nvd2" * * GET /index/vulncheck-nvd2 */ export const getApiIndexVulncheckNvd2 = async (args: GetApiIndexVulncheckNvd2Args, options: GetApiIndexVulncheckNvd2Options) => { const {baseUrl, fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (args.start_cursor != null) query.append("start_cursor", String(args.start_cursor)) if (args.order != null) query.append("order", String(args.order)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.cve != null) query.append("cve", String(args.cve)) if (args.alias != null) query.append("alias", String(args.alias)) if (args.iava != null) query.append("iava", String(args.iava)) if (args.jvndb != null) query.append("jvndb", String(args.jvndb)) if (args.ilvn != null) query.append("ilvn", String(args.ilvn)) if (args.threat_actor != null) query.append("threat_actor", String(args.threat_actor)) if (args.mitre_id != null) query.append("mitre_id", String(args.mitre_id)) if (args.misp_id != null) query.append("misp_id", String(args.misp_id)) if (args.ransomware != null) query.append("ransomware", String(args.ransomware)) if (args.botnet != null) query.append("botnet", String(args.botnet)) if (args.published != null) query.append("published", String(args.published)) if (args.date != null) query.append("date", String(args.date)) if (args.updatedAtStartDate != null) query.append("updatedAtStartDate", String(args.updatedAtStartDate)) if (args.updatedAtEndDate != null) query.append("updatedAtEndDate", String(args.updatedAtEndDate)) if (args.lastModStartDate != null) query.append("lastModStartDate", String(args.lastModStartDate)) if (args.lastModEndDate != null) query.append("lastModEndDate", String(args.lastModEndDate)) if (args.pubStartDate != null) query.append("pubStartDate", String(args.pubStartDate)) if (args.pubEndDate != null) query.append("pubEndDate", String(args.pubEndDate)) if (Bearer !== undefined) headers.set("Authorization", Bearer) const url = `${baseUrl.replace(/\/+$/, '')}/index/vulncheck-nvd2${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(renderResponseWithMetadataArrayApiNVD20CVEExtendedPaginatePagination, await res.json()) };