5 Setting up the Greenbone Security Manager¶
This chapter provides specific setup guides for all current GSM appliances:
- GSM 5400/6500 → Chapter 5.1
- GSM 400/450/600/650 → Chapter 5.2
- GSM 150 → Chapter 5.3
- GSM 35 → Chapter 5.4
- GSM CENO/DECA/TERA/PETA/EXA → Chapter 5.5
- GSM 25V → Chapter 5.6
- GSM ONE/MAVEN → Chapter 5.7
5.1 GSM 5400/6500¶
This setup guide shows the steps required to put a GSM 5400 or 6500 appliance into operation.
The following checklist can be used to monitor the progress:
| Step | Done |
|---|---|
| Power supply established (2 connectors) | |
| Networking cables connected | |
| Console access established | |
| Keyboard layout selected | |
| IP address configured | |
| DNS server configured | |
| SSH service enabled (optional) | |
| SSL certificate created | |
| Web user account created | |
| GOS selfcheck run |
5.1.1 Installing the Appliance¶
The GSM 5400 and GSM 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 GSM 5400 and GSM 6500 appliances have corresponding connectors at the front and back:
- Front
- 1 RS-232 serial port, Cisco compatible, suitable cable is enclosed
- 2 USB 2.0 ports
- 2 RJ45 Ethernet ports, labeled “MGMT”, for management
- Up to 4 optional modules with additional Ethernet ports (RJ45, SFP, SFP+ or XFP)
- Back
- 1 VGA port
- 2 USB 3.0 ports
- 2 USB 2.0 ports
- 2 power supplies
The installation requires either a monitor and a keyboard or a serial console connection and a terminal application.
5.1.2 Utilizing the Serial Port¶
The enclosed console cable is used for utilizing the serial port. Alternatively, a blue Cisco console cable (rollover cable) can be used.
To access the serial port a terminal application is required. The application needs to be configured to a speed of 9600 bits/s (Baud).
In Linux the command screen can be used in the command line to access the serial port by passing the device providing the serial port as 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 the PuTTY application can be used. After starting it, the options as shown in Fig. 5.1 and the appropriate serial port have to be selected.
Fig. 5.1 Setting up the serial port in PuTTY
5.1.3 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 short time – depending on the exact model – the first messages will be displayed in the terminal application.
5.1.4 Performing a General System Setup¶
All GSM appliances share the same way of basic configuration and readiness check.
When the GSM is delivered by Greenbone Networks 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.2).
Fig. 5.2 Using the first setup wizard
By selecting Yes and pressing Enter the first setup wizard is opened and can be used as follows:
Note
By selecting No and pressing Enter the wizard can be closed. Steps which have not been completed yet are displayed when logging in again.
By selecting Cancel and pressing Enter the wizard can be closed as well. However, in this case, incomplete steps are not shown again.
The first setup wizard is dynamic and shows only those steps necessary to operate the used GSM 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.9).
Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.
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.3).
Fig. 5.3 Configuring the network settings
Select Yes and press Enter.
Select Interfaces and press Enter.
Select the desired interface and press Enter.
Note
Using interface eth0 is recommended.
If there is only one interface, the configuration of this interface is opened directly.
→ The interface can be configured.
If DHCP should be used, select DHCP (for IPv4 or IPv6) and press Enter (see Fig. 5.4).
Fig. 5.4 Configuring the network interface
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
or
If a static IP address should be used, select Static IP (for IPv4 or IPv6) and press Enter.
Enter the IP address including the prefix length in the input box (see Fig. 5.5).
Fig. 5.5 Entering a static IP address
Press Enter.
→ A message informs that the changes have to be saved.
Press Enter to close the message.
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
2. Importing or Generating an HTTPS Certificate
An HTTPS certificate has to be present on the GSM to use the web interface securely. The certificate can be imported or generated as follows:
Select Import and press Enter (see Fig. 5.6).
→ A message informs that a PKCS#12 file can be imported.
Fig. 5.6 Importing or generating an HTTPS certificate
Select Continue and press Enter.
Open the web browser and enter the displayed URL.
Click Browse…, select the PKCS#12 file and click Upload.
→ When the certificate is retrieved by the GSM, the GOS administration menu displays the fingerprint of the certificate for verification.
Check the fingerprint and confirm the certificate by pressing Enter.
or
Select Generate and press Enter.
→ A message informs that parameters have to be entered to generate the certificate.
Select Continue and press Enter.
Provide the settings for the certificate (see Fig. 5.7).
Fig. 5.7 Entering information for the certificate
Select OK and press Enter.
→ A message informs that the certificate is created and can be downloaded (see Fig. 5.8).
Note
The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.1, steps 1 – 4 and 9 – 13.
Fig. 5.8 Completing the HTTPS certificate
or
Select CSR and press Enter.
→ A message informs that a key pair and a certificate request are created.
Select Continue and press Enter.
Provide the settings for the certificate.
Select OK and press Enter.
Open the web browser and enter the displayed URL.
Download the PEM file.
→ The GOS administration menu displays a message to verify that the CSR has not been tampered with.
Verify the information by pressing Enter.
Note
When the certificate is signed it has to be uploaded to the GSM. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.2, steps 1 – 4 and 11 – 14.
3. Creating a Web Administrator
If there is no web administrator, it is asked whether such an account should be created (see Fig. 5.9).
Note
A web administrator is required to use the web interface of the GSM.
The first web administrator (web user) that is created is automatically the Feed Import Owner (see Chapter 7.2.1.9).
Fig. 5.9 Creating a web administrator
Select Yes and press Enter.
Enter the user name for the web administrator.
Enter the password for the web administrator twice.
Select OK and press Enter.
→ A message informs that the web administrator has been created.
Press Enter to close the message.
4. Entering or Uploading a Greenbone Security Feed (GSF) Subscription Key
If no valid GSF subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed (GCF) and not the GSF. A GSF subscription key can be entered or uploaded as follows:
Select Editor and press Enter (see Fig. 5.10).
→ The editor is opened.
Fig. 5.10 Entering or uploading a GSF subscription key
Enter the subscription key.
Press Ctrl + X.
Press Y to save the changes.
Press Enter.
or
- Select HTTP Upload and press Enter.
- Open the web browser and enter the displayed URL.
- Click Browse…, select the subscription key and click Upload.
5. Downloading the Feed
If no feed is present on the GSM, the feed can be downloaded as follows:
Select Yes and press Enter (see Fig. 5.11).
Fig. 5.11 Downloading the feed
→ A message informs that the feed update was started in the background (see Fig. 5.12).
Fig. 5.12 Downloading the feed
Press Enter to close the message.
6. Finishing the First Setup Wizard
Note
After the last step, a status check is performed. A message shows the result (see Fig. 5.13).
After closing the message by pressing 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.
Fig. 5.13 Result of the status check
5.2 GSM 400/450/600/650¶
This setup guide shows the steps required to put a GSM 400, GSM 450, GSM 600 or GSM 650 appliance into operation.
The following checklist can be used to monitor the progress:
| Step | Done |
|---|---|
| Power supply established (1 connector) | |
| Networking cables connected | |
| Console access established | |
| Keyboard layout selected | |
| IP address configured | |
| DNS server configured | |
| SSH service enabled (optional) | |
| SSL certificate created | |
| Web user account created | |
| GOS selfcheck run |
5.2.1 Installing the Appliance¶
The GSM 400, GSM 450, GSM 600 and GSM 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 GSM 400, GSM 450, GSM 600 and GSM 650 appliances have corresponding connectors at the front and back:
- Front
- 1 RS-232 serial port, Cisco compatible, suitable cable is enclosed
- 2 USB 3.0 ports
- 6 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.2.2 Utilizing the Serial Port¶
The enclosed console cable is used for utilizing the serial port. Alternatively, a blue Cisco console cable (rollover cable) can be used.
To access the serial port a terminal application is required. The application needs to be configured to a speed of 9600 bits/s (Baud).
In Linux the command screen can be used in the command line to access the serial port by passing the device providing the serial port as 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 the PuTTY application can be used. After starting it, the options as shown in Fig. 5.14 and the appropriate serial port have to be selected.
Fig. 5.14 Setting up the serial port in PuTTY
5.2.3 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 short time – depending on the exact model – the first messages will be displayed in the terminal application.
5.2.4 Performing a General System Setup¶
All GSM appliances share the same way of basic configuration and readiness check.
When the GSM is delivered by Greenbone Networks 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.15).
Fig. 5.15 Using the first setup wizard
By selecting Yes and pressing Enter the first setup wizard is opened and can be used as follows:
Note
By selecting No and pressing Enter the wizard can be closed. Steps which have not been completed yet are displayed when logging in again.
By selecting Cancel and pressing Enter the wizard can be closed as well. However, in this case, incomplete steps are not shown again.
The first setup wizard is dynamic and shows only those steps necessary to operate the used GSM 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.9).
Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.
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.16).
Fig. 5.16 Configuring the network settings
Select Yes and press Enter.
Select Interfaces and press Enter.
Select the desired interface and press Enter.
Note
Using interface eth0 is recommended.
If there is only one interface, the configuration of this interface is opened directly.
→ The interface can be configured.
If DHCP should be used, select DHCP (for IPv4 or IPv6) and press Enter (see Fig. 5.17).
Fig. 5.17 Configuring the network interface
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
or
If a static IP address should be used, select Static IP (for IPv4 or IPv6) and press Enter.
Enter the IP address including the prefix length in the input box (see Fig. 5.18).
Fig. 5.18 Entering a static IP address
Press Enter.
→ A message informs that the changes have to be saved.
Press Enter to close the message.
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
2. Importing or Generating an HTTPS Certificate
An HTTPS certificate has to be present on the GSM to use the web interface securely. The certificate can be imported or generated as follows:
Select Import and press Enter (see Fig. 5.19).
→ A message informs that a PKCS#12 file can be imported.
Fig. 5.19 Importing or generating an HTTPS certificate
Select Continue and press Enter.
Open the web browser and enter the displayed URL.
Click Browse…, select the PKCS#12 file and click Upload.
→ When the certificate is retrieved by the GSM, the GOS administration menu displays the fingerprint of the certificate for verification.
Check the fingerprint and confirm the certificate by pressing Enter.
or
Select Generate and press Enter.
→ A message informs that parameters have to be entered to generate the certificate.
Select Continue and press Enter.
Provide the settings for the certificate (see Fig. 5.20).
Fig. 5.20 Entering information for the certificate
Select OK and press Enter.
→ A message informs that the certificate is created and can be downloaded (see Fig. 5.21).
Note
The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.1, steps 1 – 4 and 9 – 13.
Fig. 5.21 Completing the HTTPS certificate
or
Select CSR and press Enter.
→ A message informs that a key pair and a certificate request are created.
Select Continue and press Enter.
Provide the settings for the certificate.
Select OK and press Enter.
Open the web browser and enter the displayed URL.
Download the PEM file.
→ The GOS administration menu displays a message to verify that the CSR has not been tampered with.
Verify the information by pressing Enter.
Note
When the certificate is signed it has to be uploaded to the GSM. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.2, steps 1 – 4 and 11 – 14.
3. Creating a Web Administrator
If there is no web administrator, it is asked whether such an account should be created (see Fig. 5.22).
Note
A web administrator is required to use the web interface of the GSM.
The first web administrator (web user) that is created is automatically the Feed Import Owner (see Chapter 7.2.1.9).
Fig. 5.22 Creating a web administrator
Select Yes and press Enter.
Enter the user name for the web administrator.
Enter the password for the web administrator twice.
Select OK and press Enter.
→ A message informs that the web administrator has been created.
Press Enter to close the message.
4. Entering or Uploading a Greenbone Security Feed (GSF) Subscription Key
If no valid GSF subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed (GCF) and not the GSF. A GSF subscription key can be entered or uploaded as follows:
Select Editor and press Enter (see Fig. 5.23).
→ The editor is opened.
Fig. 5.23 Entering or uploading a GSF subscription key
Enter the subscription key.
Press Ctrl + X.
Press Y to save the changes.
Press Enter.
or
- Select HTTP Upload and press Enter.
- Open the web browser and enter the displayed URL.
- Click Browse…, select the subscription key and click Upload.
5. Downloading the Feed
If no feed is present on the GSM, the feed can be downloaded as follows:
Select Yes and press Enter (see Fig. 5.24).
Fig. 5.24 Downloading the feed
→ A message informs that the feed update was started in the background (see Fig. 5.25).
Fig. 5.25 Downloading the feed
Press Enter to close the message.
6. Finishing the First Setup Wizard
Note
After the last step, a status check is performed. A message shows the result (see Fig. 5.26).
After closing the message by pressing 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.
Fig. 5.26 Result of the status check
5.3 GSM 150¶
This setup guide shows the steps required to put a GSM 150 appliance into operation.
The following checklist can be used to monitor the progress:
| Step | Done |
|---|---|
| Power supply established (1 connector) | |
| Networking cables connected | |
| Console access established | |
| Keyboard layout selected | |
| IP address configured | |
| DNS server configured | |
| SSH service enabled (optional) | |
| SSL certificate created | |
| Web user account created | |
| GOS selfcheck run |
5.3.1 Installing the Appliance¶
The GSM 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 GSM 150 appliance has corresponding connectors at the front and back:
- Front
- 1 RS-232 serial port, Cisco compatible, 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.3.2 Utilizing the Serial Port¶
The enclosed console cable is used for utilizing the serial port. Alternatively, a blue Cisco console cable (rollover cable) can be used.
To access the serial port a terminal application is required. The application needs to be configured to a speed of 9600 bits/s (Baud).
In Linux the command screen can be used in the command line to access the serial port by passing the device providing the serial port as 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 the PuTTY application can be used. After starting it, the options as shown in Fig. 5.27 and the appropriate serial port have to be selected.
Fig. 5.27 Setting up the serial port in PuTTY
5.3.3 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 short time – depending on the exact model – the first messages will be displayed in the terminal application.
5.3.4 Performing a General System Setup¶
All GSM appliances share the same way of basic configuration and readiness check.
When the GSM is delivered by Greenbone Networks 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.28).
Fig. 5.28 Using the first setup wizard
By selecting Yes and pressing Enter the first setup wizard is opened and can be used as follows:
Note
By selecting No and pressing Enter the wizard can be closed. Steps which have not been completed yet are displayed when logging in again.
By selecting Cancel and pressing Enter the wizard can be closed as well. However, in this case, incomplete steps are not shown again.
The first setup wizard is dynamic and shows only those steps necessary to operate the used GSM 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.9).
Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.
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.29).
Fig. 5.29 Configuring the network settings
Select Yes and press Enter.
Select Interfaces and press Enter.
Select the desired interface and press Enter.
Note
Using interface eth0 is recommended.
If there is only one interface, the configuration of this interface is opened directly.
→ The interface can be configured (see Fig. 5.30).
Fig. 5.30 Configuring the network interface
If DHCP should be used, select DHCP (for IPv4 or IPv6) and press Enter.
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
or
If a static IP address should be used, select Static IP (for IPv4 or IPv6) and press Enter.
Enter the IP address including the prefix length in the input box (see Fig. 5.31).
Fig. 5.31 Entering a static IP address
Press Enter.
→ A message informs that the changes have to be saved.
Press Enter to close the message.
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
2. Importing or Generating an HTTPS Certificate
An HTTPS certificate has to be present on the GSM to use the web interface securely. The certificate can be imported or generated as follows:
Select Import and press Enter (see Fig. 5.32).
→ A message informs that a PKCS#12 file can be imported.
Fig. 5.32 Importing or generating an HTTPS certificate
Select Continue and press Enter.
Open the web browser and enter the displayed URL.
Click Browse…, select the PKCS#12 file and click Upload.
→ When the certificate is retrieved by the GSM, the GOS administration menu displays the fingerprint of the certificate for verification.
Check the fingerprint and confirm the certificate by pressing Enter.
or
Select Generate and press Enter.
→ A message informs that parameters have to be entered to generate the certificate.
Select Continue and press Enter.
Provide the settings for the certificate (see Fig. 5.33).
Fig. 5.33 Entering information for the certificate
Select OK and press Enter.
→ A message informs that the certificate is created and can be downloaded (see Fig. 5.34).
Note
The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.1, steps 1 – 4 and 9 – 13.
Fig. 5.34 Completing the HTTPS certificate
or
Select CSR and press Enter.
→ A message informs that a key pair and a certificate request are created.
Select Continue and press Enter.
Provide the settings for the certificate.
Select OK and press Enter.
Open the web browser and enter the displayed URL.
Download the PEM file.
→ The GOS administration menu displays a message to verify that the CSR has not been tampered with.
Verify the information by pressing Enter.
Note
When the certificate is signed it has to be uploaded to the GSM. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.2, steps 1 – 4 and 11 – 14.
3. Creating a Web Administrator
If there is no web administrator, it is asked whether such an account should be created (see Fig. 5.35).
Note
A web administrator is required to use the web interface of the GSM.
The first web administrator (web user) that is created is automatically the Feed Import Owner (see Chapter 7.2.1.9).
Fig. 5.35 Creating a web administrator
Select Yes and press Enter.
Enter the user name for the web administrator.
Enter the password for the web administrator twice.
Select OK and press Enter.
→ A message informs that the web administrator has been created.
Press Enter to close the message.
4. Entering or Uploading a Greenbone Security Feed (GSF) Subscription Key
If no valid GSF subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed (GCF) and not the GSF. A GSF subscription key can be entered or uploaded as follows:
Select Editor and press Enter (see Fig. 5.36).
→ The editor is opened.
Fig. 5.36 Entering or uploading a GSF subscription key
Enter the subscription key.
Press Ctrl + X.
Press Y to save the changes.
Press Enter.
or
- Select HTTP Upload and press Enter.
- Open the web browser and enter the displayed URL.
- Click Browse…, select the subscription key and click Upload.
5. Downloading the Feed
If no feed is present on the GSM, the feed can be downloaded as follows:
Select Yes and press Enter (see Fig. 5.37).
Fig. 5.37 Downloading the feed
→ A message informs that the feed update was started in the background (see Fig. 5.38).
Fig. 5.38 Downloading the feed
Press Enter to close the message.
6. Finishing the First Setup Wizard
Note
After the last step, a status check is performed. A message shows the result (see Fig. 5.39).
After closing the message by pressing 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.
Fig. 5.39 Result of the status check
5.4 GSM 35¶
This setup guide shows the steps required to put a GSM 35 sensor appliance into operation.
The following checklist can be used to monitor the progress:
| Step | Done |
|---|---|
| Power supply established (1 connector) | |
| Networking cables connected | |
| Console access established | |
| Keyboard layout selected | |
| IP address configured | |
| DNS server configured | |
| SSH service enabled (optional) | |
| SSL certificate created | |
| GOS selfcheck run |
5.4.1 Installing the Appliance¶
The GSM 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 GSM 35 appliance has corresponding connectors at the front and back:
- Front
- 1 RS-232 serial port, Cisco compatible, 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.4.2 Utilizing the Serial Port¶
The enclosed console cable is used for utilizing the serial port. Alternatively, a blue Cisco console cable (rollover cable) can be used.
To access the serial port a terminal application is required. The application needs to be configured to a speed of 9600 bits/s (Baud).
In Linux the command screen can be used in the command line to access the serial port by passing the device providing the serial port as 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 the PuTTY application can be used. After starting it, the options as shown in Fig. 5.40 and the appropriate serial port have to be selected.
Fig. 5.40 Setting up the serial port in PuTTY
5.4.3 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 short time – depending on the exact model – the first messages will be displayed in the terminal application.
5.4.4 Performing a General System Setup¶
All GSM appliances share the same way of basic configuration and readiness check.
However, since the GSM 35 is a dedicated sensor, the master key has to be exchanged with the sensor.
When the GSM is delivered by Greenbone Networks 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.41).
Fig. 5.41 Using the first setup wizard
By selecting Yes and pressing Enter the first setup wizard is opened and can be used as follows:
Note
By selecting No and pressing Enter the wizard can be closed. Steps which have not been completed yet are displayed when logging in again.
By selecting Cancel and pressing Enter the wizard can be closed as well. However, in this case, incomplete steps are not shown again.
The first setup wizard is dynamic and shows only those steps necessary to operate the used GSM 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.9).
Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.
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.42).
Fig. 5.42 Configuring the network settings
Select Yes and press Enter.
Select Interfaces and press Enter.
Select the desired interface and press Enter.
Note
Using interface eth0 is recommended.
If there is only one interface, the configuration of this interface is opened directly.
→ The interface can be configured (see Fig. 5.43).
Fig. 5.43 Configuring the network interface
If DHCP should be used, select DHCP (for IPv4 or IPv6) and press Enter.
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
or
If a static IP address should be used, select Static IP (for IPv4 or IPv6) and press Enter.
Enter the IP address including the prefix length in the input box (see Fig. 5.44).
Fig. 5.44 Entering a static IP address
Press Enter.
→ A message informs that the changes have to be saved.
Press Enter to close the message.
Select Save and press Enter.
Select Back and press Enter.
Select Ready and press Enter.
2. Importing or Generating an HTTPS Certificate
An HTTPS certificate has to be present on the GSM to use the web interface securely. The certificate can be imported or generated as follows:
Select Import and press Enter (see Fig. 5.45).
→ A message informs that a PKCS#12 file can be imported.
Fig. 5.45 Importing or generating an HTTPS certificate
Select Continue and press Enter.
Open the web browser and enter the displayed URL.
Click Browse…, select the PKCS#12 file and click Upload.
→ When the certificate is retrieved by the GSM, the GOS administration menu displays the fingerprint of the certificate for verification.
Check the fingerprint and confirm the certificate by pressing Enter.
or
Select Generate and press Enter.
→ A message informs that parameters have to be entered to generate the certificate.
Select Continue and press Enter.
Provide the settings for the certificate (see Fig. 5.46).
Fig. 5.46 Entering information for the certificate
Select OK and press Enter.
→ A message informs that the certificate is created and can be downloaded (see Fig. 5.47).
Note
The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.1, steps 1 – 4 and 9 – 13.
Fig. 5.47 Completing the HTTPS certificate
or
Select CSR and press Enter.
→ A message informs that a key pair and a certificate request are created.
Select Continue and press Enter.
Provide the settings for the certificate.
Select OK and press Enter.
Open the web browser and enter the displayed URL.
Download the PEM file.
→ The GOS administration menu displays a message to verify that the CSR has not been tampered with.
Verify the information by pressing Enter.
Note
When the certificate is signed it has to be uploaded to the GSM. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.2, steps 1 – 4 and 11 – 14.
3. Entering or Uploading a Greenbone Security Feed (GSF) Subscription Key
If no valid GSF subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed (GCF) and not the GSF. A GSF subscription key can be entered or uploaded as follows:
Select Editor and press Enter (see Fig. 5.48).
→ The editor is opened.
Fig. 5.48 Entering or uploading a GSF subscription key
Enter the subscription key.
Press Ctrl + X.
Press Y to save the changes.
Press Enter.
or
- Select HTTP Upload and press Enter.
- Open the web browser and enter the displayed URL.
- Click Browse…, select the subscription key and click Upload.
4. Downloading the Feed
If no feed is present on the GSM, the feed can be downloaded as follows:
Select Yes and press Enter (see Fig. 5.49).
Fig. 5.49 Downloading the feed
→ A message informs that the feed update was started in the background (see Fig. 5.50).
Fig. 5.50 Downloading the feed
Press Enter to close the message.
5. Finishing the First Setup Wizard
Note
After the last step, a status check is performed. A message shows the result (see Fig. 5.51).
After closing the message by pressing 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.
Fig. 5.51 Result of the status check
6. Exchanging the Master Key with the Sensor
Continue with Chapter 16 to exchange the keys with the master.
Note
The GSM 35 does not offer any web interface. The sensor is solely managed by the master. Logging into the sensor is possible by using the console and SSH from the master.
If the communication between master and sensor fails, the rule set of any internal firewall governing the network connection may be adjusted.
5.5 GSM CENO/DECA/TERA/PETA/EXA¶
This setup guide shows the steps required to put a GSM CENO, GSM DECA, GSM TERA, GSM PETA or GSM EXA appliance into operation.
The following checklist can be used to monitor the progress:
| Step | Done |
|---|---|
| VMware ESXi installed | |
| Integrity verified (optional) | |
| OVA file imported | |
| Virtual machine settings checked | |
| Keyboard layout selected | |
| IP address configured | |
| DNS server configured | |
| SSH service enabled (optional) | |
| SSL certificate created | |
| Web user account created | |
| GOS selfcheck run |
5.5.1 Setup Requirements¶
This section lists the requirements for successfully deploying a GSM CENO, GSM DECA, GSM TERA, GSM PETA or GSM EXA appliance. All requirements have to be met.
5.5.1.1 Resources¶
The virtual appliances require at least the following resources:
GSM CENO
- 2 virtual CPUs
- 8 GB RAM
- 32 GB hard disk
GSM DECA
- 4 virtual CPUs
- 8 GB RAM
- 140 GB hard disk
GSM TERA
- 6 virtual CPUs
- 8 GB RAM
- 140 GB hard disk
GSM PETA
- 8 virtual CPUs
- 16 GB RAM
- 140 GB hard disk
GSM EXA
- 12 virtual CPUs
- 24 GB RAM
- 140 GB hard disk
5.5.1.2 Supported Hypervisor¶
While a GSM CENO/DECA/TERA/PETA/EXA can be run on various hypervisors, currently only VMware hypervisors and Huawei FusionCompute are officially supported.
Each GSM CENO/DECA/TERA/PETA/EXA is delivered in hardware version 10 format. For VMware ESXi/ESX, version 5.5 or higher is required. For Huawei FusionCompute, version 8.0.0 is required.
Note
For information about the required booting mode see Chapter 6.5.2.
5.5.1.3 Verification of Integrity¶
Note
The integrity of the virtual appliance can be verified. On request the Greenbone Networks Support provides an integrity checksum.
To request the checksum contact the Greenbone Networks Support via e-mail (support@greenbone.net) including the subscription number.
The integrity checksum can be provided via phone or via support portal. Specify the preferred channel in the e-mail.
The local verification of the checksum depends on the host operating system.
On Linux systems the following command for calculating the checksum for the GSM CENO/DECA/TERA/PETA/EXA can be used:
sha256sum GSM-CENO-20.08.0-gsf201906301.ova
Note
The commands for the other GSM models differ according to the GSM model and the GSF subscription key.
On Microsoft Windows systems an appropriate program has to be installed first.
Tip
Rehash may be used which can be found at http://rehash.sourceforge.net.
To calculate the checksum, use:
rehash.exe -none -sha256 C:\<path>\GSM-CENO-20.08.0-gsf201906301.ova
Note
The commands for the other GSM models differ according to the GSM model and the GSF subscription key.
If the checksum does not match the checksum provided by the Greenbone Networks Support, the virtual appliance has been modified and should not be used.
5.5.2 Deploying the Appliance¶
The virtual appliance is provided by Greenbone Networks in the Open Virtualization Appliance (OVA) format.
Each GSM CENO/DECA/TERA/PETA/EXA is activated using a unique subscription key.
Note
Cloning the GSM CENO/DECA/TERA/PETA/EXA and using several instances in parallel is not permitted and can result in inconsistencies and unwanted side effects.
To deploy a GSM CENO/DECA/TERA/PETA/EXA, 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 GSM CENO. The installation of a GSM DECA/TERA/PETA/EXA is carried out equivalently. File names used in the example differ based on the GSM model and the GSF subscription key.
Open the web interface of the VMware ESXi instance and log in.
Click Virtual Machines in the Navigator column on the left.
Click
Create / Register VM.Select Deploy a virtual machine from an OVF or OVA file and click Next (see Fig. 5.52).
Fig. 5.52 Selecting the creation type
Enter a name for the virtual machine in the input box.
Click Click to select files or drag/drop, select the OVA file of the appliance and click Next.
Select the storage location in which to store the virtual machine files and click Next.
Adjust the deployment options as required and click Next.
Note
The default deployment settings may be used.
Check the configuration of the virtual machine (see Fig. 5.53).
Tip
Settings can be changed by clicking Back and adjusting them in the respective dialog.
Fig. 5.53 Checking the configuration of the virtual machine
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.
When the appliance is imported, click Virtual Machines in the Navigator column on the left.
Select the appliance in the list and click
Power on (see Fig. 5.54).
Fig. 5.54 Imported virtual machine
5.5.3 Performing a General System Setup¶
All GSM appliances share the same way of basic configuration and readiness check.
When the GSM is delivered by Greenbone Networks 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.55).
Fig. 5.55 Using the first setup wizard
By selecting Yes and pressing Enter the first setup wizard is opened and can be used as follows:
Note
By selecting No and pressing Enter the wizard can be closed. Steps which have not been completed yet are displayed when logging in again.
By selecting Cancel and pressing Enter the wizard can be closed as well. However, in this case, incomplete steps are not shown again.
The first setup wizard is dynamic and shows only those steps necessary to operate the used GSM 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.9).
Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.
1. Importing or Generating an HTTPS Certificate
An HTTPS certificate has to be present on the GSM to use the web interface securely. The certificate can be imported or generated as follows:
Select Import and press Enter (see Fig. 5.56).
→ A message informs that a PKCS#12 file can be imported.
Fig. 5.56 Importing or generating an HTTPS certificate
Select Continue and press Enter.
Open the web browser and enter the displayed URL.
Click Browse…, select the PKCS#12 file and click Upload.
→ When the certificate is retrieved by the GSM, the GOS administration menu displays the fingerprint of the certificate for verification.
Check the fingerprint and confirm the certificate by pressing Enter.
or
Select Generate and press Enter.
→ A message informs that parameters have to be entered to generate the certificate.
Select Continue and press Enter.
Provide the settings for the certificate (see Fig. 5.57).
Fig. 5.57 Entering information for the certificate
Select OK and press Enter.
→ A message informs that the certificate is created and can be downloaded (see Fig. 5.58).
Note
The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.1, steps 1 – 4 and 9 – 13.
Fig. 5.58 Completing the HTTPS certificate
or
Select CSR and press Enter.
→ A message informs that a key pair and a certificate request are created.
Select Continue and press Enter.
Provide the settings for the certificate.
Select OK and press Enter.
Open the web browser and enter the displayed URL.
Download the PEM file.
→ The GOS administration menu displays a message to verify that the CSR has not been tampered with.
Verify the information by pressing Enter.
Note
When the certificate is signed it has to be uploaded to the GSM. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.2, steps 1 – 4 and 11 – 14.
2. Creating a Web Administrator
If there is no web administrator, it is asked whether such an account should be created (see Fig. 5.59).
Fig. 5.59 Creating a web administrator
Note
A web administrator is required to use the web interface of the GSM.
The first web administrator (web user) that is created is automatically the Feed Import Owner (see Chapter 7.2.1.9).
Select Yes and press Enter.
Enter the user name for the web administrator.
Enter the password for the web administrator twice.
Select OK and press Enter.
→ A message informs that the web administrator has been created.
Press Enter to close the message.
3. Entering or Uploading a Greenbone Security Feed (GSF) Subscription Key
If no valid GSF subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed (GCF) and not the GSF. A GSF subscription key can be entered or uploaded as follows:
Select Editor and press Enter (see Fig. 5.60).
Fig. 5.60 Entering or uploading a GSF subscription key
→ The editor is opened.
Enter the subscription key.
Press Ctrl + X.
Press Y to save the changes.
Press Enter.
or
- Select HTTP Upload and press Enter.
- Open the web browser and enter the displayed URL.
- Click Browse…, select the subscription key and click Upload.
4. Downloading the Feed
If no feed is present on the GSM, the feed can be downloaded as follows:
Select Yes and press Enter (see Fig. 5.61).
Fig. 5.61 Downloading the feed
→ A message informs that the feed update was started in the background (see Fig. 5.62).
Fig. 5.62 Downloading the feed
Press Enter to close the message.
5. Finishing the First Setup Wizard
Note
After the last step, a status check is performed. A message shows the result (see Fig. 5.63).
After closing the message by pressing 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.
Fig. 5.63 Result of the status check
5.6 GSM 25V¶
This setup guide shows the steps required to put a GSM 25V sensor appliance into operation.
The following checklist can be used to monitor the progress:
| Step | Done |
|---|---|
| VMware ESXi installed | |
| Integrity verified (optional) | |
| OVA file imported | |
| Virtual machine settings checked | |
| Keyboard layout selected | |
| IP address configured | |
| DNS server configured | |
| SSH service enabled (optional) | |
| SSL certificate created | |
| GOS selfcheck run |
5.6.1 Setup Requirements¶
This section lists the requirements for successfully deploying the GSM 25V appliance. All requirements have to be met.
5.6.1.1 Resources¶
The virtual appliance requires at least the following resources:
- 2 virtual CPUs
- 6 GB RAM
- 16 GB hard disk
5.6.1.2 Supported Hypervisor¶
While the GSM 25V can be run on various hypervisors, currently only VMware hypervisors are officially supported.
Each GSM 25V is delivered in hardware version 10 format. For VMware ESXi/ESX version 5.5 or higher is required.
Note
For information about the required booting mode see Chapter 6.5.2.
5.6.1.3 Verification of Integrity¶
Note
The integrity of the virtual appliance can be verified. On request the Greenbone Networks Support provides an integrity checksum.
To request the checksum contact the Greenbone Networks Support via e-mail (support@greenbone.net) including the subscription number.
The integrity checksum can be provided via phone or via support portal. Specify the preferred channel in the e-mail.
The local verification of the checksum depends on the host operating system.
On Linux systems the following command for calculating the checksum for the GSM 25V can be used:
sha256sum GSM-25V-5.0.4-gsf201906301.ova
On Microsoft Windows systems an appropriate program has to be installed first.
Tip
Rehash may be used which can be found at http://rehash.sourceforge.net.
To calculate the checksum, use:
rehash.exe -none -sha256 C:\<path>\GSM-25V-5.0.4-gsf201906301.ova
If the checksum does not match the checksum provided by the Greenbone Networks Support, the virtual appliance has been modified and should not be used.
5.6.2 Deploying the Appliance¶
The GSM 25V is provided by Greenbone Networks in the Open Virtualization Appliance (OVA) format.
Each GSM 25V is activated using a unique subscription key.
Note
Cloning the GSM 25V and using several instances in parallel is not permitted because and can result in inconsistencies and unwanted side effects.
To deploy the GSM 25V, 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 GSM CENO. The installation of a GSM 25V is carried out equivalently. File names used in the example differ based on the GSM model and the GSF subscription key.
Open the web interface of the VMware ESXi instance and log in.
Click Virtual Machines in the Navigator column on the left.
Click
Create / Register VM.Select Deploy a virtual machine from an OVF or OVA file and click Next (see Fig. 5.64).
Fig. 5.64 Selecting the creation type
Enter a name for the virtual machine in the input box.
Click Click to select files or drag/drop, select the OVA file of the appliance and click Next.
Select the storage location in which to store the virtual machine files and click Next.
Adjust the deployment options as required and click Next.
Note
The default deployment settings may be used.
Check the configuration of the virtual machine (see Fig. 5.65).
Tip
Settings can be changed by clicking Back and adjusting them in the respective dialog.
Fig. 5.65 Checking the configuration of the virtual machine
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.
When the appliance is imported, click Virtual Machines in the Navigator column on the left.
Select the appliance in the list and click
Power on (see Fig. 5.66).
Fig. 5.66 Imported virtual machine
5.6.3 Performing a General System Setup¶
All GSM appliances share the same way of basic configuration and readiness check.
However, since the GSM 25V is a dedicated sensor, the master key has to be exchanged with the sensor.
When the GSM is delivered by Greenbone Networks 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.67).
Fig. 5.67 Using the first setup wizard
By selecting Yes and pressing Enter the first setup wizard is opened and can be used as follows:
Note
By selecting No and pressing Enter the wizard can be closed. Steps which have not been completed yet are displayed when logging in again.
By selecting Cancel and pressing Enter the wizard can be closed as well. However, in this case, incomplete steps are not shown again.
The first setup wizard is dynamic and shows only those steps necessary to operate the used GSM 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.9).
Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.
1. Importing or Generating an HTTPS Certificate
An HTTPS certificate has to be present on the GSM to use the web interface securely. The certificate can be imported or generated as follows:
Select Import and press Enter (see Fig. 5.68).
→ A message informs that a PKCS#12 file can be imported.
Fig. 5.68 Importing or generating an HTTPS certificate
Select Continue and press Enter.
Open the web browser and enter the displayed URL.
Click Browse…, select the PKCS#12 file and click Upload.
→ When the certificate is retrieved by the GSM, the GOS administration menu displays the fingerprint of the certificate for verification.
Check the fingerprint and confirm the certificate by pressing Enter.
or
Select Generate and press Enter.
→ A message informs that parameters have to be entered to generate the certificate.
Select Continue and press Enter.
Provide the settings for the certificate (see Fig. 5.69).
Fig. 5.69 Entering information for the certificate
Select OK and press Enter.
→ A message informs that the certificate is created and can be downloaded (see Fig. 5.70).
Note
The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.1, steps 1 – 4 and 9 – 13.
Fig. 5.70 Completing the HTTPS certificate
or
Select CSR and press Enter.
→ A message informs that a key pair and a certificate request are created.
Select Continue and press Enter.
Provide the settings for the certificate.
Select OK and press Enter.
Open the web browser and enter the displayed URL.
Download the PEM file.
→ The GOS administration menu displays a message to verify that the CSR has not been tampered with.
Verify the information by pressing Enter.
Note
When the certificate is signed it has to be uploaded to the GSM. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.2, steps 1 – 4 and 11 – 14.
2. Entering or Uploading a Greenbone Security Feed (GSF) Subscription Key
If no valid GSF subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed (GCF) and not the GSF. A GSF subscription key can be entered or uploaded as follows:
Select Editor and press Enter (see Fig. 5.71).
→ The editor is opened.
Fig. 5.71 Entering or uploading a GSF subscription key
Enter the subscription key.
Press Ctrl + X.
Press Y to save the changes.
Press Enter.
or
- Select HTTP Upload and press Enter.
- Open the web browser and enter the displayed URL.
- Click Browse…, select the subscription key and click Upload.
3. Downloading the Feed
If no feed is present on the GSM, the feed can be downloaded as follows:
Select Yes and press Enter (see Fig. 5.72).
Fig. 5.72 Downloading the feed
→ A message informs that the feed update was started in the background (see Fig. 5.73).
Fig. 5.73 Downloading the feed
Press Enter to close the message.
4. Finishing the First Setup Wizard
Note
After the last step, a status check is performed. A message shows the result (see Fig. 5.74).
After closing the message by pressing 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.
Fig. 5.74 Result of the status check
5. Exchanging the Master Key with the Sensor
Continue with Chapter 16 to exchange the keys with the master.
Note
The GSM 25V does not offer any web interface. The sensor is solely managed by the master. Logging into the sensor is possible by using the console and SSH from the master.
If the communication between master and sensor fails, the rule set of any internal firewall governing the network connection may be adjusted.
5.7 GSM ONE/MAVEN¶
This setup guide shows the steps required to put a GSM ONE or GSM MAVEN appliance into operation.
The following checklist can be used to monitor the progress:
| Step | Done |
|---|---|
| VirtualBox installed | |
| Integrity verified (optional) | |
| OVA file imported | |
| Virtual machine settings checked | |
| Keyboard layout selected | |
| IP address configured | |
| DNS server configured | |
| SSH service enabled (optional) | |
| SSL certificate created | |
| Web user account created | |
| GOS selfcheck run |
5.7.1 Setup Requirements¶
This section lists the requirements for successfully deploying a GSM ONE or GSM MAVEN appliance. All requirements have to be met.
5.7.1.1 Resources¶
The virtual appliance requires at least the following resources:
- 2 virtual CPUs
- 6 GB RAM
- 16 GB hard disk
5.7.1.2 Supported Hypervisor¶
While a GSM ONE/MAVEN can be run on various hypervisors, currently only Oracle VirtualBox version 6.1 or higher is officially supported.
Note
For information about the required booting mode see Chapter 6.5.2.
5.7.1.3 Verification of Integrity¶
Note
The integrity of the virtual appliance can be verified. On request the Greenbone Networks Support provides an integrity checksum.
To request the checksum contact the Greenbone Networks Support via e-mail (support@greenbone.net) including the subscription number.
The integrity checksum can be provided via phone or via support portal. Specify the preferred channel in the e-mail.
The local verification of the checksum depends on the host operating system.
On Linux systems the following command for calculating the checksum for a GSM ONE/MAVEN can be used:
sha256sum GSM-ONE-5.0.4-gsf201906301.ova
Note
The command for the GSM MAVEN differs according to the GSM model and the GSF subscription key.
On Microsoft Windows systems an appropriate program has to be installed first.
Tip
Rehash may be used which can be found at http://rehash.sourceforge.net.
To calculate the checksum, use:
rehash.exe -none -sha256 C:\<path>\GSM-ONE-5.0.4-gsf201906301.ova
Note
The command for the GSM MAVEN differs according to the GSM model and the GSF subscription key.
If the checksum does not match the checksum provided by the Greenbone Networks Support, the virtual appliance has been modified and should not be used.
5.7.2 Deploying the Appliance¶
The virtual appliance is provided by Greenbone Networks in the Open Virtualization Appliance (OVA) format.
Each GSM ONE/MAVEN is activated using a unique subscription key.
Note
Cloning the GSM ONE/MAVEN and using several instances in parallel is not permitted and can result in inconsistencies and unwanted side effects.
To deploy a GSM ONE/MAVEN, it has to be imported into the hypervisor of choice as follows:
Note
The figure shows the installation of a GSM ONE. The installation of a GSM MAVEN is carried out equivalently. File names used in the example differ based on the GSM model and the GSF subscription key.
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.
Start VirtualBox.
Select File > Import Appliance… in the menu bar.
Click
and select the OVA file of the appliance (see Fig. 5.75).
Fig. 5.75 Importing the OVA file of the appliance
Check the configuration of the virtual machine in the window Appliance settings (see Fig. 5.75).
Values can be changed by double clicking into the input box of the respective value.
Note
If possible, select 4096 MB RAM (memory) for optimal configuration of the virtual appliance.
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.
Select the appliance in the list and click Start.
5.7.3 Performing a General System Setup¶
All GSM appliances share the same way of basic configuration and readiness check.
When the GSM is delivered by Greenbone Networks 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.76).
Fig. 5.76 Using the first setup wizard
By selecting Yes and pressing Enter the first setup wizard is opened and can be used as follows:
Note
By selecting No and pressing Enter the wizard can be closed. Steps which have not been completed yet are displayed when logging in again.
By selecting Cancel and pressing Enter the wizard can be closed as well. However, in this case, incomplete steps are not shown again.
The first setup wizard is dynamic and shows only those steps necessary to operate the used GSM 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.9).
Every step can be skipped by selecting Skip or No and pressing Enter. Skipped steps are displayed when logging in again.
1. Importing or Generating an HTTPS Certificate
An HTTPS certificate has to be present on the GSM to use the web interface securely. The certificate can be imported or generated as follows:
Select Import and press Enter (see Fig. 5.77).
→ A message informs that a PKCS#12 file can be imported.
Fig. 5.77 Importing or generating an HTTPS certificate
Select Continue and press Enter.
Open the web browser and enter the displayed URL.
Click Browse…, select the PKCS#12 file and click Upload.
→ When the certificate is retrieved by the GSM, the GOS administration menu displays the fingerprint of the certificate for verification.
Check the fingerprint and confirm the certificate by pressing Enter.
or
Select Generate and press Enter.
→ A message informs that parameters have to be entered to generate the certificate.
Select Continue and press Enter.
Provide the settings for the certificate (see Fig. 5.78).
Fig. 5.78 Entering information for the certificate
Select OK and press Enter.
→ A message informs that the certificate is created and can be downloaded (see Fig. 5.79).
Note
The download is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.1, steps 1 – 4 and 9 – 13.
Fig. 5.79 Completing the HTTPS certificate
or
Select CSR and press Enter.
→ A message informs that a key pair and a certificate request are created.
Select Continue and press Enter.
Provide the settings for the certificate.
Select OK and press Enter.
Open the web browser and enter the displayed URL.
Download the PEM file.
→ The GOS administration menu displays a message to verify that the CSR has not been tampered with.
Verify the information by pressing Enter.
Note
When the certificate is signed it has to be uploaded to the GSM. The upload is not done in the first setup wizard, but in the later GOS administration menu as described in Chapter 7.2.3.1.3.2, steps 1 – 4 and 11 – 14.
2. Creating a Web Administrator
If there is no web administrator, it is asked whether such an account should be created (see Fig. 5.80).
Note
A web administrator is required to use the web interface of the GSM.
The first web administrator (web user) that is created is automatically the Feed Import Owner (see Chapter 7.2.1.9).
Fig. 5.80 Creating a web administrator
Select Yes and press Enter.
Enter the user name for the web administrator.
Enter the password for the web administrator twice.
Select OK and press Enter.
→ A message informs that the web administrator has been created.
Press Enter to close the message.
3. Entering or Uploading a Greenbone Security Feed (GSF) Subscription Key
If no valid GSF subscription key is stored on the appliance, the appliance only uses the public Greenbone Community Feed (GCF) and not the GSF. A GSF subscription key can be entered or uploaded as follows:
Select Editor and press Enter (see Fig. 5.81).
→ The editor is opened.
Fig. 5.81 Entering or uploading a GSF subscription key
Enter the subscription key.
Press Ctrl + X.
Press Y to save the changes.
Press Enter.
or
- Select HTTP Upload and press Enter.
- Open the web browser and enter the displayed URL.
- Click Browse…, select the subscription key and click Upload.
4. Downloading the Feed
If no feed is present on the GSM, the feed can be downloaded as follows:
Select Yes and press Enter (see Fig. 5.82).
Fig. 5.82 Downloading the feed
→ A message informs that the feed update was started in the background (see Fig. 5.83).
Fig. 5.83 Downloading the feed
Press Enter to close the message.
5. Finishing the First Setup Wizard
Note
After the last step, a status check is performed. A message shows the result (see Fig. 5.84).
After closing the message by pressing 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.
Fig. 5.84 Result of the status check