5 Setting up the Greenbone Enterprise Appliance

5.1 Setup Requirements

5.1.1 Greenbone Enterprise 6500/5400

The Greenbone Enterprise 5400 and Greenbone Enterprise 6500 are 19-inch mountable and require two rack units (RU). Rack holders for the installation in a 19-inch rack are supplied.

For cabling, the Greenbone Enterprise 5400 and Greenbone Enterprise 6500 have corresponding connectors at the front and back:

  • Front

    • 1 RJ45 console port, suitable cable is enclosed

    • 1 Mini-USB console port

    • 2 USB 3.0 ports

    • 2 RJ45 Ethernet ports, labeled “MGMT”, for management

    • 1 module with 8 RJ45 Ethernet ports

      Note

      Additional network modules must be purchased separately. A maximum of 4 network modules can be installed in total. The network modules can contain either up to 8 RJ45, 8 SFP or 2 SFP+ Ethernet ports.

  • Back

    • 1 VGA port

    • 1 USB 2.0 port

    • 2 power supplies

The installation requires either a monitor and a keyboard or a serial console connection and a terminal application.

5.1.2 Greenbone Enterprise 650/600/450/400

The Greenbone Enterprise 400, Greenbone Enterprise 450, Greenbone Enterprise 600 and Greenbone Enterprise 650 are 19-inch mountable and require one rack unit (RU). Rack holders for the installation in a 19-inch rack are supplied.

For cabling, the Greenbone Enterprise 400, Greenbone Enterprise 450, Greenbone Enterprise 600 and Greenbone Enterprise 650 have corresponding connectors at the front and back:

  • Front

    • 1 RJ45 console port, suitable cable is enclosed

    • 2 USB 3.0 ports

    • 8 RJ45 Ethernet ports

    • 2 SFP Ethernet ports

  • Back

    • 1 VGA port

    • 1 power supply

The installation requires either a monitor and a keyboard or a serial console connection and a terminal application.

5.1.3 Greenbone Enterprise 150

The Greenbone Enterprise 150 is 19-inch mountable and requires one rack unit (RU). The optional RACKMOUNT150 kit provides the rack holders for installing the appliance in a 19-inch rack.

For stand-alone appliances, four self-sticking rubber pads have to be mounted on the corresponding bottom side embossments.

For cabling, the Greenbone Enterprise 150 has corresponding connectors at the front and back:

  • Front

    • 1 RJ45 console port, suitable cable is enclosed

    • 2 USB 3.0 ports

    • 1 HDMI port

    • 4 RJ45 Ethernet ports

  • Back

    • 1 power supply

The installation requires either a monitor and a keyboard or a serial console connection and a terminal application.

5.1.4 Greenbone Enterprise 35

The Greenbone Enterprise 35 is 19-inch mountable and requires one rack unit (RU). The optional RACKMOUNT35 kit provides the rack holders for installing the appliance in a 19-inch rack.

For stand-alone appliances, four self-sticking rubber pads have to be mounted on the corresponding bottom side embossments.

For cabling, the Greenbone Enterprise 35 has corresponding connectors at the front and back:

  • Front

    • 1 RJ45 console port, suitable cable is enclosed

    • 2 USB 3.0 ports

    • 1 HDMI port

    • 4 RJ45 Ethernet ports

  • Back

    • 1 power supply

The installation requires either a monitor and a keyboard or a serial console connection and a terminal application.

5.1.5 Greenbone Enterprise DECA/TERA/PETA/EXA

This section lists the requirements for successfully deploying a Greenbone Enterprise DECA, Greenbone Enterprise TERA, Greenbone Enterprise PETA or Greenbone Enterprise EXA. All requirements have to be met.

The virtual appliances require and are limited to the following resources:

  • Greenbone Enterprise DECA

    • 4 virtual CPUs

    • 14 GB RAM

    • 500 GB virtual hard disk

  • Greenbone Enterprise TERA

    • 6 virtual CPUs

    • 14 GB RAM

    • 500 GB virtual hard disk

  • Greenbone Enterprise PETA

    • 8 virtual CPUs

    • 16 GB RAM

    • 500 GB virtual hard disk

  • Greenbone Enterprise EXA

    • 12 virtual CPUs

    • 24 GB RAM

    • 500 GB virtual hard disk

The following hypervisors are officially supported for running a Greenbone Enterprise DECA/TERA/PETA/EXA:

  • Microsoft Hyper-V, version 5.0 or higher

  • VMware vSphere Hypervisor (ESXi), version 6.0 or higher

  • Huawei FusionCompute, version 8.0

