(feature) List source of API Keys

Author: AHarmlessPyro

backend/src/api/keys/index.ts

@@ -2,6 +2,7 @@ import ApiResponseHandler from "api-response-handler"
 import { Request, Response } from "express"
 import { AppDataSource } from "data-source"
 import { ApiKey } from "models"
+import { ApiKey as ApiKeyType } from "@common/types"
 import Error404NotFound from "errors/error-404-not-found"
 import { createApiKey } from "./service"
 import Error400BadRequest from "errors/error-400-bad-request"
@@ -10,10 +11,11 @@ export const listKeys = async (req: Request, res: Response): Promise<void> => {
   const keys = await AppDataSource.getRepository(ApiKey).find()
   return ApiResponseHandler.success(
     res,
-    keys.map(v => ({
+    keys.map<ApiKeyType>(v => ({
       name: v.name,
       identifier: `metlo.${v.keyIdentifier}`,
-      created: v.createdAt
+      created: v.createdAt.toISOString(),
+      for: v.for
     })),
   )
 }
@@ -41,7 +43,8 @@ export const createKey = async (req: Request, res: Response): Promise<void> => {
     apiKey: rawKey,
     name: key.name,
     identifier: `metlo.${key.keyIdentifier}`,
-    created: key.createdAt
+    created: key.createdAt.toISOString(),
+    for: key.for
   })
 }
 

backend/src/api/keys/service.ts

@@ -3,6 +3,9 @@ import { ApiKey } from "models"
 import { hasher } from "utils/hash"
 
 export const createApiKey = (keyName: string): [ApiKey, string] => {
+  /**
+   * Generate a Generic API Key by default. If needed for AWS/GCP, modify the `for` attribute in the key object
+   */
   const buf = Buffer.alloc(30)
   const key = crypto.randomFillSync(buf)
   const b64Key = key.toString("base64")

backend/src/suricata_setup/gcp-services/gcp_setup.ts

@@ -1,5 +1,5 @@
 import { MachineSpecifications, STEP_RESPONSE } from "@common/types"
-import { ConnectionType, GCP_SOURCE_TYPE, GCP_STEPS } from "@common/enums"
+import { API_KEY_TYPE, ConnectionType, GCP_SOURCE_TYPE, GCP_STEPS } from "@common/enums"
 import { GCP_CONN } from "./gcp_apis"
 import AsyncRetry from "async-retry"
 import { promisify } from "util"
@@ -839,6 +839,7 @@ export async function push_files({
   const endpoint = "api/v1/log-request/single"
   const instance_name = instance_url.split("/").at(-1)
   let [key, raw] = createApiKey(`Metlo-collector-${id}`)
+  key.for = API_KEY_TYPE.GCP
   let api_key = await AppDataSource.getRepository(ApiKey).save(key)
 
   try {
@@ -869,11 +870,11 @@ export async function push_files({
 
     const fileMap = [
       path.normalize(`${__dirname}/../generics/scripts/install.sh`) +
-        ` ${instance_name}:~/install.sh`,
+      ` ${instance_name}:~/install.sh`,
       path.normalize(`${__dirname}/../generics/scripts/install-deps.sh`) +
-        ` ${instance_name}:~/install-deps.sh`,
+      ` ${instance_name}:~/install-deps.sh`,
       path.normalize(`${__dirname}/../generics/scripts/suricata.yaml`) +
-        ` ${instance_name}:~/suricata.yaml`,
+      ` ${instance_name}:~/suricata.yaml`,
       filepath_rules_out + ` ${instance_name}:"~/local.rules"`,
       filepath_ingestor_out + ` ${instance_name}:~/metlo-ingestor.service`,
     ]

backend/src/suricata_setup/ssh-services/index.ts

@@ -1,4 +1,4 @@
-import { ConnectionType } from "@common/enums"
+import { API_KEY_TYPE, ConnectionType } from "@common/enums"
 import { STEP_RESPONSE } from "@common/types"
 import { createApiKey } from "api/keys/service"
 import { randomUUID } from "crypto"
@@ -69,6 +69,7 @@ export async function push_files({
   const endpoint = "api/v1/log-request/single"
   let conn = new SSH_CONN(keypair, remote_machine_url, username)
   let [key, raw] = createApiKey(`Metlo-collector-${id}`)
+  key.for = API_KEY_TYPE.AWS
   let api_key = await AppDataSource.getRepository(ApiKey).save(key)
   try {
     let filepath_ingestor = `${__dirname}/../generics/scripts/metlo-ingestor-${randomUUID()}.service`

common/src/types.ts

@@ -17,6 +17,7 @@ import {
   GCP_SOURCE_TYPE,
   AuthType,
   AttackType,
+  API_KEY_TYPE,
 } from "./enums"
 import { Test, Request as TestRequest } from "@metlo/testing"
 import "axios"
@@ -491,4 +492,5 @@ export interface ApiKey {
   name: string
   identifier: string
   created: string
+  for: API_KEY_TYPE
 }

frontend/src/components/Keys/list.tsx

@@ -1,4 +1,4 @@
-import { Button, useColorMode } from "@chakra-ui/react"
+import { Badge, Box, Button, useColorMode } from "@chakra-ui/react"
 import { ApiKey } from "@common/types"
 import { deleteKey } from "api/keys"
 import EmptyView from "components/utils/EmptyView"
@@ -29,7 +29,7 @@ const ListKeys: React.FC<ListKeysInterface> = ({ keys, setKeys }) => {
   let columns: Array<TableColumn<ApiKey>> = [
     {
       name: "Name",
-      sortable: false,
+      sortable: true,
       selector: (row: ApiKey) => row.name,
       cell: (row: ApiKey) => row.name,
       id: "name",
@@ -49,6 +49,12 @@ const ListKeys: React.FC<ListKeysInterface> = ({ keys, setKeys }) => {
         DateTime.fromISO(row.created).toFormat("yyyy-MM-dd"),
       id: "created_at",
     },
+    {
+      name: "Key Used For",
+      sortable: false,
+      selector: (row: ApiKey) => row.for,
+      cell: (row: ApiKey) => <Badge fontFamily={"mono"}>{row.for}</Badge>,
+    },
     {
       name: "",
       sortable: false,