Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

file carve download with password-protected .zip file #288

Closed
mmguero opened this issue Nov 8, 2023 · 3 comments
Closed

file carve download with password-protected .zip file #288

mmguero opened this issue Nov 8, 2023 · 3 comments
Assignees
Labels
carving Relating to carving (extraction) of files from traffic and the scanning of those files enhancement New feature or request
Milestone

Comments

@mmguero
Copy link
Collaborator

mmguero commented Nov 8, 2023

In the malcolm configuration for carving files (search preserved files in that document) you see the following:

  • Expose web interface for downloading preserved files?
    • Answering Y enables access to the Zeek-extracted files path through the means of a simple HTTPS directory server at https:///extracted-files/. Beware that Zeek-extracted files may contain malware.
  • Enter AES-256-CBC encryption password for downloaded preserved files (or leave blank for unencrypted)
    • If a password is specified here, Zeek-extracted files downloaded as described under the previous question will be AES-256-CBC-encrypted in an openssl enc-compatible format (e.g., openssl enc -aes-256-cbc -d -in example.exe.encrypted -out example.exe).

It's a typical industry practice to provide files like this in a .zip file (maybe with a default password like infected or something). We should provide that as an option. So there'd be three options:

  • unencrypted
  • encrypted with openssl and the provided password
  • encrypted with zip and the provided password (defaulting to infected?)

the main place to implement this is in zeek_carved_http_server.py and anywhere the EXTRACTED_FILE_HTTP_SERVER_ENCRYPT variable is set (probably change this from true/false to an option like none, zip, or openssl maybe)

