@cccsaurora/howler-ui 2.14.0-dev.263 → 2.14.0-dev.264

package/components/routes/help/AuthDocumentation.js

@@ -1,20 +0,0 @@
-import { jsx } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import PageCenter from "../../../commons/components/pages/PageCenter.js";
-import Markdown from "../../elements/display/Markdown.js";
-import { useScrollRestoration } from "../../hooks/useScrollRestoration.js";
-import { useMemo } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/index.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-const AUTH_EN = '<!-- docs/ingestion/authentication.md -->\n\n# Howler Authentication\n\nHowler\'s API supports a number of authentication approaches when accessing the API. This document will outline the\ndifferent approaches, and explain how to use each of them.\n\n## Types of Authentication\n\nThere are four methods of authentication one can use to connect to the howler API:\n\n1. Username and Password\n2. Username and API Key\n3. Username and app token (after login)\n4. OAuth Access Token\n\nWe will outline the use case for each authentication type next.\n\n### Username/Password Authentication\n\nUsername and password authentication is the simplest and least secure method of authentication. Unlikely to be enabled\nin a production environment, it allows users to easily connect to the Howler API and make changes as the given user,\nwithout having to worry about creating API keys or using an OAuth provider like Keycloak or Azure. Users can connect\nusing username and password authentication in one of two ways:\n\n#### Direct Call to the Requisite Endpoint (Password)\n\nThis is far and away the simplest method. Simply add a basic Authorization header to the HTTP request you want to\nmake, and everything is taken care of:\n\n```bash\necho -n "user:user" | base64 -w0\n# -> dXNlcjp1c2Vy\n```\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Basic dXNlcjp1c2Vy\n```\n\n#### Exchanging for an App Token (Password)\n\nThis is a slightly more complex approach, but carries the benefit of not exposing the username and password on every\nrequest. You can leverage the `v1/auth/login` endpoint to exchange your username and password for an app token. The\ntoken works similarly to an OAuth access token - you provide it with each subsequent request, and it authenticates you\nuntil the token expires.\n\n```http\nPOST $CURRENT_URL/api/v1/auth/login/\nContent-Type: application/json\n\n{\n  "user": "user",\n  "password": "user"\n}\n```\n\nWill return something like:\n\n```json\n{\n  "api_error_message": "",\n  "api_response": {\n    "app_token": "user:5791a142067745c3af51d6596da7da8f86357a9fa92ad78d1ce118ea7d89d34e",\n    "provider": null,\n    "refresh_token": null\n  },\n  "api_server_version": "0.0.0.dev0",\n  "api_status_code": 200\n}\n```\n\nUsing this token in another API call:\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Bearer user:5791a142067745c3af51d6596da7da8f86357a9fa92ad78d1ce118ea7d89d34e\n```\n\n### Username/API Key Authentication\n\nThe username and API Key authentication works largely the same as username/password from the perspective of the client.\nOn the server side, however, API keys have several key advantages. Firstly, they can easily be revoked by the user.\nSecondly, their privileges can be limited, allowing only a subset of permissions.\n\nThere are two methods of authentication, mirroring the username and password:\n\n#### Direct Call to the Requisite Endpoint (API Key)\n\nSimply add a basic Authorization header containing the username and API key to the HTTP request you want to make, and\neverything is taken care of:\n\n```bash\n# note the format is <username>:<apikeyname>:<secret>\necho -n "user:devkey:user" | base64 -w0\n# -> dXNlcjpkZXZrZXk6dXNlcg==\n```\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Basic dXNlcjpkZXZrZXk6dXNlcg==\n```\n\n#### Exchanging for an App Token (API Key)\n\nYou can also leverage the `v1/auth/login` endpoint to exchange your username and API key for an app token. The\ntoken works similarly to an OAuth access token - you provide it with each subsequent request, and it authenticates you\nuntil the token expires.\n\n```http\nPOST $CURRENT_URL/api/v1/auth/login/\nContent-Type: application/json\n\n{\n  "user": "user",\n  "apikey": "devkey:user"\n}\n```\n\nWill return something like:\n\n```json\n{\n  "api_error_message": "",\n  "api_response": {\n    "app_token": "user:f220eb76ff8404abfece8c0c2f3368c7d89618c776bedcd3a506843dc4a952e4",\n    "provider": null,\n    "refresh_token": null\n  },\n  "api_server_version": "0.0.0.dev0",\n  "api_status_code": 200\n}\n```\n\nUsing this token in another API call:\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Bearer user:f220eb76ff8404abfece8c0c2f3368c7d89618c776bedcd3a506843dc4a952e4\n```\n\nNote that when logging in using an api key, the permissions of the api key continue to apply. So if you try and access\nan endpoint that requires the "write" permission with an API key that only has read permission, this will cause a 403\nForbidden error.\n\n### Access Token Authentication\n\nIn addition to the authentication methods provided internally by Howler, you can also authenticate with an external\nOAuth provider like Azure or Keycloak. To do this, you must obtain an access token from one of these providers. In\norder to get an access token, there are generally two flows - On-Behalf-Of, or the user login flow (see [here](https://www.rfc-editor.org/rfc/rfc6749#section-4.1) for a rundown\nof that). In the case of Howler, the `v1/auth/login` endpoint is used for step D & E in the linked user login flow, and\nit returns the following:\n\n```json\n{\n  "api_response": {\n    "app_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyIn0",\n    "provider": "keycloak",\n    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJyZWZyZXNoIn0"\n  }\n}\n```\n\nIn this case, the `app_token` is the JSON Web Token the application uses as an access token. Similarly, the\n`refresh_token` is another JWT that is used to refresh the access token if needed. Finally, the `provider` field\noutlines which provider this access token corresponds to.\n\nOnce you have that access token, you can simply pass it along in the Authorization header:\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyIn0\n```\n\nHowler will automatically detect this is a JWT, and treat it as such. If the token is valid, the user will be\nauthenticated.\n\nIn order to refresh an expired access token, you can use the following API call:\n\n```http\nPOST $CURRENT_URL/api/v1/auth/login/\nContent-Type: application/json\n\n{\n  "oauth_provider": "keycloak",\n  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJyZWZyZXNoIn0"\n}\n```\n\nAnd you\'ll get something like this back:\n\n```json\n{\n  "api_response": {\n    "app_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMiJ9",\n    "provider": "keycloak",\n    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJyZWZyZXNodG9rZW4yIn0"\n  }\n}\n```\n\n## Impersonation\n\nThe final important bit of the authentication flow is the impersonation functionality. In order for a service account\nor other user to impersonate you (i.e. to create alerts on your behalf), Howler allows users to provide a second API key\nin order to authenticate as another user.\n\nBefore you use another user\'s API key to authenticate as them, it\'s important that the API key you\'re using has been\nmarked as valid for impersonation - check with the user that provided it. If it has, you can use it by, formating your\nrequest as follows:\n\n```bash\n# Your credentials\necho -n "admin:devkey:admin" | base64 -w0\n# -> YWRtaW46ZGV2a2V5OmFkbWlu\n\n# Their credentials\necho -n "user:impersonate_admin:user" | base64 -w0\n# -> dXNlcjppbXBlcnNvbmF0ZV9hZG1pbjp1c2Vy\n```\n\n```alert\nAny form of authentication can be used by the impersonator, but validated API keys are the only permitted\nauthentication method for the person you\'re impersonating.\n```\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Basic YWRtaW46ZGV2a2V5OmFkbWlu\nX-Impersonating: Basic dXNlcjppbXBlcnNvbmF0ZV9hZG1pbjp1c2Vy\n```\n\nIf set up correctly, the result will look like:\n\n```json\n{\n  "api_error_message": "",\n  "api_response": {\n    "avatar": null,\n    "classification": "TLP:W",\n    "email": "user@howler.cyber.gc.ca",\n    "groups": ["USERS"],\n    "is_active": true,\n    "is_admin": false,\n    "name": "User",\n    "roles": ["user"],\n    "username": "user"\n  },\n  "api_server_version": "0.0.0.dev0",\n  "api_status_code": 200\n}\n```\n\nNote that the server returned this as if you were `user`, NOT `admin`. It is clearly marked in the logs, however, that you are making the request:\n\n```log\n22/12/05 14:15:02 INFO howler.api.security | Authenticating user for path /api/v1/user/whoami/\n22/12/05 14:15:03 WARNING howler.api.security | admin is impersonating user\n22/12/05 14:15:03 INFO howler.api.security | Logged in as user from 127.0.0.1\n22/12/05 14:15:03 INFO howler.api | GET /api/v1/user/whoami/ - 200\n```\n';
-const AUTH_FR = '<!-- docs/ingestion/authentication.fr.md -->\n\n# Authentification de Howler\n\nL\'API de Howler prend en charge un certain nombre d\'approches d\'authentification lors de l\'accès à l\'API. Ce document présente les\ndifférentes approches et explique comment utiliser chacune d\'entre elles.\n\n## Types d\'authentification\n\nIl existe quatre méthodes d\'authentification que l\'on peut utiliser pour se connecter à l\'API howler:\n\n1. Nom d\'utilisateur et mot de passe\n2. Nom d\'utilisateur et clé API\n3. Nom d\'utilisateur et clé d\'application (après connexion)\n4. Jeton d\'accès OAuth\n\nNous allons maintenant présenter les cas d\'utilisation de chaque type d\'authentification.\n\n### Authentification par nom d\'utilisateur/mot de passe\n\nL\'authentification par nom d\'utilisateur et mot de passe est la méthode d\'authentification la plus simple et la moins sûre. Il est peu probable qu\'elle soit activée\ndans un environnement de production, elle permet aux utilisateurs de se connecter facilement à l\'API Howler et d\'effectuer des modifications en tant qu\'utilisateur donné,\nsans avoir à se soucier de créer des clés API ou d\'utiliser un fournisseur OAuth comme Keycloak ou Azure. Les utilisateurs peuvent se connecter\nen utilisant l\'authentification par nom d\'utilisateur et mot de passe de l\'une des deux manières suivantes :\n\n#### Appel direct au point de terminaison requis (mot de passe)\n\nC\'est de loin la méthode la plus simple. Il suffit d\'ajouter un en-tête d\'autorisation de base à la requête HTTP que vous souhaitez effectuer, et tout est pris en charge.\nque vous voulez faire, et tout est pris en charge:\n\n```bash\necho -n "user:user" | base64 -w0\n# -> dXNlcjp1c2Vy\n```\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Basic dXNlcjp1c2Vy\n```\n\n#### Échange contre un jeton d\'application (mot de passe)\n\nIl s\'agit d\'une approche un peu plus complexe, mais qui présente l\'avantage de ne pas exposer le nom d\'utilisateur et le mot de passe à chaque demande.\nà chaque requête. Vous pouvez utiliser le point de terminaison `v1/auth/login` pour échanger votre nom d\'utilisateur et votre mot de passe contre un jeton d\'application. Le jeton\nfonctionne de la même manière qu\'un jeton d\'accès OAuth - vous le fournissez à chaque requête ultérieure, et il vous authentifie jusqu\'à ce que le jeton expire.\njusqu\'à ce que le jeton expire.\n\n```http\nPOST $CURRENT_URL/api/v1/auth/login/\nContent-Type: application/json\n\n{\n  "user": "user",\n  "password": "user"\n}\n```\n\nLe résultat sera quelque chose comme:\n\n```json\n{\n  "api_error_message": "",\n  "api_response": {\n    "app_token": "user:5791a142067745c3af51d6596da7da8f86357a9fa92ad78d1ce118ea7d89d34e",\n    "provider": null,\n    "refresh_token": null\n  },\n  "api_server_version": "0.0.0.dev0",\n  "api_status_code": 200\n}\n```\n\nUtilisation de ce jeton dans un autre appel d\'API:\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Bearer user:5791a142067745c3af51d6596da7da8f86357a9fa92ad78d1ce118ea7d89d34e\n```\n\n### Authentification par nom d\'utilisateur/clé API\n\nL\'authentification par nom d\'utilisateur et clé API fonctionne en grande partie de la même manière que l\'authentification par nom d\'utilisateur/mot de passe du point de vue du client.\nDu côté du serveur, cependant, les clés API présentent plusieurs avantages essentiels. Tout d\'abord, elles peuvent être facilement révoquées par l\'utilisateur.\nDeuxièmement, leurs privilèges peuvent être limités, n\'autorisant qu\'un sous-ensemble de permissions.\n\nIl existe deux méthodes d\'authentification, reflétant le nom d\'utilisateur et le mot de passe:\n\n#### Appel direct au point de terminaison requis (clé API)\n\nIl suffit d\'ajouter un en-tête d\'autorisation de base contenant le nom d\'utilisateur et la clé API à la requête HTTP que vous souhaitez effectuer, et\ntout est pris en charge:\n\n```bash\n# note the format is <username>:<apikeyname>:<secret>\necho -n "user:devkey:user" | base64 -w0\n# -> dXNlcjpkZXZrZXk6dXNlcg==\n```\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Basic dXNlcjpkZXZrZXk6dXNlcg==\n```\n\n#### Échange contre un jeton d\'application (clé API)\n\nVous pouvez également utiliser le point de terminaison `v1/auth/login` pour échanger votre nom d\'utilisateur et votre clé API contre un jeton d\'application. Le jeton\nfonctionne de la même manière qu\'un jeton d\'accès OAuth - vous le fournissez à chaque demande ultérieure, et il vous authentifie jusqu\'à ce que le jeton expire.\n\n```http\nPOST $CURRENT_URL/api/v1/auth/login/\nContent-Type: application/json\n\n{\n  "user": "user",\n  "apikey": "devkey:user"\n}\n```\n\nLe résultat sera quelque chose comme:\n\n```json\n{\n  "api_error_message": "",\n  "api_response": {\n    "app_token": "user:f220eb76ff8404abfece8c0c2f3368c7d89618c776bedcd3a506843dc4a952e4",\n    "provider": null,\n    "refresh_token": null\n  },\n  "api_server_version": "0.0.0.dev0",\n  "api_status_code": 200\n}\n```\n\nUtilisation de ce jeton dans un autre appel d\'API:\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Bearer user:f220eb76ff8404abfece8c0c2f3368c7d89618c776bedcd3a506843dc4a952e4\n```\n\nNotez que lorsque vous vous connectez à l\'aide d\'une clé d\'@cccsaurora/howler-ui/api, les autorisations de la clé d\'@cccsaurora/howler-ui/api continuent de s\'appliquer. Ainsi, si vous essayez d\'accéder à\nà un point d\'accès qui requiert l\'autorisation "write" avec une clé API qui n\'a que l\'autorisation "read", cela provoquera une erreur 403\nForbidden (Interdit).\n\n### Authentification par jeton d\'accès\n\nEn plus des méthodes d\'authentification fournies en interne par Howler, vous pouvez également vous authentifier avec un fournisseur OAuth externe comme Azure ou Keycloak.\nPour ce faire, vous devez obtenir un jeton d\'accès auprès de l\'un de ces fournisseurs.\nPour obtenir un jeton d\'accès, il y a généralement deux flux - On-Behalf-Of, ou le flux de connexion de l\'utilisateur (voir [ici](https://www.rfc-editor.org/rfc/rfc6749#section-4.1) pour un récapitulatif\nde cela). Dans le cas de Howler, le point de terminaison `v1/auth/login` est utilisé pour les étapes D & E du flux de connexion de l\'utilisateur, et\nil renvoie ce qui suit:\n\n```json\n{\n  "api_response": {\n    "app_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyIn0",\n    "provider": "keycloak",\n    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJyZWZyZXNoIn0"\n  }\n}\n```\n\nDans ce cas, le `app_token` est le Web Token JSON que l\'application utilise comme jeton d\'accès. De la même manière, le\n`refresh_token` est un autre JWT qui est utilisé pour rafraîchir le jeton d\'accès si nécessaire. Enfin, le champ `provider` (fournisseur)\nindique à quel fournisseur correspond ce jeton d\'accès.\n\nUne fois que vous avez ce jeton d\'accès, vous pouvez simplement le transmettre dans l\'en-tête Authorization :\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyIn0\n```\n\nHowler détectera automatiquement qu\'il s\'agit d\'un JWT et le traitera comme tel. Si le jeton est valide, l\'utilisateur sera\nauthentifié.\n\nAfin de rafraîchir un jeton d\'accès expiré, vous pouvez utiliser l\'appel API suivant:\n\n```http\nPOST $CURRENT_URL/api/v1/auth/login/\nContent-Type: application/json\n\n{\n  "oauth_provider": "keycloak",\n  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJyZWZyZXNoIn0"\n}\n```\n\nEt vous obtiendrez quelque chose comme ceci en retour:\n\n```json\n{\n  "api_response": {\n    "app_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMiJ9",\n    "provider": "keycloak",\n    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJyZWZyZXNodG9rZW4yIn0"\n  }\n}\n```\n\n## Impersonation\n\nLe dernier élément important du flux d\'authentification est la fonctionnalité d\'usurpation d\'identité. Pour qu\'un compte de service\nou un autre utilisateur puisse se faire passer pour vous (c\'est-à-dire créer des alertes en votre nom), Howler permet aux utilisateurs de fournir une deuxième clé API\nafin de s\'authentifier en tant qu\'autre utilisateur.\n\nAvant d\'utiliser la clé API d\'un autre utilisateur pour vous authentifier en tant que lui, il est important que la clé API que vous utilisez ait été\nmarquée comme valide pour l\'usurpation d\'identité - vérifiez auprès de l\'utilisateur qui l\'a fournie. Si c\'est le cas, vous pouvez l\'utiliser en formulant votre requête\ncomme suit:\n\n```bash\n# Your credentials\necho -n "admin:devkey:admin" | base64 -w0\n# -> YWRtaW46ZGV2a2V5OmFkbWlu\n\n# Their credentials\necho -n "user:impersonate_admin:user" | base64 -w0\n# -> dXNlcjppbXBlcnNvbmF0ZV9hZG1pbjp1c2Vy\n```\n\n```alert\nToute forme d\'authentification peut être utilisée par l\'usurpateur, mais les clés API validées sont la seule méthode d\'authentification autorisée pour la personne dont vous usurpez l\'identité.\n```\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Basic YWRtaW46ZGV2a2V5OmFkbWlu\nX-Impersonating: Basic dXNlcjppbXBlcnNvbmF0ZV9hZG1pbjp1c2Vy\n```\n\nSi la configuration est correcte, le résultat sera le suivant:\n\n```json\n{\n  "api_error_message": "",\n  "api_response": {\n    "avatar": null,\n    "classification": "TLP:W",\n    "email": "user@howler.cyber.gc.ca",\n    "groups": ["USERS"],\n    "is_active": true,\n    "is_admin": false,\n    "name": "User",\n    "roles": ["user"],\n    "username": "user"\n  },\n  "api_server_version": "0.0.0.dev0",\n  "api_status_code": 200\n}\n```\n\nNotez que le serveur a renvoyé cette requête comme si vous étiez `user`, PAS `admin`. Il est cependant clairement indiqué dans les logs que c\'est vous qui faites la requête:\n\n```log\n22/12/05 14:15:02 INFO howler.api.security | Authenticating user for path /api/v1/user/whoami/\n22/12/05 14:15:03 WARNING howler.api.security | admin is impersonating user\n22/12/05 14:15:03 INFO howler.api.security | Logged in as user from 127.0.0.1\n22/12/05 14:15:03 INFO howler.api | GET /api/v1/user/whoami/ - 200\n```\n';
-const AuthDocumentation = () => {
-  const { i18n } = useTranslation();
-  useScrollRestoration();
-  const md = useMemo(
-    () => (i18n.language === "en" ? AUTH_EN : AUTH_FR).replace(/\$CURRENT_URL/g, window.location.origin),
-    [i18n.language]
-  );
-  return /* @__PURE__ */ jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: /* @__PURE__ */ jsx(Markdown, { md }) });
-};
-export {
-  AuthDocumentation as default
-};

