@cccsaurora/howler-ui 2.14.0-dev.268 → 2.14.0-dev.271

package/components/routes/help/markdown/en/authentication.md.js

@@ -0,0 +1 @@
+export default "<!-- 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"

package/components/routes/help/markdown/en/bundles.md.js

@@ -0,0 +1 @@
+export default "<!-- 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"

package/components/routes/help/markdown/en/client.md.js

@@ -0,0 +1 @@
+export default "# 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"

package/components/routes/help/markdown/en/links.md.js

@@ -0,0 +1 @@
+export default "# 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"

package/components/routes/help/markdown/en/notebook.md.js

@@ -0,0 +1 @@
+export default "# Notebook Integration\n\nHowler provides the option to add notebooks to analytics to aid in triaging hits and alerts. It allows users to quickly spin up a notebook within a jupyter environment with either analytic and/or hit information.\n\nHowler will look for variables to replace within the first code cell of a notebook, giving the flexibility of providing context within the first cells using markdown.\n\nHere an example of how howler will replace the variables within your notebook:\n\n```notebook tab=\"Template\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"howlerHitId = \\\"{{hit.howler.id}}\\\"\\n\",\n        \"howlerAnalyticId = \\\"{{analytic.analytic_id}}\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\n```notebook tab=\"Processed\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"howlerHitId = \\\"7dxHCat0Y2Sj48qyU7ZkVV\\\"\\n\",\n        \"howlerAnalyticId = \\\"2SXKl6Cq4rOxWLps2SFHyB\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\nor with some markdown in the first cell:\n\n```notebook tab=\"Template\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"markdown\",\n      \"id\": \"e17cbaa8-9849-462f-9bd2-bf30943f76b3\",\n      \"source\": [\n        \"### Example Notebook\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"howlerHitId = \\\"{{hit.howler.id}}\\\"\\n\",\n        \"howlerAnalyticId = \\\"{{analytic.analytic_id}}\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\n```notebook tab=\"Processed\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"markdown\",\n      \"id\": \"e17cbaa8-9849-462f-9bd2-bf30943f76b3\",\n      \"source\": [\n        \"### Example Notebook\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"howlerHitId = \\\"7dxHCat0Y2Sj48qyU7ZkVV\\\"\\n\",\n        \"howlerAnalyticId = \\\"2SXKl6Cq4rOxWLps2SFHyB\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\nCurrently, howler will only try to replace hit and analytic objects.\n\n# Requirements for the notebook integration to work\n\n- A working NBGallery setup is required.\n  - If the user can send a notebook from nbgallery to their jupyter environment, it will also work using the open in jupyhub button on Howler.\n- Just like with NBGallery, the user needs to make sure their Jupyter Environment is currently running, otherwise Howler will fail to open the notebook.\n\nHowler will append the id of the Hit/Alert when sending a notebook to Jupyter, making it easy to track for analysis. It is possible to open a notebook from within an analytic page, in this case, no hit id will be appended to the file name of the notebook and Howler won't be able to replace hit informations in the templated notebook since no hit was provided.\n\n# Adding a notebook to an analytic\n\nTo add a notebook to an analytic, it's only necessary to provide the NBGallery link of the notebook. The link shoud look like this. The notebook shouldn't be private, otherwise, only the user that uploaded it will be able to use it on Howler.\n\n```\n$NBGALLERY_URL/notebooks/5-example\n```\n\n```alert\nIt is advised to clear any outputs from a notebook before adding it on NBGallery to avoid leaking sensitive data.\n```\n"

package/components/routes/help/markdown/en/retention.md.js

@@ -0,0 +1 @@
+export default "# Retention in Howler\n\nIn order to comply with organizational policies, Howler is configured to purge stale alerts after a specific amount of time. On this instance, that duration is `duration`.\n\nHowler calculates whether it is time for the removal of an alert by the `event.created` date - once this surpasses the confgured deadline, a nightly automated job will remove the alert.\n\nIn order to communicate this to the user, see the example alert below:\n\n`alert`\n\nIn the top right, hovering over the timestamp will outline how long users have before the alert is removed. In order to ensure compliance with policy, ensure that `event.created` matches the date the underlying data was collected, allowing howler to ensure data is purged in time.\n\n```alert\nThis will soon change - there will be a dedicated field to set that will override this approach.\n```\n"

package/components/routes/help/markdown/en/schema.md.js

@@ -0,0 +1 @@
+export default "# Hit Schema\n\nA howler hit can contain a large number of unique fields, each with a particular definition, in order to make hits across analytics mutually intelligible. Below is a table containing all the given hit fields, as well as their type and a short description of what they are used for. While the vast majority of the fields are based on the Elastic Common Schema (see [this guide on ECS](https://www.elastic.co/guide/en/ecs/8.5/index.html) for documentation), there are also custom fields depending on the plugins enabled in Howler.\n\n## Howler Fields - Best Practices\n\nIn order to allow for some consistency between various analytics, there are a number of fields with recommended (but not required) styles. These include:\n\n- `howler.analytic`: Denotes the overarching analytic that generated the hit. For example, if the name of your analytic is Bad Guy Finder, you can set this field to Bad Guy Finder. Examples of use:\n  - Bad Guy Finder (correct)\n  - BadGuyFinder (acceptable, but spaces are preferred)\n  - bad.guy.finder (incorrect, don't use periods)\n  - bad_guy_finder (incorrect, don't use underscores)\n  - in general, you can use [this regex](https://regexr.com/7ikco) to validate your proposed analytic name\n\n- `howler.detection`: Denotes the specific algorithm or portion of the analytic that generated the hit. For example, if your analytic has three ways of detecting hits that should be looked at (Impossible Travel, Incorrect Login Information, XSS Attack Detection), then the manner in which the hit you're creating was detected should be set. Examples of use:\n  - Impossible Travel (correct)\n  - ImpossibleTravel (acceptable, but spaces are preferred)\n  - impossible.travel (incorrect, don't use periods)\n  - impossible_travel (incorrect, don't use underscores)\n"

package/components/routes/help/markdown/en/templates.md.js

@@ -0,0 +1 @@
+export default "# Howler Templates\n\nHowler is, fundamentally, an application that allows analysts to triage hits and alerts. In order to make sure analysts can do this as efficiently as possible, we want to have the ability to present relevant data for a given alert to analysts in an easy, understandable way.\n\nTo this end, Howler allows analysts and detection engineers to create **templates**, which allow various analytics and their detections to present fields and data relevant to triaging alerts generated by that analytic/detection. For example, let's consider two different alerts, by two different detections:\n\n```json\n$ALERT_1\n```\n\n```json\n$ALERT_2\n```\n\nNote that while both share some similar fields, they also differ. We want each of these alert cards to present different data - for that, we can use templates. This allows us to show both hits in the same list, but with differing fields displayed:\n\n===SPLIT===\n\nAs we can see, by specifying a template for each of the detections, different data will be presented to the analyst. To do so, you can use the template creator [here]($CURRENT_URL/templates/view?type=personal).\n\n```alert\nNote that you must have ingested some hits for the given analytic/detection pair for it to show as an option in the template creation UI!\n```\n"

package/components/routes/help/markdown/en/views.md.js

@@ -0,0 +1 @@
+export default "# Views\n\nViews are a feature in Howler that allows users to create custom, default queries through which they can organize and triage hits. In this document, we will outline how to create and interact with views.\n\n## Using a View\n\nYou can use views by navigating to the view manager under [Manage > Views](/views). Clicking on any view will open it in the search page. Here, you can also use the `search` icon to open the view in the search page. You can also edit views that belong to you, and mark them as favourites. This will show them in the `t(route.views.saved)` dropdown in the sidebar. In the top right, you can also choose your \"`t(route.views.manager.default)`\", that will be selected by default when opening the alerts page.\n\n## Creating Views\n\nIn order to create a view, you can use the create view page, located [here](/views/create). This page allows you to modifer your view, specify a `t(hit.search.sort.fields)` and `t(hit.search.span)`, and save the view with a particular name. You can mark a view as global or personal, depending on who you want to be able to see and use the view.\n"

package/components/routes/help/markdown/fr/actionIntroduction.md.js

