import {z} from 'zod' export type GetApiIndexExploitsArgs = {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, max_exploit_maturity?: string | undefined, validation_level?: string | undefined, in_kev?: boolean | undefined, in_vckev?: boolean | undefined, date?: string | undefined, updatedAtStartDate?: string | undefined, updatedAtEndDate?: string | undefined, lastModStartDate?: string | undefined, lastModEndDate?: string | undefined, pubStartDate?: string | undefined, pubEndDate?: string | undefined}; export type GetApiIndexExploitsOptions = {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 apiExploitsV3Count = z.object({botnets: z.number().int().optional(), exploits: z.number().int().optional(), ransomware_families: z.number().int().optional(), threat_actors: z.number().int().optional()}); export const apiEPSS = z.object({epss_percentile: z.number().optional(), epss_score: z.number().optional(), last_modified: z.string().optional()}); export const apiNormalizedExploitV3Entry = z.object({clone_ssh_url: z.string().optional(), clone_ssh_url_cached: z.string().optional(), commit_hash: z.string().optional(), date_added: z.string().optional(), date_cached: z.string().optional(), exploit_availability: z.string().optional(), exploit_maturity: z.string().optional(), exploit_type: z.string().optional(), name: z.string().optional(), reference_url: z.string().optional(), refsource: z.string().optional(), repo_id: z.string().optional(), url: z.string().optional(), validation_level: z.string().optional()}); export const apiNormalizedReportV3Entry = z.object({date_added: z.string().optional(), name: z.string().optional(), refsource: z.string().optional(), url: z.string().optional()}); export const apiExploitsV3Timeline = z.object({cisa_kev_date_added: z.string().optional(), cisa_kev_date_due: z.string().optional(), first_exploit_published: z.string().optional(), first_exploit_published_weaponized_or_higher: z.string().optional(), first_reported_botnet: z.string().optional(), first_reported_ransomware: z.string().optional(), first_reported_threat_actor: z.string().optional(), first_reported_vulncheck_canaries: z.string().optional(), most_recent_exploit_published: z.string().optional(), most_recent_reported_botnet: z.string().optional(), most_recent_reported_ransomware: z.string().optional(), most_recent_reported_threat_actor: z.string().optional(), nvd_last_modified: z.string().optional(), nvd_published: z.string().optional(), vulncheck_kev_date_added: z.string().optional(), vulncheck_kev_date_due: z.string().optional()}); export const apiExploitsTrending = z.object({github: z.boolean().optional()}); export const apiExploitV3Result = z.object({_timestamp: z.string().optional(), commercial_exploit_found: z.boolean().optional(), counts: apiExploitsV3Count.optional(), date_added: z.string().optional(), epss: apiEPSS.optional(), exploits: z.array(apiNormalizedExploitV3Entry).optional(), id: z.string().optional(), inKEV: z.boolean().optional(), inVCKEV: z.boolean().optional(), max_exploit_maturity: z.string().optional(), public_exploit_found: z.boolean().optional(), reported_exploitation: z.array(apiNormalizedReportV3Entry).optional(), reported_exploited: z.boolean().optional(), reported_exploited_by_botnets: z.boolean().optional(), reported_exploited_by_honeypot_service: z.boolean().optional(), reported_exploited_by_ransomware: z.boolean().optional(), reported_exploited_by_threat_actors: z.boolean().optional(), reported_exploited_by_vulncheck_canaries: z.boolean().optional(), timeline: apiExploitsV3Timeline.optional(), trending: apiExploitsTrending.optional(), weaponized_exploit_found: z.boolean().optional()}); export const renderResponseWithMetadataArrayApiExploitV3ResultPaginatePagination = z.object({_benchmark: z.number().optional(), _meta: paginatePagination.optional(), data: z.array(apiExploitV3Result).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 "exploits" * * GET /index/exploits */ export const getApiIndexExploits = async (args: GetApiIndexExploitsArgs, options: GetApiIndexExploitsOptions) => { 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.max_exploit_maturity != null) query.append("max_exploit_maturity", String(args.max_exploit_maturity)) if (args.validation_level != null) query.append("validation_level", String(args.validation_level)) if (args.in_kev != null) query.append("in_kev", String(args.in_kev)) if (args.in_vckev != null) query.append("in_vckev", String(args.in_vckev)) 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/exploits${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(renderResponseWithMetadataArrayApiExploitV3ResultPaginatePagination, await res.json()) };