web

Documentation

Overview

Service web provides a web dashboard and communication between sarif and HTTP.

Index

• Constants
• Variables
• func GenerateApiKey() (string, error)
• func RequestToMessage(req *http.Request, urlPrefix string) (sarif.Message, error)
• type Config
• type Dependencies
• type Server
  • func New(deps *Dependencies) *Server
  • func (s *Server) Disable() error
  • func (s *Server) Enable() error

Constants

const (
	REST_URL = "/api/v0/"
)

Variables

var Module = &services.Module{
	Name:        "web",
	Version:     "1.0",
	NewInstance: New,
}

Functions

func GenerateApiKey

func GenerateApiKey() (string, error)

func RequestToMessage

func RequestToMessage(req *http.Request, urlPrefix string) (sarif.Message, error)

Types

type Config

type Config struct {
	Interface      string
	ApiKeys        map[string]string
	AllowedActions map[string][]string
}

type Dependencies

type Dependencies struct {
	Config        services.Config
	ClientFactory sarif.ClientFactory
	Client        sarif.Client
}

type Server

type Server struct {
	Config services.Config

	ClientFactory sarif.ClientFactory

	Client sarif.Client
	// contains filtered or unexported fields
}

func New

func New(deps *Dependencies) *Server

func (*Server) Disable

func (s *Server) Disable() error

func (*Server) Enable

func (s *Server) Enable() error