@@ -0,0 +1 @@
+export default "# Utilisation des actions dans Howler\n\nLes actions sont une fonctionnalit\u00e9 de Howler qui permet aux utilisateurs d'effectuer des t\u00e2ches particuli\u00e8res sur un grand nombre de hits, en automatisant l'ex\u00e9cution d'une t\u00e2che sur chaque hit. Il y a actuellement `action_count` op\u00e9rations support\u00e9es dans Howler :\n\n`action_list`\n\nToutes ces op\u00e9rations peuvent \u00eatre combin\u00e9es ensemble dans des actions uniques - c'est-\u00e0-dire que les op\u00e9rations sont essentiellement les blocs de construction des actions dans Howler. Chaque op\u00e9ration ne peut appara\u00eetre qu'une seule fois par action, et toutes les op\u00e9rations sont configur\u00e9es \u00e0 travers une interface unifi\u00e9e. Dans ce document, nous allons parcourir les \u00e9tapes n\u00e9cessaires \u00e0 l'ex\u00e9cution et \u00e0 la sauvegarde d'une action.\n\n## Configuration d'une action\n\nPour commencer \u00e0 configurer votre action, d\u00e9cidez s'il s'agit d'une action unique ou d'une action sauvegard\u00e9e que vous souhaitez ex\u00e9cuter plusieurs fois. Si vous voulez l'ex\u00e9cuter une fois, utilisez l'entr\u00e9e `t(route.actions.change)` dans la barre lat\u00e9rale, alors qu'une action sauvegard\u00e9e est mieux configur\u00e9e sous `t(route.actions.manager)` en appuyant sur \"`t(route.actions.create)`\".\n\nLa premi\u00e8re \u00e9tape de toute action sera de concevoir une requ\u00eate sur laquelle vous voulez que cette action s'ex\u00e9cute. La bo\u00eete de recherche en haut de l'\u00e9cran accepte n'importe quelle requ\u00eate lucene - le m\u00eame format que pour la recherche d'occurrences.\n\n`tui_phrase`\n\nUne fois que vous \u00eates satisfait des occurrences qui seront incluses dans cette requ\u00eate, vous pouvez commencer \u00e0 ajouter des op\u00e9rations. Vous pouvez le faire en s\u00e9lectionnant l'op\u00e9ration que vous voulez ajouter dans la liste d\u00e9roulante:\n\n`operation_select`\n\nUne fois que vous avez s\u00e9lectionn\u00e9 l'op\u00e9ration que vous souhaitez ajouter, une liste de param\u00e8tres \u00e0 remplir vous est propos\u00e9e. Voici un exemple d'ajout d'une \u00e9tiquette.\n\n`operation_configuration`\n\nUne fois que l'op\u00e9ration est valid\u00e9e avec succ\u00e8s, vous pouvez r\u00e9p\u00e9ter ce processus avec l'op\u00e9ration suivante. Une fois que vous avez ajout\u00e9 toutes les op\u00e9rations qui vous int\u00e9ressent, vous pouvez ex\u00e9cuter ou sauvegarder l'action en utilisant le bouton situ\u00e9 sous la barre de recherche. Vous obtiendrez ainsi un rapport sur les \u00e9tapes franchies.\n\n`report`\n\nIl peut arriver que des actions g\u00e9n\u00e8rent une erreur, soit lors de la validation, soit lors de l'ex\u00e9cution. Dans ce cas, une alerte d'erreur sera affich\u00e9e, vous aidant \u00e0 r\u00e9soudre le probl\u00e8me.\n\n## Automatiser une action\n\nPour automatiser une action, ouvrez une action sauvegard\u00e9e. Les options disponibles pour l'automatisation (`automation_options`) appara\u00eetront sous forme de cases \u00e0 cocher. En cochant la case, vous vous assurez que l'action s'ex\u00e9cutera ensuite - aucune autre op\u00e9ration n'est n\u00e9cessaire.\n"

package/components/routes/help/markdown/fr/authentication.md.js

@@ -0,0 +1 @@
+export default "<!-- 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\u00e8s \u00e0 l'API. Ce document pr\u00e9sente les\ndiff\u00e9rentes approches et explique comment utiliser chacune d'entre elles.\n\n## Types d'authentification\n\nIl existe quatre m\u00e9thodes d'authentification que l'on peut utiliser pour se connecter \u00e0 l'API howler:\n\n1. Nom d'utilisateur et mot de passe\n2. Nom d'utilisateur et cl\u00e9 API\n3. Nom d'utilisateur et cl\u00e9 d'application (apr\u00e8s connexion)\n4. Jeton d'acc\u00e8s OAuth\n\nNous allons maintenant pr\u00e9senter 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\u00e9thode d'authentification la plus simple et la moins s\u00fbre. Il est peu probable qu'elle soit activ\u00e9e\ndans un environnement de production, elle permet aux utilisateurs de se connecter facilement \u00e0 l'API Howler et d'effectuer des modifications en tant qu'utilisateur donn\u00e9,\nsans avoir \u00e0 se soucier de cr\u00e9er des cl\u00e9s 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\u00e8res suivantes :\n\n#### Appel direct au point de terminaison requis (mot de passe)\n\nC'est de loin la m\u00e9thode la plus simple. Il suffit d'ajouter un en-t\u00eate d'autorisation de base \u00e0 la requ\u00eate 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#### \u00c9change contre un jeton d'application (mot de passe)\n\nIl s'agit d'une approche un peu plus complexe, mais qui pr\u00e9sente l'avantage de ne pas exposer le nom d'utilisateur et le mot de passe \u00e0 chaque demande.\n\u00e0 chaque requ\u00eate. Vous pouvez utiliser le point de terminaison `v1/auth/login` pour \u00e9changer votre nom d'utilisateur et votre mot de passe contre un jeton d'application. Le jeton\nfonctionne de la m\u00eame mani\u00e8re qu'un jeton d'acc\u00e8s OAuth - vous le fournissez \u00e0 chaque requ\u00eate ult\u00e9rieure, et il vous authentifie jusqu'\u00e0 ce que le jeton expire.\njusqu'\u00e0 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\u00e9sultat 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\u00e9 API\n\nL'authentification par nom d'utilisateur et cl\u00e9 API fonctionne en grande partie de la m\u00eame mani\u00e8re que l'authentification par nom d'utilisateur/mot de passe du point de vue du client.\nDu c\u00f4t\u00e9 du serveur, cependant, les cl\u00e9s API pr\u00e9sentent plusieurs avantages essentiels. Tout d'abord, elles peuvent \u00eatre facilement r\u00e9voqu\u00e9es par l'utilisateur.\nDeuxi\u00e8mement, leurs privil\u00e8ges peuvent \u00eatre limit\u00e9s, n'autorisant qu'un sous-ensemble de permissions.\n\nIl existe deux m\u00e9thodes d'authentification, refl\u00e9tant le nom d'utilisateur et le mot de passe:\n\n#### Appel direct au point de terminaison requis (cl\u00e9 API)\n\nIl suffit d'ajouter un en-t\u00eate d'autorisation de base contenant le nom d'utilisateur et la cl\u00e9 API \u00e0 la requ\u00eate 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#### \u00c9change contre un jeton d'application (cl\u00e9 API)\n\nVous pouvez \u00e9galement utiliser le point de terminaison `v1/auth/login` pour \u00e9changer votre nom d'utilisateur et votre cl\u00e9 API contre un jeton d'application. Le jeton\nfonctionne de la m\u00eame mani\u00e8re qu'un jeton d'acc\u00e8s OAuth - vous le fournissez \u00e0 chaque demande ult\u00e9rieure, et il vous authentifie jusqu'\u00e0 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\u00e9sultat 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 \u00e0 l'aide d'une cl\u00e9 d'@cccsaurora/howler-ui/api, les autorisations de la cl\u00e9 d'@cccsaurora/howler-ui/api continuent de s'appliquer. Ainsi, si vous essayez d'acc\u00e9der \u00e0\n\u00e0 un point d'acc\u00e8s qui requiert l'autorisation \"write\" avec une cl\u00e9 API qui n'a que l'autorisation \"read\", cela provoquera une erreur 403\nForbidden (Interdit).\n\n### Authentification par jeton d'acc\u00e8s\n\nEn plus des m\u00e9thodes d'authentification fournies en interne par Howler, vous pouvez \u00e9galement vous authentifier avec un fournisseur OAuth externe comme Azure ou Keycloak.\nPour ce faire, vous devez obtenir un jeton d'acc\u00e8s aupr\u00e8s de l'un de ces fournisseurs.\nPour obtenir un jeton d'acc\u00e8s, il y a g\u00e9n\u00e9ralement 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\u00e9capitulatif\nde cela). Dans le cas de Howler, le point de terminaison `v1/auth/login` est utilis\u00e9 pour les \u00e9tapes 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\u00e8s. De la m\u00eame mani\u00e8re, le\n`refresh_token` est un autre JWT qui est utilis\u00e9 pour rafra\u00eechir le jeton d'acc\u00e8s si n\u00e9cessaire. Enfin, le champ `provider` (fournisseur)\nindique \u00e0 quel fournisseur correspond ce jeton d'acc\u00e8s.\n\nUne fois que vous avez ce jeton d'acc\u00e8s, vous pouvez simplement le transmettre dans l'en-t\u00eate Authorization :\n\n```http\nGET $CURRENT_URL/api/v1/user/whoami\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyIn0\n```\n\nHowler d\u00e9tectera automatiquement qu'il s'agit d'un JWT et le traitera comme tel. Si le jeton est valide, l'utilisateur sera\nauthentifi\u00e9.\n\nAfin de rafra\u00eechir un jeton d'acc\u00e8s expir\u00e9, 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 \u00e9l\u00e9ment important du flux d'authentification est la fonctionnalit\u00e9 d'usurpation d'identit\u00e9. Pour qu'un compte de service\nou un autre utilisateur puisse se faire passer pour vous (c'est-\u00e0-dire cr\u00e9er des alertes en votre nom), Howler permet aux utilisateurs de fournir une deuxi\u00e8me cl\u00e9 API\nafin de s'authentifier en tant qu'autre utilisateur.\n\nAvant d'utiliser la cl\u00e9 API d'un autre utilisateur pour vous authentifier en tant que lui, il est important que la cl\u00e9 API que vous utilisez ait \u00e9t\u00e9\nmarqu\u00e9e comme valide pour l'usurpation d'identit\u00e9 - v\u00e9rifiez aupr\u00e8s de l'utilisateur qui l'a fournie. Si c'est le cas, vous pouvez l'utiliser en formulant votre requ\u00eate\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 \u00eatre utilis\u00e9e par l'usurpateur, mais les cl\u00e9s API valid\u00e9es sont la seule m\u00e9thode d'authentification autoris\u00e9e pour la personne dont vous usurpez l'identit\u00e9.\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\u00e9sultat 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\u00e9 cette requ\u00eate comme si vous \u00e9tiez `user`, PAS `admin`. Il est cependant clairement indiqu\u00e9 dans les logs que c'est vous qui faites la requ\u00eate:\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"