package/components/routes/help/BundleDocumentation.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const BundleDocumentation: FC;
-export default BundleDocumentation;

package/components/routes/help/BundleDocumentation.js

@@ -1,84 +0,0 @@
-import { jsx } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import Markdown from "../../elements/display/Markdown.js";
-import { useMemo } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/index.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-const BUNDLES_EN = '<!-- docs/ingestion/bundles.md -->\n\n# Howler Hit Bundles\n\nHit bundles can be used to easily package together a large number of similar alerts, allowing analysts to easily triage them as a single incident. For example, consider a single computer that repeatedly makes a network call to `baddomain.ru` - while an alert may be generated for every instance of this computer hitting that domain, it makes sense for analysts to treat all these alerts as a single case.\n\n## Creating bundles through the Howler Client\n\nThere are a couple of ways to create a bundle through the howler client:\n\n```python\nfrom howler_client import get_client\n\nhowler = get_client("https://howler.dev.analysis.cyber.gc.ca")\n\n"""Creating a howler bundle and the hits at the same time"""\nhowler.bundle.create(\n    # First argument is the bundle hit\n    {\n        "howler.analytic": "example-test",\n        "howler.score": 0\n    },\n    # Second argument is a hit or list of hits to include in the bundle\n    [\n        {\n            "howler.analytic": "example-test",\n            "howler.score": 0\n        },\n        {\n            "howler.analytic": "example-test",\n            "howler.score": 0\n        }\n    ]\n)\n\n"""Creating a howler bundle from existing hits"""\nhowler.bundle.create(\n    {\n        "howler.analytic": "example-test",\n        "howler.score": 0,\n        "howler.hits": ["YcUsL8QsjmwwIdstieROk", "6s7MztwuSvz6tM0PgGJhvz"]\n    },\n    # Note: In future releases, you won\'t need to include this argument\n    []\n)\n\n\n"""Creating from a map"""\nbundle_hit = {\n    "score": 0,\n    "bundle": True\n}\n\nmap = {\n    "score": ["howler.score"],\n    "bundle": ["howler.is_bundle"]\n}\n\nhowler.bundle.create_from_map("example-test", bundle_hit, map, [{"score": 0}])\n```\n\n## Viewing bundles on the Howler UI\n\nIn order to view created bundles on the Howler UI, you can use the query `howler.is_bundle:true`. This will provide a list of created bundles you can look through.\n\nClicking on a bundle will open up a slightly different search UI to normal. In this case, we automatically filter the search results to include only hits that are included in the bundle. To make this obvious, the header representing the bundle will appear above the search bar.\n\nYou can continue to filter through hits using the same queries as usual, and view them as usual. When triaging a bundle, assessing it will apply this assessment to all hits in the bundle, **except those that have already been triaged**. That is, if the bundle is open, all open hits will be assessed when you assess it.\n\nBundles also have a **Summary** tab not available for regular hits. This summary tab will aid you in aggregating data about all the hits in the bundle. Simply open the tab and click "Create Summary". Note that this may take some time, as a large number of queries are being run to aggregate the data.\n';
-const BUNDLES_FR = `<!-- docs/ingestion/bundles.fr.md -->
-
-# Les groupes des hits Howler
-
-Les groupes des hits peuvent être utilisés pour regrouper facilement un grand nombre d'alertes similaires, ce qui permet aux analystes de les traiter comme un seul incident. Prenons l'exemple d'un ordinateur qui effectue à plusieurs reprises un appel réseau vers \`baddomain.ru\` - bien qu'une alerte puisse être générée pour chaque cas où cet ordinateur accède à ce domaine, il est logique que les analystes traitent toutes ces alertes comme un seul et même cas.
-
-## Création de groupes via le client Howler
-
-Il y a plusieurs façons de créer un groupe via le client Howler:
-
-\`\`\`python
-from howler_client import get_client
-
-howler = get_client("https://howler.dev.analysis.cyber.gc.ca")
-
-"""Création simultanée d'un groupe howler et de hits"""
-howler.bundle.create(
-    # Le premier argument est le hit de l'offre groupée
-    {
-        "howler.analytic": "example-test",
-        "howler.score": 0
-    },
-    # Le deuxième argument est un hit ou une liste de hits à inclure dans l'offre groupée.
-    [
-        {
-            "howler.analytic": "example-test",
-            "howler.score": 0
-        },
-        {
-            "howler.analytic": "example-test",
-            "howler.score": 0
-        }
-    ]
-)
-
-"""Création d'un groupe howler à partir de hits existants"""
-howler.bundle.create(
-    {
-        "howler.analytic": "example-test",
-        "howler.score": 0,
-        "howler.hits": ["YcUsL8QsjmwwIdstieROk", "6s7MztwuSvz6tM0PgGJhvz"]
-    },
-    # Noter: Dans les prochaines versions, vous n'aurez plus besoin d'inclure cet argument.
-    []
-)
-
-
-"""Création à partir d'une carte"""
-bundle_hit = {
-    "score": 0,
-    "bundle": True
-}
-
-map = {
-    "score": ["howler.score"],
-    "bundle": ["howler.is_bundle"]
-}
-
-howler.bundle.create_from_map("example-test", bundle_hit, map, [{"score": 0}])
-\`\`\`
-
-## Visualiser les groupes sur l'interface utilisateur de Howler
-
-Afin de visualiser les groupes créés sur l'interface utilisateur de Howler, vous pouvez utiliser la requête \`howler.is_bundle:true\`. Cela fournira une liste de groupes créés que vous pourrez consulter.
-
-En cliquant sur un groupe, vous ouvrirez une interface de recherche légèrement différente de l'interface normale. Dans ce cas, nous filtrons automatiquement les résultats de la recherche pour n'inclure que les résultats inclus dans le groupe. Pour que cela soit évident, l'en-tête représentant le groupe apparaît au-dessus de la barre de recherche.
-
-Vous pouvez continuer à filtrer les résultats en utilisant les mêmes requêtes que d'habitude et à les visualiser comme d'habitude. Lors du triage d'un groupe, son évaluation s'appliquera à tous les hits du groupe, **sauf ceux qui ont déjà été triés**. En d'autres termes, si le groupe est ouvert, tous les hits ouverts seront évalués lorsque vous l'évaluerez.
-
-Les groupes disposent également d'un onglet **Résumé** qui n'est pas disponible pour les hits ordinaires. Cet onglet vous aidera à regrouper les données relatives à tous les résultats du groupe. Il suffit d'ouvrir l'onglet et de cliquer sur "Créer un sommaire". Notez que cette opération peut prendre un certain temps, car un grand nombre de requêtes sont exécutées pour agréger les données.
-`;
-const BundleDocumentation = () => {
-  const { i18n } = useTranslation();
-  const md = useMemo(() => i18n.language === "en" ? BUNDLES_EN : BUNDLES_FR, [i18n.language]);
-  return /* @__PURE__ */ jsx(Markdown, { md });
-};
-export {
-  BundleDocumentation as default
-};

