ostorlab.yaml

kind: Agent
name: openvas
version: 0.5.0
image: images/logo.png
description: |
  This repository is an implementation of the OpenVas agent.

  ## Getting Started
  To perform your first scan, simply run the following command.
  ```shell
  ostorlab scan run --install --agent agent/ostorlab/openvas ip 8.8.8.8
  ```

  This command will download and install `agent/ostorlab/openvas` 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)


  ## Usage

  Agent OpenVas can be installed directly from the ostorlab agent store or built from this repository.

   ### Install directly from ostorlab agent store

   ```shell
   ostorlab agent install agent/ostorlab/openvas
   ```

  You can then run the agent with the following command:
  ```shell
  ostorlab scan run --agent agent/ostorlab/openvas ip 8.8.8.8
  ```


  ### Build directly from the repository

   1. To build the openvas 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.

  ```shell
  pip3 install ostorlab
  ```

   2. Clone this repository.

  ```shell
  git clone https://github.com/Ostorlab/agent_openvas.git && cd agent_openvas
  ```

   3. Build the agent image using ostorlab cli.

   ```shell
   ostortlab 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 one of the following commands:
       * If you did not specify an organization when building the image:
        ```shell
        ostorlab scan run --agent agent//openvas ip 8.8.8.8
        ```
       * If you specified an organization when building the image:
        ```shell
        ostorlab scan run --agent agent/[ORGANIZATION]/openvas ip 8.8.8.8
        ```


  ## License
  [Apache-2.0](./LICENSE)

license: Apache-2.0
source: https://github.com/Ostorlab/agent_openvas
in_selectors:
  - v3.asset.ip.v4
  - v3.asset.ip.v6
  - v3.asset.domain_name
  - v3.asset.link
out_selectors:
  - v3.report.vulnerability
docker_file_path : Dockerfile
docker_build_root : .
args:
  - name: "scope_domain_regex"
    type: "string"
    description: "Regular expression to define domain scanning scope."
  - name: "scan_config_id"
    type: "string"
    description: "OpenVas scan configuration used by the task."