> For the complete documentation index, see [llms.txt](https://docs.enginsight.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enginsight.com/docs/manual/english/platform-usage/penetration-testing/required-services/hacktors.md).

# Hacktors

Hacktor is an Enginsight component that is installed as a service in a specific network segment to run penetration tests on reachable assets using defined checks.

You can extend the checks provided and maintained by Enginsight with your own scripts. These scripts are stored directly on the server on which the Hacktor is installed.

{% hint style="success" icon="lightbulb" %}
For more information how to use custom scripts in penetration tests, see our Knowledge Base: [How can I use custom scripts in penetration tests with Enginsight?](https://docs.enginsight.com/docs/knowledge-base/english/penetration-tests/how-can-i-use-custom-scripts-in-penetration-tests-with-enginsight)
{% endhint %}

***

<i class="fa-compass">:compass:</i> Navigate to **Penetration Tests** → **Hacktors** to show an overview of all installed Hacktors. If you have not added a Hacktor yet, this view is empty.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2Fs7ysLDH60mBiQewMM7fo%2Fenginsight-screenshot-penetrations%20testing-required%20services-hacktors.jpg?alt=media&amp;token=2bc76701-3045-481a-92d9-74fb6ee15427" alt=""><figcaption></figcaption></figure>

The [Hacktor overview](#hacktor-overview) provides information such as:

* when a Hacktor was installed and last edited.
* which version of a Hacktor is installed and whether an update is available.
* which target IP addresses are used for penetration tests performed with a Hacktor.

You can also retrieve logs for a Hacktor and [add new Hacktors](#add-hacktor).

***

## Navigation

<i class="fa-magnifying-glass">:magnifying-glass:</i> Click the **Text Search** field above the list and enter a search term of your choice to find specific list items more quickly.

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Refresh** icon <i class="fa-arrows-rotate-reverse">:arrows-rotate-reverse:</i> above the list to update all list items.

<i class="fa-computer-mouse-scrollwheel">:computer-mouse-scrollwheel:</i> Scroll down the list or adjust the number of results shown per page ![](https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FfjKACCt2SKXcFd3S7Xb5%2FEnginsight-EN-Results%20per%20Page.jpg?alt=media\&token=e1650160-7a41-4965-aaca-6975db758dbe) to view additional entries. Use the page navigation ![](https://content.gitbook.com/content/V7OrHgKXA0t1jankQBYf/blobs/wnxVw06QGoSsYjhwMJRF/Enginsight-Seitennavigation-2.jpg) to switch between pages.&#x20;

### Sorting List Items

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Sort** icon <i class="fa-sort">:sort:</i> next to a column name in the table header to sort by that column in ascending <i class="fa-angle-up">:angle-up:</i> or descending order <i class="fa-chevron-down">:chevron-down:</i> .

<i class="fa-computer-mouse">:computer-mouse:</i> Click the sort icon <i class="fa-bars-sort">:bars-sort:</i> above the list to adjust the priority of the applied sorting. A menu opens that shows all columns by which the list is currently sorted. Drag and drop the shown items to change the sorting priority.

### Further Actions for List Items

<i class="fa-computer-mouse">:computer-mouse:</i> Select the checkbox <i class="fa-square">:square:</i> next to a list item to select the respective item. Alternatively, select the checkbox in the table header to select all list items.

The number of selected list items is now shown next to the search field.

The <i class="fa-slider">:slider:</i> **Actions** menu also appears in the upper-right corner. Click it to expand the respective submenu. The following actions are available:

<table><thead><tr><th width="200.08203125">Action</th><th>Description</th></tr></thead><tbody><tr><td>Delete</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Delete</strong> and confirm the prompt by clicking <strong>Delete</strong> to delete all selected Hacktors.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Please note</strong>: Deleted settings cannot be recovered.</p></div></td></tr><tr><td>Update Service</td><td><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Update Service</strong> to download and install the latest version of the Hacktor.</td></tr></tbody></table>

***

## Hacktors: Overview

The Hacktor overview is structured as a table.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FgbdFtfVhbedr2mN6fadS%2Fenginsight-screenshot-penetrations%20testing-required%20services-hacktors-overview.jpg?alt=media&amp;token=4c24a044-a80d-455f-ba89-09216f979dac" alt=""><figcaption></figcaption></figure>

The following information is shown:

<table><thead><tr><th width="200">Column</th><th>Description</th></tr></thead><tbody><tr><td>Display Name</td><td><p>Shows the custom name of the Hacktor, as well as the date and time it was created and last edited. </p><p></p><p>The installed Hacktor version and the runtime environment, in this case <em>service</em>, is also shown.</p><p><br>Each Hacktor is also represented by an icon with a colored dot indicating whether the Hacktor is up to date or whether an update is available.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>The latest Hacktor version is shown in the header of the Hacktor overview.</p></div><p>The following colors can be shown:</p><ul><li><strong>Green</strong>: The Hacktor is up to date.</li><li><strong>Red</strong>: The installed Hacktor version is outdated. In this case, the <strong>Update Available</strong> button also appears. While the Hacktor is being updated, the <strong>Updating</strong> button is shown.</li></ul><p><br><i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a Hacktor to navigate to the respective <a href="#hacktor-edit-view">edit view</a>. Here you can change configured settings.</p></td></tr><tr><td>IP Addresses</td><td>Shows all IP addresses on which penetration tests are performed using the respective Hacktor.</td></tr><tr><td>Actions</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <i class="fa-file-lines">:file-lines:</i> <strong>Retrieve Logs</strong> to download the Hacktor logs as a <strong>txt.gz</strong> file.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You can find the exported file in the default download location of your browser.</p></div><div data-gb-custom-block data-tag="hint" data-style="warning" class="hint hint-warning"><p><strong>Please note</strong>: How far back the log entries go depends on the configured retention period (time to live; TTL) for penetration test audit log entries. The default TTL is 90 days. You can adjust the TTL manually.</p></div><div data-gb-custom-block data-tag="hint" data-style="success" data-icon="lightbulb" class="hint hint-success"><p>For more information on how to change the retention periods for Enginsight log entries, see our Knowledge Base: <a href="https://docs.enginsight.com/docs/knowledge-base/english/logging/how-can-i-adjust-the-retention-periods-for-my-enginsight-logs">How can I adjust the retention periods for my Enginsight logs?</a></p><p></p></div></td></tr></tbody></table>

***

## Adding a Hacktor

<i class="fa-computer-mouse">:computer-mouse:</i> Click <i class="fa-plus">:plus:</i> **Add Hacktor** in the upper-right corner to install a new Hacktor.

For the respective installation instructions, refer to [Installation and Configuration: Hacktor](/docs/manual/english/installation-and-configuration/installation-and-configuration/enginsight-components/hacktor.md).

***

## Hacktor: Edit View

<i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a Hacktor to navigate to the respective edit view. Here you can change [configured settings](/docs/manual/english/installation-and-configuration/installation-and-configuration/enginsight-components/hacktor.md#general-settings).

***

## Further Resources

**Knowledge Base**

* [How can I use custom scripts in penetration tests with Enginsight?](https://docs.enginsight.com/docs/knowledge-base/english/penetration-tests/how-can-i-use-custom-scripts-in-penetration-tests-with-enginsight)
* [How can I adjust the retention periods for my Enginsight logs?](https://docs.enginsight.com/docs/knowledge-base/english/logging/how-can-i-adjust-the-retention-periods-for-my-enginsight-logs)
* [How can I retrieve the logs of the Enginsight component Hacktor?](https://docs.enginsight.com/docs/knowledge-base/english/logging/how-can-i-retrieve-the-logs-of-the-enginsight-component-hacktor)

***