package/components/routes/help/ClientDocumentation.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const ClientDocumentation: FC;
-export default ClientDocumentation;

package/components/routes/help/ClientDocumentation.js

@@ -1,20 +0,0 @@
-import { jsx } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import PageCenter from "../../../commons/components/pages/PageCenter.js";
-import Markdown from "../../elements/display/Markdown.js";
-import { useMemo } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/index.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-import { useScrollRestoration } from "../../hooks/useScrollRestoration.js";
-const CLIENT_EN = '# Howler Client Documentation\n\nThis documentation will outline how to interact with the howler API using the howler client in both Java and python development environments. We will outline the basic process of creating a new hit in each environment as well as searching howler for hits matching your query.\n\n## Getting started\n\n### Installation\n\nIn order to use the howler client, you need to list it as a dependency in your project.\n\n#### **Python**\n\nSimply install through pip:\n\n```bash\npip install howler-client\n```\n\nYou can also add it to your requirements.txt, or whatever dependency management system you use.\n\n### Authentication\n\nAs outlined in the [Authentication Documentation](/help/auth), there\'s a number of ways users can choose to authenticate. In order to interface with the howler client, however, the suggested flow is to use an API key. So before we start, let\'s generate a key.\n\n1. Open the Howler UI you\'d like to interface with.\n2. Log in, then click your profile in the top right.\n3. Under user menu, click Settings.\n4. Under User Security, press the (+) icon on the API Keys row.\n5. Name your key, and give it the requisite permissions.\n6. Press Create, and copy the supplied string somewhere safe. **You will not see this string again.**\n\nThis API Key will be supplied to your code later on.\n\n## Python Client\n\nIn order to connect with howler using the python client, there is a fairly simple process to follow:\n\n```python\nfrom howler_client import get_client\n\nUSERNAME = \'user\' # Obtain this from the user settings page of the Howler UI\nAPIKEY = \'@cccsaurora/howler-ui/apikey_name:apikey_data\'\n\napikey = (USERNAME, APIKEY)\n\nhowler = get_client("$CURRENT_URL", apikey=apikey)\n```\n\n```alert\nYou can skip generating an API Key and providing it if you\'re executing this code within HOGWARTS (i.e., on jupyterhub or airflow). OBO will handle authentication for you!\n```\n\nThat\'s it! You can now use the `howler` object to interact with the server. So what does that actually look like?\n\n### Creating hits in Python\n\nFor the python client, you can create hits using either the `howler.hit.create` or `howler.hit.create_from_map` functions.\n\n#### `create`\n\nThis function takes in a single argument - either a single hit, or a list of them, conforming to the [Howler Schema](/help/hit?tab=schema). Here is a simple example:\n\n```python\n# Some bogus data in the Howler Schema format\nexample_hit = {\n  "howler": {\n    "analytic": "example",\n    "score": 10.0\n  },\n  "event": {\n    "reason": "Example hit"\n  }\n}\n\nhowler.hit.create(example_hit)\n```\n\nYou can also ingest data in a flat format:\n\n```python\nexample_hit = {\n  "howler.analytic": "example",\n  "howler.score": 10.0,\n  "event.reason": "Example hit"\n}\n\nhowler.hit.create(example_hit)\n```\n\n#### `create_from_map`\n\nThis function takes in three arguments:\n\n- `tool name`: The name of the analytic creating the hit\n- `map`: A mapping between the raw data you have and the howler schema\n  - The format is a dictionary where the keys are the flattened path of the raw data, and the values are a list of flattened paths for Howler\'s fields where the data will be copied into.\n- `documents`: The raw data you want to add to howler\n\nHere is a simple example:\n\n```python\n# The mapping from our data to howler\'s schema\nhwl_map = {\n  "file.sha256": ["file.hash.sha256", "howler.hash"],\n  "file.name": ["file.name"],\n  "src_ip": ["source.ip", "related.ip"],\n  "dest_ip": ["destination.ip", "related.ip"],\n  "time.created": ["event.start"],\n}\n\n# Some bogus data in a custom format we want to add to howler\nexample_hit = {\n  "src_ip": "0.0.0.0",\n  "dest_ip": "8.8.8.8",\n  "file": {\n    "name": "hello.exe",\n    "sha256": sha256(str("hello.exe").encode()).hexdigest()\n  },\n  "time": {\n    "created": datetime.now().isoformat()\n  },\n}\n\n# Note that the third argument is of type list!\nhowler.hit.create_from_map("example_ingestor", hwl_map, [example_hit])\n```\n\n### Querying Hits\n\nQuerying hits using the howler python client is done using the `howler.search.hit` function. It has a number of required and optional arguments:\n\n- Required:\n  - `query`: lucene query (string)\n- Optional:\n  - `filters`: Additional lucene queries used to filter the data (list of strings)\n  - `fl`: List of fields to return (comma separated string of fields)\n  - `offset`: Offset at which the query items should start (integer)\n  - `rows`: Number of records to return (integer)\n  - `sort`: Field used for sorting with direction (string: ex. \'id desc\')\n  - `timeout`: Max amount of milliseconds the query will run (integer)\n  - `use_archive`: Also query the archive\n  - `track_total_hits`: Number of hits to track (default: 10k)\n\nHere are some example queries:\n\n```python\n# Search for all hits created by assemblyline, show the first 50, and return only their ids\nhowler.search.hit("howler.analytic:assemblyline", fl="howler.id", rows=50)\n\n# Search for all resolved hits created in the last five days, returning their id and the analytic that created them. Show only ten, offset by 40\nhowler.search.hit("howler.status:resolved", filters=[\'event.created:[now-5d TO now]\'] fl="howler.id,howler.analytic", rows=10, offset=40)\n\n# Search for all hits, timeout if the query takes more than 100ms\nhowler.search.hit("howler.id:*", track_total_hits=100000000, timeout=100, use_archive=True)\n```\n\n### Updating Hits\n\nIn order to update hits, there are a number of supported functions:\n\n- `howler.hit.update(...)`\n- `howler.hit.update_by_query(...)`\n- `howler.hit.overwrite(...)`\n\n#### `update()`\n\nIf you want to update a hit in a transactional way, you can use the following code:\n\n```python\nhit_to_update = client.search.hit("howler.id:*", rows=1, sort="event.created desc")["items"][0]\n\nresult = client.hit.update(hit_to_update["howler"]["id"], [(UPDATE_SET, "howler.score", hit_to_update["howler"]["score"] + 100)])\n```\n\nThe following operations can be run to update a hit.\n\n**List Operations:**\n\n- `UPDATE_APPEND`: Used to append a value to a given list\n- `UPDATE_APPEND_IF_MISSING`: Used to append a value to a given list if the value isn\'t already in the list\n- `UPDATE_REMOVE`: Will remove a given value from a list\n\n**Numeric Operations:**\n\n- `UPDATE_DEC`: Decrement a numeric value by the specified amount\n- `UPDATE_INC`: Increment a numeric value by the specified amount\n- `UPDATE_MAX`: Will set a numeric value to the maximum of the existing value and the specified value\n- `UPDATE_MIN`: Will set a numeric value to the minimum of the existing value and the specified value\n\n**Multipurpose Operations:**\n\n- `UPDATE_SET`: Set a field\'s value to the given value\n- `UPDATE_DELETE`: Will delete a given field\'s value\n\n#### `update_by_query()`\n\nThis function allows you to update a large number of hits by a query:\n\n```python\nclient.hit.update_by_query(f\'howler.analytic:"Example Alert"\', [(UPDATE_INC, "howler.score", 100)])\n```\n\nThe same operations as in `update()` can be used.\n\n### `overwrite()`\n\nThis function allows you to directly overwrite a hit with a partial hit object. This is the most easy to use, but loses some of the validation and additional processing of the update functions.\n\n```python\nhit_to_update = client.search.hit("howler.id:*", rows=1, sort="event.created desc")["items"][0]\n\nresult = client.hit.overwrite(hit_to_update["howler"]["id"], {"source.ip": "127.0.0.1", "destination.ip": "8.8.8.8"})\n```\n';
-const CLIENT_FR = '# Documentation du client Howler\n\nCette documentation explique comment interagir avec l\'API howler en utilisant le client howler dans les environnements de développement Java et Python. Nous décrirons le processus de base de la création d\'un nouveau hit dans chaque environnement ainsi que la recherche dans howler des hits correspondant à votre requête.\n\n## Mise en route\n\n### Installation\n\nAfin d\'utiliser le client howler, vous devez le lister comme une dépendance dans votre projet.\n\n#### **Python**\n\nIl suffit de l\'installer à l\'aide de pip:\n\n```bash\npip install howler-client\n```\n\nVous pouvez également l\'ajouter à votre requirements.txt, ou à tout autre système de gestion des dépendances que vous utilisez.\n\n### Authentification\n\nComme indiqué dans la [Documentation sur l\'authentification](/help/auth), les utilisateurs peuvent s\'authentifier de différentes manières. Pour interfacer avec le client howler, cependant, le flux suggéré est d\'utiliser une clé API. Avant de commencer, générons une clé.\n\n1. Ouvrez l\'interface utilisateur Howler avec laquelle vous souhaitez vous interfacer.\n2. Connectez-vous, puis cliquez sur votre profil en haut à droite.\n3. Dans le menu utilisateur, cliquez sur Paramètres.\n4. Sous Sécurité de l\'utilisateur, appuyez sur l\'icône (+) sur la ligne Clés API.\n5. Nommez votre clé et donnez-lui les autorisations nécessaires.\n6. Appuyez sur Create (Créer) et copiez la chaîne fournie dans un endroit sûr. \\*\\*Vous ne reverrez plus cette chaîne.\n\nCette clé API sera fournie à votre code par la suite.\n\n## Client Python\n\nPour se connecter à howler en utilisant le client python, il y a un processus assez simple à suivre:\n\n```python\nfrom howler_client import get_client\n\nUSERNAME = \'user\' # Obtenez-le à partir de la page des paramètres de l\'utilisateur de l\'interface utilisateur de Howler.\nAPIKEY = \'@cccsaurora/howler-ui/apikey_name:apikey_data\'\n\napikey = (USERNAME, APIKEY)\n\nhowler = get_client("$CURRENT_URL", apikey=apikey)\n```\n\nVoilà, c\'est fait ! Vous pouvez maintenant utiliser l\'objet `howler` pour interagir avec le serveur. A quoi cela ressemble-t-il en réalité?\n\n### Créer des hits en Python\n\nPour le client python, vous pouvez créer des hits en utilisant les fonctions `howler.hit.create` ou `howler.hit.create_from_map`.\n\n#### `create`\n\nCette fonction prend un seul argument - soit un hit unique, soit une liste de hits, conforme au [Howler Schema] (/help/hit?tab=schema). Voici un exemple simple :\n\n```python\n# Quelques données bidons au format Howler Schema\nexemple_hit = {\n  "howler" : {\n    "analytic" : "exemple",\n    "score" : 10.0\n  },\n  "event" : {\n    "reason" : "Exemple hit"\n  }\n}\n\nhowler.hit.create(example_hit)\n```\n\nVous pouvez également ingérer des données dans un format plat :\n\n```python\nexample_hit = {\n  "howler.analytic": "example",\n  "howler.score": 10.0,\n  "event.reason": "Example hit"\n}\n\nhowler.hit.create(example_hit)\n```\n\n#### `create_from_map`\n\nThis function takes in three arguments:\n\n- `tool name`: Le nom de l\'outil d\'analyse qui crée le hit\n- `map`: Une correspondance entre les données brutes que vous avez et le schéma howler\n  - Le format est un dictionnaire où les clés sont le chemin aplati des données brutes, et les valeurs sont une liste de chemins aplatis pour les champs de Howler dans lesquels les données seront copiées.\n- `documents`: Les données brutes que vous voulez ajouter à Howler.\n\nVoici un exemple simple:\n\n```python\n# La correspondance entre nos données et le schéma de Howler\nhwl_map = {\n  "file.sha256": ["file.hash.sha256", "howler.hash"],\n  "file.name": ["file.name"],\n  "src_ip": ["source.ip", "related.ip"],\n  "dest_ip": ["destination.ip", "related.ip"],\n  "time.created": ["event.start"],\n}\n\n# Quelques fausses données dans un format personnalisé que nous voulons ajouter à howler\nexample_hit = {\n  "src_ip": "0.0.0.0",\n  "dest_ip": "8.8.8.8",\n  "file": {\n    "name": "hello.exe",\n    "sha256": sha256(str("hello.exe").encode()).hexdigest()\n  },\n  "time": {\n    "created": datetime.now().isoformat()\n  },\n}\n\n# Notez que le troisième argument est de type liste!\nhowler.hit.create_from_map("example_ingestor", hwl_map, [example_hit])\n```\n\n### Interroger les hits en Python\n\nL\'interrogation des hits avec le client python howler se fait en utilisant la fonction `howler.search.hit`. Elle possède un certain nombre d\'arguments obligatoires et optionnels:\n\n- Obligatoire:\n  - `query`: requête lucene (chaîne)\n- Facultatif: `filters`: requête lucene (chaîne):\n  - `filters`: Requêtes lucene additionnelles utilisées pour filtrer les données (liste de chaînes)\n  - `fl`: Liste des champs à retourner (chaîne de champs séparés par des virgules)\n  - `offset`: Offset auquel les éléments de la requête doivent commencer (entier)\n  - `rows`: Nombre d\'enregistrements à retourner (entier)\n  - `sort`: Champ utilisé pour le tri avec direction (chaîne: ex. \'id desc\')\n  - `timeout`: Nombre maximum de millisecondes d\'exécution de la requête (entier)\n  - `use_archive`: Interroge également l\'archive\n  - `track_total_hits`: Nombre de hits à suivre (par défaut: 10k)\n\nVoici quelques exemples de requêtes:\n\n```python\n# Rechercher tous les hits créés par assemblyline, afficher les 50 premiers et ne renvoyer que leurs identifiants.\nhowler.search.hit("howler.analytic:assemblyline", fl="howler.id", rows=50)\n\n# Recherche de toutes les occurrences résolues créées au cours des cinq derniers jours, avec indication de leur identifiant et de l\'analyste qui les a créées. N\'en afficher que dix, décalés de 40\nhowler.search.hit("howler.status:resolved", filters=[\'event.created:[now-5d TO now]\'] fl="howler.id,howler.analytic", rows=10, offset=40)\n\n# Recherche de tous les résultats, délai d\'attente si la requête prend plus de 100 ms\nhowler.search.hit("howler.id:*", track_total_hits=100000000, timeout=100, use_archive=True)\n```\n\n### Mise à jour des résultats\n\nAfin de mettre à jour les hits, il existe un certain nombre de fonctions supportées :\n\n- `howler.hit.update(...)`\n- `howler.hit.update_by_query(...)`\n- `howler.hit.overwrite(...)`\n\n#### `update()`\n\nSi vous souhaitez mettre à jour un hit de manière transactionnelle, vous pouvez utiliser le code suivant:\n\n```python\nhit_to_update = client.search.hit("howler.id:*", rows=1, sort="event.created desc")["items"][0]\n\nresult = client.hit.update(hit_to_update["howler"]["id"], [(UPDATE_SET, "howler.score", hit_to_update["howler"]["score"] + 100)])\n```\n\nLes opérations suivantes peuvent être exécutées pour mettre à jour un résultat.\n\n**Opérations de liste:**\n\n- `UPDATE_APPEND` : Utilisé pour ajouter une valeur à une liste donnée\n- `UPDATE_APPEND_IF_MISSING` : Utilisé pour ajouter une valeur à une liste donnée si la valeur n\'est pas déjà dans la liste.\n- `UPDATE_REMOVE` : Supprime une valeur donnée d\'une liste\n\n**Opérations numériques:**\n\n- `UPDATE_DEC` : Diminue une valeur numérique de la quantité spécifiée.\n- `UPDATE_INC` : Incrémente une valeur numérique de la quantité spécifiée.\n- `UPDATE_MAX` : Fixe une valeur numérique au maximum de la valeur existante et de la valeur spécifiée.\n- `UPDATE_MIN` : Fixe une valeur numérique au minimum de la valeur existante et de la valeur spécifiée.\n\n**Opérations polyvalentes:**\n\n- `UPDATE_SET` : Fixe la valeur d\'un champ à la valeur donnée.\n- `UPDATE_DELETE` : Supprime la valeur d\'un champ donné\n\n#### `update_by_query()`\n\nCette fonction vous permet de mettre à jour un grand nombre d\'occurrences à l\'aide d\'une requête :\n\n```python\nclient.hit.update_by_query(f\'howler.analytic : "Exemple d\\\'analytic"\', [(UPDATE_INC, "howler.score", 100)])\n```\n\nLes mêmes opérations que dans `update()` peuvent être utilisées.\n\n### `overwrite()`\n\nCette fonction vous permet d\'écraser directement un hit avec un objet hit partiel. C\'est la plus facile à utiliser, mais elle perd une partie de la validation et du traitement supplémentaire des fonctions de mise à jour.\n\n```python\nhit_to_update = client.search.hit("howler.id:*", rows=1, sort="event.created desc")["items"][0]\n\nresult = client.hit.overwrite(hit_to_update["howler"]["id"], {"source.ip" : "127.0.0.1", “destination.ip” : "8.8.8.8"})\n```\n';
-const ClientDocumentation = () => {
-  const { i18n } = useTranslation();
-  useScrollRestoration();
-  const md = useMemo(
-    () => (i18n.language === "en" ? CLIENT_EN : CLIENT_FR).replace(/\$CURRENT_URL/g, window.location.origin),
-    [i18n.language]
-  );
-  return /* @__PURE__ */ jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: /* @__PURE__ */ jsx(Markdown, { md }) });
-};
-export {
-  ClientDocumentation as default
-};

