@cccsaurora/howler-ui 2.12.0-dev.30

package/dist/models/entities/generated/Url.d.ts

@@ -0,0 +1,19 @@
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface Url {
+    domain?: string;
+    extension?: string;
+    fragment?: string;
+    full?: string;
+    original?: string;
+    password?: string;
+    path?: string;
+    port?: number;
+    query?: string;
+    registered_domain?: string;
+    scheme?: string;
+    subdomain?: string;
+    top_level_domain?: string;
+    username?: string;
+}

package/dist/models/entities/generated/Url.js

@@ -0,0 +1 @@
+export {};

package/dist/models/entities/generated/User.d.ts

@@ -0,0 +1,14 @@
+import type { Group } from './Group';
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface User {
+    domain?: string;
+    email?: string;
+    full_name?: string;
+    group?: Group;
+    hash?: string;
+    id?: string;
+    name?: string;
+    roles?: string[];
+}

package/dist/models/entities/generated/User.js

@@ -0,0 +1 @@
+export {};

package/dist/models/entities/generated/UserAgent.d.ts

@@ -0,0 +1,12 @@
+import type { Device } from './Device';
+import type { Os } from './Os';
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface UserAgent {
+    device?: Device;
+    name?: string;
+    original?: string;
+    os?: Os;
+    version?: string;
+}

package/dist/models/entities/generated/UserAgent.js

@@ -0,0 +1 @@
+export {};

package/dist/models/entities/generated/UserUser.d.ts

@@ -0,0 +1,18 @@
+import type { Dashboard } from './Dashboard';
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface UserUser {
+    api_quota?: number;
+    classification?: string;
+    dashboard?: Dashboard;
+    email?: string;
+    favourite_analytics?: string[];
+    favourite_views?: string[];
+    groups?: string[];
+    is_active?: boolean;
+    name?: string;
+    password?: string;
+    type?: string[];
+    uname?: string;
+}

package/dist/models/entities/generated/UserUser.js

@@ -0,0 +1 @@
+export {};

package/dist/models/entities/generated/View.d.ts

@@ -0,0 +1,14 @@
+import type { Settings } from './Settings';
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface View {
+    owner?: string;
+    query?: string;
+    settings?: Settings;
+    sort?: string;
+    span?: string;
+    title?: string;
+    type?: string;
+    view_id?: string;
+}

package/dist/models/entities/generated/View.js

@@ -0,0 +1 @@
+export {};

package/dist/models/entities/generated/Votes.d.ts

@@ -0,0 +1,8 @@
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface Votes {
+    benign?: string[];
+    malicious?: string[];
+    obscure?: string[];
+}

package/dist/models/entities/generated/Votes.js

@@ -0,0 +1 @@
+export {};

package/dist/models/entities/generated/Vulnerability.d.ts

@@ -0,0 +1,12 @@
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface Vulnerability {
+    category?: string[];
+    classification?: string;
+    description?: string;
+    enumeration?: string;
+    id?: string;
+    reference?: string;
+    report_id?: string;
+}

package/dist/models/entities/generated/Vulnerability.js

@@ -0,0 +1 @@
+export {};

package/dist/models/entities/generated/Yara.d.ts

@@ -0,0 +1,9 @@
+/**
+ * NOTE: This is an auto-generated file. Don't edit this manually.
+ */
+export interface Yara {
+    subtype?: string;
+    type?: string;
+    value?: string;
+    verdict?: string;
+}

package/dist/models/entities/generated/Yara.js

@@ -0,0 +1 @@
+export {};

package/dist/models/socket/HitUpdate.d.ts

@@ -0,0 +1,12 @@
+import type { Hit } from 'models/entities/generated/Hit';
+export interface HitUpdate {
+    version: string;
+    hit: Hit;
+}
+export interface SocketEvent {
+    event: {
+        id: string;
+        action: string;
+        username: string;
+    };
+}

package/dist/models/socket/HitUpdate.js

@@ -0,0 +1 @@
+export {};

