Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikesplain/openvas-docker

A Docker container for Openvas
https://github.com/mikesplain/openvas-docker

docker docker-container openvas scan security shell

Last synced: 3 months ago
JSON representation

A Docker container for Openvas

Awesome Lists containing this project

README 

        
## This has been deprecated



Thanks to the many users over the years for continueing to develop and support this project. I originally built this container to solve a problem at work and I was amazed to see many other folks interested in using it as well.  With over 29 Million downloads from Docker hub, it's clear to me that it has had a good run, but as correctly pointed out in a number of issues such as [#271](https://github.com/mikesplain/openvas-docker/issues/271), there are better, supported solutions out there.  Thanks to all the support, contributions, and forks over the years.  And finally, thanks to the folks a Greenbone for a wonderful tool and fully supporting docker based deployments going forward.



Please reference the [Greenbone Documentation](https://greenbone.github.io/docs/latest/) on how to utilize their [containers](https://hub.docker.com/u/greenbone). 



Cheers 🍻

Mike



OpenVAS image for Docker

==============



[![Travis CI](https://img.shields.io/travis/mikesplain/openvas-docker/master.svg)](https://travis-ci.org/mikesplain/openvas-docker/branches) [![Docker Pulls](https://img.shields.io/docker/pulls/mikesplain/openvas.svg)](https://hub.docker.com/r/mikesplain/openvas/) [![Docker Stars](https://img.shields.io/docker/stars/mikesplain/openvas.svg)](https://hub.docker.com/r/mikesplain/openvas/) [![](https://images.microbadger.com/badges/image/mikesplain/openvas.svg)](https://microbadger.com/images/mikesplain/openvas "Get your own image badge on microbadger.com")



A Docker container for OpenVAS on Ubuntu.  By default, the latest images includes the OpenVAS Base as well as the NVTs and Certs required to run OpenVAS.  We made the decision to move to 9 as the default branch since 8 seems to have [many issues](https://github.com/mikesplain/openvas-docker/issues/84) in docker.  We suggest you use 9 as it is much more stable. Our Openvas9 build was designed to be a smaller image with fewer extras built in. Please note, OpenVAS 8 is no longer being built as OpenVAS 9 is now standard.  The image is can still be pulled from the Docker hub, however the source has been removed in this github as is standard with deprecated Docker Images.



| Openvas Version | Tag     | Web UI Port |

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

| 9               | latest/9| 443        |



Usage

-----



Simply run:



```

# latest (9)

docker run -d -p 443:443 --name openvas mikesplain/openvas

# 9

docker run -d -p 443:443 --name openvas mikesplain/openvas:9

```



This will grab the container from the docker registry and start it up.  Openvas startup can take some time (4-5 minutes while NVT's are scanned and databases rebuilt), so be patient.  Once you see a `It seems like your OpenVAS-9 installation is OK.` process in the logs, the web ui is good to go.  Goto `https://`



```

Username: admin

Password: admin

```



To check the status of the process, run:



```

docker top openvas

```



In the output, look for the process scanning cert data.  It contains a percentage.



To run bash inside the container run:



```

docker exec -it openvas bash

```



#### Specify DNS Hostname

By default, the system only allows connections for the hostname "openvas".  To allow access using a custom DNS name, you must use this command:



```

docker run -d -p 443:443 -e PUBLIC_HOSTNAME=myopenvas.example.org --name openvas mikesplain/openvas

```



#### OpenVAS Manager

To use OpenVAS Manager, add port `9390` to you docker run command:

```

docker run -d -p 443:443 -p 9390:9390 --name openvas mikesplain/openvas

```



#### Volume Support

We now support volumes. Simply mount your data directory to `/var/lib/openvas/mgr/`:

```

mkdir data

docker run -d -p 443:443 -v $(pwd)/data:/var/lib/openvas/mgr/ --name openvas mikesplain/openvas

```

Note, your local directory must exist prior to running.



#### Set Admin Password

The admin password can be changed by specifying a password at runtime using the env variable `OV_PASSWORD`:

```

docker run -d -p 443:443 -e OV_PASSWORD=securepassword41 --name openvas mikesplain/openvas

```

#### Update NVTs

Occasionally you'll need to update NVTs. We update the container about once a week but you can update your container by execing into the container and running a few commands:

```

docker exec -it openvas bash

## inside container

greenbone-nvt-sync

openvasmd --rebuild --progress

greenbone-certdata-sync

greenbone-scapdata-sync

openvasmd --update --verbose --progress



/etc/init.d/openvas-manager restart

/etc/init.d/openvas-scanner restart

```

#### Docker compose (experimental)



For simplicity a docker-compose.yml file is provided, as well as configuration for Nginx as a reverse proxy, with the following features:



* Nginx as a reverse proxy

* Redirect from port 80 (http) to port 433 (https)

* Automatic SSL certificates from [Let's Encrypt](https://letsencrypt.org/)

* A cron that updates daily the NVTs



To run:



* Change "example.com" in the following files:

  * [docker-compose.yml](docker-compose.yml)

  * [conf/nginx.conf](conf/nginx.conf)

  * [conf/nginx_ssl.conf](conf/nginx_ssl.conf)

* Change the "OV_PASSWORD" enviromental variable in [docker-compose.yml](docker-compose.yml)

* Install the latest [docker-compose](https://docs.docker.com/compose/install/)

* run `docker-compose up -d`



#### LDAP Support (experimental)

Openvas do not support full ldap integration but only per-user authentication. A workaround is in place here by syncing ldap admin user(defined by `LDAP_ADMIN_FILTER `) with openvas admin users everytime the app start up.  To use this, just need to specify the required ldap env variables:

```

docker run -d -p 443:443 -p 9390:9390 --name openvas -e LDAP_HOST=your.ldap.host -e LDAP_BIND_DN=uid=binduid,dc=company,dc=com -e LDAP_BASE_DN=cn=accounts,dc=company,dc=com -e LDAP_AUTH_DN=uid=%s,cn=users,cn=accounts,dc=company,dc=com -e LDAP_ADMIN_FILTER=memberOf=cn=admins,cn=groups,cn=accounts,dc=company,dc=com -e LDAP_PASSWORD=password -e OV_PASSWORD=admin mikesplain/openvas 

```



#### Email Support

To configure the postfix server, provide the following env variables at runtime: `OV_SMTP_HOSTNAME`, `OV_SMTP_PORT`, `OV_SMTP_USERNAME`, `OV_SMTP_KEY`

```

docker run -d -p 443:443 -e OV_SMTP_HOSTNAME=smtp.example.com -e OV_SMTP_PORT=587 -e [email protected] -e OV_SMTP_KEY=g0bBl3de3Go0k --name openvas mikesplain/openvas

```



Contributing

------------



I'm always happy to accept [pull requests](https://github.com/mikesplain/openvas-docker/pulls) or [issues](https://github.com/mikesplain/openvas-docker/issues).



Thanks

------

Thanks to hackertarget for the great tutorial: http://hackertarget.com/install-openvas-7-ubuntu/

Thanks to Serge Katzmann for contributing with some great work on OpenVAS 8: https://github.com/sergekatzmann/openvas8-complete