package/components/routes/help/Help.d.ts

@@ -1,2 +0,0 @@
-declare const HelpDashboard: () => import("react/jsx-runtime").JSX.Element;
-export default HelpDashboard;

package/components/routes/help/Help.js

@@ -1,61 +0,0 @@
-import { jsx, jsxs } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import { HelpCenter, OpenInNew } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/@mui+icons-material@5.18.0_@mui+material@5.18.0_@emotion+react@11.14.0_@types+react@18._b9cf98cd2d466d3b4f338d38bc895c0b/node_modules/@mui/icons-material/esm/index.js";
-import { Stack, Typography, Divider, Grid, Card, CardHeader, IconButton, CardContent, CardActions, Button } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/@mui+material@5.18.0_@emotion+react@11.14.0_@types+react@18.3.23_react@18.3.1__@emotion_19a5ee0476da228d66b5ad5c143bb0c3/node_modules/@mui/material/index.js";
-import PageCenter from "../../../commons/components/pages/PageCenter.js";
-import useMyPreferences from "../../hooks/useMyPreferences.js";
-import { useScrollRestoration } from "../../hooks/useScrollRestoration.js";
-import howlerPluginStore from "../../../plugins/store.js";
-import { useMemo } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/index.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-import { usePluginStore } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-pluggable@0.4.3_react@18.3.1/node_modules/react-pluggable/dist/react-pluggable.esm.js";
-import { Link } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-router-dom@6.30.1_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-router-dom/dist/index.js";
-const HelpDashboard = () => {
-  const { t } = useTranslation(["translation", "helpMain"]);
-  const { leftnav } = useMyPreferences();
-  const pluginStore = usePluginStore();
-  useScrollRestoration();
-  const tabs = useMemo(
-    () => ({
-      "help.hit": ["schema", "header", "bundle", "links"],
-      "help.actions": ["introduction", ...howlerPluginStore.operations]
-    }),
-    []
-  );
-  const links = useMemo(
-    () => leftnav.elements.find((el) => el.type === "group" && el.element.id === "help").element.items.filter((_item) => _item.id !== "help.main"),
-    [leftnav.elements]
-  );
-  return /* @__PURE__ */ jsx(PageCenter, { margin: 4, width: "100%", maxWidth: "1750px", textAlign: "left", children: /* @__PURE__ */ jsxs(Stack, { spacing: 1, children: [
-    /* @__PURE__ */ jsxs(Typography, { variant: "h3", sx: { display: "flex", flexDirection: "row", alignItems: "center" }, children: [
-      /* @__PURE__ */ jsx(HelpCenter, { fontSize: "inherit", sx: { mr: 1 } }),
-      /* @__PURE__ */ jsx("span", { children: t("page.help.title") })
-    ] }),
-    /* @__PURE__ */ jsx(Divider, { sx: (theme) => ({ marginLeft: `${theme.spacing(1)} !important` }) }),
-    /* @__PURE__ */ jsx(Grid, { container: true, spacing: 1, sx: { pr: 1 }, children: links.map((link) => /* @__PURE__ */ jsx(Grid, { item: true, xs: 12, md: 3, sx: { display: "flex" }, children: /* @__PURE__ */ jsxs(Card, { sx: { flex: 1, display: "flex", flexDirection: "column" }, children: [
-      /* @__PURE__ */ jsx(
-        CardHeader,
-        {
-          title: /* @__PURE__ */ jsxs(
-            Stack,
-            {
-              direction: "row",
-              alignItems: "center",
-              sx: { "& svg": { fontSize: "inherit" }, "& > span": { ml: 1 } },
-              children: [
-                link.icon,
-                /* @__PURE__ */ jsx("span", { children: t(link.i18nKey) }),
-                /* @__PURE__ */ jsx(IconButton, { component: Link, to: link.route, sx: { ml: "auto" }, children: /* @__PURE__ */ jsx(OpenInNew, { color: "primary", fontSize: "inherit" }) })
-              ]
-            }
-          )
-        }
-      ),
-      /* @__PURE__ */ jsx(CardContent, { sx: { flex: 1 }, children: /* @__PURE__ */ jsx(Typography, { children: t(`helpMain:${link.i18nKey}.description`) }) }),
-      tabs[link.id] && /* @__PURE__ */ jsx(CardActions, { children: tabs[link.id].map((tab) => /* @__PURE__ */ jsx(Button, { size: "small", component: Link, to: `${link.route}?tab=${tab}`, children: tab }, tab)) })
-    ] }) }, link.id)) }),
-    howlerPluginStore.plugins.map((plugin) => pluginStore.executeFunction(`${plugin}.help`))
-  ] }) });
-};
-export {
-  HelpDashboard as default
-};

