• Stars
    star
    212
  • Rank 186,122 (Top 4 %)
  • Language
    JavaScript
  • License
    GNU Affero Genera...
  • Created about 7 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Greenbone Security Assistant - The web frontend for the Greenbone Community Edition

Greenbone Logo

Greenbone Security Assistant

GitHub releases code test coverage Build and test JS

The Greenbone Security Assistant is the web interface developed for the Greenbone Enterprise appliances written in React.

Releases

All release files are signed with the Greenbone Community Feed integrity key. This gpg key can be downloaded at https://www.greenbone.net/GBCommunitySigningKey.asc and the fingerprint is 8AE4 BE42 9B60 A59B 311C 2E73 9823 FAA6 0ED1 E580.

Installation

Prerequisites for GSA:

  • node.js >= 14.0
  • yarn >= 1.0

To install nodejs 14 the following commands can be used

export VERSION=node_14.x
export KEYRING=/usr/share/keyrings/nodesource.gpg
export DISTRIBUTION="$(lsb_release -s -c)"

curl -fsSL https://deb.nodesource.com/gpgkey/nodesource.gpg.key | gpg --dearmor | sudo tee "$KEYRING" >/dev/null
gpg --no-default-keyring --keyring "$KEYRING" --list-keys

echo "deb [signed-by=$KEYRING] https://deb.nodesource.com/$VERSION $DISTRIBUTION main" | sudo tee /etc/apt/sources.list.d/nodesource.list
echo "deb-src [signed-by=$KEYRING] https://deb.nodesource.com/$VERSION $DISTRIBUTION main" | sudo tee -a /etc/apt/sources.list.d/nodesource.list

Change into the gsa source directory and delete the possible existing build output directory.

cd path/to/gsa
rm -rf build

Install the JavaScript dependencies and start the build process. The build process creates a build directory with a production build of GSA. The build/img directory will contain images like logos and banners. The build/static directory will contain generated JavaScript and CSS files and additionally in the build/static/media directory SVG files for all icons will be found.

yarn
yarn build

All content of the production build can be shipped with every web server. For providing GSA via our gsad web server, the files need to be copied into the share/gvm/gsad/web/ subdirectory of your chosen CMAKE_INSTALL_PREFIX directory when building gsad. Normally this is set to /usr or /usr/local.