For Microsoft Hyper-V, each Greenbone Enterprise CENO/DECA/TERA/PETA/EXA is delivered as a generation 2 virtual machine.

The required booting mode is the EFI/UEFI boot mode.

5.1.6 Greenbone Enterprise CENO

This section lists the requirements for successfully deploying a Greenbone Enterprise CENO. All requirements have to be met.

The virtual appliance requires and is limited to the following resources:

  • 2 virtual CPUs

  • 12 GB RAM

  • 500 GB virtual hard disk

The following hypervisors are officially supported for running a Greenbone Enterprise CENO:

  • Microsoft Hyper-V, version 5.0 or higher

  • VMware vSphere Hypervisor (ESXi), version 6.0 or higher

For Microsoft Hyper-V, each Greenbone Enterprise CENO/DECA/TERA/PETA/EXA is delivered as a generation 2 virtual machine.

The required booting mode is the EFI/UEFI boot mode.

5.1.7 Greenbone Enterprise 25V

This section lists the requirements for successfully deploying a Greenbone Enterprise 25V. All requirements have to be met.

The virtual appliance requires and is limited to the following resources:

  • 2 virtual CPUs

  • 8 GB RAM

  • 500 GB virtual hard disk

The following hypervisors are officially supported for running a Greenbone Enterprise 25V:

  • Microsoft Hyper-V, version 5.0 or higher

  • VMware vSphere Hypervisor (ESXi), version 6.0 or higher

  • Huawei FusionCompute, version 8.0

For Microsoft Hyper-V, each Greenbone Enterprise 25V is delivered as a generation 2 virtual machine.

The required booting mode is the EFI/UEFI boot mode.

5.1.8 Greenbone Basic Appliance

This section lists the requirements for successfully deploying a Greenbone Basic Appliance. All requirements have to be met.

The virtual appliance requires and is limited to the following resources:

  • 2 virtual CPUs

  • 12 GB RAM

  • 500 GB virtual hard disk

The following hypervisors are officially supported for running a Greenbone Basic Appliance:

  • Microsoft Hyper-V, version 5.0 or higher

  • VMware vSphere Hypervisor (ESXi), version 6.0 or higher

  • VMware Workstation Player, version 16.0 or higher

  • VMware Workstation Pro, version 16.0 or higher

  • Oracle VirtualBox, version 6.1 or higher

  • Huawei FusionCompute, version 8.0

The required booting mode is the EFI/UEFI boot mode.

Note

The following steps are mandatory for a Greenbone Basic Appliance, otherwise no vulnerability scans can be performed:

  • Entering or uploading a Greenbone Enterprise feed subscription key (see Chapter 5.4.4)

  • Downloading the Greenbone Enterprise Feed (see Chapter 5.4.5)

A Greenbone Enterprise Feed subscription key should have been received with the order of the Greenbone Basic Appliance. If no key was received, contact sales@greenbone.net.

5.1.9 Greenbone Enterprise ONE

This section lists the requirements for successfully deploying a Greenbone Enterprise ONE. All requirements have to be met.

The virtual appliance requires and is limited to the following resources:

  • 2 virtual CPUs

  • 12 GB RAM

  • 500 GB virtual hard disk

The following hypervisors are officially supported for running a Greenbone Enterprise ONE:

  • Oracle VirtualBox, version 6.1 or higher

  • VMware Workstation Player, version 16.0 or higher

  • VMware Workstation Pro, version 16.0 or higher

The required booting mode is the EFI/UEFI boot mode.

5.2 Setting up a Hardware Appliance

Note

The requirements for installing the appliance can be found in Chapter 5.1.

5.2.1 Utilizing the Serial Port

The enclosed console cable is used for utilizing the serial port.

To access the serial port, a terminal application is required. The application must be configured to a speed of 9600 bits/s (Baud).

Under Linux, the command screen can be used in the command line to access the serial port. The device providing the serial port must be passed as a parameter:

screen /dev/ttyS0  #(for serial port)
screen /dev/ttyUSB0 #(for USB adapter)

Tip

After starting screen, it may be necessary to press Enter several times to see a command prompt.

To close the serial connection, press Ctrl + a and immediately afterwards \.

In Microsoft Windows, PuTTY can be used. After starting it, the options as shown in Fig. 5.1 and the appropriate serial port must be selected.