package/components/routes/help/markdown/fr/bundles.md.js

@@ -0,0 +1 @@
+export default "<!-- docs/ingestion/bundles.fr.md -->\n\n# Les groupes des hits Howler\n\nLes groupes des hits peuvent \u00eatre utilis\u00e9s 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 \u00e0 plusieurs reprises un appel r\u00e9seau vers `baddomain.ru` - bien qu'une alerte puisse \u00eatre g\u00e9n\u00e9r\u00e9e pour chaque cas o\u00f9 cet ordinateur acc\u00e8de \u00e0 ce domaine, il est logique que les analystes traitent toutes ces alertes comme un seul et m\u00eame cas.\n\n## Cr\u00e9ation de groupes via le client Howler\n\nIl y a plusieurs fa\u00e7ons de cr\u00e9er un groupe via le client Howler:\n\n```python\nfrom howler_client import get_client\n\nhowler = get_client(\"https://howler.dev.analysis.cyber.gc.ca\")\n\n\"\"\"Cr\u00e9ation simultan\u00e9e d'un groupe howler et de hits\"\"\"\nhowler.bundle.create(\n    # Le premier argument est le hit de l'offre group\u00e9e\n    {\n        \"howler.analytic\": \"example-test\",\n        \"howler.score\": 0\n    },\n    # Le deuxi\u00e8me argument est un hit ou une liste de hits \u00e0 inclure dans l'offre group\u00e9e.\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\"\"\"Cr\u00e9ation d'un groupe howler \u00e0 partir de hits existants\"\"\"\nhowler.bundle.create(\n    {\n        \"howler.analytic\": \"example-test\",\n        \"howler.score\": 0,\n        \"howler.hits\": [\"YcUsL8QsjmwwIdstieROk\", \"6s7MztwuSvz6tM0PgGJhvz\"]\n    },\n    # Noter: Dans les prochaines versions, vous n'aurez plus besoin d'inclure cet argument.\n    []\n)\n\n\n\"\"\"Cr\u00e9ation \u00e0 partir d'une carte\"\"\"\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## Visualiser les groupes sur l'interface utilisateur de Howler\n\nAfin de visualiser les groupes cr\u00e9\u00e9s sur l'interface utilisateur de Howler, vous pouvez utiliser la requ\u00eate `howler.is_bundle:true`. Cela fournira une liste de groupes cr\u00e9\u00e9s que vous pourrez consulter.\n\nEn cliquant sur un groupe, vous ouvrirez une interface de recherche l\u00e9g\u00e8rement diff\u00e9rente de l'interface normale. Dans ce cas, nous filtrons automatiquement les r\u00e9sultats de la recherche pour n'inclure que les r\u00e9sultats inclus dans le groupe. Pour que cela soit \u00e9vident, l'en-t\u00eate repr\u00e9sentant le groupe appara\u00eet au-dessus de la barre de recherche.\n\nVous pouvez continuer \u00e0 filtrer les r\u00e9sultats en utilisant les m\u00eames requ\u00eates que d'habitude et \u00e0 les visualiser comme d'habitude. Lors du triage d'un groupe, son \u00e9valuation s'appliquera \u00e0 tous les hits du groupe, **sauf ceux qui ont d\u00e9j\u00e0 \u00e9t\u00e9 tri\u00e9s**. En d'autres termes, si le groupe est ouvert, tous les hits ouverts seront \u00e9valu\u00e9s lorsque vous l'\u00e9valuerez.\n\nLes groupes disposent \u00e9galement d'un onglet **R\u00e9sum\u00e9** qui n'est pas disponible pour les hits ordinaires. Cet onglet vous aidera \u00e0 regrouper les donn\u00e9es relatives \u00e0 tous les r\u00e9sultats du groupe. Il suffit d'ouvrir l'onglet et de cliquer sur \"Cr\u00e9er un sommaire\". Notez que cette op\u00e9ration peut prendre un certain temps, car un grand nombre de requ\u00eates sont ex\u00e9cut\u00e9es pour agr\u00e9ger les donn\u00e9es.\n"

package/components/routes/help/markdown/fr/client.md.js

