import {z} from 'zod' export type GetApiApi3AssetsIdArgs = {id: number}; export type GetApiApi3AssetsIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const address = z.object({ip: z.string().optional(), mac: z.string().optional()}); export const configuration = z.object({name: z.string(), value: z.string().optional()}); export const database = z.object({description: z.string().optional(), id: z.number().int().optional(), name: z.string()}); export const file = z.object({attributes: z.array(configuration).optional(), name: z.string(), size: z.number().int().optional(), type: z.enum(["file", "directory"])}); export const assetHistory = z.object({date: z.string().optional(), description: z.string().optional(), scanId: z.object({}).optional(), type: z.string().optional(), user: z.string().optional(), version: z.number().int().optional(), vulnerabilityExceptionId: z.object({}).optional()}); export const hostName = z.object({name: z.string(), source: z.enum(["user", "dns", "netbios", "dce", "epsec", "ldap", "other"]).optional()}); export const uniqueId = z.object({id: z.string(), source: z.string().optional()}); 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 operatingSystemCpe = z.object({edition: z.string().optional(), language: z.string().optional(), other: z.string().optional(), part: z.enum(["o", "a", "h"]), product: z.string().optional(), swEdition: z.string().optional(), targetHW: z.string().optional(), targetSW: z.string().optional(), update: z.string().optional(), "v2.2": z.string().optional(), "v2.3": z.string().optional(), vendor: z.string().optional(), version: z.string().optional()}); export const operatingSystem = z.object({architecture: z.string().optional(), configurations: z.array(configuration).optional(), cpe: operatingSystemCpe.optional(), description: z.string().optional(), family: z.string().optional(), id: z.number().int().optional(), product: z.string().optional(), systemName: z.string().optional(), type: z.string().optional(), vendor: z.string().optional(), version: z.string().optional()}); export const groupAccount = z.object({id: z.number().int().optional(), name: z.string()}); export const userAccount = z.object({fullName: z.string().optional(), id: z.number().int().optional(), name: z.string().optional()}); export const webPage = z.object({linkType: z.enum(["seed", "html-ref", "robots", "js-string", "query-param", "pdf", "css", "implied-dir", "rss", "redirection", "sitemap", "backup", "vck-rewrite", "non-ref-guess", "soft-404"]).optional(), path: z.string().optional(), response: z.number().int().optional()}); export const webApplication = z.object({id: z.number().int().optional(), pages: z.array(webPage).optional(), root: z.string().optional(), virtualHost: z.string().optional()}); export const service = z.object({configurations: z.array(configuration).optional(), databases: z.array(database).optional(), family: z.string().optional(), links: z.array(link), name: z.string().optional(), nic: z.string().optional(), port: z.number().int(), product: z.string().optional(), protocol: z.enum(["ip", "icmp", "igmp", "ggp", "tcp", "pup", "udp", "idp", "esp", "nd", "raw"]), userGroups: z.array(groupAccount).optional(), users: z.array(userAccount).optional(), vendor: z.string().optional(), version: z.string().optional(), webApplications: z.array(webApplication).optional()}); export const softwareCpe = z.object({edition: z.string().optional(), language: z.string().optional(), other: z.string().optional(), part: z.enum(["o", "a", "h"]), product: z.string().optional(), swEdition: z.string().optional(), targetHW: z.string().optional(), targetSW: z.string().optional(), update: z.string().optional(), "v2.2": z.string().optional(), "v2.3": z.string().optional(), vendor: z.string().optional(), version: z.string().optional()}); export const software = z.object({configurations: z.array(configuration).optional(), cpe: softwareCpe.optional(), description: z.string().optional(), family: z.string().optional(), id: z.object({}).optional(), product: z.string().optional(), type: z.string().optional(), vendor: z.string().optional(), version: z.string().optional()}); export const assetVulnerabilities = z.object({critical: z.number().int().optional(), exploits: z.number().int().optional(), malwareKits: z.number().int().optional(), moderate: z.number().int().optional(), severe: z.number().int().optional(), total: z.number().int().optional()}); export const asset = z.object({addresses: z.array(address).optional(), assessedForPolicies: z.boolean().optional(), assessedForVulnerabilities: z.boolean().optional(), configurations: z.array(configuration).optional(), databases: z.array(database).optional(), files: z.array(file).optional(), history: z.array(assetHistory).optional(), hostName: z.string().optional(), hostNames: z.array(hostName).optional(), id: z.object({}).optional(), ids: z.array(uniqueId).optional(), ip: z.string().optional(), links: z.array(link), mac: z.string().optional(), os: z.string().optional(), osCertainty: z.string().optional(), osFingerprint: operatingSystem.optional(), rawRiskScore: z.number().optional(), riskScore: z.number().optional(), services: z.array(service).optional(), software: z.array(software).optional(), type: z.enum(["unknown", "guest", "hypervisor", "physical", "mobile"]).optional(), userGroups: z.array(groupAccount).optional(), users: z.array(userAccount).optional(), vulnerabilities: assetVulnerabilities.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 }; /** * Asset * * GET /api/3/assets/{id} */ export const getApiApi3AssetsId = async (args: GetApiApi3AssetsIdArgs, options?: GetApiApi3AssetsIdOptions) => { 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/assets/${encodeURIComponent(String(args.id))}${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(asset, await res.json()) };