mihari 5.2.3 → 5.3.0

data/frontend/src/types.ts

@@ -0,0 +1,188 @@
+export interface Pagination {
+  total: number
+  currentPage: number
+  pageSize: number
+}
+
+export interface ConfigValue {
+  key: string
+  value: string | null
+}
+
+export interface Config {
+  name: string
+  isConfigured: boolean
+  values: ConfigValue[]
+  type: string
+}
+
+export interface Tag {
+  name: string
+}
+
+export interface Tags {
+  tags: string[]
+}
+
+export interface RuleSet {
+  ruleIds: string[]
+}
+
+export interface DnsRecord {
+  resource: string
+  value: string
+}
+
+export interface Contact {
+  name: string | null
+  organization: string | null
+}
+
+export interface Registrar {
+  name: string | null
+  organization: string | null
+}
+
+export interface WhoisRecord {
+  createdOn: Date | null
+  updatedOn: Date | null
+  expiresOn: Date | null
+  registrar: Registrar | null
+  contacts: Contact[]
+}
+
+export interface AutonomousSystem {
+  asn: number
+}
+
+export interface Geolocation {
+  country: string
+  countryCode: string
+}
+
+export interface ReverseDnsName {
+  name: string
+}
+
+export interface CPE {
+  cpe: string
+}
+
+export interface Port {
+  port: string
+}
+
+export interface Artifact {
+  id: string
+  data: string
+  dataType: string
+  source: string
+  metadata: unknown | null
+  createdAt: string
+
+  autonomousSystem: AutonomousSystem | null
+  whoisRecord: WhoisRecord | null
+  geolocation: Geolocation | null
+
+  dnsRecords: DnsRecord[] | null
+  reverseDnsNames: ReverseDnsName[] | null
+  cpes: CPE[] | null
+  ports: Port[] | null
+}
+
+export interface ArtifactWithTags extends Artifact {
+  tags: string[]
+}
+
+export interface Alert {
+  id: string
+  ruleId: string
+  createdAt: string
+
+  tags: Tag[]
+  artifacts: Artifact[]
+}
+
+export interface Alerts extends Pagination {
+  alerts: Alert[]
+}
+
+export interface PaginationParams {
+  page: number | undefined
+}
+
+export interface AlertSearchParams extends PaginationParams {
+  artifact: string | undefined
+  ruleId: string | undefined
+  tag: string | undefined
+  fromAt: string | undefined
+  toAt: string | undefined
+}
+
+export interface IPInfo {
+  ip: string
+  hostname: string | null
+  loc: string
+  countryCode: string
+  asn: string
+}
+
+export interface GCS {
+  lat: number
+  long: number
+}
+
+export interface Country {
+  name: string
+  code: string
+  lat: number
+  long: number
+}
+
+export type LinkType = "ip" | "domain" | "url" | "hash"
+
+export interface Link {
+  name: string
+  type: string
+  baseURL: string
+  // eslint-disable-next-line no-unused-vars
+  href(data: string): string
+  favicon(): string
+}
+
+export interface Rule {
+  id: string
+  title: string
+  description: string
+  yaml: string
+  createdAt: string
+  updatedAt: string
+  tags: Tag[]
+}
+
+export interface CreateRule {
+  yaml: string
+}
+
+export interface UpdateRule {
+  id: string
+  yaml: string
+}
+
+export interface Query {
+  analyzer: string
+  query: string
+  interval: null
+}
+
+export interface Rules extends Pagination {
+  rules: Rule[]
+}
+
+export interface RuleSearchParams extends PaginationParams {
+  description: string | undefined
+  tag: string | undefined
+  title: string | undefined
+  fromAt: string | undefined
+  toAt: string | undefined
+}

data/frontend/src/utils.ts

