@mitre-attack/attack-data-model/dist/schemas/common/stix-core.d.ts

A TypeScript API for the MITRE ATT&CK data model

import { z } from 'zod';

declare const stixDomainObjectSchema: z.ZodObject<z.objectUtil.extendShape<{
    type: z.ZodEnum<["attack-pattern", "bundle", "campaign", "course-of-action", "identity", "intrusion-set", "malware", "tool", "marking-definition", "x-mitre-data-component", "x-mitre-data-source", "x-mitre-tactic", "x-mitre-asset", "x-mitre-matrix", "x-mitre-collection", "relationship", "file", "artifact"]>;
    id: z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>;
    spec_version: z.ZodEnum<["2.0", "2.1"]>;
    created: z.ZodBranded<z.ZodType<`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`, z.ZodTypeDef, `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`>, "StixCreatedTimestamp">;
    modified: z.ZodBranded<z.ZodType<`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`, z.ZodTypeDef, `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`>, "StixModifiedTimestamp">;
    created_by_ref: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>, `identity--${string}`, string>>;
    labels: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
    revoked: z.ZodOptional<z.ZodBoolean>;
    confidence: z.ZodOptional<z.ZodEffects<z.ZodOptional<z.ZodNumber>, number | undefined, number | undefined>>;
    lang: z.ZodOptional<z.ZodString>;
    external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
        source_name: z.ZodString;
        description: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
        external_id: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }, {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }>, "many">>;
    object_marking_refs: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>, "many">, (`attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`)[], string[]>>;
    granular_markings: z.ZodOptional<z.ZodArray<z.ZodObject<{
        marking_ref: z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>;
        selectors: z.ZodArray<z.ZodString, "many">;
    }, "strip", z.ZodTypeAny, {
        marking_ref: `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`;
        selectors: string[];
    }, {
        marking_ref: string;
        selectors: string[];
    }>, "many">>;
    extensions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
        extension_type: z.ZodString;
        extension_properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, "strip", z.ZodTypeAny, {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }, {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>>;
}, {}>, "strict", z.ZodTypeAny, {
    type: "attack-pattern" | "bundle" | "campaign" | "course-of-action" | "identity" | "intrusion-set" | "malware" | "tool" | "marking-definition" | "x-mitre-data-component" | "x-mitre-data-source" | "x-mitre-tactic" | "x-mitre-asset" | "x-mitre-matrix" | "x-mitre-collection" | "relationship" | "file" | "artifact";
    id: `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`;
    spec_version: "2.0" | "2.1";
    created: (`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`) & z.BRAND<"StixCreatedTimestamp">;
    modified: (`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`) & z.BRAND<"StixModifiedTimestamp">;
    created_by_ref?: `identity--${string}` | undefined;
    labels?: string[] | undefined;
    revoked?: boolean | undefined;
    confidence?: number | undefined;
    lang?: string | undefined;
    external_references?: {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }[] | undefined;
    object_marking_refs?: (`attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`)[] | undefined;
    granular_markings?: {
        marking_ref: `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`;
        selectors: string[];
    }[] | undefined;
    extensions?: Record<string, Record<string, unknown> | {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }> | undefined;
}, {
    type: "attack-pattern" | "bundle" | "campaign" | "course-of-action" | "identity" | "intrusion-set" | "malware" | "tool" | "marking-definition" | "x-mitre-data-component" | "x-mitre-data-source" | "x-mitre-tactic" | "x-mitre-asset" | "x-mitre-matrix" | "x-mitre-collection" | "relationship" | "file" | "artifact";
    id: string;
    spec_version: "2.0" | "2.1";
    created: `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`;
    modified: `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`;
    created_by_ref?: string | undefined;
    labels?: string[] | undefined;
    revoked?: boolean | undefined;
    confidence?: number | undefined;
    lang?: string | undefined;
    external_references?: {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }[] | undefined;
    object_marking_refs?: string[] | undefined;
    granular_markings?: {
        marking_ref: string;
        selectors: string[];
    }[] | undefined;
    extensions?: Record<string, Record<string, unknown> | {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }> | undefined;
}>;
declare const stixRelationshipObjectSchema: z.ZodObject<z.objectUtil.extendShape<{
    type: z.ZodEnum<["attack-pattern", "bundle", "campaign", "course-of-action", "identity", "intrusion-set", "malware", "tool", "marking-definition", "x-mitre-data-component", "x-mitre-data-source", "x-mitre-tactic", "x-mitre-asset", "x-mitre-matrix", "x-mitre-collection", "relationship", "file", "artifact"]>;
    id: z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>;
    spec_version: z.ZodEnum<["2.0", "2.1"]>;
    created: z.ZodBranded<z.ZodType<`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`, z.ZodTypeDef, `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`>, "StixCreatedTimestamp">;
    modified: z.ZodBranded<z.ZodType<`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`, z.ZodTypeDef, `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`>, "StixModifiedTimestamp">;
    created_by_ref: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>, `identity--${string}`, string>>;
    labels: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
    revoked: z.ZodOptional<z.ZodBoolean>;
    confidence: z.ZodOptional<z.ZodEffects<z.ZodOptional<z.ZodNumber>, number | undefined, number | undefined>>;
    lang: z.ZodOptional<z.ZodString>;
    external_references: z.ZodOptional<z.ZodArray<z.ZodObject<{
        source_name: z.ZodString;
        description: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
        external_id: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }, {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }>, "many">>;
    object_marking_refs: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>, "many">, (`attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`)[], string[]>>;
    granular_markings: z.ZodOptional<z.ZodArray<z.ZodObject<{
        marking_ref: z.ZodEffects<z.ZodString, `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`, string>;
        selectors: z.ZodArray<z.ZodString, "many">;
    }, "strip", z.ZodTypeAny, {
        marking_ref: `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`;
        selectors: string[];
    }, {
        marking_ref: string;
        selectors: string[];
    }>, "many">>;
    extensions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
        extension_type: z.ZodString;
        extension_properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, "strip", z.ZodTypeAny, {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }, {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>>;
}, {}>, "strict", z.ZodTypeAny, {
    type: "attack-pattern" | "bundle" | "campaign" | "course-of-action" | "identity" | "intrusion-set" | "malware" | "tool" | "marking-definition" | "x-mitre-data-component" | "x-mitre-data-source" | "x-mitre-tactic" | "x-mitre-asset" | "x-mitre-matrix" | "x-mitre-collection" | "relationship" | "file" | "artifact";
    id: `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`;
    spec_version: "2.0" | "2.1";
    created: (`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`) & z.BRAND<"StixCreatedTimestamp">;
    modified: (`${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`) & z.BRAND<"StixModifiedTimestamp">;
    created_by_ref?: `identity--${string}` | undefined;
    labels?: string[] | undefined;
    revoked?: boolean | undefined;
    confidence?: number | undefined;
    lang?: string | undefined;
    external_references?: {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }[] | undefined;
    object_marking_refs?: (`attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`)[] | undefined;
    granular_markings?: {
        marking_ref: `attack-pattern--${string}` | `bundle--${string}` | `campaign--${string}` | `course-of-action--${string}` | `identity--${string}` | `intrusion-set--${string}` | `malware--${string}` | `tool--${string}` | `marking-definition--${string}` | `x-mitre-data-component--${string}` | `x-mitre-data-source--${string}` | `x-mitre-tactic--${string}` | `x-mitre-asset--${string}` | `x-mitre-matrix--${string}` | `x-mitre-collection--${string}` | `relationship--${string}` | `file--${string}` | `artifact--${string}`;
        selectors: string[];
    }[] | undefined;
    extensions?: Record<string, Record<string, unknown> | {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }> | undefined;
}, {
    type: "attack-pattern" | "bundle" | "campaign" | "course-of-action" | "identity" | "intrusion-set" | "malware" | "tool" | "marking-definition" | "x-mitre-data-component" | "x-mitre-data-source" | "x-mitre-tactic" | "x-mitre-asset" | "x-mitre-matrix" | "x-mitre-collection" | "relationship" | "file" | "artifact";
    id: string;
    spec_version: "2.0" | "2.1";
    created: `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`;
    modified: `${number}-${number}-${number}T${number}:${number}:${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`;
    created_by_ref?: string | undefined;
    labels?: string[] | undefined;
    revoked?: boolean | undefined;
    confidence?: number | undefined;
    lang?: string | undefined;
    external_references?: {
        source_name: string;
        description?: string | undefined;
        url?: string | undefined;
        external_id?: string | undefined;
    }[] | undefined;
    object_marking_refs?: string[] | undefined;
    granular_markings?: {
        marking_ref: string;
        selectors: string[];
    }[] | undefined;
    extensions?: Record<string, Record<string, unknown> | {
        extension_type: string;
        extension_properties: Record<string, unknown>;
    }> | undefined;
}>;
type SDO = z.infer<typeof stixDomainObjectSchema>;
type SRO = z.infer<typeof stixRelationshipObjectSchema>;

export { type SDO, type SRO, stixDomainObjectSchema, stixRelationshipObjectSchema };