Skip to content
Snippets Groups Projects
Commit fdb5fae7 authored by Jiří Rája's avatar Jiří Rája 🔥
Browse files

Merge branch 'fix-links-after-the-group-transfer' into 'master'

Fixed project links

See merge request cryton/cryton-modules!33
parents 53830351 509f7383
No related branches found
No related tags found
No related merge requests found
......@@ -17,7 +17,7 @@ cache:
before_script:
- python --version
- pip install poetry==1.1.15
- git clone https://gitlab.ics.muni.cz/beast-public/cryton/cryton-worker.git
- git clone https://gitlab.ics.muni.cz/cryton/cryton-worker.git
- cd cryton-worker
- poetry install
- export $(grep -v '^#' .env | xargs)
......
......@@ -7,18 +7,18 @@ Cryton (attack) modules is a collection of Python scripts with the goal of orche
(Nmap, Metasploit, THC Hydra, etc.). Although this is their intended purpose, they are still Python scripts, and therefore
any custom-made script can be used similarly.
Attack modules get executed inside Step objects using [Cryton Worker](https://gitlab.ics.muni.cz/beast-public/cryton/cryton-worker).
Attack modules get executed inside Step objects using [Cryton Worker](https://gitlab.ics.muni.cz/cryton/cryton-worker).
All provided arguments are given to the Attack module.
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.
[Link to the documentation](https://beast-public.gitlab-pages.ics.muni.cz/cryton/cryton-documentation/).
[Link to the documentation](https://cryton.gitlab-pages.ics.muni.cz/cryton-documentation/).
## Usage
**Before you download the modules or once you clone the repository, please make sure to choose the correct version (`git checkout <version>`).**
As mentioned, modules are primarily targeted for use with Cryton Worker. See how to set them up [here](https://gitlab.ics.muni.cz/beast-public/cryton/cryton-worker#setting-up-modules).
As mentioned, modules are primarily targeted for use with Cryton Worker. See how to set them up [here](https://gitlab.ics.muni.cz/cryton/cryton-worker#setting-up-modules).
Since they are python modules, you can install and use them manually. You should use a virtual environment like [Poetry](https://python-poetry.org/docs/).
......@@ -40,10 +40,10 @@ The most important file is the module itself (**must be called `mod.py`**). It c
- `execute` (is used as an entry point for module execution; takes and returns **dictionary**)
- `validate` (is used to validate input parameters for the `execute` method; takes **dictionary** and returns 0 if it's okay, else raises an exception)
The [input](https://gitlab.ics.muni.cz/beast-public/cryton/cryton-worker#input-parameters)
and [output](https://gitlab.ics.muni.cz/beast-public/cryton/cryton-worker#output-parameters) are specified in Worker.
The [input](https://gitlab.ics.muni.cz/cryton/cryton-worker#input-parameters)
and [output](https://gitlab.ics.muni.cz/cryton/cryton-worker#output-parameters) are specified in Worker.
You can also use [prebuilt functionality](https://gitlab.ics.muni.cz/beast-public/cryton/cryton-worker#prebuilt-functionality-for-modules) from Worker.
You can also use [prebuilt functionality](https://gitlab.ics.muni.cz/cryton/cryton-worker#prebuilt-functionality-for-modules) from Worker.
Here's a simple example:
```python
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment