Manage your population of honeytokens

Overview

The Honeytoken module homepage presents the list of your honeytokens, displaying the main information as well as the status of each one.

You can filter the honeytokens based on a number of filters:

• Type of honeytokens
• Source (monitored repositories where the honeytoken is located)
• Status (Active, Triggered, Revoked)
• Tag (Publicly exposed)
• Labels

Clicking on the honeytoken name will direct you to its detail page.

• The Information section summarises the main information about your honeytoken and allows you to edit the name, description and labels.
• The Events section is where any usage of the honeytoken will get logged.
• The Timeline section provides the history of the honeytoken: when and where it was created, edited, deployed in a monitored source, triggered… It is also possible to add comments there.

Using labels to categorize your honeytokens

Labels provide a flexible way to organize honeytokens. You can create your own labels in the form of keys and values, assign them to honeytokens, and use them to filter and search for honeytokens based on specific characteristics.

Manage labels

Go to Settings > Secrets > Honeytoken to access the Labels settings page. From here, you can view the existing keys as well as the existing values for each key, and see how many honeytokens are categorized under them.

Create labels

You can create new keys and values from the Labels setting page. It is also possible to create them directly when creating or editing a honeytoken.

Edit or delete labels

On the Labels settings page, hover over a key or value name to bring up the option to edit or delete the label. Note that deleting a label is not reversible, even if it is used in honeytokens. However, it is still possible to delete it, which will remove it from any honeytoken.

Similarly, if you edit a key or value, the modification will be applied to all honeytokens that use that label.

Examples of use

• Create one place key that can have the values codebase, docker, jenkins, jira, slack... representing the type of location where the honeytoken is deployed.
• Create one team key that can have values representing your teams and indicating which scope is covered by this honeytoken.
• Create one env key that can have the values prod, test, staging...

Assigning Labels to Honeytokens

Each honeytoken can receive one or several labels. Please note that when assigning labels to a honeytoken, only one value from each key may be used.

Number of allowed honeytokens

AWS honeytokens are available in a limited number. If you have reached this limitation, it is not possible to create new honeytokens anymore.

Revoked honeytokens are not included in the count of honeytokens. Only active and triggered honeytokens are included.

If you don’t have enough honeytokens, you can reach out to GitGuardian to discuss extending your limitation.