import {z} from 'zod' export type GetApiV1ThreatLibraryActionsArgs = {action_ids?: Array | undefined, action_display_ids?: Array | undefined}; export type GetApiV1ThreatLibraryActionsOptions = {baseUrl?: string | undefined, AccessToken?: string | undefined, fetch?: typeof fetch | undefined}; export const platform = z.object({architecture: z.string().optional(), name: z.string().optional(), os: z.string().optional()}); export const mitre = z.object({sub_technique: z.string().optional(), sub_technique_id: z.string().optional(), tactic: z.string().optional(), tactic_id: z.string().optional(), technique: z.string().optional(), technique_id: z.string().optional()}); export const ukc = z.object({phase: z.string().optional(), stage: z.string().optional()}); export const frameworks = z.object({mitre: mitre.optional(), ukc: ukc.optional()}); export const kWDictionary = z.object({id: z.number().int().optional(), query: z.string().optional(), type: z.string().optional()}); export const file = z.object({MD5: z.string().optional(), SHA1: z.string().optional(), SHA256: z.string().optional(), name: z.string().optional()}); export const affectedAction = z.object({id: z.number().int().optional(), name: z.string().optional()}); export const processFilesSummary = z.object({FileSize: z.number().int().optional(), FileType: z.string().optional(), Id: z.number().int().optional(), IsDownloaded: z.boolean().optional(), IsExecutable: z.boolean().optional(), Name: z.string().optional(), Path: z.string().optional(), SkipZipExtract: z.boolean().optional(), Url: z.string().optional()}); export const process = z.object({affected_actions: z.array(affectedAction).optional(), argument: z.string().optional(), created_at: z.string().optional(), id: z.number().int().optional(), is_predefined: z.boolean().optional(), path: z.string().optional(), process_files_summary: z.array(processFilesSummary).optional()}); export const moduleBasedDetails = z.object({file: file.optional(), processes: z.array(process).optional()}); export const reference = z.object({link: z.string().optional(), name: z.string().optional()}); export const actionDetailReferences = z.object({cve_reference: reference.optional(), cwe_reference: reference.optional(), virus_total_reference: z.array(reference).optional()}); export const actionReturn = z.object({affected_os: z.array(z.string()).optional(), affected_platforms: z.array(platform).optional(), affected_products: z.array(z.string()).optional(), attack_category: z.string().optional(), attack_module: z.string().optional(), attack_module_id: z.number().int().optional(), created_at: z.number().int().optional(), cve: z.string().optional(), cwe: z.string().optional(), description: z.string().optional(), display_id: z.number().int().optional(), frameworks: frameworks.optional(), id: z.number().int().optional(), keyword_queries: z.array(kWDictionary).optional(), module_based_details: moduleBasedDetails.optional(), name: z.string().optional(), owasp: z.string().optional(), references: actionDetailReferences.optional(), release_date: z.number().int().optional(), sources: z.array(z.string()).optional(), tags: z.array(z.string()).optional(), updated_at: z.number().int().optional()}); export const pagination = z.object({limit: z.number().int().optional(), offset: z.number().int().optional(), total_count: z.number().int().optional()}); export const getApiV1ThreatLibraryActionsResponse = z.object({actions: z.array(actionReturn).optional(), pages: pagination.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 }; /** * # Action Details List * * GET /v1/threat-library/actions */ export const getApiV1ThreatLibraryActions = async (args: GetApiV1ThreatLibraryActionsArgs, options?: GetApiV1ThreatLibraryActionsOptions) => { const {baseUrl = "https://api.picussecurity.com", fetch: fetchFn = fetch, AccessToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") for (const item of args.action_ids ?? []) query.append("action_ids", String(item)) for (const item of args.action_display_ids ?? []) query.append("action_display_ids", String(item)) if (AccessToken !== undefined) headers.set("Authorization", AccessToken) const url = `${baseUrl.replace(/\/+$/, '')}/v1/threat-library/actions${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(getApiV1ThreatLibraryActionsResponse, await res.json()) };