safebrowsing

README

Central proxy server for safebrowsing

Since we use the sotred local database version of the safebrowsing api, we need a central server to query on, we can't have a database on each bot process or node. (would likely run into api quota issues at some point)

Documentation

Index

• Variables
• func CheckString(input string) (*safebrowsing.URLThreat, error)
• func RegisterPlugin()
• func Shutdown()
• type Plugin
  • func (p *Plugin) PluginInfo() *common.PluginInfo
  • func (p *Plugin) RunBackgroundWorker()
  • func (p *Plugin) StopBackgroundWorker(wg *sync.WaitGroup)

Variables

var ErrNoSafebrowsingAPIKey = errors.New("no safebrowsing api key provided")

var SafeBrowser *safebrowsing.SafeBrowser

Functions

func CheckString

func CheckString(input string) (*safebrowsing.URLThreat, error)

CheckString checks a string against google safebrowsing for threats if the safebrowser is running on this process then it will perform the check instantly otherwise it will make a api request towards the safebrowsing proxy server (or return an error)

func RegisterPlugin

func RegisterPlugin()

func Shutdown

func Shutdown()

Types

type Plugin

type Plugin struct {
}

func (*Plugin) PluginInfo

func (p *Plugin) PluginInfo() *common.PluginInfo

func (*Plugin) RunBackgroundWorker

func (p *Plugin) RunBackgroundWorker()

func (*Plugin) StopBackgroundWorker

func (p *Plugin) StopBackgroundWorker(wg *sync.WaitGroup)