@@ -0,0 +1 @@
+export default "# Documentation du client Howler\n\nCette documentation explique comment interagir avec l'API howler en utilisant le client howler dans les environnements de d\u00e9veloppement Java et Python. Nous d\u00e9crirons le processus de base de la cr\u00e9ation d'un nouveau hit dans chaque environnement ainsi que la recherche dans howler des hits correspondant \u00e0 votre requ\u00eate.\n\n## Mise en route\n\n### Installation\n\nAfin d'utiliser le client howler, vous devez le lister comme une d\u00e9pendance dans votre projet.\n\n#### **Python**\n\nIl suffit de l'installer \u00e0 l'aide de pip:\n\n```bash\npip install howler-client\n```\n\nVous pouvez \u00e9galement l'ajouter \u00e0 votre requirements.txt, ou \u00e0 tout autre syst\u00e8me de gestion des d\u00e9pendances que vous utilisez.\n\n### Authentification\n\nComme indiqu\u00e9 dans la [Documentation sur l'authentification](/help/auth), les utilisateurs peuvent s'authentifier de diff\u00e9rentes mani\u00e8res. Pour interfacer avec le client howler, cependant, le flux sugg\u00e9r\u00e9 est d'utiliser une cl\u00e9 API. Avant de commencer, g\u00e9n\u00e9rons une cl\u00e9.\n\n1. Ouvrez l'interface utilisateur Howler avec laquelle vous souhaitez vous interfacer.\n2. Connectez-vous, puis cliquez sur votre profil en haut \u00e0 droite.\n3. Dans le menu utilisateur, cliquez sur Param\u00e8tres.\n4. Sous S\u00e9curit\u00e9 de l'utilisateur, appuyez sur l'ic\u00f4ne (+) sur la ligne Cl\u00e9s API.\n5. Nommez votre cl\u00e9 et donnez-lui les autorisations n\u00e9cessaires.\n6. Appuyez sur Create (Cr\u00e9er) et copiez la cha\u00eene fournie dans un endroit s\u00fbr. \\*\\*Vous ne reverrez plus cette cha\u00eene.\n\nCette cl\u00e9 API sera fournie \u00e0 votre code par la suite.\n\n## Client Python\n\nPour se connecter \u00e0 howler en utilisant le client python, il y a un processus assez simple \u00e0 suivre:\n\n```python\nfrom howler_client import get_client\n\nUSERNAME = 'user' # Obtenez-le \u00e0 partir de la page des param\u00e8tres 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\u00e0, c'est fait ! Vous pouvez maintenant utiliser l'objet `howler` pour interagir avec le serveur. A quoi cela ressemble-t-il en r\u00e9alit\u00e9?\n\n### Cr\u00e9er des hits en Python\n\nPour le client python, vous pouvez cr\u00e9er 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\u00e9es 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 \u00e9galement ing\u00e9rer des donn\u00e9es 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\u00e9e le hit\n- `map`: Une correspondance entre les donn\u00e9es brutes que vous avez et le sch\u00e9ma howler\n  - Le format est un dictionnaire o\u00f9 les cl\u00e9s sont le chemin aplati des donn\u00e9es brutes, et les valeurs sont une liste de chemins aplatis pour les champs de Howler dans lesquels les donn\u00e9es seront copi\u00e9es.\n- `documents`: Les donn\u00e9es brutes que vous voulez ajouter \u00e0 Howler.\n\nVoici un exemple simple:\n\n```python\n# La correspondance entre nos donn\u00e9es et le sch\u00e9ma 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\u00e9es dans un format personnalis\u00e9 que nous voulons ajouter \u00e0 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\u00e8me 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\u00e8de un certain nombre d'arguments obligatoires et optionnels:\n\n- Obligatoire:\n  - `query`: requ\u00eate lucene (cha\u00eene)\n- Facultatif: `filters`: requ\u00eate lucene (cha\u00eene):\n  - `filters`: Requ\u00eates lucene additionnelles utilis\u00e9es pour filtrer les donn\u00e9es (liste de cha\u00eenes)\n  - `fl`: Liste des champs \u00e0 retourner (cha\u00eene de champs s\u00e9par\u00e9s par des virgules)\n  - `offset`: Offset auquel les \u00e9l\u00e9ments de la requ\u00eate doivent commencer (entier)\n  - `rows`: Nombre d'enregistrements \u00e0 retourner (entier)\n  - `sort`: Champ utilis\u00e9 pour le tri avec direction (cha\u00eene: ex. 'id desc')\n  - `timeout`: Nombre maximum de millisecondes d'ex\u00e9cution de la requ\u00eate (entier)\n  - `use_archive`: Interroge \u00e9galement l'archive\n  - `track_total_hits`: Nombre de hits \u00e0 suivre (par d\u00e9faut: 10k)\n\nVoici quelques exemples de requ\u00eates:\n\n```python\n# Rechercher tous les hits cr\u00e9\u00e9s 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\u00e9solues cr\u00e9\u00e9es au cours des cinq derniers jours, avec indication de leur identifiant et de l'analyste qui les a cr\u00e9\u00e9es. N'en afficher que dix, d\u00e9cal\u00e9s 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\u00e9sultats, d\u00e9lai d'attente si la requ\u00eate prend plus de 100 ms\nhowler.search.hit(\"howler.id:*\", track_total_hits=100000000, timeout=100, use_archive=True)\n```\n\n### Mise \u00e0 jour des r\u00e9sultats\n\nAfin de mettre \u00e0 jour les hits, il existe un certain nombre de fonctions support\u00e9es :\n\n- `howler.hit.update(...)`\n- `howler.hit.update_by_query(...)`\n- `howler.hit.overwrite(...)`\n\n#### `update()`\n\nSi vous souhaitez mettre \u00e0 jour un hit de mani\u00e8re 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\u00e9rations suivantes peuvent \u00eatre ex\u00e9cut\u00e9es pour mettre \u00e0 jour un r\u00e9sultat.\n\n**Op\u00e9rations de liste:**\n\n- `UPDATE_APPEND` : Utilis\u00e9 pour ajouter une valeur \u00e0 une liste donn\u00e9e\n- `UPDATE_APPEND_IF_MISSING` : Utilis\u00e9 pour ajouter une valeur \u00e0 une liste donn\u00e9e si la valeur n'est pas d\u00e9j\u00e0 dans la liste.\n- `UPDATE_REMOVE` : Supprime une valeur donn\u00e9e d'une liste\n\n**Op\u00e9rations num\u00e9riques:**\n\n- `UPDATE_DEC` : Diminue une valeur num\u00e9rique de la quantit\u00e9 sp\u00e9cifi\u00e9e.\n- `UPDATE_INC` : Incr\u00e9mente une valeur num\u00e9rique de la quantit\u00e9 sp\u00e9cifi\u00e9e.\n- `UPDATE_MAX` : Fixe une valeur num\u00e9rique au maximum de la valeur existante et de la valeur sp\u00e9cifi\u00e9e.\n- `UPDATE_MIN` : Fixe une valeur num\u00e9rique au minimum de la valeur existante et de la valeur sp\u00e9cifi\u00e9e.\n\n**Op\u00e9rations polyvalentes:**\n\n- `UPDATE_SET` : Fixe la valeur d'un champ \u00e0 la valeur donn\u00e9e.\n- `UPDATE_DELETE` : Supprime la valeur d'un champ donn\u00e9\n\n#### `update_by_query()`\n\nCette fonction vous permet de mettre \u00e0 jour un grand nombre d'occurrences \u00e0 l'aide d'une requ\u00eate :\n\n```python\nclient.hit.update_by_query(f'howler.analytic : \"Exemple d\\'analytic\"', [(UPDATE_INC, \"howler.score\", 100)])\n```\n\nLes m\u00eames op\u00e9rations que dans `update()` peuvent \u00eatre utilis\u00e9es.\n\n### `overwrite()`\n\nCette fonction vous permet d'\u00e9craser directement un hit avec un objet hit partiel. C'est la plus facile \u00e0 utiliser, mais elle perd une partie de la validation et du traitement suppl\u00e9mentaire des fonctions de mise \u00e0 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\", \u201cdestination.ip\u201d : \"8.8.8.8\"})\n```\n"

package/components/routes/help/markdown/fr/links.md.js

@@ -0,0 +1 @@
+export default "# Liens du hit\n\nAfin de faciliter l'ajout d'outils suppl\u00e9mentaires que l'on peut utiliser pour suivre un hit, Howler permet aux utilisateurs de sp\u00e9cifier un ensemble de liens, ainsi qu'un titre et une ic\u00f4ne \u00e0 afficher. Cette documentation vous expliquera comment utiliser ces liens.\n\n## Specification\n\nAfin d'ajouter des liens, vous pouvez utiliser le champ `howler.links`. Ce champ contient une liste d'objets avec trois cl\u00e9s :\n\n```python\nhit = {\n  \"howler.links\": [\n    {\n      \"title\": \"Titre du lien avec image interne\",\n      \"href\": \"https://example.com\",\n      # Notez qu'il s'agit d'une autre application, et non d'un lien vers une image.\n      \"icon\": \"superset\",\n    },\n    {\n      \"title\": \"Titre du lien avec image externe\",\n      \"href\": \"https://www.britannica.com/animal/goose-bird\",\n      # Notez qu'il s'agit d'un lien vers une image. Nous ne fournissons pas d'h\u00e9bergement, vous devrez donc l'h\u00e9berger ailleurs !\n      \"icon\": \"https://cdn.britannica.com/76/76076-050-39DDCBA1/goose-Canada-North-America.jpg\",\n    },\n  ]\n}\n```\n\nNotez que l'ic\u00f4ne peut \u00eatre soit :\n\n1. Un nom identifiant une application li\u00e9e (\u00e0 partir du s\u00e9lecteur d'applications), afin d'utiliser son ic\u00f4ne.\n2. Une URL externe\n\nSi vous souhaitez utiliser une application li\u00e9e, les valeurs suivantes sont actuellement prises en charge :\n\n$APP_LIST\n\nL'utilisation de l'une de ces valeurs entra\u00eene automatiquement l'utilisation de l'ic\u00f4ne correspondante. Inutile d'h\u00e9berger la v\u00f4tre !\n"