package/dist/plugins/HowlerPlugin.d.ts

@@ -0,0 +1,45 @@
+import type { HowlerHelper } from 'components/elements/display/handlebars/helpers';
+import type { ActionButton } from 'components/elements/hit/actions/SharedComponents';
+import type { StatusProps } from 'components/elements/hit/HitBanner';
+import type { PivotLinkProps } from 'components/elements/hit/related/PivotLink';
+import type { PluginChipProps } from 'components/elements/PluginChip';
+import type { PluginTypographyProps } from 'components/elements/PluginTypography';
+import type { CustomActionProps } from 'components/routes/action/edit/ActionEditor';
+import type { LeadFormProps } from 'components/routes/dossiers/LeadEditor';
+import type { PivotFormProps } from 'components/routes/dossiers/PivotForm';
+import type { PluginDocumentation } from 'components/routes/help/ActionDocumentation';
+import type { i18n as I18N } from 'i18next';
+import type { Hit } from 'models/entities/generated/Hit';
+import type React from 'react';
+import type { PropsWithChildren } from 'react';
+import type { IPlugin, PluginStore } from 'react-pluggable';
+declare abstract class HowlerPlugin implements IPlugin {
+    abstract name: string;
+    abstract version: string;
+    abstract author: string;
+    abstract description: string;
+    pluginStore: PluginStore;
+    private functionsToRemove;
+    getPluginName(): string;
+    getDependencies(): string[];
+    init(pluginStore: PluginStore): void;
+    activate(): void;
+    deactivate(): void;
+    addLead(format: string, form: (props: LeadFormProps) => React.ReactNode, renderer: (content: string, metadata: any) => React.ReactNode): void;
+    addPivot(format: string, form: (props: PivotFormProps) => React.ReactNode, renderer: (props: PivotLinkProps) => React.ReactNode): void;
+    addOperation(format: string, form: (props: CustomActionProps) => React.ReactNode, documentation: PluginDocumentation): void;
+    on(_event: string, _hit: Hit): any;
+    provider(): React.FC<PropsWithChildren<{}>> | null;
+    setup(): void;
+    localization(_i18n: I18N): void;
+    helpers(): HowlerHelper[];
+    typography(_props: PluginTypographyProps): any;
+    chip(_props: PluginChipProps): any;
+    actions(_hits: Hit[]): ActionButton[];
+    status(_props: StatusProps): React.ReactNode;
+    support(): React.ReactNode;
+    help(): React.ReactNode;
+    settings(_section: 'admin' | 'local' | 'profile' | 'security'): React.ReactNode;
+    integrations(): [string, () => React.ReactNode][];
+}
+export default HowlerPlugin;

package/dist/plugins/HowlerPlugin.js

