package
1.12.1
Repository: https://github.com/alphasoc/nfr.git
Documentation: pkg.go.dev

# Functions

New creates new AlphaSOC client with given host.
NewMock creates new AlphaSOC mock client for testing.

# Constants

DefaultVersion for AlphaSOC API.
Telemetry types processed by AlphaSOC.
Telemetry types processed by AlphaSOC.
Telemetry types processed by AlphaSOC.
Telemetry types processed by AlphaSOC.

# Variables

DefaultUserAgent for nfr.
ErrNoAPIKey is returned when Client method is called without api key set if it's required.
ErrNoRequest is returned when nil request is pass to method.
ErrTooManyRequests is returned when API returns "429 Too Many Requests".

# Structs

AccountRegisterRequest contains information needed to register alphasoc account and obtain API key.
AccountStatusResponse represents response for /account/status call.
Alert provides result of AlphaSOC Engine analysis, which was found to be threat.
AlertsResponse represents response for /events call.
AlphaSOCClient handles connection to AlphaSOC server.
DNSEntry is single dns entry for analize.
ErrorResponse represents AlphaSOC API error response.
EventsDNSRequest contains slice of ip events.
EventsDNSResponse represents response for /events/dns call.
EventsHTTPResponse represents response for /events/http call.
EventsIPRequest contains slice of ip events.
EventsIPResponse for logs/ip call.
EventsHTTPResponse represents response for /events/http call.
No description provided by the author
HTTPEntry is single dns entry for analize.
IPEntry is single ip entry for analize.
KeyRequestRequest contasin information needed for key registration.
KeyRequestResponse represents response for /key/request call.
KeyResetRequest contasin information needed for key reset.
MockAlphaSOCClient creates Client for testing.
Threat provides more details about threat, like human-readable description.
TLSEntry is single dns entry for analize.

# Interfaces

Client interface for AlphaSOC API.

# Type aliases

EventType defines a network event type.