package/components/routes/help/markdown/fr/notebook.md.js

@@ -0,0 +1 @@
+export default "# Int\u00e9gration de carnets\n\nHowler offre la possibilit\u00e9 d'ajouter des carnets aux analyses afin de faciliter le triage des hits et des alertes. Il permet aux utilisateurs de cr\u00e9er rapidement un carnet dans un environnement Jupyter avec des informations analytiques et/ou des informations sur les hits.\n\nHowler cherchera des variables \u00e0 remplacer dans la premi\u00e8re cellule de code d'un notebook, ce qui permettra de fournir un contexte dans les premi\u00e8res cellules \u00e0 l'aide de markdown.\n\nVoici un exemple de la fa\u00e7on dont Howler remplacera les variables dans votre carnet :\n\n```notebook tab=\"Mod\u00e8le\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"HowlerHitId = \\\"{{hit.howler.id}}\\\"\\n\",\n        \"HowlerAnalyticId = \\\"{{analytic.analytic_id}}\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\n```notebook tab=\"Trait\u00e9\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"HowlerHitId = \\\"7dxHCat0Y2Sj48qyU7ZkVV\\\"\\n\",\n        \"HowlerAnalyticId = \\\"2SXKl6Cq4rOxWLps2SFHyB\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\nou avec du markdown dans la premi\u00e8re cellule :\n\n```notebook tab=\"Mod\u00e8le\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"markdown\",\n      \"id\": \"e17cbaa8-9849-462f-9bd2-bf30943f76b3\",\n      \"source\": [\n        \"### Exemple de carnet\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"HowlerHitId = \\\"{{hit.howler.id}}\\\"\\n\",\n        \"HowlerAnalyticId = \\\"{{analytic.analytic_id}}\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\n```notebook tab=\"Trait\u00e9\"\n{\n  \"cells\": [\n    {\n      \"cell_type\": \"markdown\",\n      \"id\": \"e17cbaa8-9849-462f-9bd2-bf30943f76b3\",\n      \"source\": [\n        \"### Exemple de carnet\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"fe6f810f-2459-4ad7-92ac-1e925ce892d4\",\n      \"outputs\": [],\n      \"source\": [\n        \"HowlerHitId = \\\"7dxHCat0Y2Sj48qyU7ZkVV\\\"\\n\",\n        \"HowlerAnalyticId = \\\"2SXKl6Cq4rOxWLps2SFHyB\\\"\"\n      ]\n    },\n    {\n      \"cell_type\": \"code\",\n      \"id\": \"586470ef-c8e6-45b1-bd17-17ccd083eef1\",\n      \"outputs\": [],\n      \"source\": [\n        \"from howler_client import get_client\\n\\n\",\n        \"howler = get_client(\\\"$CURRENT_URL\\\")\\n\",\n        \"hit = howler.hit(howlerHitId)\"\n      ]\n    }\n  ],\n  \"nbformat\": 4,\n  \"nbformat_minor\": 5\n}\n```\n\nPr\u00e9sentement, Howler n'essaiera de remplacer que les objets de hit et d'analytic.\n\n# Conditions requises pour que l'int\u00e9gration de carnets fonctionne\n\n- Une configuration NBGallery fonctionnelle est n\u00e9cessaire.\n  - Si l'utilisateur peut envoyer un carnet depuis NBGallery vers son environnement Jupyter, il fonctionnera aussi en utilisant le bouton open in jupyhub sur Howler.\n- Comme pour NBGallery, l'utilisateur doit s'assurer que son environnement Jupyter est en cours d'ex\u00e9cution, sinon Howler ne parviendra pas \u00e0 envoyer le carnet.\n\nHowler ajoutera l'identifiant du Hit/Alert lorsqu'il enverra un carnet \u00e0 Jupyter, ce qui facilitera son suivi pour l'analyse. Il est possible d'ouvrir un carnet \u00e0 partir d'une page analytique. Dans ce cas, aucun identifiant de r\u00e9sultat ne sera ajout\u00e9 au nom de fichier du carnet et Howler ne sera pas en mesure de remplacer les informations de hit dans le carnet mod\u00e8le puisqu'aucun hit n'a \u00e9t\u00e9 fourni.\n\n# Ajout d'un carnet \u00e0 une analyse\n\nPour ajouter un carnet \u00e0 une analyse, il suffit de fournir le lien NBGallery du carnet. Le lien ressemblera \u00e0 l'exemple ci-dessous. Le carnet ne doit pas \u00eatre priv\u00e9, sinon seul l'utilisateur qui l'a ajout\u00e9 pourra l'utiliser sur Howler.\n\n```\n$NBGALLERY_URL/notebooks/5-example\n```\n\n```alert\nIl est conseill\u00e9 d'effacer toutes les sorties d'un carnet avant de l'ajouter sur NBGallery afin d'\u00e9viter la fuite de donn\u00e9es sensibles.\n```\n"

package/components/routes/help/markdown/fr/retention.md.js

@@ -0,0 +1 @@
+export default "# R\u00e9tention dans Howler\n\nAfin de se conformer au r\u00e8glement, Howler est configur\u00e9 pour purger les alertes p\u00e9rim\u00e9es apr\u00e8s une p\u00e9riode de temps sp\u00e9cifique. Dans cette instance, cette dur\u00e9e est `duration`.\n\nHowler calcule s'il est temps de supprimer une alerte en fonction de la date `event.created` - une fois que celle-ci d\u00e9passe la date limite configur\u00e9e, un travail automatis\u00e9 nocturne supprimera l'alerte.\n\nAfin de communiquer cela \u00e0 l'utilisateur, voir l'exemple d'alerte ci-dessous :\n\n`alert`\n\nEn haut \u00e0 droite, le survol de l'horodatage indique le temps dont dispose l'utilisateur avant que l'alerte ne soit supprim\u00e9e. Afin de se conformer au r\u00e8glement, assurez-vous que `event.created` correspond \u00e0 la date \u00e0 laquelle les donn\u00e9es sous-jacentes ont \u00e9t\u00e9 collect\u00e9es, ce qui permet \u00e0 howler de s'assurer que les donn\u00e9es sont purg\u00e9es \u00e0 temps.\n\n```alert\nCela va bient\u00f4t changer - il y aura un champ d\u00e9di\u00e9 \u00e0 d\u00e9finir qui remplacera cette approche.\n```\n"

package/components/routes/help/markdown/fr/schema.md.js

