import {z} from 'zod' export type GetApiV1SimulationsIdRunRunIdFrameworksArgs = {Id: number, RunId: number}; export type GetApiV1SimulationsIdRunRunIdFrameworksOptions = {baseUrl?: string | undefined, AccessToken?: string | undefined, fetch?: typeof fetch | undefined}; export const alert = z.object({alert_result: z.string().optional(), alerted_time: z.number().int().optional()}); export const logging = z.object({log_result: z.string().optional(), logged_time: z.number().int().optional()}); export const integrationBasedResult = z.object({alert: alert.optional(), has_alert_analysis: z.boolean().optional(), has_log_analysis: z.boolean().optional(), integration_id: z.number().int().optional(), log: logging.optional(), product_name: z.string().optional(), protocol: z.string().optional(), status: z.string().optional()}); export const detectionResult = z.object({alert_result: z.string().optional(), has_alert_analysis: z.boolean().optional(), has_log_analysis: z.boolean().optional(), integration_based_results: z.array(integrationBasedResult).optional(), log_result: z.string().optional()}); export const subTechniqueResults = z.object({blocked_action_count: z.number().int().optional(), description: z.string().optional(), detection_result: detectionResult.optional(), mitre_id: z.string().optional(), mitre_name: z.string().optional(), name: z.string().optional(), not_blocked_action_count: z.number().int().optional(), not_tested_action_count: z.number().int().optional(), total_action_count: z.number().int().optional(), url: z.string().optional()}); export const techniqueResults = z.object({blocked_action_count: z.number().int().optional(), description: z.string().optional(), detection_result: detectionResult.optional(), mitre_id: z.string().optional(), mitre_name: z.string().optional(), name: z.string().optional(), not_blocked_action_count: z.number().int().optional(), not_tested_action_count: z.number().int().optional(), sub_techniques: z.array(subTechniqueResults).optional(), total_action_count: z.number().int().optional(), url: z.string().optional()}); export const tacticResults = z.object({blocked_action_count: z.number().int().optional(), description: z.string().optional(), detection_result: detectionResult.optional(), mitre_id: z.string().optional(), mitre_name: z.string().optional(), name: z.string().optional(), not_blocked_action_count: z.number().int().optional(), not_tested_action_count: z.number().int().optional(), techniques: z.array(techniqueResults).optional(), total_action_count: z.number().int().optional(), url: z.string().optional()}); export const mitreResults = z.object({tactics: z.array(tacticResults).optional()}); export const phasesResult = z.object({blocked_action_count: z.number().int().optional(), detection_result: detectionResult.optional(), name: z.string().optional(), not_blocked_action_count: z.number().int().optional(), not_tested_action_count: z.number().int().optional(), total_action_count: z.number().int().optional()}); export const stagesResult = z.object({blocked_action_count: z.number().int().optional(), detection_result: detectionResult.optional(), name: z.string().optional(), not_blocked_action_count: z.number().int().optional(), not_tested_action_count: z.number().int().optional(), phases: z.array(phasesResult).optional(), total_action_count: z.number().int().optional()}); export const ukcResults = z.object({stages: z.array(stagesResult).optional()}); export const getApiV1SimulationsIdRunRunIdFrameworksResponse = z.object({mitre_attack_results: mitreResults.optional(), unified_kill_chain_results: ukcResults.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 }; /** * Simulation Run Result with Mitre ATT&CK and Unified Kill Chain framework * * GET /v1/simulations/{Id}/run/{RunId}/frameworks */ export const getApiV1SimulationsIdRunRunIdFrameworks = async (args: GetApiV1SimulationsIdRunRunIdFrameworksArgs, options?: GetApiV1SimulationsIdRunRunIdFrameworksOptions) => { const {baseUrl = "https://api.picussecurity.com", fetch: fetchFn = fetch, AccessToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (AccessToken !== undefined) headers.set("Authorization", AccessToken) const url = `${baseUrl.replace(/\/+$/, '')}/v1/simulations/${encodeURIComponent(String(args.Id))}/run/${encodeURIComponent(String(args.RunId))}/frameworks${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(getApiV1SimulationsIdRunRunIdFrameworksResponse, await res.json()) };