package/components/routes/help/HitBannerDocumentation.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const HitBannerDocumentation: FC;
-export default HitBannerDocumentation;

package/components/routes/help/HitBannerDocumentation.js

@@ -1,62 +0,0 @@
-import { jsxs, Fragment, jsx } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import { Typography, Divider, CardContent } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/@mui+material@5.18.0_@emotion+react@11.14.0_@types+react@18.3.23_react@18.3.1__@emotion_19a5ee0476da228d66b5ad5c143bb0c3/node_modules/@mui/material/index.js";
-import HowlerCard from "../../elements/display/HowlerCard.js";
-import JSONViewer from "../../elements/display/json/JSONViewer.js";
-import HitBanner from "../../elements/hit/HitBanner.js";
-import { HitLayout } from "../../elements/hit/HitLayout.js";
-import { useMemo } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/index.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-const HitBannerDocumentation = () => {
-  const { t } = useTranslation();
-  const dummyHit = useMemo(
-    () => ({
-      timestamp: "2023-02-11T15:10:31.585826Z",
-      howler: {
-        id: "howler.id",
-        analytic: "howler.analytic",
-        detection: "howler.detection",
-        assignment: "howler.assignment",
-        hash: "howler.hash",
-        outline: {
-          threat: "howler.outline.threat",
-          target: "howler.outline.target",
-          indicators: ["howler.outline.indicators"],
-          summary: "howler.outline.summary"
-        },
-        escalation: "howler.escalation",
-        status: "howler.status"
-      },
-      event: {
-        created: "2023-02-11T15:10:31.585826Z",
-        provider: "event.provider"
-      },
-      organization: {
-        id: "organization.id",
-        name: "organization.name"
-      },
-      threat: {
-        tactic: {
-          id: "threat.tactic.id",
-          name: "threat.tactic.name"
-        },
-        technique: {
-          id: "threat.technique.id",
-          name: "threat.technique.name"
-        }
-      }
-    }),
-    []
-  );
-  return /* @__PURE__ */ jsxs(Fragment, { children: [
-    /* @__PURE__ */ jsx("h1", { children: t("help.hit.banner.title") }),
-    /* @__PURE__ */ jsx(Typography, { variant: "body1", children: t("help.hit.banner.description") }),
-    /* @__PURE__ */ jsx(Divider, { orientation: "horizontal", sx: { my: 2 } }),
-    /* @__PURE__ */ jsx(HowlerCard, { sx: { mb: 2 }, children: /* @__PURE__ */ jsx(CardContent, { children: /* @__PURE__ */ jsx(HitBanner, { hit: dummyHit, layout: HitLayout.COMFY }) }) }),
-    /* @__PURE__ */ jsx(Typography, { variant: "body1", children: t("help.hit.banner.json") }),
-    /* @__PURE__ */ jsx(Divider, { orientation: "horizontal", sx: { my: 2 } }),
-    /* @__PURE__ */ jsx(JSONViewer, { data: dummyHit })
-  ] });
-};
-export {
-  HitBannerDocumentation as default
-};