@@ -0,0 +1,54 @@
+import dayjs from "dayjs"
+import relativeTime from "dayjs/plugin/relativeTime"
+import timezone from "dayjs/plugin/timezone"
+import utc from "dayjs/plugin/utc"
+import type { LocationQueryValue } from "vue-router"
+
+import { getCountryByCode } from "@/countries"
+import type { GCS, IPInfo } from "@/types"
+
+dayjs.extend(relativeTime)
+dayjs.extend(timezone)
+dayjs.extend(utc)
+
+export function getLocalDatetime(datetime: string): string {
+  return dayjs(datetime).local().format("YYYY-MM-DD HH:mm:ss")
+}
+
+export function getHumanizedRelativeTime(datetime: string): string {
+  return dayjs(datetime).local().fromNow()
+}
+
+export function getGCSByCountryCode(countryCode: string): GCS | undefined {
+  const country = getCountryByCode(countryCode)
+  if (country !== undefined) {
+    return { lat: country.lat, long: country.long }
+  }
+}
+
+export function getGCSByIPInfo(ipinfo: IPInfo): GCS | undefined {
+  if (ipinfo.loc !== undefined) {
+    const numbers = ipinfo.loc.split(",")
+    if (numbers.length === 2) {
+      const lat = numbers[0]
+      const long = numbers[1]
+
+      return { lat: parseFloat(lat), long: parseFloat(long) }
+    }
+  }
+  return getGCSByCountryCode(ipinfo.countryCode)
+}
+
+export function normalizeQueryParam(
+  param: undefined | null | string | string[] | LocationQueryValue | LocationQueryValue[]
+): string | undefined {
+  if (param === undefined || param === null) {
+    return undefined
+  }
+
+  if (typeof param === "string") {
+    return param
+  }
+
+  return param.toString()
+}

data/frontend/src/views/Alerts.vue

@@ -0,0 +1,20 @@
+<template>
+  <Alerts></Alerts>
+</template>
+
+<script lang="ts">
+import { useTitle } from "@vueuse/core"
+import { defineComponent } from "vue"
+
+import Alerts from "@/components/alert/AlertsWrapper.vue"
+
+export default defineComponent({
+  name: "AlertsView",
+  components: {
+    Alerts
+  },
+  setup() {
+    useTitle("Alerts - Mihari")
+  }
+})
+</script>

data/frontend/src/views/Artifact.vue

@@ -0,0 +1,44 @@
+<template>
+  <Artifact :id="artifactId"></Artifact>
+</template>
+
+<script lang="ts">
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted, ref, watch } from "vue"
+
+import Artifact from "@/components/artifact/ArtifactWrapper.vue"
+
+export default defineComponent({
+  name: "ArtifactView",
+  components: {
+    Artifact
+  },
+  props: {
+    id: {
+      type: String,
+      required: true
+    }
+  },
+  setup(props) {
+    const artifactId = ref<string>(props.id)
+
+    const updateTitle = () => {
+      useTitle(`Artifact:${artifactId.value} - Mihari`)
+    }
+
+    onMounted(() => {
+      updateTitle()
+    })
+
+    watch(
+      () => props.id,
+      () => {
+        artifactId.value = props.id
+        updateTitle()
+      }
+    )
+
+    return { artifactId }
+  }
+})
+</script>

data/frontend/src/views/Configs.vue

@@ -0,0 +1,20 @@
+<template>
+  <Configs></Configs>
+</template>
+
+<script lang="ts">
+import { useTitle } from "@vueuse/core"
+import { defineComponent } from "vue"
+
+import Configs from "@/components/config/ConfigsWrapper.vue"
+
+export default defineComponent({
+  name: "ConfigView",
+  components: {
+    Configs
+  },
+  setup() {
+    useTitle("Config - Mihari")
+  }
+})
+</script>

data/frontend/src/views/EditRule.vue

@@ -0,0 +1,44 @@
+<template>
+  <EditRule :id="id"></EditRule>
+</template>
+
+<script lang="ts">
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted, ref, watch } from "vue"
+
+import EditRule from "@/components/rule/EditRuleWrapper.vue"
+
+export default defineComponent({
+  name: "EditRuleView",
+  components: {
+    EditRule
+  },
+  props: {
+    id: {
+      type: String,
+      required: true
+    }
+  },
+  setup(props) {
+    const ruleId = ref<string>(props.id)
+
+    const updateTitle = () => {
+      useTitle(`Edit rule:${ruleId.value} - Mihari`)
+    }
+
+    onMounted(() => {
+      updateTitle()
+    })
+
+    watch(
+      () => props.id,
+      () => {
+        ruleId.value = props.id
+        updateTitle()
+      }
+    )
+
+    return { ruleId }
+  }
+})
+</script>

data/frontend/src/views/NewRule.vue

@@ -0,0 +1,26 @@
+<template>
+  <NewRule></NewRule>
+</template>
+
+<script lang="ts">
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted } from "vue"
+
+import NewRule from "@/components/rule/NewRule.vue"
+
+export default defineComponent({
+  name: "NewRuleView",
+  components: {
+    NewRule
+  },
+  setup() {
+    const updateTitle = () => {
+      useTitle(`New rule - Mihari`)
+    }
+
+    onMounted(() => {
+      updateTitle()
+    })
+  }
+})
+</script>

data/frontend/src/views/Rule.vue