@@ -0,0 +1 @@
+export default "# Sch\u00e9ma du hit\n\nUn hit howler peut contenir un grand nombre de champs uniques, chacun avec une d\u00e9finition particuli\u00e8re, afin de rendre les hits mutuellement intelligibles d'une analyse \u00e0 l'autre. Vous trouverez ci-dessous un tableau contenant tous les champs de r\u00e9sultats donn\u00e9s, ainsi que leur type et une br\u00e8ve description de leur utilisation. Alors que la grande majorit\u00e9 des champs sont bas\u00e9s sur le sch\u00e9ma commun Elastic (voir [ici](https://www.elastic.co/guide/en/ecs/8.5/index.html) pour la documentation), il existe \u00e9galement des champs personnalis\u00e9s pour Howler, et aussi des champs suppl\u00e9mentaires configur\u00e9s par divers plugins Howler.\n\n## Champs Howler - Bonnes pratiques\n\nAfin d'assurer une certaine coh\u00e9rence entre les diff\u00e9rents analytiques, il existe un certain nombre de champs dont le style est recommand\u00e9 (mais pas obligatoire). Il s'agit notamment des champs suivants:\n\n- `howler.analytic` : Indique l'analyse globale qui a g\u00e9n\u00e9r\u00e9 le r\u00e9sultat. Par exemple, si le nom de votre analyse est Bad Guy Finder, vous pouvez d\u00e9finir ce champ \u00e0 Bad Guy Finder. Exemples d'utilisation :\n  - Bad Guy Finder (correct)\n  - BadGuyFinder (acceptable, mais les espaces sont pr\u00e9f\u00e9rables)\n  - bad.guy.finder (incorrect, ne pas utiliser de points)\n  - bad_guy_finder (incorrect, n'utilisez pas de caract\u00e8res de soulignement)\n  - en g\u00e9n\u00e9ral, vous pouvez utiliser [cette regex](https://regexr.com/7ikco) pour valider le nom analytique que vous proposez\n\n- `howler.detection` : Indique l'algorithme sp\u00e9cifique ou la partie de l'analyse qui a g\u00e9n\u00e9r\u00e9 le hit. Par exemple, si votre analyse a trois fa\u00e7ons de d\u00e9tecter les hits qui devraient \u00eatre examin\u00e9s (Voyage impossible, Informations de connexion incorrectes, D\u00e9tection d'attaque XSS), alors la fa\u00e7on dont le hit que vous cr\u00e9ez a \u00e9t\u00e9 d\u00e9tect\u00e9 devrait \u00eatre d\u00e9finie. Exemples d'utilisation :\n  - Impossible Travel (correct)\n  - ImpossibleTravel (acceptable, mais les espaces sont pr\u00e9f\u00e9rables)\n  - impossible.travel (incorrect, ne pas utiliser de points)\n  - impossible_travel (incorrect, ne pas utiliser de caract\u00e8res de soulignement)\n"

package/components/routes/help/markdown/fr/templates.md.js

@@ -0,0 +1 @@
+export default "# Mod\u00e8les de Howler\n\nHowler est, fondamentalement, une application qui permet aux analystes de trier les hits et les alertes. Afin de s'assurer que les analystes puissent le faire aussi efficacement que possible, nous voulons avoir la possibilit\u00e9 de pr\u00e9senter les donn\u00e9es pertinentes pour une alerte donn\u00e9e aux analystes d'une mani\u00e8re facile et compr\u00e9hensible.\n\n\u00c0 cette fin, Howler permet aux analystes et aux ing\u00e9nieurs de d\u00e9tection de cr\u00e9er des **mod\u00e8les**, qui permettent \u00e0 diverses analyses et \u00e0 leurs d\u00e9tections de pr\u00e9senter des champs et des donn\u00e9es pertinents pour le triage des alertes g\u00e9n\u00e9r\u00e9es par cette analyse/d\u00e9tection. Par exemple, consid\u00e9rons deux alertes diff\u00e9rentes, g\u00e9n\u00e9r\u00e9es par deux d\u00e9tections diff\u00e9rentes :\n\n```json\n$ALERT_1\n```\n\n```json\n$ALERT_2\n```\n\nNotez que si les deux cartes partagent des champs similaires, elles diff\u00e8rent \u00e9galement. Nous voulons que chacune de ces cartes d'alerte pr\u00e9sente des donn\u00e9es diff\u00e9rentes - pour cela, nous pouvons utiliser des mod\u00e8les. Cela nous permet d'afficher les deux occurrences dans la m\u00eame liste, mais avec des champs diff\u00e9rents :\n\n===SPLIT===\n\nComme nous pouvons le voir, en sp\u00e9cifiant un mod\u00e8le pour chacune des d\u00e9tections, des donn\u00e9es diff\u00e9rentes seront pr\u00e9sent\u00e9es \u00e0 l'analyste.Pour ce faire, vous pouvez utiliser le cr\u00e9ateur de mod\u00e8les [ici]($CURRENT_URL/templates/view?type=personal).\n\n```alert\nNotez que vous devez avoir ing\u00e9r\u00e9 des hits pour la paire analyse/d\u00e9tection donn\u00e9e pour qu'elle apparaisse en tant qu'option dans l'interface utilisateur de cr\u00e9ation de mod\u00e8le !\n```\n"

package/components/routes/help/markdown/fr/views.md.js

@@ -0,0 +1 @@
+export default "# Vues\n\nLes vues sont une fonctionnalit\u00e9 de Howler qui permet aux utilisateurs de cr\u00e9er des requ\u00eates personnalis\u00e9es par d\u00e9faut \u00e0 travers lesquelles ils peuvent organiser et trier les hits. Dans ce document, nous d\u00e9crirons comment cr\u00e9er et interagir avec des vues.\n\n## Utilisation d'une vue\n\nVous pouvez utiliser les vues en acc\u00e9dant au gestionnaire de vues sous [Manage > Views](/views). En cliquant sur une vue, vous l'ouvrirez dans la page de recherche. Vous pouvez \u00e9galement utiliser l'ic\u00f4ne `recherche` pour ouvrir la vue dans la page de recherche. Vous pouvez \u00e9galement modifier les vues qui vous appartiennent et les marquer comme favorites. Cela les affichera dans le menu d\u00e9roulant `t(route.views.saved)` dans la barre lat\u00e9rale. En haut \u00e0 droite, vous pouvez \u00e9galement choisir votre `t(route.views.manager.default)`, qui sera s\u00e9lectionn\u00e9 par d\u00e9faut lors de l'ouverture de la page d'alertes.\n\n## Cr\u00e9er des vues\n\nPour cr\u00e9er une vue, vous pouvez utiliser la page de cr\u00e9ation de vue, situ\u00e9e [ici](/views/create). Cette page vous permet de modifier votre vue, de sp\u00e9cifier un `t(hit.search.sort.fields)` et un `t(hit.search.span)`, et de sauvegarder la vue avec un nom particulier. Vous pouvez marquer une vue comme globale ou personnelle, en fonction des personnes que vous souhaitez voir et utiliser.\n"

package/components/routes/hits/search/BundleParentMenu.d.ts

@@ -0,0 +1,6 @@
+import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
+import type { FC } from 'react';
+declare const BundleParentMenu: FC<{
+    bundle: Hit;
+}>;
+export default BundleParentMenu;

package/components/routes/hits/search/BundleParentMenu.js

