import {z} from 'zod' export type GetApiIndexMitreCvelistV5Args = {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 GetApiIndexMitreCvelistV5Options = {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 advisoryProgramRoutine = z.object({name: z.string().optional()}); export const advisoryVersionChange = z.object({at: z.string().optional(), status: z.string().optional()}); export const advisoryMVersion = z.object({changes: z.array(advisoryVersionChange).optional(), lessThan: z.string().optional(), lessThanOrEqual: z.string().optional(), status: z.string().optional(), version: z.string().optional(), versionType: z.string().optional()}); export const advisoryMAffected = 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(advisoryProgramRoutine).optional(), repo: z.string().optional(), vendor: z.string().optional(), versions: z.array(advisoryMVersion).optional()}); export const advisoryMDescriptions = z.object({lang: z.string().optional(), value: z.string().optional()}); export const advisoryMCPEMatch = 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 advisoryMNodes = z.object({cpeMatch: z.array(advisoryMCPEMatch).optional(), negate: z.boolean().optional(), operator: z.string().optional()}); export const advisoryMCPEApplicability = z.object({negate: z.boolean().optional(), nodes: z.array(advisoryMNodes).optional(), operator: z.string().optional()}); export const advisoryCustomCPE = z.object({mcpeapplicability: advisoryMCPEApplicability.optional(), stringValue: z.string().optional()}); export const advisoryCredit = z.object({lang: z.string().optional(), type: z.string().optional(), user: z.string().optional(), value: z.string().optional()}); export const advisoryImpact = z.object({capecId: z.string().optional(), descriptions: z.array(advisoryMDescriptions).optional()}); export const advisoryMCvssV20 = z.object({accessVector: z.string().optional(), attackComplexity: 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 advisoryMCvssV30 = 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 advisoryMCvssV31 = 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 advisoryMCvssV40 = z.object({attackComplexity: z.string().optional(), attackRequirements: z.string().optional(), attackVector: z.string().optional(), automatable: z.string().optional(), baseScore: z.number().optional(), baseSeverity: z.string().optional(), privilegesRequired: z.string().optional(), providerUrgency: z.string().optional(), recovery: z.string().optional(), safety: 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 advisoryMetricsOther = z.object({content: z.object({}).optional(), type: z.string().optional()}); export const advisoryMetricScenario = z.object({lang: z.string().optional(), value: z.string().optional()}); export const advisoryMetric = z.object({cvssV2_0: advisoryMCvssV20.optional(), cvssV3_0: advisoryMCvssV30.optional(), cvssV3_1: advisoryMCvssV31.optional(), cvssV4_0: advisoryMCvssV40.optional(), format: z.string().optional(), other: advisoryMetricsOther.optional(), scenarios: z.array(advisoryMetricScenario).optional()}); export const advisoryMReference = z.object({name: z.string().optional(), tags: z.array(z.string()).optional(), url: z.string().optional()}); export const advisoryPTMDescriptions = z.object({cweId: z.string().optional(), description: z.string().optional(), lang: z.string().optional(), references: z.array(advisoryMReference).optional(), type: z.string().optional()}); export const advisoryMProblemTypes = z.object({descriptions: z.array(advisoryPTMDescriptions).optional()}); export const advisoryMProviderMetadata = z.object({dateUpdated: z.string().optional(), orgId: z.string().optional(), shortName: z.string().optional()}); export const advisoryTaxonomyRelation = z.object({relationshipName: z.string().optional(), relationshipValue: z.string().optional(), taxonomyId: z.string().optional()}); export const advisoryTaxonomyMapping = z.object({taxonomyName: z.string().optional(), taxonomyRelations: z.array(advisoryTaxonomyRelation).optional(), taxonomyVersion: z.string().optional()}); export const advisoryTimeline = z.object({lang: z.string().optional(), time: z.string().optional(), value: z.string().optional()}); export const advisoryADPContainer = z.object({affected: z.array(advisoryMAffected).optional(), configurations: z.array(advisoryMDescriptions).optional(), cpeApplicability: z.array(advisoryCustomCPE).optional(), credits: z.array(advisoryCredit).optional(), datePublic: z.string().optional(), descriptions: z.array(advisoryMDescriptions).optional(), exploits: z.array(advisoryMDescriptions).optional(), impacts: z.array(advisoryImpact).optional(), metrics: z.array(advisoryMetric).optional(), problemTypes: z.array(advisoryMProblemTypes).optional(), providerMetadata: advisoryMProviderMetadata.optional(), references: z.array(advisoryMReference).optional(), solutions: z.array(advisoryMDescriptions).optional(), source: z.object({}).optional(), tags: z.array(z.string()).optional(), taxonomyMappings: z.array(advisoryTaxonomyMapping).optional(), timeline: z.array(advisoryTimeline).optional(), title: z.string().optional(), workarounds: z.array(advisoryMDescriptions).optional()}); export const advisoryMCna = z.object({affected: z.array(advisoryMAffected).optional(), configurations: z.array(advisoryMDescriptions).optional(), cpeApplicability: z.array(advisoryCustomCPE).optional(), credits: z.array(advisoryCredit).optional(), dateAssigned: z.string().optional(), datePublic: z.string().optional(), descriptions: z.array(advisoryMDescriptions).optional(), exploits: z.array(advisoryMDescriptions).optional(), impacts: z.array(advisoryImpact).optional(), metrics: z.array(advisoryMetric).optional(), problemTypes: z.array(advisoryMProblemTypes).optional(), providerMetadata: advisoryMProviderMetadata.optional(), references: z.array(advisoryMReference).optional(), rejectedReasons: z.array(advisoryMDescriptions).optional(), replacedBy: z.array(z.string()).optional(), solutions: z.array(advisoryMDescriptions).optional(), source: z.object({}).optional(), tags: z.array(z.string()).optional(), taxonomyMappings: z.array(advisoryTaxonomyMapping).optional(), timeline: z.array(advisoryTimeline).optional(), title: z.string().optional(), workarounds: z.array(advisoryMDescriptions).optional()}); export const advisoryMContainers = z.object({adp: z.array(advisoryADPContainer).optional(), cna: advisoryMCna.optional()}); export const advisoryMCveMetadata = z.object({assignerOrgId: z.string().optional(), assignerShortName: z.string().optional(), cveId: z.string().optional(), datePublished: z.string().optional(), dateRejected: z.string().optional(), dateReserved: z.string().optional(), dateUpdated: z.string().optional(), requesterUserId: z.string().optional(), serial: z.number().int().optional(), state: z.string().optional()}); export const advisoryMitreCVEListV5Ref = z.object({containers: advisoryMContainers.optional(), cveMetadata: advisoryMCveMetadata.optional(), dataType: z.string().optional(), dataVersion: z.string().optional()}); export const advisoryMitreCVEListV5 = z.object({cve: z.array(z.string()).optional(), date_added: z.string().optional(), mitre_ref: advisoryMitreCVEListV5Ref.optional(), references: z.array(z.string()).optional(), summary: z.string().optional(), title: z.string().optional(), updated_at: z.string().optional(), url: z.string().optional()}); export const renderResponseWithMetadataArrayAdvisoryMitreCVEListV5PaginatePagination = z.object({_benchmark: z.number().optional(), _meta: paginatePagination.optional(), data: z.array(advisoryMitreCVEListV5).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 "mitre-cvelist-v5" * * GET /index/mitre-cvelist-v5 */ export const getApiIndexMitreCvelistV5 = async (args: GetApiIndexMitreCvelistV5Args, options: GetApiIndexMitreCvelistV5Options) => { 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/mitre-cvelist-v5${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(renderResponseWithMetadataArrayAdvisoryMitreCVEListV5PaginatePagination, await res.json()) };