@mmguero mmguero added the carving Relating to carving (extraction) of files from traffic and the scanning of those files label Nov 8, 2023
@mmguero mmguero added this to Malcolm Nov 8, 2023
@mmguero mmguero moved this to Todo (develop) in Malcolm Nov 8, 2023
@mmguero mmguero added the enhancement New feature or request label Nov 8, 2023
@mmguero mmguero added this to the v24.01.0 milestone Dec 5, 2023
@mmguero mmguero self-assigned this Dec 21, 2023
@mmguero mmguero moved this from Todo (develop) to In Progress in Malcolm Dec 21, 2023
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Dec 21, 2023
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Dec 21, 2023
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Dec 21, 2023
…ust base it off of whether or not EXTRACTED_FILE_HTTP_SERVER_KEY is set (idaholab#288)
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Dec 21, 2023
@mmguero
Copy link
Collaborator Author

mmguero commented Dec 21, 2023

The new documentation describes the change:
The EXTRACTED_FILE_HTTP_SERVER_… environment variables in zeek.env and zeek-secret.env configure access to the Zeek-extracted files path through the means of a simple HTTPS directory server accessible at https://localhost/extracted-files/ if connecting locally. Beware that Zeek-extracted files may contain malware. As such, these files may be optionally ZIP archived (with or without a password) or encrypted (to be decrypted using openssl, e.g., openssl enc -aes-256-cbc -d -in example.exe.encrypted -out example.exe) upon download. In other words:

  • to disable the extracted files server:
    • EXTRACTED_FILE_HTTP_SERVER_ENABLE=false
  • to enable the extracted file server:
    • EXTRACTED_FILE_HTTP_SERVER_ZIP=true
    • downloaded files are zipped, without a password:
      • EXTRACTED_FILE_HTTP_SERVER_ZIP=true
      • EXTRACTED_FILE_HTTP_SERVER_KEY=
    • downloaded files are zipped, with a password:
      • EXTRACTED_FILE_HTTP_SERVER_ZIP=true
      • EXTRACTED_FILE_HTTP_SERVER_KEY=xxxxxxxxxxxxx
    • downloaded files are OpenSSL AES-256-CBC-compatibly encrypted:
      • EXTRACTED_FILE_HTTP_SERVER_ZIP=false
      • EXTRACTED_FILE_HTTP_SERVER_KEY=xxxxxxxxxxxxx
    • downloaded files are downloaded as-is, without archival or compression:
      • EXTRACTED_FILE_HTTP_SERVER_ZIP=false
      • EXTRACTED_FILE_HTTP_SERVER_KEY=

mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Dec 21, 2023
@mmguero mmguero moved this from In Progress to Testing in Malcolm Dec 21, 2023
@mmguero
Copy link
Collaborator Author

mmguero commented Jan 4, 2024

Before I finalize this, I'm watching uktrade/stream-zip#94 which will allow us to stream both the unencrypted and encrypted ZIP files.

mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Jan 4, 2024
@mmguero mmguero moved this from Testing to Done in Malcolm Jan 4, 2024
@mmguero
Copy link
Collaborator Author

mmguero commented Jan 4, 2024

this appears to be working!

@mmguero mmguero closed this as completed Jan 4, 2024
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Jan 4, 2024
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Jan 4, 2024
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Jan 4, 2024
This was referenced Jan 17, 2024
mmguero added a commit that referenced this issue Jan 17, 2024
Malcolm v24.01.0 contains new features, improvements, bug fixes and component version updates.

v23.12.1...v24.0.1

* Features and enhancements
    + new Malcolm instance landing page (#252)
    + file carve download with password-protected .zip file (#288)
    + new "all files exept common plain text files" option for Malcolm's file carving to match Hedgehog capability (#290)
    + allow customizing indexes for logs written to OpenSearch/Elasticsearch (#313)
    + more consistently differentiate between uploaded and live-captured traffic (#321)
    + make download extracted file context item from Arkime smarter (#330)
    + improve netbox device type library import by using "official" import script (#384)
* Component version updates
    + Alpine Linux to [v3.19](https://alpinelinux.org/posts/Alpine-3.19.0-released.html) as the base for some Docker images
    + Fluent Bit to [v2.2.2](https://github.com/fluent/fluent-bit/releases/tag/v2.2.2)
    + Beats to [v8.11.4](https://www.elastic.co/guide/en/beats/libbeat/8.11/release-notes-8.11.4.html)
    + LogStash to [v8.11.4](https://www.elastic.co/guide/en/logstash/current/logstash-8-11-4.html)
* Bug fixes
    + Suricata Alerts dashboard "Alerts - Tags" visualization is useless (#314)
    + third party logs are not parsed correctly from fluentbit -> fluentd aggregator -> Malcolm (#318)
    + update document lookup APIs to search either network or host data (#322)
    + suricata rule update is broken (#323)
    + time sync from hedgehog to Malcolm opensearch instance not working (#324)
    + fix issue specifying database mode via command-line
    + have pruning of OpenSearch indices (based on size) include "other" Malcolm indices as well (e.g., nginx logs, system resources, third-party logs, etc.)
* Configuration changes (in [environment variables](https://idaholab.github.io/Malcolm/docs/malcolm-config.html#MalcolmConfigEnvVars) in [`./config/`](https://github.com/idaholab/Malcolm/tree/v24.0.1/config))
    + added the following variables with relation to #313
        - added `ARKIME_ROTATE_INDEX` to [`arkime.env`](https://github.com/idaholab/Malcolm/tree/v24.0.1/arkime.env.example) with default value of `daily` (see [Arkime docs on rotateIndex](https://arkime.com/settings#rotateIndex))
        - added the following variables and defaults to [`opensearch.env`](https://github.com/idaholab/Malcolm/tree/v24.0.1/opensearch.env.example):
        ```
        # OpenSearch index patterns and timestamp fields
        # Index pattern for network traffic logs written via Logstash (e.g., Zeek logs, Suricata alerts)
        MALCOLM_NETWORK_INDEX_PATTERN=arkime_sessions3-*
        # Default time field to use for network traffic logs in Logstash and Dashboards
        MALCOLM_NETWORK_INDEX_TIME_FIELD=firstPacket
        # Suffix used to create index to which network traffic logs are written (supports Ruby strftime strings in %{})
        MALCOLM_NETWORK_INDEX_SUFFIX=%{%y%m%d}
        # Index pattern for other logs written via Logstash (e.g., nginx, beats, fluent-bit, etc.)
        MALCOLM_OTHER_INDEX_PATTERN=malcolm_beats_*
        # Default time field to use for other logs in Logstash and Dashboards
        MALCOLM_OTHER_INDEX_TIME_FIELD=@timestamp
        # Suffix used to create index to which other logs are written (supports Ruby strftime strings in %{})
        MALCOLM_OTHER_INDEX_SUFFIX=%{%y%m%d}
        # Index pattern used specifically by Arkime (will probably match MALCOLM_NETWORK_INDEX_PATTERN, should probably be arkime_sessions3-*)
        ARKIME_NETWORK_INDEX_PATTERN=arkime_sessions3-*
        # Default time field used by for sessions in Arkime viewer
        ARKIME_NETWORK_INDEX_TIME_FIELD=firstPacket
        ```
    + changed default for `EXTRACTED_FILE_HTTP_SERVER_KEY` to `infected` in [`zeek-secret.env`](https://github.com/idaholab/Malcolm/tree/v24.0.1/zeek-secret.env.example)
    + added `EXTRACTED_FILE_HTTP_SERVER_ZIP` with default value of `false` in [`zeek.env`](https://github.com/idaholab/Malcolm/tree/v24.0.1/zeek.env.example), see (#288)
mmguero added a commit to cisagov/Malcolm that referenced this issue Jan 17, 2024
Malcolm v24.01.0 contains new features, improvements, bug fixes and component version updates.

v23.12.1...v24.0.1

* Features and enhancements
    + new Malcolm instance landing page (idaholab#252)
    + file carve download with password-protected .zip file (idaholab#288)
    + new "all files exept common plain text files" option for Malcolm's file carving to match Hedgehog capability (idaholab#290)
    + allow customizing indexes for logs written to OpenSearch/Elasticsearch (idaholab#313)
    + more consistently differentiate between uploaded and live-captured traffic (idaholab#321)
    + make download extracted file context item from Arkime smarter (idaholab#330)
    + improve netbox device type library import by using "official" import script (idaholab#384)
* Component version updates
    + Alpine Linux to [v3.19](https://alpinelinux.org/posts/Alpine-3.19.0-released.html) as the base for some Docker images
    + Fluent Bit to [v2.2.2](https://github.com/fluent/fluent-bit/releases/tag/v2.2.2)
    + Beats to [v8.11.4](https://www.elastic.co/guide/en/beats/libbeat/8.11/release-notes-8.11.4.html)
    + LogStash to [v8.11.4](https://www.elastic.co/guide/en/logstash/current/logstash-8-11-4.html)
* Bug fixes
    + Suricata Alerts dashboard "Alerts - Tags" visualization is useless (idaholab#314)
    + third party logs are not parsed correctly from fluentbit -> fluentd aggregator -> Malcolm (idaholab#318)
    + update document lookup APIs to search either network or host data (idaholab#322)
    + suricata rule update is broken (idaholab#323)
    + time sync from hedgehog to Malcolm opensearch instance not working (idaholab#324)
    + fix issue specifying database mode via command-line
    + have pruning of OpenSearch indices (based on size) include "other" Malcolm indices as well (e.g., nginx logs, system resources, third-party logs, etc.)
* Configuration changes (in [environment variables](https://idaholab.github.io/Malcolm/docs/malcolm-config.html#MalcolmConfigEnvVars) in [`./config/`](https://github.com/cisagov/Malcolm/tree/v24.0.1/config))
    + added the following variables with relation to idaholab#313
        - added `ARKIME_ROTATE_INDEX` to [`arkime.env`](https://github.com/cisagov/Malcolm/tree/v24.0.1/arkime.env.example) with default value of `daily` (see [Arkime docs on rotateIndex](https://arkime.com/settings#rotateIndex))
        - added the following variables and defaults to [`opensearch.env`](https://github.com/cisagov/Malcolm/tree/v24.0.1/opensearch.env.example):
        ```
        # OpenSearch index patterns and timestamp fields
        # Index pattern for network traffic logs written via Logstash (e.g., Zeek logs, Suricata alerts)
        MALCOLM_NETWORK_INDEX_PATTERN=arkime_sessions3-*
        # Default time field to use for network traffic logs in Logstash and Dashboards
        MALCOLM_NETWORK_INDEX_TIME_FIELD=firstPacket
        # Suffix used to create index to which network traffic logs are written (supports Ruby strftime strings in %{})
        MALCOLM_NETWORK_INDEX_SUFFIX=%{%y%m%d}
        # Index pattern for other logs written via Logstash (e.g., nginx, beats, fluent-bit, etc.)
        MALCOLM_OTHER_INDEX_PATTERN=malcolm_beats_*
        # Default time field to use for other logs in Logstash and Dashboards
        MALCOLM_OTHER_INDEX_TIME_FIELD=@timestamp
        # Suffix used to create index to which other logs are written (supports Ruby strftime strings in %{})
        MALCOLM_OTHER_INDEX_SUFFIX=%{%y%m%d}
        # Index pattern used specifically by Arkime (will probably match MALCOLM_NETWORK_INDEX_PATTERN, should probably be arkime_sessions3-*)
        ARKIME_NETWORK_INDEX_PATTERN=arkime_sessions3-*
        # Default time field used by for sessions in Arkime viewer
        ARKIME_NETWORK_INDEX_TIME_FIELD=firstPacket
        ```
    + changed default for `EXTRACTED_FILE_HTTP_SERVER_KEY` to `infected` in [`zeek-secret.env`](https://github.com/cisagov/Malcolm/tree/v24.0.1/zeek-secret.env.example)
    + added `EXTRACTED_FILE_HTTP_SERVER_ZIP` with default value of `false` in [`zeek.env`](https://github.com/cisagov/Malcolm/tree/v24.0.1/zeek.env.example), see (idaholab#288)
@mmguero mmguero moved this from Done to Released in Malcolm Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
carving Relating to carving (extraction) of files from traffic and the scanning of those files enhancement New feature or request
Projects
Status: Released
Development

No branches or pull requests

1 participant