package/components/routes/help/HitDocumentation.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const HitDocumentation: FC;
-export default HitDocumentation;

package/components/routes/help/HitDocumentation.js

@@ -1,83 +0,0 @@
-import { jsx, jsxs } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import { useTheme, useMediaQuery, Stack, Tab, Typography, Box } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/@mui+material@5.18.0_@emotion+react@11.14.0_@types+react@18.3.23_react@18.3.1__@emotion_19a5ee0476da228d66b5ad5c143bb0c3/node_modules/@mui/material/index.js";
-import PageCenter from "../../../commons/components/pages/PageCenter.js";
-import { useScrollRestoration } from "../../hooks/useScrollRestoration.js";
-import { useState, useCallback } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/index.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-import { useSearchParams } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-router-dom@6.30.1_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-router-dom/dist/index.js";
-import BundleDocumentation from "./BundleDocumentation.js";
-import HelpTabs from "./components/HelpTabs.js";
-import HitBannerDocumentation from "./HitBannerDocumentation.js";
-import HitLabelsDocumentation from "./HitLabelsDocumentation.js";
-import HitLinksDocumentation from "./HitLinksDocumentation.js";
-import HitSchemaDocumentation from "./HitSchemaDocumentation.js";
-const HitDocumentation = () => {
-  const { t } = useTranslation();
-  const theme = useTheme();
-  const useHorizontal = useMediaQuery(theme.breakpoints.down(1700));
-  useScrollRestoration();
-  const [searchParams, setSearchParams] = useSearchParams();
-  const [tab, setTab] = useState(searchParams.get("tab") ?? "schema");
-  const onChange = useCallback(
-    (_tab) => {
-      setTab(_tab);
-      searchParams.set("tab", _tab);
-      setSearchParams(new URLSearchParams(searchParams));
-    },
-    [searchParams, setSearchParams]
-  );
-  return /* @__PURE__ */ jsx(PageCenter, { margin: 4, width: "100%", maxWidth: "1750px", textAlign: "left", children: /* @__PURE__ */ jsxs(Stack, { sx: { flexDirection: useHorizontal ? "column" : "row", "& h1": { mt: 0 } }, children: [
-    /* @__PURE__ */ jsxs(HelpTabs, { value: tab, children: [
-      /* @__PURE__ */ jsx(
-        Tab,
-        {
-          label: /* @__PURE__ */ jsx(Typography, { variant: "caption", children: t("help.hit.schema.title") }),
-          value: "schema",
-          onClick: () => onChange("schema")
-        }
-      ),
-      /* @__PURE__ */ jsx(
-        Tab,
-        {
-          label: /* @__PURE__ */ jsx(Typography, { variant: "caption", children: t("help.hit.banner.title") }),
-          value: "header",
-          onClick: () => onChange("header")
-        }
-      ),
-      /* @__PURE__ */ jsx(
-        Tab,
-        {
-          label: /* @__PURE__ */ jsx(Typography, { variant: "caption", children: t("help.hit.bundle.title") }),
-          value: "bundle",
-          onClick: () => onChange("bundle")
-        }
-      ),
-      /* @__PURE__ */ jsx(
-        Tab,
-        {
-          label: /* @__PURE__ */ jsx(Typography, { variant: "caption", children: t("help.hit.links.title") }),
-          value: "links",
-          onClick: () => onChange("links")
-        }
-      ),
-      /* @__PURE__ */ jsx(
-        Tab,
-        {
-          label: /* @__PURE__ */ jsx(Typography, { variant: "caption", children: t("help.hit.labels.title") }),
-          value: "labels",
-          onClick: () => onChange("labels")
-        }
-      )
-    ] }),
-    /* @__PURE__ */ jsx(Box, { children: {
-      bundle: () => /* @__PURE__ */ jsx(BundleDocumentation, {}),
-      header: () => /* @__PURE__ */ jsx(HitBannerDocumentation, {}),
-      links: () => /* @__PURE__ */ jsx(HitLinksDocumentation, {}),
-      labels: () => /* @__PURE__ */ jsx(HitLabelsDocumentation, {}),
-      schema: () => /* @__PURE__ */ jsx(HitSchemaDocumentation, {})
-    }[tab]() })
-  ] }) });
-};
-export {
-  HitDocumentation as default
-};

