citadel

README

Citadel 🏰

Table of contents

1. Installation
2. About
3. Vulnerability Service
4. Incidents Service

Installation

Clone the repository and navigate inside

gh repo clone brittonhayes/citadel && cd citadel

Download the vendor dependencies

go mod download

Navigate to the cmd directory, build, and run citadel

cd ./cmd/citadel
go build
./citadel

About

Citadel is a compilation of Security Operations (SecOps) microservices built with goa and go-kit. Each service functions independently, allowing you to use all of them or just the service that fits your needs. The goal of the project is to provide a baseline set of services that a team could easily store, query, and interact with SecOps resources.

Goa allows this project to be very flexible to design changes. All the code and REST API documentation is generated based on the design specification. The flexibility of this comes into play in the event that a resource or service needs to be expanded upon, added, or removed without untangling anything.

What's inside

Citadel includes the following services:

1. Vulnerability Service
2. Security Incident Service

Vulnerability Service

Transports: 
    - http
Models: 
    - Vulnerability

Security Incident Service

Transports: 
    - http
Models: 
    - Incident

---

Built with go-kit and gorm

Social Icon by Freepik from Flaticon

Documentation

Overview

citadel is a family of Security Operations (SecOps) microservices

Introduction

In Citadel, each service functions independently, allowing you to use all of them or just the service that fits your needs. The goal of the project is to provide a baseline set of services that a team could easily use to store, query, and interact with Security Operations resources.

API Documentation

REST API Documentation can be found in the following places:

REST.md
gen/http/openapi3.yaml
gen/http/openapi3.json

Installation

Download the project, install dependencies, and generate updated docs and services

go get github.com/brittonhayes/citadel
go mod download
go generate

Usage (Server)

Navigate to the cmd/citadel directory to start up the server

cd cmd/citadel
go build
./citadel

Usage (CLI)

Navigate to the cmd/citadel-cli directory to use the command line interface

cd cmd/citadel-cli
go build
./citadel-cli --help

Index

• func NewIncidents(logger log.Logger) incidents.Service
• func NewVulnerabilities(logger log.Logger) vulnerabilities.Service

Functions

func NewIncidents

func NewIncidents(logger log.Logger) incidents.Service

NewIncidents returns the incidents service implementation.

func NewVulnerabilities

func NewVulnerabilities(logger log.Logger) vulnerabilities.Service

NewVulnerabilities returns the vulnerabilities service implementation.