mkdir -p $INSTALL_PREFIX/share/gvm/gsad/web/
cp -r build/* $INSTALL_PREFIX/share/gvm/gsad/web/

If you are not familiar or comfortable building from source code, we recommend that you use the Greenbone Security Manager TRIAL (GSM TRIAL), a prepared virtual machine with a readily available setup. Information regarding the virtual machine is available at https://www.greenbone.net/en/testnow.

Developing

Using GSA requires to re-build the JavaScript bundle. This process is very time-consuming and therefore may be avoided during development. It is possible to run GSA in a special web development server. The development server can be started with:

cd path/to/gsa && yarn run start

Afterwards the development web server is set up and a new browser window is opened at the URL http://127.0.0.1:8080, containing the GSA web application. When a JavaScript file of GSA in the src folder is changed, the browser window will reload automatically.

Besides the development server gsad needs to be running with CORS enabled.

gsad --http-cors="http://127.0.0.1:8080"

To be able to communicate with gsad, the web application needs to know the server URL. This can be accomplished by editing the path/to/gsa/public/config.js file. The following lines can be used for a local gsad running with HTTP on port 9392:

  config = {
    protocol: 'http',
    server: '127.0.0.1:9392',
  };

For HTTPS only the protocol property must be 'https' accordingly.

After changing the config.js file, the browser window should be reloaded manually.

Support

For any question on the usage of gsa please use the Greenbone Community Portal. If you found a problem with the software, please create an issue on GitHub. If you are a Greenbone customer you may alternatively or additionally forward your issue to the Greenbone Support Portal.

Maintainer

This project is maintained by Greenbone Networks GmbH.

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at github first.

License

Copyright (C) 2009-2022 Greenbone AG

Licensed under the AGPL-3.0 GNU Affero General Public License v3.0 or later.

More Repositories

1

openvas-scanner

This repository contains the scanner component for Greenbone Community Edition.
Rust
3,228
star
2

gvmd

Greenbone Vulnerability Manager - The database backend for the Greenbone Community Edition
C
280
star
3

autohooks

Library for managing git hooks
Python
187
star
4

gvm-tools

Remote control your Greenbone Community Edition or Greenbone Enterprise Appliance
Python
161
star
5

python-gvm

Greenbone Vulnerability Management Python Library
Python
106
star
6

gvm-libs

Greenbone Vulnerability Management Libraries
C
83
star
7

ospd-openvas

ospd-openvas is an OSP server implementation to allow GVM to remotely control an OpenVAS Scanner
Python
66
star
8

openvas-smb

SMB module for OpenVAS Scanner
C
47
star
9

notus-scanner

Notus is a vulnerability scanner for creating results from local security checks
Python
40
star
10

ospd

OSPd is a framework for vulnerability scanners which share the same communication protocol: OSP (Open Scanner Protocol)
Python
30
star
11

docs

Documentation for the Greenbone Community Edition
Shell
22
star
12

gsad

Greenbone Security Assistant HTTP Server - The server talking to the Greenbone Vulnerability Management daemon (gvmd).
C
10
star
13

pheme

pheme is a service to create scan reports
Python
9
star
14

pontos

Common utilities and tools maintained by Greenbone Networks
Python
9
star
15

greenbone-feed-sync

New script for downloading the Greenbone Community Feed
Python
8
star
16

pg-gvm

Greenbone Library for helper functions in PostgreSQL
CMake
7
star
17

actions

GitHub Actions for Greenbone projects
Python
7
star
18

greenbone-container-images

Additional Container Images from Greenbone
Dockerfile
6
star
19

troubadix

A linting tool for NASL files
Python
6
star
20

hyperion

Abandoned. This repository is not used anymore.
Python
6
star
21

.github

Default GitHub files for Greenbone Projects
5
star
22

autohooks-plugin-black

An autohooks plugin for python code formatting via black
Python
5
star
23

ospd-debsecan

OSP server implementation to allow GVM to remotely control a debsecan scanner
Python
5
star
24

ospd-example-scanner

Example ospd based scanner
Python
4
star
25

boreas

Boreas a command line tool to scan for alive hosts
CMake
4
star
26

ospd-ikescan

ospd-ikescan is a OSP server implementation to allow GVM to remotely control a ike-scan scanner
Python
4
star
27

ospd-nmap-nse

ospd-nmap-nse is an OSP server implementation to allow GVM to remotely control the nmap port scanner
Python
4
star
28

ospd-ikeprobe

ospd-ikeprobe is a OSP server implementation to allow GVM to remotely control a ikeprobe scanner
Python
3
star
29

autohooks-plugin-pylint

Autohooks plugin for code linting via pylint
Python
3
star
30

ospd-netstat

ospd-netstat is a OSP server implementation to allow GVM to remotely control the netstat tool
Python
3
star
31

ui-components

React Components
TypeScript
3
star
32

go-project-template

Go Project Template
Go
3
star
33

templates

Greenbone Templates for repositories on GitHub
3
star
34

ospd-nmap

ospd-nmap is a OSP server implementation to allow GVM to remotely control the nmap port scanner
Python
3
star
35

keycloak-client-golang

Reusable keycloak client for golang
Go
3
star
36

autohooks-plugin-isort

An autohooks plugin for Python include sorting with isort
Python
3
star
37

vt-test-environments

Environments for VT testing
Dockerfile
3
star
38

scanner-api

API for the scanner
HTML
3
star
39

ospd-ssh-keyscan

ospd-ssh-keyscan is a OSP server implementation to allow GVM to remotely control the ssh-keyscan tool of OpenSSH
Python
2
star
40

autohooks-plugin-flake8

Autohooks plugin for flake8
Python
2
star
41

autohooks-plugin-pytest

Python
2
star
42

python-project-template

Python Project Template
Python
2
star
43

greenbone.github.io

Pages
HTML
1
star
44

opensight-golang-libraries

A collection of reusable Golang code to provide functionality to OpenSight backend services
Go
1
star
45

exercise-admin-notification

An example REST service as end point for an application execise
Go
1
star