{"id":19866604,"url":"https://github.com/mitre-attack/attack-workbench-deployment","last_synced_at":"2025-02-28T23:41:19.170Z","repository":{"id":37952368,"uuid":"465809061","full_name":"mitre-attack/attack-workbench-deployment","owner":"mitre-attack","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-07T12:33:18.000Z","size":35,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-01-11T15:48:17.057Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mitre-attack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-03T16:58:39.000Z","updated_at":"2024-07-27T14:12:44.000Z","dependencies_parsed_at":"2024-11-12T15:32:49.969Z","dependency_job_id":"c35a27c5-c1d0-4e8d-afb9-eef91f5aa6f9","html_url":"https://github.com/mitre-attack/attack-workbench-deployment","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitre-attack%2Fattack-workbench-deployment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitre-attack%2Fattack-workbench-deployment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitre-attack%2Fattack-workbench-deployment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mitre-attack%2Fattack-workbench-deployment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mitre-attack","download_url":"https://codeload.github.com/mitre-attack/attack-workbench-deployment/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241277529,"owners_count":19937757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T15:26:33.650Z","updated_at":"2025-02-28T23:41:19.138Z","avatar_url":"https://github.com/mitre-attack.png","language":null,"readme":"# ATT\u0026CK Workbench Deployment\n\nThis repository contains Docker Compose templates and helper files to assist with the initialization of the ATT\u0026CK Workbench.\n\n## Getting Started\n\n1. Clone this repository:\n   ```\n   git clone https://github.com/your-repo/attack-workbench-deployment.git\n   cd attack-workbench-deployment\n   ```\n\n2. Create the required configuration files:\n   - `configs/rest-api/.env`: Define environment variables for the REST API service.\n   - `configs/taxii/config/.env`: Define environment variables for the TAXII server service (if included).\n\n   Configuration templates are provided for the REST API and TAXII 2.1 servers:\n   ```bash\n   cp configs/rest-api/template.env configs/rest-api/.env\n   cp configs/taxii/config/template.env configs/taxii/config/.env\n   ```\n\n3. Start the Docker Compose services:\n   - To include the TAXII server, run:\n     ```\n     docker-compose --profile with-taxii up -d\n     ```\n   - To exclude the TAXII server, run:\n     ```\n     docker-compose up -d\n     ```\n\n## Configuration\n\n### ATT\u0026CK Workbench REST API\n\nThe REST API service is configured using environment variables defined in the `configs/rest-api/.env` file. Here's an example:\n\n```\n# configs/rest-api/.env\nDATABASE_URL=mongodb://attack-workbench-database/attack-workspace\nAUTHN_MECHANISM=anonymous\n```\n\nAdditionally, an optional JSON configuration file can be used by setting the `JSON_CONFIG_PATH` environment variable to point to `configs/rest-api/rest-api-service-config.json`.\n\n### ATT\u0026CK Workbench TAXII 2.1 Server\n\nThe ATT\u0026CK Workbench TAXII 2.1 API is an optional extension of the ATT\u0026CK Workbench. It is defined in the `taxii` service of the included [Docker Compose template](./docker-compose.yml).\n\nThe TAXII server requires at least one `.env` configuration file at runtime. This file will be volume-mounted to the container. On the Docker host, place the `.env` file in `configs/taxii/config/`.\n\nThe `TAXII_ENV` environment variable determines the name of the `.env` file that the TAXII application will load. For example:\n- `TAXII_ENV=dev` will load `configs/taxii/config/dev.env`\n- `TAXII_ENV=prod` will load `configs/taxii/config/prod.env`\n- If `TAXII_ENV` is not set, it will load `configs/taxii/config/.env`\n\nA `.env` [template](./configs/taxii/config/template.env) is included to help you get started.\n\nAdditionally, if the TAXII server is configured to use HTTPS, you'll need to provide the following files:\n- `configs/taxii/config/private-key.pem`\n- `configs/taxii/config/public-certificate.pem`\n\nAlternatively, you can base64 encode the `pem` files and set them via `TAXII_SSL_PRIVATE_KEY` and `TAXII_SSL_PUBLIC_KEY` in your `.env` file.\n\n## Using Docker Compose Profiles\n\nThis repository includes a Docker Compose profile to optionally include or exclude the TAXII server service.\n\n- To include the TAXII server, use the `with-taxii` profile:\n  ```\n  docker-compose --profile with-taxii up -d\n  ```\n\n- To exclude the TAXII server, run Docker Compose without any profile:\n  ```\n  docker-compose up -d\n  ```\n\nThe `with-taxii` profile is defined in the `docker-compose.yml` file and includes the `taxii` service.","funding_links":[],"categories":["Shell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmitre-attack%2Fattack-workbench-deployment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmitre-attack%2Fattack-workbench-deployment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmitre-attack%2Fattack-workbench-deployment/lists"}