@@ -0,0 +1,111 @@
+import i18nInstance from 'i18n';
+import { difference } from 'lodash-es';
+import howlerPluginStore from './store';
+const INTERNAL_FUNCTIONS = [
+    'constructor',
+    'getPluginName',
+    'getDependencies',
+    'init',
+    'activate',
+    'deactivate',
+    'addLead'
+];
+class HowlerPlugin {
+    pluginStore;
+    functionsToRemove = [];
+    getPluginName() {
+        return `${this.name}@${this.version}`;
+    }
+    getDependencies() {
+        return [];
+    }
+    init(pluginStore) {
+        this.pluginStore = pluginStore;
+    }
+    activate() {
+        difference(Object.getOwnPropertyNames(HowlerPlugin.prototype), INTERNAL_FUNCTIONS).forEach(_function => {
+            this.pluginStore.addFunction(`${this.name}.${_function}`, this[_function]);
+            this.functionsToRemove.push(`${this.name}.${_function}`);
+        });
+        this.localization(i18nInstance);
+    }
+    deactivate() {
+        difference(Object.getOwnPropertyNames(HowlerPlugin.prototype), INTERNAL_FUNCTIONS).forEach(_function => this.pluginStore.removeFunction(`${this.name}.${_function}`));
+        this.functionsToRemove.forEach(name => this.pluginStore.removeFunction(name));
+    }
+    addLead(format, form, renderer) {
+        if (!howlerPluginStore.addLead(format)) {
+            // eslint-disable-next-line no-console
+            console.error(`Lead format ${format} already configured, not enabling for plugin ${this.getPluginName()}`);
+            return;
+        }
+        this.pluginStore.addFunction(`lead.${format}`, renderer);
+        this.functionsToRemove.push(`lead.${format}`);
+        this.pluginStore.addFunction(`lead.${format}.form`, form);
+        this.functionsToRemove.push(`lead.${format}.form`);
+        // eslint-disable-next-line no-console
+        console.debug(`Lead format ${format} enabled for plugin ${this.getPluginName()}`);
+    }
+    addPivot(format, form, renderer) {
+        if (!howlerPluginStore.addPivot(format)) {
+            // eslint-disable-next-line no-console
+            console.error(`Pivot format ${format} already configured, not enabling for plugin ${this.getPluginName()}`);
+            return;
+        }
+        this.pluginStore.addFunction(`pivot.${format}`, renderer);
+        this.functionsToRemove.push(`pivot.${format}`);
+        this.pluginStore.addFunction(`pivot.${format}.form`, form);
+        this.functionsToRemove.push(`pivot.${format}.form`);
+        // eslint-disable-next-line no-console
+        console.debug(`Pivot format ${format} enabled for plugin ${this.getPluginName()}`);
+    }
+    addOperation(format, form, documentation) {
+        if (!howlerPluginStore.addOperation(format)) {
+            // eslint-disable-next-line no-console
+            console.error(`Operation ${format} already configured, not enabling for plugin ${this.getPluginName()}`);
+            return;
+        }
+        this.pluginStore.addFunction(`operation.${format}`, form);
+        this.functionsToRemove.push(`operation.${format}`);
+        this.pluginStore.addFunction(`operation.${format}.documentation`, () => documentation);
+        this.functionsToRemove.push(`operation.${format}.documentation`);
+        // eslint-disable-next-line no-console
+        console.debug(`Operation ${format} enabled for plugin ${this.getPluginName()}`);
+    }
+    on(_event, _hit) {
+        return null;
+    }
+    provider() {
+        return null;
+    }
+    setup() { }
+    localization(_i18n) { }
+    helpers() {
+        return [];
+    }
+    typography(_props) {
+        return null;
+    }
+    chip(_props) {
+        return null;
+    }
+    actions(_hits) {
+        return [];
+    }
+    status(_props) {
+        return null;
+    }
+    support() {
+        return null;
+    }
+    help() {
+        return null;
+    }
+    settings(_section) {
+        return null;
+    }
+    integrations() {
+        return [];
+    }
+}
+export default HowlerPlugin;

package/dist/plugins/store.d.ts

@@ -0,0 +1,23 @@
+import type { Hit } from 'models/entities/generated/Hit';
+import { Event } from 'react-pluggable';
+import type HowlerPlugin from './HowlerPlugin';
+export declare class HitEvent extends Event {
+    hit: Hit;
+    constructor(type: string, hit: Hit);
+}
+declare class HowlerPluginStore {
+    pluginStore: import("react-pluggable").PluginStore;
+    plugins: string[];
+    private _leadFormats;
+    private _pivotFormats;
+    private _operations;
+    install(plugin: HowlerPlugin): void;
+    addLead(format: string): boolean;
+    addPivot(format: string): boolean;
+    addOperation(format: string): boolean;
+    get leadFormats(): string[];
+    get pivotFormats(): string[];
+    get operations(): string[];
+}
+declare const howlerPluginStore: HowlerPluginStore;
+export default howlerPluginStore;

package/dist/plugins/store.js

