import {z} from 'zod' export type GetApiIndexVulncheckNvdArgs = {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 GetApiIndexVulncheckNvdOptions = {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 apiCPEName = z.object({cpe22Uri: z.string().optional(), cpe23Uri: z.string().optional(), lastModifiedDate: z.string().optional()}); export const apiCPEMatch = z.object({cpe22Uri: z.string().optional(), cpe23Uri: z.string().optional(), cpe_name: z.array(apiCPEName).optional(), versionEndExcluding: z.string().optional(), versionEndIncluding: z.string().optional(), versionStartExcluding: z.string().optional(), versionStartIncluding: z.string().optional(), vulnerable: z.boolean().optional()}); export const apiNodes: z.ZodType = z.object({children: z.array(z.lazy(() => apiNodes)).optional(), cpe_match: z.array(apiCPEMatch).optional(), operator: z.string().optional()}); export const apiConfigurations = z.object({CVE_data_version: z.string().optional(), nodes: z.array(apiNodes).optional()}); export const apiCVEDataMetaExtended = z.object({ALIAS: z.string().optional(), ASSIGNER: z.string().optional(), ID: z.string().optional(), STATUS: z.string().optional()}); export const apiCategorizationExtended = z.object({tags: z.array(z.string()).optional()}); export const apiDescriptionData = z.object({lang: z.string().optional(), value: z.string().optional()}); export const apiDescription = z.object({description_data: z.array(apiDescriptionData).optional()}); export const apiProblemTypeDescriptionExtended = z.object({lang: z.string().optional(), name: z.string().optional(), url: z.string().optional(), value: z.string().optional()}); export const apiProblemTypeDataExtended = z.object({description: z.array(apiProblemTypeDescriptionExtended).optional()}); export const apiProblemTypeExtended = z.object({problemtype_data: z.array(apiProblemTypeDataExtended).optional()}); export const apiReferenceDataExtended = 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(), status: z.string().optional(), tags: z.array(z.string()).optional(), url: z.string().optional()}); export const apiReferencesExtended = z.object({reference_data: z.array(apiReferenceDataExtended).optional()}); export const apiCVEExtended = z.object({CVE_data_meta: apiCVEDataMetaExtended.optional(), categorization: apiCategorizationExtended.optional(), data_format: z.string().optional(), data_type: z.string().optional(), data_version: z.string().optional(), description: apiDescription.optional(), problemtype: apiProblemTypeExtended.optional(), references: apiReferencesExtended.optional()}); export const apiCVSSV2 = z.object({accessComplexity: z.string().optional(), accessVector: z.string().optional(), authentication: z.string().optional(), availabilityImpact: z.string().optional(), baseScore: z.number().optional(), confidentialityImpact: z.string().optional(), integrityImpact: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const apiBaseMetricV2 = z.object({acInsufInfo: z.boolean().optional(), cvssV2: apiCVSSV2.optional(), exploitabilityScore: z.number().optional(), impactScore: z.number().optional(), obtainAllPrivilege: z.boolean().optional(), obtainOtherPrivilege: z.boolean().optional(), obtainUserPrivilege: z.boolean().optional(), severity: z.string().optional(), userInteractionRequired: z.boolean().optional()}); export const apiCVSSV3 = z.object({attackComplexity: z.string().optional(), attackVector: z.string().optional(), availabilityImpact: z.string().optional(), baseScore: z.number().optional(), baseSeverity: z.string().optional(), confidentialityImpact: z.string().optional(), integrityImpact: z.string().optional(), privilegesRequired: z.string().optional(), scope: z.string().optional(), userInteraction: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const apiBaseMetricV3 = z.object({cvssV3: apiCVSSV3.optional(), exploitabilityScore: z.number().optional(), impactScore: z.number().optional()}); export const apiEPSS = z.object({epss_percentile: z.number().optional(), epss_score: z.number().optional(), last_modified: 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 apiSSVC = z.object({automatable: z.string().optional(), exploitation: z.string().optional(), source: z.string().optional(), technicalImpact: z.string().optional()}); export const apiTemporalCVSSV2 = z.object({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 apiTemporalMetricV2 = z.object({cvssV2: apiTemporalCVSSV2.optional()}); export const apiTemporalCVSSV3 = z.object({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 apiTemporalMetricV3 = z.object({cvssV3: apiTemporalCVSSV3.optional()}); export const advisoryCVSSV40Threat = z.object({baseThreatScore: z.number().optional(), baseThreatSeverity: z.string().optional(), exploitMaturity: z.string().optional()}); export const apiImpactExtended = z.object({baseMetricV2: apiBaseMetricV2.optional(), baseMetricV3: apiBaseMetricV3.optional(), correctedBaseMetricV3: apiBaseMetricV3.optional(), epss: apiEPSS.optional(), metricV40: advisoryCVSSV40.optional(), ssvc: z.array(apiSSVC).optional(), temporalMetricV2: apiTemporalMetricV2.optional(), temporalMetricV3: apiTemporalMetricV3.optional(), temporalV3Corrected: apiTemporalMetricV3.optional(), threatMetricV40: advisoryCVSSV40Threat.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 apiRelatedAttackPattern = z.object({capec_id: z.string().optional(), capec_name: z.string().optional(), capec_url: z.string().optional(), lang: z.string().optional()}); export const apiCveItemsExtended = z.object({_timestamp: z.string().optional(), configurations: apiConfigurations.optional(), cve: apiCVEExtended.optional(), date_added: z.string().optional(), documentGenerationDate: z.string().optional(), impact: apiImpactExtended.optional(), lastModifiedDate: z.string().optional(), mitre_attack_techniques: z.array(apiMitreAttackTech).optional(), publishedDate: z.string().optional(), related_attack_patterns: z.array(apiRelatedAttackPattern).optional(), vcConfigurations: apiConfigurations.optional(), vcVulnerableCPEs: z.array(z.string()).optional(), vulnerable_cpes: z.array(z.string()).optional()}); export const renderResponseWithMetadataArrayApiCveItemsExtendedPaginatePagination = z.object({_benchmark: z.number().optional(), _meta: paginatePagination.optional(), data: z.array(apiCveItemsExtended).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-nvd" * * GET /index/vulncheck-nvd */ export const getApiIndexVulncheckNvd = async (args: GetApiIndexVulncheckNvdArgs, options: GetApiIndexVulncheckNvdOptions) => { 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-nvd${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(renderResponseWithMetadataArrayApiCveItemsExtendedPaginatePagination, await res.json()) };