package/components/routes/help/HitLabelsDocumentation.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const HitLabelsDocumentation: FC;
-export default HitLabelsDocumentation;

package/components/routes/help/HitLabelsDocumentation.js

@@ -1,46 +0,0 @@
-import { jsxs, jsx } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-import { Stack, TableContainer, Paper, Table, TableHead, TableRow, TableCell, TableBody, Chip } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/@mui+material@5.18.0_@emotion+react@11.14.0_@types+react@18.3.23_react@18.3.1__@emotion_19a5ee0476da228d66b5ad5c143bb0c3/node_modules/@mui/material/index.js";
-import { capitalize } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/lodash-es@4.17.21/node_modules/lodash-es/lodash.js";
-import { LABEL_TYPES } from "../../../utils/constants.js";
-const HitLabelsDocumentation = () => {
-  const { t } = useTranslation();
-  return /* @__PURE__ */ jsxs(Stack, { children: [
-    /* @__PURE__ */ jsx("h1", { children: t("help.hit.labels.title") }),
-    /* @__PURE__ */ jsx(TableContainer, { component: Paper, children: /* @__PURE__ */ jsxs(Table, { children: [
-      /* @__PURE__ */ jsx(TableHead, { children: /* @__PURE__ */ jsxs(TableRow, { children: [
-        /* @__PURE__ */ jsx(TableCell, { children: t("page.documentation.labels.name") }),
-        /* @__PURE__ */ jsx(TableCell, { children: t("page.documentation.labels.description") }),
-        /* @__PURE__ */ jsx(TableCell, { children: t("page.documentation.labels.example") })
-      ] }) }),
-      /* @__PURE__ */ jsx(TableBody, { children: Object.entries(LABEL_TYPES).map(([label, details]) => /* @__PURE__ */ jsxs(TableRow, { children: [
-        /* @__PURE__ */ jsx(TableCell, { children: capitalize(label) }),
-        /* @__PURE__ */ jsx(TableCell, { children: t(`hit.label.category.${label}`).replace(/.+ - /, "") }),
-        /* @__PURE__ */ jsx(TableCell, { children: /* @__PURE__ */ jsx(
-          Chip,
-          {
-            icon: (details == null ? void 0 : details.icon) ?? void 0,
-            variant: "filled",
-            size: "small",
-            label,
-            sx: [
-              {
-                mr: 1,
-                mb: 1
-              },
-              (details == null ? void 0 : details.color) && {
-                "&, & svg": {
-                  color: (theme) => theme.palette.getContrastText(details.color) + " !important"
-                },
-                backgroundColor: details.color
-              }
-            ]
-          }
-        ) })
-      ] }, label)) })
-    ] }) })
-  ] });
-};
-export {
-  HitLabelsDocumentation as default
-};

