Feat(Job): new job nmap

# 🛡 Nmap

## Description

[Nmap](https://nmap.org) is a tool designed to discover networks, map them, and

information that they could offer by being reachable on the internet. Its

powerful [scripting engine](https://nmap.org/book/nse.html) is very

flexible to retrieve this information.

This `nmap` job allows you to scan automatically your deployed server or the

new version you want to deploy. It is able to list every ports opened and check

if one of them should not be.

## How to use it

1. Add the corresponding URL to your `.gitlab-ci.yml` file (see [Getting

   started](/use-the-hub)). Example:

   ```yaml

   include:

     - remote: 'https://jobs.r2devops.io/nmap.yml'

   ```

2. Choose a target

    !!! note

        This job can be run on external services or by running a container

        instance of your software. **You need to choose between two following

        options**.

    * Option 1: external service

    Add the IP address or the domain name of the service in `NMAP_TARGET`

    variable by adding following lines in your `.gitlab-ci.yml` file:

    ```yaml

    nmap:

      variables:

        NMAP_TARGET: <address or domain name>

    ```

    *  Option 2: container instance

    To use this option, you must have access to a container image of your

    software. For example, if you are using our

    [docker_build](https://r2devops.io/jobs/build/docker_build/) job, just

    add the following configuration in your `.gitlab-ci.yml` file:

    !!! info

        * The `name` option must contain your image name and tag

        * The `alias` option permits to the job to reach your application using a name. This name must be the same that the one specified inside [variable `NMAP_TARGET`](#variables)

        * You may also run some other services like a database depending on your application needs

    ```yaml

    nmap:

      services:

        - name: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA

          alias: app

    ```

4. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

5. Well done, your job is ready to work ! 😀

## Job details

* Job name: `nmap`

* Docker image:

[`instrumentisto/nmap`](https://hub.docker.com/r/instrumentisto/nmaps)

* Default stage: `dynamic_tests`

* When: `always`

### Variables

| Name | Description | Default |

| ---- | ----------- | ------- |

| `NMAP_TARGET` <img width=100/> | The target server, its IP or domain name <img width=175/>| `app` <img width=100/>|

| `NMAP_SCRIPTS` | Comma separated list of lua [scripts](https://nmap.org/book/nse.html) to run | ` ` |

| `NMAP_OPTIONS` | Additional options you may want for the scan (`man nmap`) | ` ` |

| `NMAP_OUTPUT` | Name for the XML output file for nmap | `nmap-report.xml` |

| `HTML_OUTPUT` | Name for the html file for the Merge Request Widget for this job | `nmap-report.html` |

name: nmap

description: A port scan job using nmap to alert on unwanted services on your server

default_stage: dynamic_tests

icon: 🛡

maintainer: FulcrandG

license: MIT

stages:

  - dynamic_tests

nmap:

  image:

    name: instrumentisto/nmap

    entrypoint: [""]

  stage: dynamic_tests

  variables:

    NMAP_TARGET: "app"

    NMAP_SCRIPTS: ""

    NMAP_OPTIONS: ""

    NMAP_OUTPUT: "nmap-report.xml"

    HTML_OUTPUT: "nmap-report.html"

  script:

    - apk add --no-cache libxslt

    - if [[ ! -z ${NMAP_SCRIPTS} ]]; then

    -   NMAP_OPTIONS="--script=${NMAP_SCRIPTS} ${NMAP_OPTIONS}"

    - fi

    - nmap -oX ${NMAP_OUTPUT} ${NMAP_OPTIONS} ${NMAP_TARGET}

    - xsltproc ${NMAP_OUTPUT} -o ${HTML_OUTPUT}

  artifacts:

    expose_as: "nmap-report"

    paths:

      - "${HTML_OUTPUT}"

    when: always

* Initial version

 No newline at end of file