This script is meant to help make bulk tag operations across different objects that tags can be added to. Most commonly you can tag clients, assets, reports, findings, or writeups in the WriteupsDB. This script allows you to refractor, remove, or add tags in bulk. Refractor Mode: Search across all objects for specific tags and replace it with a new value. Removal Mode: Remove all occurrences of certain tags. Addition Mode: Add tags to objects where existing tags are found.

Tags also exist at the tenant level. The list of tenant tags is what populates the dropdown whenever adding a tag to an object. This script will add any tag to the tenant level if it was added to an object. It will also remove tags from the tenant level after successfully removing all occurrences of the tag from all objects in a PT instance.

• Python 3+
• pip
• pipenv

After installing Python, pip, and pipenv, run the following commands to setup the Python virtual environment.

git clone this_repo
cd path/to/cloned/repo
pipenv install

After setting up the Python environment the script will run in, you will need to setup a few things to configure the script before running.

In the config.yaml file you should add the full URL to your instance of Plextrac.

The config also can store your username and password. Plextrac authentication lasts for 15 mins before requiring you to re-authenticate. The script is set up to do this automatically through the authentication handler. If these 3 values are set in the config, and MFA is not enabled for the user, the script will take those values and authenticate automatically, both initially and every 15 mins. If any value is not saved in the config, you will be prompted when the script is run and during re-authentication.

After setting everything up you can run the script with the following command. You should run the command from the folder where you cloned the repo.

pipenv run python main.py

You can also add values to the config.yaml file to simplify providing the script with custom parameters needed to run.

The following values can either be added to the config.yaml file or entered when prompted for when the script is run.

• PlexTrac Top Level Domain e.g. https://yourapp.plextrac.com
• Username
• Password

Since the script has to load a lot of objects from the DB, ideally you input multiple tag replacements that the script will then update as it runs through the data once.

• Authenticates user to Plextrac instance with tags to be refactored
• Prompts the user which mode should be run
• Prompts the user to enter tags based on the mode chosen
• Once all tags to be replaced are entered, if will run through each tag entered and ask for the replacement for each tag
• After the user confirms the changes to be made, it will create lists of all objects by making multiple API requests to the Plextrac instance
• After the user confirms the objects that were loaded, it will go through the lists of loaded objects and make API requests to update any object found with required changes

The script will create a log file each time it is run. The script should only stop if it fails to load data at the beginning. As it runs, if an object couldn't be updated, it will log the exception and continue running. You can Ctrl+F and search for exception in the generated log file to see any problems during runtime.