_images/putty_serial.png

Fig. 5.1 Setting up the serial port in PuTTY

5.2.2 Starting the Appliance

Once the appliance is fully wired, a connection to the appliance using the console cable is achieved and the terminal application (PuTTY, screen or similar) is set up, the appliance can be started.

The appliance will boot and after a short time – depending on the exact model – the login prompt is shown. The default login information is:

  • User: admin

  • Password: admin

Note

During the first setup, this password should be changed (see Chapter 7.2.1.1).

5.3 Setting up a Virtual Appliance

Note

The requirements for installing the appliance can be found in Chapter 5.1.

5.3.1 Verification of Integrity

Note

The integrity of the virtual appliance can be verified. On request, the Greenbone Enterprise Support provides an integrity checksum.

To request the checksum, contact the Greenbone Enterprise Support including the subscription number.

The integrity checksum can be provided via phone or via support portal.

The local verification of the checksum depends on the host operating system.

On Linux systems, the following command for calculating the checksum can be used:

sha256sum <file>

Note

Replace <file> with the name of the appliance’s OVA file.

On Microsoft Windows systems, the following command for calculating the checksum can be used in the Windows PowerShell:

Get-Filehash 'C:\<path>\<file>' -Algorithm SHA256

Note

Replace <path> and <file> with the path and the name of the appliance’s OVA file.

If the checksum does not match the checksum provided by the Greenbone Enterprise Support, the virtual appliance has been modified and should not be used.

5.3.2 Deploying the Appliance

5.3.2.1 VMware vSphere/ESXi

The virtual appliance is provided by Greenbone in the Open Virtualization Appliance (OVA) format.

Each appliance is activated using a unique subscription key.

Note

Cloning the appliance and using several instances in parallel is not permitted and can result in inconsistencies and unwanted side effects.

To deploy an appliance, it has to be imported into the hypervisor of choice as follows:

Note

The example features VMware ESXi, but is also applicable for VMware vCenter.

The figures show the installation of a Greenbone Enterprise TERA. The installation of another appliance model is carried out equivalently. File names used in the example differ based on the appliance model and the subscription key.

  1. Open the web interface of the VMware ESXi instance and log in.

  2. Click Virtual Machines in the Navigator column on the left.

  3. Click Create / Register VM.

  4. Select Deploy a virtual machine from an OVF or OVA file and click Next (see Fig. 5.2).

    _images/vmware_2.png

    Fig. 5.2 Selecting the creation type

  5. Enter a name for the virtual machine in the input box.

  6. Click Click to select files or drag/drop, select the OVA file of the appliance and click Next.

  7. Select the storage location in which to store the virtual machine files and click Next.

  8. Adjust the deployment options as required and click Next.

    Note

    The default deployment settings may be used.

  9. Check the configuration of the virtual machine (see Fig. 5.3).

    Tip

    Settings can be changed by clicking Back and adjusting them in the respective dialog.

    _images/setup_vmware_readycomplete.png

    Fig. 5.3 Checking the configuration of the virtual machine

  10. Click Finish.

    → The appliance is being imported. This can take up to 10 minutes.

    Important

    Do not refresh the browser while the virtual machine is being deployed.

  11. When the appliance is imported, click Virtual Machines in the Navigator column on the left.

  12. Select the appliance in the list and click Power on (see Fig. 5.4).

    _images/vmware_3.png

    Fig. 5.4 Imported virtual machine

    → The appliance will boot and after a short time – depending on the exact model – the login prompt is shown.

  13. Log in using the default login information:

    • User: admin

    • Password: admin

    Note

    During the first setup, this password should be changed (see Chapter 7.2.1.1).

5.3.2.2 Oracle VirtualBox

The virtual appliance is provided by Greenbone in the Open Virtualization Appliance (OVA) format.

Each appliance is activated using a unique subscription key.

Note

Cloning the appliance and using several instances in parallel is not permitted and can result in inconsistencies and unwanted side effects.

To deploy an appliance, it has to be imported into the hypervisor of choice as follows:

Note