@@ -0,0 +1,52 @@
+import { createPluginStore, Event } from 'react-pluggable';
+export class HitEvent extends Event {
+    hit;
+    constructor(type, hit) {
+        super(type);
+        this.hit = hit;
+    }
+}
+class HowlerPluginStore {
+    pluginStore = createPluginStore();
+    plugins = [];
+    _leadFormats = [];
+    _pivotFormats = [];
+    _operations = [];
+    install(plugin) {
+        console.log(`Installing plugin ${plugin.getPluginName()} by ${plugin.author}`);
+        this.plugins.push(plugin.name);
+        this.pluginStore.install(plugin);
+    }
+    addLead(format) {
+        if (this._leadFormats.includes(format)) {
+            return false;
+        }
+        this._leadFormats.push(format);
+        return true;
+    }
+    addPivot(format) {
+        if (this._pivotFormats.includes(format)) {
+            return false;
+        }
+        this._pivotFormats.push(format);
+        return true;
+    }
+    addOperation(format) {
+        if (this._operations.includes(format)) {
+            return false;
+        }
+        this._operations.push(format);
+        return true;
+    }
+    get leadFormats() {
+        return this._leadFormats;
+    }
+    get pivotFormats() {
+        return this._pivotFormats;
+    }
+    get operations() {
+        return this._operations;
+    }
+}
+const howlerPluginStore = new HowlerPluginStore();
+export default howlerPluginStore;

package/dist/rest/AxiosClient.d.ts

