From 4b75cbb0fee6a0b43de5d18db8cd1c8c3dbd6bfd Mon Sep 17 00:00:00 2001 From: rabsondev Date: Mon, 18 Mar 2024 13:11:11 +0000 Subject: [PATCH] Update references to OXO --- README.md | 24 ++++++++++++------------ ostorlab.yaml | 26 +++++++++++++------------- requirement.txt | 2 +- 3 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 30bfbb4..6ffb2bc 100644 --- a/README.md +++ b/README.md @@ -9,37 +9,37 @@ _Metasploit is a powerful penetration testing framework._ --- -This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/) for the [Metasploit Framework](https://github.com/rapid7/metasploit-framework) by Rapid7. +This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/) for the [Metasploit Framework](https://github.com/rapid7/metasploit-framework) by Rapid7. ## Getting Started To perform your first scan, simply run the following command: ```shell -ostorlab scan run --install --agent agent/ostorlab/metasploit ip 8.8.8.8 +oxo scan run --install --agent agent/ostorlab/metasploit ip 8.8.8.8 ``` This command will download and install `agent/ostorlab/metasploit` and target the ip `8.8.8.8`. -For more information, please refer to the [Ostorlab Documentation](https://github.com/Ostorlab/ostorlab/blob/main/README.md) +For more information, please refer to the [OXO Documentation](https://oxo.ostorlab.co/docs) ## Usage Agent Metasploit can be installed directly from the ostorlab agent store or built from this repository. - ### Install directly from ostorlab agent store + ### Install directly from oxo agent store ```shell - ostorlab agent install agent/ostorlab/metasploit + oxo agent install agent/ostorlab/metasploit ``` You can then run the agent with the following command: ```shell -ostorlab scan run --agent agent/ostorlab/metasploit ip 8.8.8.8 +oxo scan run --agent agent/ostorlab/metasploit ip 8.8.8.8 ``` ### Build directly from the repository - 1. To build the metasploit agent you need to have [ostorlab](https://pypi.org/project/ostorlab/) installed in your machine. if you have already installed ostorlab, you can skip this step. + 1. To build the metasploit agent you need to have [oxo](https://pypi.org/project/ostorlab/) installed in your machine. If you have already installed oxo, you can skip this step. ```shell pip3 install ostorlab @@ -51,10 +51,10 @@ pip3 install ostorlab git clone https://github.com/Ostorlab/agent_metasploit.git && cd agent_metasploit ``` - 3. Build the agent image using ostorlab cli. + 3. Build the agent image using oxo cli. ```shell - ostorlab agent build --file=ostorlab.yaml + oxo agent build --file=ostorlab.yaml ``` You can pass the optional flag `--organization` to specify your organisation. The organization is empty by default. @@ -62,11 +62,11 @@ git clone https://github.com/Ostorlab/agent_metasploit.git && cd agent_metasploi 4. Run the agent using on of the following commands: * If you did not specify an organization when building the image: ```shell - ostorlab scan run --agent agent//metasploit ip 8.8.8.8 + oxo scan run --agent agent//metasploit ip 8.8.8.8 ``` * If you specified an organization when building the image: ```shell - ostorlab scan run --agent agent/[ORGANIZATION]/metasploit ip 8.8.8.8 + oxo scan run --agent agent/[ORGANIZATION]/metasploit ip 8.8.8.8 ``` ### Run agent metasploit with module options @@ -96,7 +96,7 @@ agents: value: "www.ostorlab.co" ``` -`ostorlab scan run -g agent_group.yaml domain-name www.ostorlab.co` +`oxo scan run -g agent_group.yaml domain-name www.ostorlab.co` ## License [Apache](./LICENSE) diff --git a/ostorlab.yaml b/ostorlab.yaml index 9c89a78..2123357 100644 --- a/ostorlab.yaml +++ b/ostorlab.yaml @@ -2,32 +2,32 @@ kind: Agent name: metasploit version: 0.0.10 description: | - This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/) for the [Metasploit Framework](https://github.com/rapid7/metasploit-framework) by Rapid7. + This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/) for the [Metasploit Framework](https://github.com/rapid7/metasploit-framework) by Rapid7. ## Getting Started To perform your first scan, simply run the following command: ```shell - ostorlab scan run --install --agent agent/ostorlab/metasploit ip 8.8.8.8 + oxo scan run --install --agent agent/ostorlab/metasploit ip 8.8.8.8 ``` This command will download and install `agent/ostorlab/metasploit` and target the ip `8.8.8.8`. - For more information, please refer to the [Ostorlab Documentation](https://github.com/Ostorlab/ostorlab/blob/main/README.md) + For more information, please refer to the [OXO Documentation](https://oxo.ostorlab.co/docs) ## Usage - Agent Metasploit can be installed directly from the ostorlab agent store or built from this repository. + Agent Metasploit can be installed directly from the oxo agent store or built from this repository. Supported agent flags: * `config`: Array of metasploit modules with their respective options. - ### Install directly from ostorlab agent store + ### Install directly from oxo agent store ```shell - ostorlab agent install agent/ostorlab/metasploit + oxo agent install agent/ostorlab/metasploit ``` You can then run the agent with the following command: ```shell - ostorlab scan run --agent agent/ostorlab/metasploit ip 8.8.8.8 + oxo scan run --agent agent/ostorlab/metasploit ip 8.8.8.8 ``` ### Build directly from the repository - 1. To build the metasploit agent you need to have [ostorlab](https://pypi.org/project/ostorlab/) installed in your machine. if you have already installed ostorlab, you can skip this step. + 1. To build the metasploit agent you need to have [oxo](https://pypi.org/project/ostorlab/) installed in your machine. If you have already installed oxo, you can skip this step. ```shell pip3 install ostorlab ``` @@ -35,19 +35,19 @@ description: | ```shell git clone https://github.com/Ostorlab/agent_metasploit.git && cd agent_metasploit ``` - 3. Build the agent image using ostorlab cli. + 3. Build the agent image using oxo cli. ```shell - ostorlab agent build --file=ostorlab.yaml + oxo agent build --file=ostorlab.yaml ``` You can pass the optional flag `--organization` to specify your organisation. The organization is empty by default. 4. Run the agent using on of the following commands: * If you did not specify an organization when building the image: ```shell - ostorlab scan run --agent agent//metasploit ip 8.8.8.8 + oxo scan run --agent agent//metasploit ip 8.8.8.8 ``` * If you specified an organization when building the image: ```shell - ostorlab scan run --agent agent/[ORGANIZATION]/metasploit ip 8.8.8.8 + oxo scan run --agent agent/[ORGANIZATION]/metasploit ip 8.8.8.8 ``` ## Example run @@ -76,7 +76,7 @@ description: | value: "www.ostorlab.co" ``` - `ostorlab scan run -g agent_group.yaml domain-name www.ostorlab.co` + `oxo scan run -g agent_group.yaml domain-name www.ostorlab.co` ## License [Apache-2.0](./LICENSE) diff --git a/requirement.txt b/requirement.txt index fbde6be..2c44265 100644 --- a/requirement.txt +++ b/requirement.txt @@ -1,3 +1,3 @@ ostorlab[agent] rich -tenacity \ No newline at end of file +tenacity