File names used in the example differ based on the subscription key.

  1. Install Oracle VirtualBox for the current operating system.

    Note

    VirtualBox is often included with Linux distributions.

    Should this not be the case and or a version of Microsoft Windows is used, VirtualBox is available at https://www.virtualbox.org/wiki/Downloads.

  2. Start VirtualBox.

  3. Select File > Import Appliance… in the menu bar.

  4. Click and select the OVA file of the appliance (see Fig. 5.5).

    _images/vbox_import_ONE.png

    Fig. 5.5 Importing the OVA file of the appliance

  5. Check the configuration of the virtual machine in the window Appliance settings (see Fig. 5.5).

    Values can be changed by double clicking into the input box of the respective value.

  6. Click Import.

    → The appliance is being imported. This can take up to 10 minutes.

    When the appliance is imported, it is displayed in the left column in VirtualBox.

  7. Select the appliance in the list and click Start.

    → The appliance will boot and after a short time – depending on the exact model – the login prompt is shown.

  8. Log in using the default login information:

    • User: admin

    • Password: admin

    Note

    During the first setup, this password should be changed (see Chapter 7.2.1.1).

5.4 Performing a General System Setup

All appliances share the same way of basic configuration and readiness check.

When the appliance is delivered by Greenbone or after a factory reset, the GOS administration menu shows the first setup wizard after logging in to assist with the basic GOS configuration (see Fig. 5.6).

  • By selecting Yes and pressing Enter the first setup wizard is opened.

  • By selecting No and pressing Enter, the setup wizard is closed. Incomplete steps are displayed again when logging in the next time.

  • By selecting Cancel and pressing Enter, the setup wizard is closed as well. However, incomplete steps are not displayed again.

_images/first_setup_wizard_1.png

Fig. 5.6 Using the first setup wizard

Note

The first setup wizard is dynamic and shows only those steps necessary to operate the used appliance model. In the following, all possible steps are mentioned but they may not appear in every case.

In case of a factory reset, all steps have to be carried out (see 20.10).

Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.

5.4.1 Configuring the Network

The network must be set up for the appliance to be fully functional. If there is no IP address configured, it is asked whether the network settings should be adjusted (see Fig. 5.7).

Note

When using DHCP, the appliance does not transmit the MAC address but a DHCP Unique ID (DUID). While this should not pose a problem with modern DHCP servers, some older DHCP servers (for example Windows Server 2012) may not be able to handle it.

One possible solution is to specify the DUID instead of the MAC address on the DHCP server. Alternatively, a static IP address can be used on the appliance.

_images/first_setup_wizard_10.png

Fig. 5.7 Configuring the network settings

  1. Select Yes and press Enter.

  2. Select Interfaces and press Enter.

  3. Select the desired interface and press Enter.

    → The interface can be configured.

  4. If DHCP should be used, select DHCP (for IPv4 or IPv6) and press Enter (see Fig. 5.8).

    _images/first_setup_wizard_12.png

    Fig. 5.8 Configuring the network interface

  5. Select Save and press Enter.

  6. Select Back and press Enter.

  7. Select Back and press Enter.

  8. Select Ready and press Enter.

    or

  1. If a static IP address should be used, select Static IP (for IPv4 or IPv6) and press Enter.

  2. Enter the IP address including the prefix length in the input box (see Fig. 5.9).

    _images/first_setup_wizard_13.png

    Fig. 5.9 Entering a static IP address

  3. Press Enter.

    → A message informs that the changes have to be saved.

  4. Press Enter to close the message.

  5. Select Save and press Enter.

  6. Select Back and press Enter.

  7. Select Back and press Enter.

  8. Select Ready and press Enter.

5.4.2 Importing or Generating an HTTPS Certificate

An HTTPS certificate must be present on the appliance to use the web interface securely. The certificate can be imported or generated as follows:

  1. Select Import and press Enter (see Fig. 5.10).

    → A message informs that a PKCS#12 file can be imported.

    _images/first_setup_wizard_2.png

    Fig. 5.10 Importing or generating an HTTPS certificate

  2. Select Continue and press Enter.

  3. Open the web browser and enter the displayed URL.

  4. Click Browse…, select the PKCS#12 file and click Upload.

    → When the certificate is retrieved by the appliance, the GOS administration menu displays the fingerprint of the certificate for verification.

  5. Check the fingerprint and confirm the certificate by pressing Enter.

    or

  1. Select Generate and press Enter.

    → A message informs that parameters have to be entered to generate the certificate.

  2. Select Continue and press Enter.

  3. Provide the settings for the certificate (see Fig. 5.11).

    Note

    It is valid to generate a certificate without a common name. However, a certificate should not be created without (a) Subject Alternative Name(s).

    If a common name is used, it should be the same as one of the SANs.

    _images/first_setup_wizard_3.png

    Fig. 5.11 Entering information for the certificate

  4. Select OK and press Enter.

    → A message informs that the certificate is created and can be downloaded (see Fig. 5.12).

    Note

    The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.4.1.7.1, steps 1 – 4 and 9 – 13.

    _images/first_setup_wizard_8.png

    Fig. 5.12 Completing the HTTPS certificate

    or

  1. Select CSR and press Enter.

    → A message informs that a key pair and a certificate request are created.

  2. Select Continue and press Enter.

  3. Provide the settings for the certificate.

    Note

    It is valid to generate a certificate without a common name. However, a certificate should not be created without (a) Subject Alternative Name(s).

    If a common name is used, it should be the same as one of the SANs.

  4. Select OK and press Enter.

  5. Open the web browser and enter the displayed URL.

  6. Download the PEM file.

    → The GOS administration menu displays a message to verify that the CSR has not been tampered with.

  7. Verify the information by pressing Enter.

    Note

    When the certificate is signed, it has to be uploaded to the appliance. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.4.1.7.2, steps 1 – 4 and 11 – 14.

