[//]: # (TODO: add badges for python versions, black, pylint, flake8, unit tests, integration tests)
# Cryton Core
Cryton Core is the center point of the Cryton toolset. It is used for:
- Creating, planning, and scheduling attack scenarios
- Generating reports from attack scenarios
- Controlling Workers and scenarios execution
Cryton toolset is tested and targeted primarily on **Debian** and **Kali Linux**. Please keep in mind that **only
the latest version is supported** and issues regarding different OS or distributions may **not** be resolved.
For more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/core/).
## Quick-start
To be able to execute attack scenarios, you also need to install **[Cryton Worker](https://gitlab.ics.muni.cz/cryton/cryton-worker)**
and **[Cryton CLI](https://gitlab.ics.muni.cz/cryton/cryton-cli)** packages.
Optionally you can install [Cryton Frontend](https://gitlab.ics.muni.cz/cryton/cryton-frontend) for a non-command line experience.
Make sure Git, Docker, and Docker Compose plugin are installed:
- [Git](https://git-scm.com/)
- [Docker Compose](https://docs.docker.com/compose/install/)
Optionally, check out these Docker [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/).
The following script clones the repository and runs the Docker Compose configuration. The compose file contains the necessary prerequisites
(Postgres, PgBouncer, RabbitMQ), Cryton Core itself (listener and REST API), and a proxy that allows access to the Cryton Core's REST API
at http://0.0.0.0:8000/.
```shell
git clone https://gitlab.ics.muni.cz/cryton/cryton-core.git
cd cryton-core
sed -i "s|CRYTON_CORE_RABBIT_HOST=127.0.0.1|CRYTON_CORE_RABBIT_HOST=cryton-rabbit|" .env
sed -i "s|CRYTON_CORE_DB_HOST=127.0.0.1|CRYTON_CORE_DB_HOST=cryton-pgbouncer|" .env
sed -i "s|CRYTON_CORE_API_USE_STATIC_FILES=false|CRYTON_CORE_API_USE_STATIC_FILES=true|" .env
docker compose up -d
```
For more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/core/).
## Contributing
Contributions are welcome. Please **contribute to the [project mirror](https://gitlab.com/cryton-toolset/cryton-core)** on gitlab.com.
For more information see the [contribution page](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/contribution-guide/).
Raw data
{
"_id": null,
"home_page": "https://gitlab.ics.muni.cz/cryton",
"name": "cryton-core",
"maintainer": "Ji\u0159\u00ed R\u00e1ja",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "raja@ics.muni.cz",
"keywords": "cryton,core,advanced,scheduler",
"author": "Ivo Nut\u00e1r",
"author_email": "nutar@ics.muni.cz",
"download_url": "https://files.pythonhosted.org/packages/b3/bc/0c5089a793d56a771217cfae0cafd936c02ac9754f3b66041c24ca9f9804/cryton_core-1.2.2.tar.gz",
"platform": null,
"description": "\n\n[//]: # (TODO: add badges for python versions, black, pylint, flake8, unit tests, integration tests)\n\n# Cryton Core\nCryton Core is the center point of the Cryton toolset. It is used for:\n- Creating, planning, and scheduling attack scenarios\n- Generating reports from attack scenarios\n- Controlling Workers and scenarios execution\n\nCryton toolset is tested and targeted primarily on **Debian** and **Kali Linux**. Please keep in mind that **only \nthe latest version is supported** and issues regarding different OS or distributions may **not** be resolved.\n\nFor more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/core/).\n\n## Quick-start\nTo be able to execute attack scenarios, you also need to install **[Cryton Worker](https://gitlab.ics.muni.cz/cryton/cryton-worker)** \nand **[Cryton CLI](https://gitlab.ics.muni.cz/cryton/cryton-cli)** packages. \nOptionally you can install [Cryton Frontend](https://gitlab.ics.muni.cz/cryton/cryton-frontend) for a non-command line experience.\n\nMake sure Git, Docker, and Docker Compose plugin are installed:\n- [Git](https://git-scm.com/)\n- [Docker Compose](https://docs.docker.com/compose/install/)\n\nOptionally, check out these Docker [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/).\n\nThe following script clones the repository and runs the Docker Compose configuration. The compose file contains the necessary prerequisites\n(Postgres, PgBouncer, RabbitMQ), Cryton Core itself (listener and REST API), and a proxy that allows access to the Cryton Core's REST API\nat http://0.0.0.0:8000/.\n```shell\ngit clone https://gitlab.ics.muni.cz/cryton/cryton-core.git\ncd cryton-core\nsed -i \"s|CRYTON_CORE_RABBIT_HOST=127.0.0.1|CRYTON_CORE_RABBIT_HOST=cryton-rabbit|\" .env\nsed -i \"s|CRYTON_CORE_DB_HOST=127.0.0.1|CRYTON_CORE_DB_HOST=cryton-pgbouncer|\" .env\nsed -i \"s|CRYTON_CORE_API_USE_STATIC_FILES=false|CRYTON_CORE_API_USE_STATIC_FILES=true|\" .env\ndocker compose up -d\n```\n\nFor more information see the [documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/components/core/).\n\n## Contributing\nContributions are welcome. Please **contribute to the [project mirror](https://gitlab.com/cryton-toolset/cryton-core)** on gitlab.com.\nFor more information see the [contribution page](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/latest/contribution-guide/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Advanced scheduler for attack scenarios",
"version": "1.2.2",
"project_urls": {
"Documentation": "https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/",
"Homepage": "https://gitlab.ics.muni.cz/cryton",
"Repository": "https://gitlab.ics.muni.cz/cryton/cryton-core"
},
"split_keywords": [
"cryton",
"core",
"advanced",
"scheduler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0168eb5676c188d6cdfdfe6cb0a0efa39849424a94f21fe1f8cd4ca081ef18d7",
"md5": "7319280d8b89fddf23e54b88746bd18a",
"sha256": "c2e2f82334154603928cf65d2b4e5216e0305247651aa7a244b7a9d172881d58"
},
"downloads": -1,
"filename": "cryton_core-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7319280d8b89fddf23e54b88746bd18a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 4483054,
"upload_time": "2023-09-25T10:41:55",
"upload_time_iso_8601": "2023-09-25T10:41:55.861448Z",
"url": "https://files.pythonhosted.org/packages/01/68/eb5676c188d6cdfdfe6cb0a0efa39849424a94f21fe1f8cd4ca081ef18d7/cryton_core-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3bc0c5089a793d56a771217cfae0cafd936c02ac9754f3b66041c24ca9f9804",
"md5": "440cbe65cc91858d92bdbb91c75bf335",
"sha256": "2fdcba488d6c871fd5cfeb37bd5f1fb357e7c4ad668a0e54aa3c3761b2b21b38"
},
"downloads": -1,
"filename": "cryton_core-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "440cbe65cc91858d92bdbb91c75bf335",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 4376999,
"upload_time": "2023-09-25T10:41:58",
"upload_time_iso_8601": "2023-09-25T10:41:58.580523Z",
"url": "https://files.pythonhosted.org/packages/b3/bc/0c5089a793d56a771217cfae0cafd936c02ac9754f3b66041c24ca9f9804/cryton_core-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 10:41:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cryton-core"
}
JSON