@mitre-attack/attack-data-model
Version:
A TypeScript API for the MITRE ATT&CK data model
640 lines (623 loc) • 23.8 kB
JavaScript
;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
for (var name in all)
__defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
// src/schemas/sdo/data-component.schema.ts
var data_component_schema_exports = {};
__export(data_component_schema_exports, {
dataComponentSchema: () => dataComponentSchema,
extensibleDataComponentSchema: () => extensibleDataComponentSchema,
xMitreDataSourceRefSchema: () => xMitreDataSourceRefSchema
});
module.exports = __toCommonJS(data_component_schema_exports);
var import_zod11 = require("zod");
// src/schemas/common/attack-base-object.ts
var import_zod9 = require("zod");
// src/schemas/common/stix-core.ts
var import_zod8 = require("zod");
// src/schemas/common/stix-identifier.ts
var import_zod2 = require("zod");
// src/schemas/common/stix-type.ts
var import_zod = require("zod");
var stixTypeToTypeName = {
"attack-pattern": "Technique",
bundle: "StixBundle",
campaign: "Campaign",
"course-of-action": "Mitigation",
identity: "Identity",
"intrusion-set": "Group",
malware: "Malware",
tool: "Tool",
"marking-definition": "MarkingDefinition",
"x-mitre-data-component": "DataComponent",
"x-mitre-data-source": "DataSource",
"x-mitre-tactic": "Tactic",
"x-mitre-asset": "Asset",
"x-mitre-matrix": "Matrix",
"x-mitre-collection": "Collection",
relationship: "Relationship",
file: "",
// not used in ATT&CK but used in sample_refs for Malware
artifact: ""
// not used in ATT&CK but used in sample_refs for Malware
// 'observed-data': 'ObservedData', // not used in ATT&CK
// 'report': 'Report', // not used in ATT&CK
// 'threat-actor': 'ThreatActor', // not used in ATT&CK
// 'vulnerability': 'Vulnerability', // not used in ATT&CK
};
var supportedStixTypes = [
"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",
// not used in ATT&CK but used in sample_refs for Malware
"artifact"
// not used in ATT&CK but used in sample_refs for Malware
// "indicator", // not used in ATT&CK
// "observed-data", // not used in ATT&CK
// "report", // not used in ATT&CK
// "threat-actor", // not used in ATT&CK
// "vulnerability", // not used in ATT&CK
];
var stixTypeSchema = import_zod.z.enum(supportedStixTypes, {
errorMap: (issue, ctx) => {
if (issue.code === "invalid_enum_value") {
const received = typeof ctx.data === "string" ? ctx.data : String(ctx.data);
return {
message: `Invalid STIX type '${received}'. Expected one of the supported STIX types.`
};
}
return { message: ctx.defaultError };
}
}).describe(
"The type property identifies the type of STIX Object (SDO, Relationship Object, etc). The value of the type field MUST be one of the types defined by a STIX Object (e.g., indicator)."
);
function createStixTypeValidator(stixType) {
const objectName = stixTypeToTypeName[stixType];
return import_zod.z.string().superRefine((val, ctx) => {
if (val !== stixType) {
ctx.addIssue({
code: import_zod.z.ZodIssueCode.custom,
message: `Invalid 'type' property. Expected '${stixType}' for ${objectName} object, but received '${val}'.`
});
return import_zod.z.NEVER;
}
});
}
// src/schemas/common/stix-identifier.ts
var isValidUuid = (uuid) => {
return /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(uuid);
};
var createStixIdError = (id, errorType) => {
const parts = id.split("--");
const stixType = parts.length > 0 ? parts[0] : "";
const typeName = stixType in stixTypeToTypeName ? stixTypeToTypeName[stixType] : "STIX";
let message;
switch (errorType) {
case "format":
message = `Invalid STIX Identifier for ${typeName} object: must comply with format 'type--UUIDv4'`;
break;
case "type":
message = `Invalid STIX Identifier for ${typeName} object: contains invalid STIX type '${stixType}'`;
break;
case "uuid":
message = `Invalid STIX Identifier for ${typeName} object: contains invalid UUIDv4 format`;
break;
}
return {
code: import_zod2.z.ZodIssueCode.custom,
message,
path: ["id"]
};
};
var stixIdentifierSchema = import_zod2.z.string().refine(
(val) => {
if (typeof val !== "string") return false;
if (!val.includes("--")) return false;
const [type, uuid] = val.split("--");
const isValidType = stixTypeSchema.safeParse(type).success;
const isValidUuidValue = isValidUuid(uuid);
return isValidType && isValidUuidValue;
},
(val) => {
if (typeof val !== "string") {
return createStixIdError(String(val), "format");
}
if (!val.includes("--")) {
return createStixIdError(val, "format");
}
const [type, uuid] = val.split("--");
if (!stixTypeSchema.safeParse(type).success) {
return createStixIdError(val, "type");
}
if (!isValidUuid(uuid)) {
return createStixIdError(val, "uuid");
}
return createStixIdError(val, "format");
}
).describe(
"Represents identifiers across the CTI specifications. The format consists of the name of the top-level object being identified, followed by two dashes (--), followed by a UUIDv4."
);
function createStixIdValidator(expectedType) {
const typeName = stixTypeToTypeName[expectedType] || expectedType;
return stixIdentifierSchema.refine(
(val) => val.startsWith(`${expectedType}--`),
{
message: `Invalid STIX Identifier for ${typeName}: must start with '${expectedType}--'`,
path: ["id"]
}
);
}
// src/schemas/common/stix-spec-version.ts
var import_zod3 = require("zod");
var specVersionDescription = [
"The version of the STIX specification used to represent this object.",
"The value of this property MUST be 2.1 for STIX Objects defined according to this specification.",
"If objects are found where this property is not present, the implicit value for all STIX Objects other than SCOs is 2.0.",
"Since SCOs are now top-level objects in STIX 2.1, the default value for SCOs is 2.1."
].join(" ");
var stixSpecVersionSchema = import_zod3.z.enum(["2.0", "2.1"]).describe(specVersionDescription);
// src/schemas/common/stix-timestamp.ts
var import_zod4 = require("zod");
var RFC3339_REGEX = /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d+)?)Z$/;
var StixTimestampError = {
InvalidFormat: {
code: import_zod4.z.ZodIssueCode.custom,
message: "Invalid STIX timestamp format: must be an RFC3339 timestamp with a timezone specification of 'Z'."
}
};
var isValidRFC3339 = (timestamp) => {
if (!RFC3339_REGEX.test(timestamp)) return false;
const date = new Date(timestamp);
return !isNaN(date.getTime());
};
var stixTimestampSchema = import_zod4.z.custom(
(val) => {
if (val instanceof Date) {
return isValidRFC3339(val.toISOString());
}
if (typeof val === "string") {
return isValidRFC3339(val);
}
return false;
},
{
message: StixTimestampError.InvalidFormat.message
}
).describe(
"Represents timestamps across the CTI specifications. The format is an RFC3339 timestamp, with a required timezone specification of 'Z'."
);
var stixCreatedTimestampSchema = stixTimestampSchema.brand("StixCreatedTimestamp");
var stixModifiedTimestampSchema = stixTimestampSchema.brand("StixModifiedTimestamp");
// src/schemas/common/misc.ts
var import_zod6 = require("zod");
// src/schemas/common/attack-id.ts
var import_zod5 = require("zod");
// src/schemas/common/misc.ts
var externalReferenceSchema = import_zod6.z.object({
source_name: import_zod6.z.string({
required_error: "Source name is required.",
invalid_type_error: "Source name must be a string."
}),
description: import_zod6.z.string({ invalid_type_error: "Description must be a string." }).optional(),
url: import_zod6.z.string({ invalid_type_error: "URL must be a string." }).url({ message: "Invalid URL format. Please provide a valid URL." }).optional(),
external_id: import_zod6.z.string({ invalid_type_error: "External ID must be a string." }).optional()
});
var externalReferencesSchema = import_zod6.z.array(externalReferenceSchema).min(1, "At least one external reference is required when 'external_references' is defined.").describe("A list of external references which refers to non-STIX information.");
var stixCreatedByRefSchema = createStixIdValidator("identity").describe(
"The created_by_ref property specifies the id property of the identity object that describes the entity that created this object. If this attribute is omitted, the source of this information is undefined. This may be used by object creators who wish to remain anonymous."
);
var granularMarkingSchema = import_zod6.z.object({
marking_ref: stixIdentifierSchema,
selectors: import_zod6.z.array(import_zod6.z.string())
});
var extensionSchema = import_zod6.z.object({
extension_type: import_zod6.z.string(),
extension_properties: import_zod6.z.record(import_zod6.z.unknown())
});
var extensionsSchema = import_zod6.z.record(import_zod6.z.union([extensionSchema, import_zod6.z.record(import_zod6.z.unknown())])).describe("Specifies any extensions of the object, as a dictionary.");
// src/schemas/common/common-properties.ts
var import_zod7 = require("zod");
var versionSchema = import_zod7.z.string().regex(/^\d+\.\d+$/, "Version must be in the format 'major.minor'").default("2.1").describe(
"Represents the version of the object in a 'major.minor' format, where both 'major' and 'minor' are integers. This versioning follows semantic versioning principles but excludes the patch number. The version number is incremented by ATT&CK when the content of the object is updated. This property does not apply to relationship objects."
);
var nameSchema = import_zod7.z.string().min(1, "Name must not be empty").describe("The name of the object.");
var descriptionSchema = import_zod7.z.string().describe("A description of the object.");
var aliasesSchema = import_zod7.z.array(import_zod7.z.string(), {
invalid_type_error: "Aliases must be an array of strings."
}).describe(
"Alternative names used to identify this object. The first alias must match the object's name."
);
var majorMinorVersionRegex = /^(\d{1,3})\.(\d{1,3})$/;
var xMitreVersionSchema = import_zod7.z.custom().refine(
(value) => {
if (!majorMinorVersionRegex.test(value)) return false;
const [major, minor] = value.split(".").map(Number);
return Number.isInteger(major) && Number.isInteger(minor) && major >= 0 && major <= 99 && minor >= 0 && minor <= 99;
},
{
message: "The version must be in the format 'M.N' where M and N are integers between 0 and 99"
}
).describe(
"Represents the version of the object in a 'major.minor' format, where both 'major' and 'minor' are integers between 0 and 99. This versioning follows semantic versioning principles but excludes the patch number. The version number is incremented by ATT&CK when the content of the object is updated. This property does not apply to relationship objects."
);
var majorMinorPatchVersionRegex = /^[0-9]\.[0-9]\.[0-9]$/;
var xMitreAttackSpecVersionSchema = import_zod7.z.string().refine(
(value) => {
if (!majorMinorPatchVersionRegex.test(value)) return false;
const [major, minor, patch] = value.split(".").map(Number);
return major >= 0 && major <= 9 && minor >= 0 && minor <= 9 && patch >= 0 && patch <= 9;
},
{
message: "Must be in the format 'M.N.P' where M, N, and P are single-digit integers (0-9)"
}
).describe(
"The version of the ATT&CK spec used by the object. This field helps consuming software determine if the data format is supported. If the field is not present on an object, the spec version will be assumed to be 2.0.0. Refer to the ATT&CK CHANGELOG for all supported versions."
);
var oldAttackIdRegex = /^MOB-(M|S)\d{4}$/;
var xMitreOldAttackIdSchema = import_zod7.z.string().refine(
(value) => {
return oldAttackIdRegex.test(value);
},
{
message: "Must be in the format 'MOB-X0000' where X is either 'M' or 'S', followed by exactly four digits"
}
).describe("Old ATT&CK IDs that may have been associated with this object");
var attackDomainSchema = import_zod7.z.enum(["enterprise-attack", "mobile-attack", "ics-attack"]);
var xMitreDomainsSchema = import_zod7.z.array(attackDomainSchema).min(1, {
message: "At least one MITRE ATT&CK domain must be specified."
}).describe("The technology domains to which the ATT&CK object belongs.");
var xMitreDeprecatedSchema = import_zod7.z.boolean({
invalid_type_error: "x_mitre_deprecated must be a boolean."
}).describe("Indicates whether the object has been deprecated.");
var supportedMitrePlatforms = [
"Field Controller/RTU/PLC/IED",
"Network Devices",
"Data Historian",
"Google Workspace",
"Office Suite",
"ESXi",
"Identity Provider",
"Containers",
"Azure AD",
"Engineering Workstation",
"Control Server",
"Human-Machine Interface",
"Windows",
"Linux",
"IaaS",
"None",
"iOS",
"PRE",
"SaaS",
"Input/Output Server",
"macOS",
"Android",
"Safety Instrumented System/Protection Relay",
"Embedded"
];
var xMitrePlatformsSchema = import_zod7.z.array(import_zod7.z.enum(supportedMitrePlatforms), {
invalid_type_error: "x_mitre_platforms must be an array of strings.",
message: "x_mitre_platforms may only contain values from the following list: " + supportedMitrePlatforms.join(", ")
}).min(1).refine((items) => new Set(items).size === items.length, {
message: "Platforms must be unique (no duplicates allowed)."
}).describe("List of platforms that apply to the object.");
var objectMarkingRefsSchema = import_zod7.z.array(stixIdentifierSchema).superRefine((val, ctx) => {
val.forEach((identifier, index) => {
if (!identifier.startsWith("marking-definition--")) {
ctx.addIssue({
code: import_zod7.z.ZodIssueCode.custom,
message: `All identifiers must start with 'marking-definition--'. Invalid identifier at index ${index}.`,
path: [index]
});
}
});
}).describe("The list of marking-definition objects to be applied to this object.");
var xMitreContributorsSchema = import_zod7.z.array(import_zod7.z.string()).describe(
"People and organizations who have contributed to the object. Not found on relationship objects."
);
var xMitreIdentity = "identity--c78cb6e5-0c4b-4611-8297-d1b8b55e40b5";
var xMitreModifiedByRefSchema = stixIdentifierSchema.refine((val) => val == xMitreIdentity).describe(
"The STIX ID of the MITRE identity object. Used to track the identity of the MITRE organization, which created the current version of the object. Previous versions of the object may have been created by other individuals or organizations."
);
var killChainNameSchema = import_zod7.z.enum([
"mitre-attack",
"mitre-mobile-attack",
"mitre-ics-attack"
]);
var killChainPhaseSchema = import_zod7.z.object({
phase_name: import_zod7.z.string({
required_error: "Phase name is required.",
invalid_type_error: "Phase name must be a string."
}).describe(
"The name of the phase in the kill chain. The value of this property SHOULD be all lowercase and SHOULD use hyphens instead of spaces or underscores as word separators."
).refine(
(value) => {
const isLowercase = value === value.toLowerCase();
const usesHyphens = !value.includes(" ") && !value.includes("_");
return isLowercase && usesHyphens;
},
{
message: "Phase name should be all lowercase and use hyphens instead of spaces or underscores."
}
),
kill_chain_name: killChainNameSchema
}).strict();
// src/schemas/common/stix-core.ts
var stixBaseObjectSchema = import_zod8.z.object({
id: stixIdentifierSchema.describe(
"The id property universally and uniquely identifies this object."
),
type: stixTypeSchema,
spec_version: stixSpecVersionSchema.describe(
"The version of the STIX specification used to represent this object."
),
created: stixCreatedTimestampSchema.describe(
"The created property represents the time at which the first version of this object was created. The timstamp value MUST be precise to the nearest millisecond."
),
modified: stixModifiedTimestampSchema.describe(
"The modified property represents the time that this particular version of the object was modified. The timstamp value MUST be precise to the nearest millisecond."
),
created_by_ref: stixCreatedByRefSchema.optional(),
labels: import_zod8.z.array(import_zod8.z.string()).describe("The labels property specifies a set of terms used to describe this object.").optional(),
revoked: import_zod8.z.boolean().describe("The revoked property indicates whether the object has been revoked.").optional(),
confidence: import_zod8.z.number().describe("Identifies the confidence that the creator has in the correctness of their data.").int().min(1).max(99).optional().refine((val) => val === void 0 || val > 0 && val < 100, {
message: "Confidence must be between 1 and 99 inclusive."
}).optional(),
lang: import_zod8.z.string().describe("Identifies the language of the text content in this object.").optional(),
external_references: externalReferencesSchema.optional(),
object_marking_refs: objectMarkingRefsSchema.optional(),
granular_markings: import_zod8.z.array(granularMarkingSchema).describe("The set of granular markings that apply to this object.").optional(),
extensions: extensionsSchema.optional()
}).required({
id: true,
type: true,
spec_version: true,
created: true,
modified: true
}).strict();
var stixDomainObjectSchema = stixBaseObjectSchema.extend({});
var stixRelationshipObjectSchema = stixBaseObjectSchema.extend({});
// src/schemas/common/attack-base-object.ts
var attackBaseObjectSchema = stixDomainObjectSchema.extend({
name: nameSchema,
/**
* Required on all ATT&CK schemas except:
* - Marking Definition
*/
x_mitre_attack_spec_version: xMitreAttackSpecVersionSchema,
/**
* Required on all ATT&CK schemas except:
* - Marking Definition
* - Identity
* - Relationship
*/
x_mitre_version: xMitreVersionSchema,
x_mitre_old_attack_id: xMitreOldAttackIdSchema.optional(),
x_mitre_deprecated: xMitreDeprecatedSchema.optional()
});
var attackBaseDomainObjectSchema = attackBaseObjectSchema.extend({});
var attackBaseRelationshipObjectSchema = attackBaseObjectSchema.extend({});
var attackBaseMetaObjectSchema = attackBaseObjectSchema.extend({}).omit({ modified: true });
// src/schemas/common/open-vocabulary.ts
var import_zod10 = require("zod");
var MalwareTypeOpenVocabulary = import_zod10.z.enum([
"adware",
"backdoor",
"bot",
"bootkit",
"ddos",
"downloader",
"dropper",
"exploit-kit",
"keylogger",
"ransomware",
"remote-access-trojan",
"resource-exploitation",
"rogue-security-software",
"rootkit",
"screen-capture",
"spyware",
"trojan",
"virus",
"webshell",
"wiper",
"worm",
"unknown"
]);
var ProcessorArchitecturesOpenVocabulary = import_zod10.z.enum([
"alpha",
"arm",
"ia-64",
"mips",
"powerpc",
"sparc",
"x86",
"x86-64"
]);
var ImplementationLanguagesOpenVocabulary = import_zod10.z.enum([
"applescript",
"bash",
"c",
"c++",
"c#",
"go",
"java",
"javascript",
"lua",
"objective-c",
"perl",
"php",
"powershell",
"python",
"ruby",
"scala",
"swift",
"typescript",
"visual-basic",
"x86-32",
"x86-64"
]);
var MalwareCapabilitiesOpenVocabulary = import_zod10.z.enum([
"accesses-remote-machines",
"anti-debugging",
"anti-disassembly",
"anti-emulation",
"anti-memory-forensics",
"anti-sandbox",
"anti-vm",
"captures-input-peripherals",
"captures-output-peripherals",
"captures-system-state-data",
"cleans-traces-of-infection",
"commits-fraud",
"communicates-with-c2",
"compromises-data-integrity",
"compromises-data-availability",
"compromises-system-availability",
"controls-local-machine",
"degrades-security-software",
"degrades-system-updates",
"determines-c2-server",
"emails-spam",
"escalates-privileges",
"evades-av",
"exfiltrates-data",
"fingerprints-host",
"hides-artifacts",
"hides-executing-code",
"infects-files",
"infects-remote-machines",
"installs-other-components",
"persists-after-system-reboot",
"prevents-artifact-access",
"prevents-artifact-deletion",
"probes-network-environment",
"self-modifies",
"steals-authentication-credentials",
"violates-system-operational-integrity"
]);
var ToolTypesOpenVocabulary = import_zod10.z.enum([
"denial-of-service",
"exploitation",
"information-gathering",
"network-capture",
"credential-exploitation",
"remote-access",
"vulnerability-scanning",
"unknown"
]);
var identityClassOpenVocabulary = import_zod10.z.enum([
"individual",
"group",
"system",
"organization",
"class",
"unspecified"
]);
var attackMotivationOpenVocabulary = import_zod10.z.enum([
"accidental",
"coercion",
"dominance",
"ideology",
"notoriety",
"organizational-gain",
"personal-gain",
"personal-satisfaction",
"revenge",
"unpredictable"
]);
var attackResourceLevelOpenVocabulary = import_zod10.z.enum([
"individual",
"club",
"contest",
"team",
"organization",
"government"
]);
var industrySectorOpenVocabulary = import_zod10.z.enum([
"agriculture",
"aerospace",
"automotive",
"chemical",
"commercial",
"communications",
"construction",
"defense",
"education",
"energy",
"entertainment",
"financial-services",
"government",
"government-emergency-services",
"government-local",
"government-national",
"government-public-services",
"government-regional",
"healthcare",
"hospitality-leisure",
"infrastructure",
"infrastructure-dams",
"infrastructure-nuclear",
"infrastructure-water",
"insurance",
"manufacturing",
"mining",
"non-profit",
"pharmaceuticals",
"retail",
"technology",
"telecommunications",
"transportation",
"utilities"
]);
// src/schemas/sdo/data-component.schema.ts
var xMitreDataSourceRefSchema = createStixIdValidator("x-mitre-data-source").describe(
"STIX ID of the data source this component is a part of."
);
var extensibleDataComponentSchema = attackBaseDomainObjectSchema.extend({
id: createStixIdValidator("x-mitre-data-component"),
type: createStixTypeValidator("x-mitre-data-component"),
description: descriptionSchema,
// Optional in STIX but required in ATT&CK
created_by_ref: stixCreatedByRefSchema,
// Optional in STIX but required in ATT&CK
object_marking_refs: objectMarkingRefsSchema,
x_mitre_domains: xMitreDomainsSchema,
x_mitre_modified_by_ref: xMitreModifiedByRefSchema,
x_mitre_data_source_ref: xMitreDataSourceRefSchema
}).strict();
var dataComponentSchema = extensibleDataComponentSchema;
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
dataComponentSchema,
extensibleDataComponentSchema,
xMitreDataSourceRefSchema
});