5.4.3 Creating a Web Administrator

If there is no web administrator, it is asked whether such an account should be created (see Fig. 5.13).

_images/first_setup_wizard_7.png

Fig. 5.13 Creating a web administrator

Note

A web administrator is required to use the web interface of the appliance.

The first web administrator (web user) that is created is automatically the Feed Import Owner (see Chapter 7.2.1.10).

  1. Select Yes and press Enter.

  2. Enter the user name for the web administrator.

    Note

    Only the following characters are allowed for the user name:

    • All alphanumeric characters

    • - (dash)

    • _ (underscore)

    • . (full stop)

  3. Enter the password for the web administrator twice.

    Note

    The password can contain any type of character and can be at most 30 characters long.

    When using special characters, note that these must be available on all used keyboards and correctly supported by all client software and operating systems. Copying and pasting special characters for passwords can lead to invalid passwords depending on these external factors.

  4. Select OK and press Enter.

    → A message informs that the web administrator has been created.

  5. Press Enter to close the message.

5.4.4 Entering or Uploading a Greenbone Enterprise Feed Subscription Key

If no valid subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed and not the Greenbone Enterprise Feed.

Note

It is not necessary to add a Greenbone Enterprise Feed subscription key on a newly delivered appliance since a key is already pre-installed.

As an exception, the model Greenbone Basic Appliance does not come with a pre-installed subscription key and cannot be used with the Greenbone Community Feed.

A subscription key can be entered or uploaded as follows:

  1. Select Editor and press Enter (see Fig. 5.14).

    _images/first_setup_wizard_9.png

    Fig. 5.14 Entering or uploading a subscription key

    → The editor is opened.

  2. Enter the content of the subscription key.

    Note

    It is important to enter the content of the key and not the name of the key (for example gsf2022122017).

    The content of the key can be displayed with any text editor or under Linux using the program less. If the content is opened with a text editor, care must be taken to not change anything.

  3. Press Ctrl + S to save the changes.

  4. Press Ctrl + X to close the editor.

    or

  1. Select HTTP Upload and press Enter.

  2. Open the web browser and enter the displayed URL.

  3. Click Browse…, select the subscription key and click Upload.

5.4.5 Downloading the Feed

If no feed is present on the appliance, the feed can be downloaded as follows:

  1. Select Yes and press Enter (see Fig. 5.15).

    _images/first_setup_wizard_4.png

    Fig. 5.15 Downloading the feed

    → A message informs that the feed update was started in the background (see Fig. 5.16).

    _images/first_setup_wizard_5.png

    Fig. 5.16 Downloading the feed

  2. Press Enter to close the message.

5.4.6 Finishing the First Setup Wizard

Note

After the last step, a status check is performed.

  1. When the check is finished, press Enter.

    → The results of the check are displayed (see Fig. 5.17).

    _images/first_setup_wizard_6.png

    Fig. 5.17 Result of the status check

  2. Press Enter.

    → The GOS administration menu can be used as described in Chapter 7.

    If there are any unfinished or skipped steps, the first setup wizard is shown when logging in again.

5.5 Logging into the Web Interface

Note

This step does not apply for the Greenbone Enterprise 35 and the Greenbone Enterprise 25V.

The main interface of the appliance is the web interface, also called Greenbone Security Assistant (GSA). The web interface can be accessed as described in Chapter 8.1.