@@ -0,0 +1,44 @@
+<template>
+  <Rule :id="ruleId"></Rule>
+</template>
+
+<script lang="ts">
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted, ref, watch } from "vue"
+
+import Rule from "@/components/rule/RuleWrapper.vue"
+
+export default defineComponent({
+  name: "RuleView",
+  components: {
+    Rule
+  },
+  props: {
+    id: {
+      type: String,
+      required: true
+    }
+  },
+  setup(props) {
+    const ruleId = ref<string>(props.id)
+
+    const updateTitle = () => {
+      useTitle(`Rule:${ruleId.value} - Mihari`)
+    }
+
+    onMounted(() => {
+      updateTitle()
+    })
+
+    watch(
+      () => props.id,
+      () => {
+        ruleId.value = props.id
+        updateTitle()
+      }
+    )
+
+    return { ruleId }
+  }
+})
+</script>

data/frontend/src/views/Rules.vue

@@ -0,0 +1,20 @@
+<template>
+  <Rules></Rules>
+</template>
+
+<script lang="ts">
+import { useTitle } from "@vueuse/core"
+import { defineComponent } from "vue"
+
+import Rules from "@/components/rule/RulesWrapper.vue"
+
+export default defineComponent({
+  name: "RulesView",
+  components: {
+    Rules
+  },
+  setup() {
+    useTitle("Rules - Mihari")
+  }
+})
+</script>

data/frontend/tests/utils.spec.ts

@@ -0,0 +1,9 @@
+import { describe, expect, it } from 'vitest'
+
+import { getHumanizedRelativeTime } from '@/utils'
+
+describe('getHumanizedRelativeTime', () => {
+  it('returns a relative time in humanized format', () => {
+    expect(getHumanizedRelativeTime('1970-01-01 00:00:00')).toContain('years')
+  })
+})

data/frontend/tsconfig.app.json

@@ -0,0 +1,21 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": [
+    "env.d.ts",
+    "src/**/*",
+    "src/**/*.vue",
+    "tests/**/*"
+  ],
+  "exclude": [
+    "src/**/__tests__/*"
+  ],
+  "compilerOptions": {
+    "composite": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": [
+        "./src/*"
+      ]
+    }
+  }
+}

data/frontend/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    },
+    {
+      "path": "./tsconfig.app.json"
+    },
+    {
+      "path": "./tsconfig.vitest.json"
+    }
+  ]
+}

data/frontend/tsconfig.node.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@tsconfig/node20/tsconfig.json",
+  "include": [
+    "vite.config.*",
+  ],
+  "compilerOptions": {
+    "composite": true,
+    "module": "ESNext",
+    "types": [
+      "node"
+    ]
+  }
+}

data/frontend/tsconfig.vitest.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.app.json",
+  "exclude": [],
+  "compilerOptions": {
+    "composite": true,
+    "lib": [],
+    "types": [
+      "node",
+      "jsdom"
+    ]
+  }
+}

data/frontend/vite.config.ts

@@ -0,0 +1,24 @@
+import { fileURLToPath, URL } from "node:url"
+
+import vue from "@vitejs/plugin-vue"
+import { defineConfig } from "vite"
+
+const env = process.env
+const target = env.BACKEND_URL || "http://localhost:9292/"
+const port = parseInt(env.port || "8080")
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [vue()],
+  server: {
+    port,
+    proxy: {
+      "/api": target
+    }
+  },
+  resolve: {
+    alias: {
+      "@": fileURLToPath(new URL("./src", import.meta.url))
+    }
+  }
+})

data/frontend/vitest.config.ts

@@ -0,0 +1,21 @@
+import { fileURLToPath } from "node:url"
+
+import { mergeConfig } from "vite"
+import { configDefaults, defineConfig } from "vitest/config"
+
+import viteConfig from "./vite.config"
+
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      environment: "jsdom",
+      exclude: [...configDefaults.exclude, "e2e/*"],
+      root: fileURLToPath(new URL("./", import.meta.url)),
+      transformMode: {
+        web: [/\.[jt]sx$/]
+      },
+      include: ["**/__tests__/**/*.?(c|m)[jt]s?(x)", "**/?(*.){test,spec}.?(c|m)[jt]s?(x)"]
+    }
+  })
+)

data/lefthook.yml

@@ -0,0 +1,12 @@
+pre-commit:
+  parallel: true
+  commands:
+    standard:
+      glob: "*.rb"
+      run: bundle exec standardrb --fix {staged_files}
+      stage_fixed: true
+    eslint:
+      root: "frontend/"
+      glob: "*.{js,ts,vue}"
+      run: npx eslint --fix {staged_files}
+      stage_fixed: true