package/components/routes/help/HitLinksDocumentation.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const HitLinksDocumentation: FC;
-export default HitLinksDocumentation;

package/components/routes/help/HitLinksDocumentation.js

@@ -1,56 +0,0 @@
-import { jsx } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/jsx-runtime.js";
-import Markdown from "../../elements/display/Markdown.js";
-import { useContext, useMemo } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react@18.3.1/node_modules/react/index.js";
-import { useTranslation } from "/home/runner/work/howler/howler/ui/node_modules/.pnpm/react-i18next@14.1.3_i18next@23.16.8_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/react-i18next/dist/es/index.js";
-import { ApiConfigContext } from "../../app/providers/ApiConfigProvider.js";
-const LINKS_EN = '# Hit Links\n\nIn order to facilitate the addition of additional tools one can use to triage a hit, Howler allows users to specify a set of links, along with a title and icon to show. This documentation will walk you through how to use these links.\n\n## Specification\n\nIn order to add links, you can use the `howler.links` field. This field takes in a list of objects with three keys:\n\n```python\nhit = {\n  "howler.links": [\n    {\n      "title": "Link Title with Internal Image",\n      "href": "https://example.com",\n      # Note that this specifies another application, not an image link\n      "icon": "superset",\n    },\n    {\n      "title": "Link Title with External Image",\n      "href": "https://www.britannica.com/animal/goose-bird",\n      # Note that this specifies an image link. We don\'t provide hosting, so you\'ll need to host it somewhere else!\n      "icon": "https://cdn.britannica.com/76/76076-050-39DDCBA1/goose-Canada-North-America.jpg",\n    },\n  ]\n}\n```\n\nNote the icon can either be:\n\n1. A name identifying a linked application (from the app switcher), to use its icon\n2. An external URL\n\nIf you\'d like to use a linked app, the following values are currently supported:\n\n$APP_LIST\n\nUsing any of these values will automatically use the corresponding icon. No need to host your own!\n';
-const LINKS_FR = `# Liens du hit
-
-Afin de faciliter l'ajout d'outils supplémentaires que l'on peut utiliser pour suivre un hit, Howler permet aux utilisateurs de spécifier un ensemble de liens, ainsi qu'un titre et une icône à afficher. Cette documentation vous expliquera comment utiliser ces liens.
-
-## Specification
-
-Afin d'ajouter des liens, vous pouvez utiliser le champ \`howler.links\`. Ce champ contient une liste d'objets avec trois clés :
-
-\`\`\`python
-hit = {
-  "howler.links": [
-    {
-      "title": "Titre du lien avec image interne",
-      "href": "https://example.com",
-      # Notez qu'il s'agit d'une autre application, et non d'un lien vers une image.
-      "icon": "superset",
-    },
-    {
-      "title": "Titre du lien avec image externe",
-      "href": "https://www.britannica.com/animal/goose-bird",
-      # Notez qu'il s'agit d'un lien vers une image. Nous ne fournissons pas d'hébergement, vous devrez donc l'héberger ailleurs !
-      "icon": "https://cdn.britannica.com/76/76076-050-39DDCBA1/goose-Canada-North-America.jpg",
-    },
-  ]
-}
-\`\`\`
-
-Notez que l'icône peut être soit :
-
-1. Un nom identifiant une application liée (à partir du sélecteur d'applications), afin d'utiliser son icône.
-2. Une URL externe
-
-Si vous souhaitez utiliser une application liée, les valeurs suivantes sont actuellement prises en charge :
-
-$APP_LIST
-
-L'utilisation de l'une de ces valeurs entraîne automatiquement l'utilisation de l'icône correspondante. Inutile d'héberger la vôtre !
-`;
-const HitLinksDocumentation = () => {
-  const { i18n } = useTranslation();
-  const { config } = useContext(ApiConfigContext);
-  const md = useMemo(() => {
-    const appList = config.configuration.ui.apps.map((a) => `- \`${a.name.toLowerCase()}\``).join("\n");
-    return (i18n.language === "en" ? LINKS_EN : LINKS_FR).replace("$APP_LIST", appList);
-  }, [config.configuration.ui.apps, i18n.language]);
-  return /* @__PURE__ */ jsx(Markdown, { md });
-};
-export {
-  HitLinksDocumentation as default
-};

package/components/routes/help/HitSchemaDocumentation.d.ts

@@ -1,3 +0,0 @@
-import { FC } from 'react';
-declare const HitSchemaDocumentation: FC;
-export default HitSchemaDocumentation;