@@ -0,0 +1,10 @@
+import type { HowlerResponse } from 'api';
+import type RestClient from 'rest';
+export default class AxiosClient implements RestClient {
+    private cache;
+    private client;
+    constructor();
+    fetch<R>(url: string, method?: 'get' | 'post' | 'put' | 'delete' | 'patch', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<[HowlerResponse<R>, number, {
+        [index: string]: any;
+    }]>;
+}

package/dist/rest/AxiosClient.js

@@ -0,0 +1,60 @@
+import axios, { AxiosError } from 'axios';
+import axiosRetry, { exponentialDelay, isNetworkError } from 'axios-retry';
+import { getAxiosCache, setAxiosCache } from 'utils/sessionStorage';
+class AxiosCache {
+    constructor(_axios) {
+        _axios.interceptors.response.use(async (res) => {
+            const cache = getAxiosCache();
+            if (res.status >= 200 && res.status < 300 && res.headers.etag) {
+                setAxiosCache(res.headers.etag, res.data);
+            }
+            if (res.status === 304) {
+                const etag = res.config.headers['If-Match'];
+                if (etag) {
+                    res.data = cache[etag];
+                }
+            }
+            return res;
+        });
+    }
+}
+export default class AxiosClient {
+    // @ts-ignore
+    cache;
+    client;
+    constructor() {
+        this.client = axios.create({
+            validateStatus: status => (status >= 200 && status < 300) || status === 304
+        });
+        this.cache = new AxiosCache(this.client);
+        axiosRetry(this.client, {
+            retries: 3,
+            retryCondition: err => {
+                return (
+                // Don't retry 502s, as we assume the server handles retries in those cases
+                isNetworkError(err) || (err?.response?.status >= 500 && err?.response?.status !== 502));
+            },
+            retryDelay: exponentialDelay
+        });
+    }
+    async fetch(url, method = 'get', body, params, headers) {
+        const config = {
+            url,
+            params,
+            method,
+            withCredentials: true,
+            data: JSON.stringify(body),
+            headers: headers
+        };
+        try {
+            const response = await this.client(config);
+            return [response.data, response.status, response.headers];
+        }
+        catch (e) {
+            if (e instanceof AxiosError && e.response?.data) {
+                return [e.response.data, e.response.status, e.response.headers];
+            }
+            throw e;
+        }
+    }
+}

package/dist/rest/FetchClient.d.ts

@@ -0,0 +1,7 @@
+import type { HowlerResponse } from 'api';
+import type RestClient from 'rest';
+export default class FetchClient implements RestClient {
+    fetch<R>(url: string, method?: 'get' | 'post' | 'put' | 'delete', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<[HowlerResponse<R>, number, {
+        [index: string]: any;
+    }]>;
+}

package/dist/rest/FetchClient.js

@@ -0,0 +1,16 @@
+export default class FetchClient {
+    async fetch(url, method = 'get', body, params, headers) {
+        const _url = `${url}${params ? `?${params.toString()}` : ''}`;
+        const response = await fetch(_url, {
+            method,
+            credentials: 'same-origin',
+            headers: headers,
+            body: body ? JSON.stringify(body) : null
+        });
+        if (response.status === 204) {
+            return null;
+        }
+        const json = (await response.json());
+        return [json, response.status, response.headers];
+    }
+}

package/dist/rest/index.d.ts

@@ -0,0 +1,6 @@
+import type { HowlerResponse } from 'api';
+export default interface RestClient {
+    fetch<R>(url: string, method: 'get' | 'post' | 'put' | 'delete', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<[HowlerResponse<R>, number, {
+        [index: string]: any;
+    }]>;
+}

package/dist/rest/index.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/Throttler.d.ts

@@ -0,0 +1,9 @@
+export default class Throttler {
+    private throttleId;
+    private delayId;
+    private msec;
+    constructor(msec: number);
+    throttle(fn: () => void): void;
+    debounce(fn: () => void): void;
+    delayAsync(fn: (...args: any[]) => Promise<any>, ...args: any[]): Promise<any>;
+}

package/dist/utils/Throttler.js

@@ -0,0 +1,38 @@
+export default class Throttler {
+    throttleId = null;
+    delayId = null;
+    msec = null;
+    constructor(msec) {
+        this.msec = msec;
+        this.debounce = this.debounce.bind(this);
+    }
+    throttle(fn) {
+        if (!this.throttleId) {
+            fn();
+            this.throttleId = setTimeout(() => {
+                this.throttleId = null;
+            }, this.msec);
+        }
+    }
+    debounce(fn) {
+        if (this.delayId) {
+            clearTimeout(this.delayId);
+        }
+        this.delayId = setTimeout(fn, this.msec);
+    }
+    delayAsync(fn, ...args) {
+        if (this.delayId) {
+            clearTimeout(this.delayId);
+        }
+        return new Promise((resolve, reject) => {
+            this.delayId = setTimeout(async () => {
+                try {
+                    resolve(await fn?.(...args));
+                }
+                catch (error) {
+                    reject(error);
+                }
+            }, this.msec);
+        });
+    }
+}

package/dist/utils/actionUtils.d.ts

@@ -0,0 +1,31 @@
+import type { ActionOperation, ActionOperationStep } from 'models/ActionTypes';
+import type { Operation } from 'models/entities/generated/Operation';
+/**
+ * A simple validation function to ensure we have all the necessary arguments filled out.
+ * @param step The step to validate
+ * @param values The context to validate on
+ * @returns whether all the necessary arguments have been filled in the given step
+ */
+export declare const checkArgsAreFilled: (step: ActionOperationStep, values: string) => boolean;
+/**
+ * Take the raw options object as specified by the server and get a list of usable options, filtered using the current values suppled for the action entry.
+ * @param options The raw list of options from the server
+ * @param arg The argument for which we are parsing options
+ * @param context The values provided so far by the user
+ * @returns a list of options matching the current context
+ */
+export declare const getOptionsByContext: (options: ActionOperationStep["options"], arg: string, context: string) => string[];
+/**
+ * Get a list of arguments to display based on the current context, using the current values supplied for the action entry.
+ * @param args a complete list of all arguments in the action
+ * @param values the current list of values provided by the user
+ * @returns A list of arguments to display
+ */
+export declare const getArgsByContext: (args: ActionOperationStep["args"], values: string) => string[];
+/**
+ * Check to see if a given action has all the data necessary to execute successfully
+ * @param data The user-provided data
+ * @param action The action to validate
+ * @returns whether the action is ready to execute
+ */
+export declare const operationReady: (data: Operation["data_json"], action: ActionOperation) => boolean;