@@ -0,0 +1,32 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import { AccountTree } from '@mui/icons-material';
+import { IconButton, Paper, Popover, Skeleton, Stack, Tooltip } from '@mui/material';
+import api from '@cccsaurora/howler-ui/api';
+import HowlerCard from '@cccsaurora/howler-ui/components/elements/display/HowlerCard';
+import HitBanner from '@cccsaurora/howler-ui/components/elements/hit/HitBanner';
+import { HitLayout } from '@cccsaurora/howler-ui/components/elements/hit/HitLayout';
+import { useCallback, useEffect, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { useNavigate } from 'react-router-dom';
+const BundleParentMenu = ({ bundle }) => {
+    const { t } = useTranslation();
+    const navigate = useNavigate();
+    const [parentAnchor, setParentAnchor] = useState(null);
+    const [parentHits, setParentHits] = useState([]);
+    const onSelect = useCallback((bundleId) => {
+        navigate(`/bundles/${bundleId}?span=date.range.all&query=howler.id%3A*`);
+        setParentAnchor(null);
+    }, [navigate]);
+    useEffect(() => {
+        if (!parentAnchor) {
+            return;
+        }
+        api.search.hit
+            .post({ query: `howler.id:(${bundle.howler.bundles.join(' OR ')})` })
+            .then(response => setParentHits(response.items));
+    }, [bundle.howler.bundles, parentAnchor]);
+    return (_jsxs(_Fragment, { children: [_jsx(Tooltip, { title: t('hit.bundle.parents.show'), children: _jsx(IconButton, { size: "small", onClick: event => setParentAnchor(event.currentTarget), children: _jsx(AccountTree, { fontSize: "small" }) }) }), _jsx(Popover, { open: !!parentAnchor, anchorEl: parentAnchor, anchorOrigin: { vertical: 'top', horizontal: 'left' }, transformOrigin: { horizontal: 'right', vertical: 'top' }, onClose: () => setParentAnchor(null), children: _jsx(Paper, { sx: { p: 1, minWidth: '750px' }, children: _jsx(Stack, { spacing: 1, children: parentHits.length < 1
+                            ? bundle.howler.bundles.map(id => _jsx(Skeleton, { variant: "rounded", height: "100px" }, id))
+                            : parentHits.map(parent => (_jsx(HowlerCard, { sx: { p: 1, cursor: 'pointer' }, onClick: () => onSelect(parent.howler.id), children: _jsx(HitBanner, { hit: parent, layout: HitLayout.DENSE }) }, parent.howler.id))) }) }) })] }));
+};
+export default BundleParentMenu;

package/components/routes/hits/search/BundleScroller.d.ts

@@ -0,0 +1,2 @@
+import type { FC, PropsWithChildren } from 'react';
+export declare const BundleScroller: FC<PropsWithChildren>;

package/components/routes/hits/search/BundleScroller.js

@@ -0,0 +1,6 @@
+import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
+import { useScrollRestoration } from '@cccsaurora/howler-ui/components/hooks/useScrollRestoration';
+export const BundleScroller = ({ children }) => {
+    useScrollRestoration('hitscrollbar');
+    return _jsx(_Fragment, { children: children });
+};

package/components/routes/hits/search/CustomSort.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("react").NamedExoticComponent<{}>;
+export default _default;

package/components/routes/hits/search/CustomSort.js

@@ -0,0 +1,37 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { ArrowDownward, ArrowUpward, Cancel } from '@mui/icons-material';
+import { Autocomplete, Chip, Grid, MenuItem, Select, Stack, TextField } from '@mui/material';
+import { FieldContext } from '@cccsaurora/howler-ui/components/app/providers/FieldProvider';
+import { ParameterContext } from '@cccsaurora/howler-ui/components/app/providers/ParameterProvider';
+import { uniqBy } from 'lodash-es';
+import { memo, useContext, useEffect, useMemo, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { useContextSelector } from 'use-context-selector';
+const CustomSort = () => {
+    const { t } = useTranslation();
+    const [field, setField] = useState('');
+    const [sort, setSort] = useState('');
+    const { hitFields, getHitFields } = useContext(FieldContext);
+    const sortEntries = useContextSelector(ParameterContext, ctx => ctx.sort?.split(','));
+    const setSavedSort = useContextSelector(ParameterContext, ctx => ctx.setSort);
+    const sortFields = useMemo(() => sortEntries.map(entry => entry.split(' ').slice(0, 2)), [sortEntries]);
+    useEffect(() => {
+        getHitFields();
+    }, [getHitFields]);
+    useEffect(() => {
+        if (!sort) {
+            setSort('desc');
+        }
+    }, [sort]);
+    useEffect(() => {
+        if (!field) {
+            return;
+        }
+        setSavedSort(uniqBy([...sortEntries, `${field} ${sort}`], entry => entry.replace(/ .+/, '')).join(','));
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [field]);
+    return (_jsxs(Stack, { spacing: 1, maxWidth: "450px", children: [_jsxs(Stack, { direction: "row", spacing: 1, children: [_jsx(Autocomplete, { fullWidth: true, sx: { minWidth: '225px' }, size: "small", value: field, options: hitFields.map(_field => _field.key), getOptionDisabled: option => sortEntries.map(entry => entry.replace(/ .+/, '')).includes(option), renderInput: _params => _jsx(TextField, { ..._params, label: t('hit.search.sort.fields') }), onChange: (_, value) => setField(value), disableClearable: true }), _jsxs(Select, { size: "small", sx: { minWidth: '150px' }, value: sort, onChange: e => setSort(e.target.value), children: [_jsx(MenuItem, { value: "asc", children: t('asc') }), _jsx(MenuItem, { value: "desc", children: t('desc') })] })] }), _jsx(Grid, { container: true, spacing: 1, sx: theme => ({ marginLeft: `${theme.spacing(-1)} !important` }), children: sortFields.map(([key, direction]) => (_jsx(Grid, { item: true, children: _jsx(Chip, { variant: "outlined", label: key, icon: direction === 'asc' ? _jsx(ArrowUpward, {}) : _jsx(ArrowDownward, {}), deleteIcon: _jsx(Cancel, {}), onClick: () => setSavedSort(sortEntries
+                            .map(entry => entry?.replace(`${key} ${direction}`, `${key} ${direction === 'asc' ? 'desc' : 'asc'}`))
+                            .join(',')), onDelete: () => setSavedSort(sortEntries.filter(entry => entry && entry.split(' ')[0] != key).join(',')) }) }, key))) })] }));
+};
+export default memo(CustomSort);

package/components/routes/hits/search/HitBrowser.d.ts

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

package/components/routes/hits/search/HitBrowser.js

@@ -0,0 +1,174 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { ChevronLeft, Close, ManageSearch } from '@mui/icons-material';
+import { Box, Card, Checkbox, Collapse, Drawer, Fab, IconButton, Stack, Tooltip, Typography, useMediaQuery, useTheme } from '@mui/material';
+import { HitContext } from '@cccsaurora/howler-ui/components/app/providers/HitProvider';
+import HitSearchProvider, { HitSearchContext } from '@cccsaurora/howler-ui/components/app/providers/HitSearchProvider';
+import ParameterProvider, { ParameterContext } from '@cccsaurora/howler-ui/components/app/providers/ParameterProvider';
+import { ViewContext } from '@cccsaurora/howler-ui/components/app/providers/ViewProvider';
+import FlexOne from '@cccsaurora/howler-ui/components/elements/addons/layout/FlexOne';
+import FlexPort from '@cccsaurora/howler-ui/components/elements/addons/layout/FlexPort';
+import HitSummary from '@cccsaurora/howler-ui/components/elements/hit/HitSummary';
+import { useMyLocalStorageItem } from '@cccsaurora/howler-ui/components/hooks/useMyLocalStorage';
+import ErrorBoundary from '@cccsaurora/howler-ui/components/routes/ErrorBoundary';
+import dayjs from 'dayjs';
+import { has, isNull } from 'lodash-es';
+import { memo, useCallback, useEffect, useMemo, useState } from 'react';
+import { Trans, useTranslation } from 'react-i18next';
+import { useLocation, useParams, useSearchParams } from 'react-router-dom';
+import { useContextSelector } from 'use-context-selector';
+import { StorageKey } from '@cccsaurora/howler-ui/utils/constants';
+import InformationPane from './InformationPane';
+import SearchPane from './SearchPane';
+import HitGrid from './grid/HitGrid';
+// https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/display-name.md
+const Wrapper = memo(({ show, showDrawer, children, onClose }) => {
+    return (_jsx(ErrorBoundary, { children: showDrawer ? (_jsx(Drawer, { onClose: onClose, open: show, anchor: "right", PaperProps: { sx: { backgroundImage: 'none', overflow: 'hidden', width: '75vw' } }, children: children })) : (_jsx(FlexPort, { disableOverflow: true, children: children })) }));
+});
+const HitBrowser = () => {
+    const { t } = useTranslation();
+    const theme = useTheme();
+    const views = useContextSelector(ViewContext, ctx => ctx.views);
+    const fetchViews = useContextSelector(ViewContext, ctx => ctx.fetchViews);
+    const selected = useContextSelector(ParameterContext, ctx => ctx.selected);
+    const setSelected = useContextSelector(ParameterContext, ctx => ctx.setSelected);
+    const query = useContextSelector(ParameterContext, ctx => ctx.query);
+    const setQuery = useContextSelector(ParameterContext, ctx => ctx.setQuery);
+    const setOffset = useContextSelector(ParameterContext, ctx => ctx.setOffset);
+    const selectedHits = useContextSelector(HitContext, ctx => ctx.selectedHits);
+    const addHitToSelection = useContextSelector(HitContext, ctx => ctx.addHitToSelection);
+    const removeHitFromSelection = useContextSelector(HitContext, ctx => ctx.removeHitFromSelection);
+    const clearSelectedHits = useContextSelector(HitContext, ctx => ctx.clearSelectedHits);
+    const searchPaneWidth = useMyLocalStorageItem(StorageKey.SEARCH_PANE_WIDTH, null)[0];
+    const forceDrawer = useMyLocalStorageItem(StorageKey.FORCE_DRAWER, false)[0];
+    const displayType = useContextSelector(HitSearchContext, ctx => ctx.displayType);
+    const viewId = useContextSelector(HitSearchContext, ctx => ctx.viewId);
+    const response = useContextSelector(HitSearchContext, ctx => ctx.response);
+    const queryHistory = useContextSelector(HitSearchContext, ctx => ctx?.queryHistory ?? {});
+    const setQueryHistory = useContextSelector(HitSearchContext, ctx => ctx?.setQueryHistory);
+    const setQueryList = useMyLocalStorageItem(StorageKey.QUERY_HISTORY, '')[1];
+    const location = useLocation();
+    const routeParams = useParams();
+    const [searchParams] = useSearchParams();
+    const [show, setShow] = useState(!!selected);
+    useEffect(() => setShow(!!selected), [selected]);
+    const showDrawer = useMediaQuery(theme.breakpoints.down(1600)) || forceDrawer || displayType === 'grid';
+    // State that makes up the request
+    const summaryQuery = useMemo(() => {
+        const bundle = location.pathname.startsWith('/bundles') && routeParams.id;
+        let _fullQuery = query;
+        if (bundle) {
+            _fullQuery = `(howler.bundles:${bundle}) AND (${_fullQuery})`;
+        }
+        else if (viewId) {
+            _fullQuery = `(${views[viewId]?.query || 'howler.id:*'}) AND (${_fullQuery})`;
+        }
+        return _fullQuery;
+    }, [location.pathname, query, routeParams.id, views, viewId]);
+    const showSelectBar = useMemo(() => {
+        if (selectedHits.length > 1) {
+            return true;
+        }
+        if (selectedHits.length === 1 && selected && selectedHits[0]?.howler.id !== selected) {
+            return true;
+        }
+        return false;
+    }, [selected, selectedHits]);
+    useEffect(() => {
+        const newQuery = searchParams.get('query');
+        if (newQuery) {
+            setQueryHistory(_queryHistory => ({
+                ..._queryHistory,
+                [newQuery]: new Date().toISOString()
+            }));
+        }
+    }, [searchParams, setQueryHistory]);
+    useEffect(() => {
+        setQueryList(JSON.stringify(queryHistory));
+    }, [queryHistory, setQueryList]);
+    useEffect(() => {
+        // On load check to filter out any queries older than one month
+        setQueryHistory(_queryHistory => {
+            const filterQueryTime = dayjs().subtract(1, 'month').toISOString();
+            return Object.fromEntries(Object.entries(_queryHistory).filter(([_, value]) => value > filterQueryTime));
+        });
+    }, [setQueryHistory]);
+    useEffect(() => {
+        if (!location.pathname.startsWith('/views') || has(views, viewId)) {
+            return;
+        }
+        fetchViews([viewId]);
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [location.pathname, viewId]);
+    const onClose = useCallback(() => {
+        setSelected(null);
+    }, [setSelected]);
+    useEffect(() => {
+        if (selected &&
+            response &&
+            !response.items.some(_hit => _hit.howler.id === selected) &&
+            (!location.pathname.startsWith('/bundles') || routeParams.id !== selected)) {
+            setSelected(null);
+            if (selectedHits.length < 2) {
+                removeHitFromSelection(selected);
+            }
+            return;
+        }
+        if (selected && !selectedHits.some(_hit => _hit?.howler.id === selected)) {
+            addHitToSelection(selected);
+        }
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [addHitToSelection, location.pathname, removeHitFromSelection, response, routeParams.id, selected, setSelected]);
+    return (_jsxs(Stack, { direction: "row", flex: 1, sx: { overflow: 'hidden' }, children: [_jsxs(Box, { position: "relative", flex: 1.15, height: "100%", display: "flex", sx: [{ overflow: 'auto' }, displayType === 'list' && !isNull(searchPaneWidth) && { maxWidth: searchPaneWidth }], children: [_jsx(ErrorBoundary, { children: displayType === 'list' ? _jsx(SearchPane, {}) : _jsx(HitGrid, {}) }), _jsx(Collapse, { in: showSelectBar, unmountOnExit: true, sx: {
+                            position: 'absolute',
+                            bottom: 0,
+                            left: 0,
+                            right: 0,
+                            backgroundColor: theme.palette.background.paper,
+                            py: 1,
+                            px: 2
+                        }, children: _jsxs(Stack, { direction: "row", alignItems: "center", spacing: 1, children: [_jsx(Tooltip, { title: t('hit.search.select.all'), children: _jsx(Checkbox, { size: "small", checked: !!response?.items.every(_hit1 => selectedHits.some(_hit2 => _hit1.howler.id === _hit2.howler.id)), onChange: (__, checked) => checked ? response.items.forEach(_hit => addHitToSelection(_hit.howler.id)) : clearSelectedHits() }) }), _jsx(Typography, { children: _jsx(Trans, { i18nKey: "hit.search.selected", values: { size: selectedHits.length } }) }), _jsx(FlexOne, {}), _jsx(Tooltip, { title: t('hit.search.select.clear'), children: _jsx(IconButton, { size: "small", onClick: () => {
+                                            setSelected(null);
+                                            clearSelectedHits();
+                                        }, children: _jsx(Close, {}) }) }), _jsx(Tooltip, { title: t('hit.search.select.view'), children: _jsx(IconButton, { size: "small", onClick: () => {
+                                            setOffset(0);
+                                            setQuery(`howler.id:(${selectedHits.map(hit => hit.howler.id).join(' OR ')})`);
+                                        }, children: _jsx(ManageSearch, {}) }) })] }) })] }), _jsxs(Wrapper, { show: show, showDrawer: showDrawer, onClose: () => setShow(false), children: [_jsx(HitSummary, { query: summaryQuery, response: response }), _jsxs(Card, { variant: "outlined", sx: [
+                            {
+                                zIndex: 100,
+                                overflow: 'visible',
+                                position: 'absolute',
+                                top: 0,
+                                bottom: 0,
+                                left: '100%',
+                                right: 0,
+                                borderTop: 0,
+                                borderBottom: 0,
+                                transition: theme.transitions.create('left')
+                            },
+                            selected && {
+                                left: theme.spacing(5)
+                            },
+                            location.pathname.startsWith('/bundles') &&
+                                routeParams.id && {
+                                left: 0
+                            }
+                        ], children: [_jsx(InformationPane, { onClose: onClose }), selected && !(location.pathname.startsWith('/bundles') && routeParams.id) && (_jsx(Box, { onClick: onClose, sx: {
+                                    cursor: 'pointer',
+                                    position: 'absolute',
+                                    right: '100%',
+                                    width: theme.spacing(5),
+                                    top: 0,
+                                    bottom: 0,
+                                    background: `linear-gradient(to right, transparent, ${theme.palette.background.paper})`
+                                } }))] })] }), showDrawer && (_jsx(Fab, { onClick: () => setShow(_show => !_show), color: "primary", sx: {
+                    position: 'fixed',
+                    right: show ? `calc(100% - ${theme.spacing(8)})` : theme.spacing(2),
+                    bottom: showSelectBar ? theme.spacing(6) : theme.spacing(1),
+                    zIndex: 1201,
+                    transition: theme.transitions.create(['right', 'bottom'])
+                }, children: _jsx(ChevronLeft, { sx: { transition: 'rotate 250ms', rotate: show ? '180deg' : '0deg' } }) }))] }));
+};
+const HitBrowserProvider = () => {
+    return (_jsx(ParameterProvider, { children: _jsx(HitSearchProvider, { children: _jsx(HitBrowser, {}) }) }));
+};
+export default HitBrowserProvider;

package/components/routes/hits/search/HitContextMenu.d.ts

@@ -0,0 +1,7 @@
+import type { FC, PropsWithChildren } from 'react';
+interface HitContextMenuProps {
+    getSelectedId: (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => string;
+    Component?: React.ElementType;
+}
+declare const HitContextMenu: FC<PropsWithChildren<HitContextMenuProps>>;
+export default HitContextMenu;