Merge pull request #28 from mitre-attack/refactor-hydration-process

feat: TAXII Server Hydration System Refactor
mitre-attack · Nov 17, 2024 · 489e6ba · 489e6ba
2 parents 5ed8f93 + 4a53be8
commit 489e6ba
Show file tree

Hide file tree

Showing 41 changed files with 704 additions and 436 deletions.
diff --git a/bruno/Get API Root Information.bru b/bruno/Get API Root Information.bru
@@ -29,9 +29,12 @@ tests {
     const data = res.getBody();
     expect(data).to.have.property('title').that.is.a('string').and.is.not.empty;
     expect(data).to.have.property('description').that.is.a('string').and.is.not.empty;
-    expect(data).to.have.property('version').that.is.a('string').and.startsWith('application/taxii+json');
-    expect(data).to.have.property('maxContentLength');
-    const maxContentLength = data.maxContentLength;
+    expect(data).to.have.property('versions').that.is.an('array');
+    data.versions.forEach(version => {
+        expect(version).startsWith('application/taxii+json');
+      });
+    expect(data).to.have.property('max_content_length');
+    const maxContentLength = data['max_content_length'];
 
     if (typeof maxContentLength === 'string') {
       expect(parseInt(maxContentLength)).to.be.a('number').and.not.NaN;

diff --git a/bruno/Get Object Versions.bru b/bruno/Get Object Versions.bru
@@ -36,7 +36,9 @@ tests {
 
   test("Verify response body structure", function() {
     const data = res.getBody();
-    expect(data).to.have.property('more').that.is.a('boolean');
+    if (data.hasOwnProperty('more')) {
+      expect(data.more).to.be.a('boolean');
+    }
 
     // The list of object versions returned by the request. 
     if (data.hasOwnProperty('versions')) {

diff --git a/src/common/middleware/content-negotiation/content-negotiation.middleware.ts b/src/common/middleware/content-negotiation/content-negotiation.middleware.ts
@@ -20,6 +20,11 @@ export class ContentNegotiationMiddleware implements NestMiddleware {
     // Get a hook into the request context so we can do logging
     const ctx: RequestContext = RequestContextModel.get();
 
+    // Do not enforce TAXII headers on health check endpoint
+    if (req.path == "/health/ping") {
+      return next();
+    }
+
     // Extract 'Accept' header
     const mediaType: string = req.headers["accept"];
 

diff --git a/src/config/interfaces/taxii-config.service.interface.ts b/src/config/interfaces/taxii-config.service.interface.ts
@@ -1,6 +1,6 @@
 export interface TaxiiConfigServiceInterface {
   createAppConnectOptions();
-  createCollectorConnectOptions();
+  createHydrateConnectOptions();
   createDatabaseConnectOptions();
   createStixConnectOptions();
   get APP_ADDRESS();

diff --git a/src/config/taxii-config.service.ts b/src/config/taxii-config.service.ts
@@ -6,8 +6,7 @@ import { StixConnectOptions } from "../stix/interfaces";
 import { isDefined } from "class-validator";
 import { AppConnectOptions } from "../interfaces";
 import { DatabaseConnectOptions } from "../interfaces/database-connect-options.interface";
-import { CollectorConnectOptions } from "../hydrate/collector/interfaces/collector-connect.options";
-
+import { HydrateConnectOptions } from "src/hydrate/interfaces/hydrate-connect.options";
 /**
  * This provider is responsible for loading all user-definable configuration parameters (imported from
  * environment variables) and making them available to all necessary app services
@@ -23,7 +22,7 @@ export class TaxiiConfigService implements TaxiiConfigServiceInterface {
     };
   }
 
-  createCollectorConnectOptions(): CollectorConnectOptions {
+  createHydrateConnectOptions(): HydrateConnectOptions {
     return {
       hydrateOnBoot: this.HYDRATE_ON_BOOT,
       ...this.createAppConnectOptions(),

diff --git a/src/hydrate.ts b/src/hydrate.ts
@@ -14,18 +14,12 @@ export async function bootstrap() {
     tempConfigApp.get(TaxiiConfigService);
 
   const app: NestApplication = await NestFactory.create(
-    HydrateModule.register(tempConfigService.createCollectorConnectOptions())
+    HydrateModule.register(tempConfigService.createHydrateConnectOptions())
   );
 
   // ** Initialize the Nest application ** //
   await app.init();
 
-  // Start the 'get-attack-objects' cron job to pre-populate the TAXII DB (MongoDB) with STIX
-  if (tempConfigService.HYDRATE_ON_BOOT) {
-    const provider = app.get(HydrateService);
-    await provider.hydrate();
-  }
-
   console.log(`Bootstrap process completed...cleaning up...`);
   await tempConfigApp.close();
 }

diff --git a/src/hydrate/collector/collector.module.ts b/src/hydrate/collector/collector.module.ts
diff --git a/src/hydrate/collector/constants.ts b/src/hydrate/collector/constants.ts
diff --git a/src/hydrate/collector/interfaces/collector-connect.options.ts b/src/hydrate/collector/interfaces/collector-connect.options.ts
diff --git a/src/hydrate/collector/providers/collection-collector.service.ts b/src/hydrate/collector/providers/collection-collector.service.ts
diff --git a/src/hydrate/collector/providers/object-collector.service.ts b/src/hydrate/collector/providers/object-collector.service.ts
diff --git a/src/hydrate/collector/schema/attack-object.schema.ts b/src/hydrate/collector/schema/attack-object.schema.ts
diff --git a/src/hydrate/collector/schema/taxii-collection.schema.ts b/src/hydrate/collector/schema/taxii-collection.schema.ts
diff --git a/src/hydrate/constants.ts b/src/hydrate/constants.ts
@@ -0,0 +1,2 @@
+export const GET_TAXII_RESOURCES_JOB_TOKEN = "GET_TAXII_RESOURCES";
+export const HYDRATE_OPTIONS_TOKEN = "HYDRATE_OPTIONS";
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export const GET_TAXII_RESOURCES_JOB_TOKEN = "GET_TAXII_RESOURCES";
		export const HYDRATE_OPTIONS_TOKEN = "HYDRATE_OPTIONS";