From 6226d61744b2ebe45947bb89535580ab05cb9cd0 Mon Sep 17 00:00:00 2001 From: rabsondev Date: Mon, 18 Mar 2024 16:11:29 +0000 Subject: [PATCH] Update references to OXO --- README.md | 24 ++++++++++++------------ agent/whatweb_agent.py | 1 + ostorlab.yaml | 20 ++++++++++---------- requirement.txt | 2 +- tests/conftest.py | 1 + tests/whatweb_test.py | 1 + 6 files changed, 26 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 4dac454..6176270 100644 --- a/README.md +++ b/README.md @@ -15,38 +15,38 @@ _Whatweb is a web technology fingerprinter capable of detecting CMS, blogging pl agent-whatweb

-This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/) for the [Whatweb Fingerprinter](https://github.com/urbanadventurer/WhatWeb.git). +This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/) for the [Whatweb Fingerprinter](https://github.com/urbanadventurer/WhatWeb.git). ## Getting Started To perform your first scan, simply run the following command. ```shell -ostorlab scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com +oxo scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com ``` This command will download and install `agent/ostorlab/whatweb`. -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 Whatweb can be installed directly from the ostorlab agent store or built from this repository. +Agent Whatweb can be installed directly from the oxo 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/whatweb + oxo agent install agent/ostorlab/whatweb ``` You can then run the agent with the following command: ```shell -ostorlab scan run --agent agent/ostorlab/whatweb domain-name tesla.com +oxo scan run --agent agent/ostorlab/whatweb domain-name tesla.com ``` ### Build directly from the repository - 1. To build the whatweb 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 whatweb 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 @@ -58,21 +58,21 @@ pip3 install ostorlab git clone https://github.com/Ostorlab/agent_whatweb.git && cd agent_whatweb ``` - 3. Build the agent image using ostorlab cli. + 3. Build the agent image using oxo cli. ```shell - ostortlab 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. 1. 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//whatweb domain-name tesla.com + oxo scan run --agent agent//whatweb domain-name tesla.com ``` * If you specified an organization when building the image: ```shell - ostorlab scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com + oxo scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com ``` diff --git a/agent/whatweb_agent.py b/agent/whatweb_agent.py index 6c7475f..de677d2 100644 --- a/agent/whatweb_agent.py +++ b/agent/whatweb_agent.py @@ -1,4 +1,5 @@ """WhatWeb Agent: Agent responsible for finger-printing a website.""" + import abc import dataclasses import io diff --git a/ostorlab.yaml b/ostorlab.yaml index 5508d4c..ed40c7e 100644 --- a/ostorlab.yaml +++ b/ostorlab.yaml @@ -8,7 +8,7 @@ description: | ## Getting Started To perform your first scan, simply run the following command. ```shell - ostorlab scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com + oxo scan run --install --agent agent/ostorlab/whatweb domain-name tesla.com ``` This command will download and install `agent/ostorlab/whatweb`. @@ -17,24 +17,24 @@ description: | ## Usage - Agent WhatWeb can be installed directly from the ostorlab agent store or built from this repository. + Agent WhatWeb can be installed directly from the oxo 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/whatweb + oxo agent install agent/ostorlab/whatweb ``` You can then run the agent with the following command: ```shell - ostorlab scan run --agent agent/ostorlab/whatweb domain-name tesla.com + oxo scan run --agent agent/ostorlab/whatweb domain-name tesla.com ``` ### Build directly from the repository - 1. To build the whatweb 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 whatweb 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 @@ -46,21 +46,21 @@ description: | git clone https://github.com/Ostorlab/agent_whatweb.git && cd agent_whatweb ``` - 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. 1. 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//whatweb domain-name tesla.com + oxo scan run --agent agent//whatweb domain-name tesla.com ``` * If you specified an organization when building the image: ```shell - ostorlab scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com + oxo scan run --agent agent/[ORGANIZATION]/whatweb domain-name tesla.com ``` diff --git a/requirement.txt b/requirement.txt index 8f7c54d..5e5905c 100644 --- a/requirement.txt +++ b/requirement.txt @@ -1,2 +1,2 @@ ostorlab[agent] -rich \ No newline at end of file +rich diff --git a/tests/conftest.py b/tests/conftest.py index 88c85ac..fb676d9 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,4 +1,5 @@ """Pytest fixture for the whatweb agent.""" + import pytest import json import pathlib diff --git a/tests/whatweb_test.py b/tests/whatweb_test.py index 67b068b..aa64976 100644 --- a/tests/whatweb_test.py +++ b/tests/whatweb_test.py @@ -1,4 +1,5 @@ """Unittests for whatweb agent.""" + import pathlib import subprocess import tempfile