Haaukins
Haaukins is a highly accessible and automated virtualization platform for security education, it has three main components (Docker, Virtualbox and Golang), the communication and orchestration between the components managed using Go programming language. The main reason of having Go environment to manage and deploy something on Haaukins platform is that Go’s easy concurrency and parallelism mechanism.
Our primary aim to involve anyone who desire to learn capturing the flag concept in cyber security which is widely accepted approach to learn how to find vulnerability on a system. Despite of all existing platform, Haaukins provides its own virtualized environment to you with operating system which designed to find vulnerabilities
- Prerequisites
- Installation
- Getting Dependencies
- Testing
- Re-compile proto
- Version release
- Deployment
- Known issues
- Contributing
- Event requests
- Credits
- License
Prerequisites
The following dependencies are required and must be installed separately in order to run daemon in your local environment.
- Linux
- Docker
- Go 1.13+
There is no prerequisites for installing client to your environment.
Note: Linux can be used in virtualized environment as well.
Installation
Use documentation page for installation, other connected repositories and more through documentation site ; https://docs.haaukins.com
Getting Dependencies
Haaukins platform uses go modules since version 1.6.4, hence it is quite easy to manage dependencies, you just need to run go mod download
Testing
Make sure that you are in $GOPATH/src/github.com/aau-network-security/haaukins/ directory, to run all test files, following command can be used
go test -v --race ./...Re-compile proto
Haaukins platform uses gRPC on communication of client and daemon, so after updating the protocol buffer specification (i.e. daemon/proto/daemon.proto), corresponding golang code generation is done by doing the following:
cd $GOPATH/src/github.com/aau-network-security/haaukins/daemon/
protoc -I proto/ proto/daemon.proto --go_out=plugins=grpc:protoVersion release
GoReleaser is handling release section, just tag the commit.
Deployment
Travis automatically deploys on server.
Note: by default the script uses the ~/.ssh/id_rsa key to push to GitHub.
You can override this settings by the HKN_RELEASE_PEMFILE env var.
Known issues
Give a moment and check known issues over here
Contributing
Haaukins is an open source project and built on the top of open-source projects. If you are interested, then you are welcome to contribute.
Check out the Contributing Guide to get started.
Event requests
As AAU, we believe in power of open source community and would like to offer test our platform for organizations and users , if you would like to get your own domain which will be assigned by us please contact us in advance.
Credits
- Logo designed by indepedenthand
License
Copyright (c) 2019-present, Haaukins