import {z} from 'zod' export type GetApiApi3SitesIdScanTemplateArgs = {id: number}; export type GetApiApi3SitesIdScanTemplateOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const link = z.object({deprecation: z.string().optional(), href: z.string().optional(), hreflang: z.string().optional(), media: z.string().optional(), rel: z.string().optional(), title: z.string().optional(), type: z.string().optional()}); export const scanTemplateVulnerabilityCheckCategories = z.object({disabled: z.array(z.string()).optional(), enabled: z.array(z.string()).optional(), links: z.array(link)}); export const scanTemplateVulnerabilityCheckIndividual = z.object({disabled: z.array(z.object({})).optional(), enabled: z.array(z.object({})).optional(), links: z.array(link)}); export const vulnerabilityCheckType = z.object({disabled: z.array(z.string()).optional(), enabled: z.array(z.string()).optional(), links: z.array(link)}); export const scanTemplateVulnerabilityChecks = z.object({categories: scanTemplateVulnerabilityCheckCategories.optional(), correlate: z.boolean().optional(), individual: scanTemplateVulnerabilityCheckIndividual.optional(), links: z.array(link), potential: z.boolean().optional(), types: vulnerabilityCheckType.optional(), unsafe: z.boolean().optional()}); export const scanTemplateDatabase = z.object({db2: z.string().optional(), links: z.array(link), oracle: z.array(z.string()).optional(), postgres: z.string().optional()}); export const scanTemplateAssetDiscovery = z.object({collectWhoisInformation: z.boolean().optional(), fingerprintMinimumCertainty: z.number().gte(0).lte(1).optional(), fingerprintRetries: z.number().int().gte(0).lte(1000).optional(), ipFingerprintingEnabled: z.boolean().optional(), sendArpPings: z.boolean().optional(), sendIcmpPings: z.boolean().optional(), tcpPorts: z.array(z.number().int()).optional(), treatTcpResetAsAsset: z.boolean().optional(), udpPorts: z.array(z.number().int()).optional()}); export const scanTemplateDiscoveryPerformancePacketsRate = z.object({defeatRateLimit: z.boolean().optional(), maximum: z.number().int().gte(0).lte(15000).optional(), minimum: z.number().int().gte(0).lte(15000).optional()}); export const scanTemplateDiscoveryPerformanceParallelism = z.object({maximum: z.number().int().gte(0).lte(1000).optional(), minimum: z.number().int().gte(0).lte(1000).optional()}); export const scanTemplateDiscoveryPerformanceScanDelay = z.object({maximum: z.string().optional(), minimum: z.string().optional()}); export const scanTemplateDiscoveryPerformanceTimeout = z.object({initial: z.string().optional(), maximum: z.string().optional(), minimum: z.string().optional()}); export const scanTemplateDiscoveryPerformance = z.object({packetRate: scanTemplateDiscoveryPerformancePacketsRate.optional(), parallelism: scanTemplateDiscoveryPerformanceParallelism.optional(), retryLimit: z.number().int().gte(1).lte(15).optional(), scanDelay: scanTemplateDiscoveryPerformanceScanDelay.optional(), timeout: scanTemplateDiscoveryPerformanceTimeout.optional()}); export const scanTemplateServiceDiscoveryTcp = z.object({additionalPorts: z.string().optional(), excludedPorts: z.string().optional(), links: z.array(link), method: z.enum(["SYN", "SYN+RST", "SYN+FIN", "SYN+ECE", "Full"]).optional(), ports: z.enum(["all", "well-known", "custom", "none"]).optional()}); export const scanTemplateServiceDiscoveryUdp = z.object({additionalPorts: z.string().optional(), excludedPorts: z.string().optional(), links: z.array(link), ports: z.enum(["all", "well-known", "custom", "none"]).optional()}); export const scanTemplateServiceDiscovery = z.object({serviceNameFile: z.string().optional(), tcp: scanTemplateServiceDiscoveryTcp.optional(), udp: scanTemplateServiceDiscoveryUdp.optional()}); export const scanTemplateDiscovery = z.object({asset: scanTemplateAssetDiscovery.optional(), performance: scanTemplateDiscoveryPerformance.optional(), service: scanTemplateServiceDiscovery.optional()}); export const policy = z.object({enabled: z.array(z.object({})).optional(), links: z.array(link), recursiveWindowsFSSearch: z.boolean().optional(), storeSCAP: z.boolean().optional()}); export const telnet = z.object({characterSet: z.string().optional(), failedLoginRegex: z.string().optional(), links: z.array(link), loginRegex: z.string().optional(), passwordPromptRegex: z.string().optional(), questionableLoginRegex: z.string().optional()}); export const scanTemplate = z.object({checks: scanTemplateVulnerabilityChecks.optional(), database: scanTemplateDatabase.optional(), description: z.string().optional(), discovery: scanTemplateDiscovery.optional(), discoveryOnly: z.boolean().optional(), enableWindowsServices: z.boolean().optional(), enhancedLogging: z.boolean().optional(), id: z.string().optional(), links: z.array(link), maxParallelAssets: z.number().int().optional(), maxScanProcesses: z.number().int().optional(), name: z.string().optional(), policy: policy.optional(), policyEnabled: z.boolean().optional(), telnet: telnet.optional(), vulnerabilityEnabled: z.boolean().optional(), web: z.object({}).optional(), webEnabled: z.boolean().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 }; /** * Site Scan Template * * GET /api/3/sites/{id}/scan_template */ export const getApiApi3SitesIdScanTemplate = async (args: GetApiApi3SitesIdScanTemplateArgs, options?: GetApiApi3SitesIdScanTemplateOptions) => { const {baseUrl = "https://:", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json;charset=UTF-8") const url = `${baseUrl.replace(/\/+$/, '')}/api/3/sites/${encodeURIComponent(String(args.id))}/scan_template${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(scanTemplate, await res.json()) };