Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a new agent "BinaryEdge" as suggested in the issue #648

Merged
merged 19 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions integration-tests/integration-test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ var (
"criminalip": criminalipTestcases{},
"hunterhow": hunterhowTestcases{},
"google": googleTestcases{},
"binaryedge": binaryedgeTestcases{},
// feature tests
"output": outputTestcases{},
}
Expand Down
18 changes: 18 additions & 0 deletions integration-tests/source-test.go
Original file line number Diff line number Diff line change
Expand Up @@ -206,3 +206,21 @@ func (h googleTestcases) Execute() error {
}
return expectResultsGreaterThanCount(results, 0)
}

type binaryedgeTestcases struct{}

func (h binaryedgeTestcases) Execute() error {
token := os.Getenv("BINARYEDGE_API_KEY")
if token == "" {
return errors.New("missing binaryedge api key")
}

binaryedgeToken := fmt.Sprintf(`binaryedge: [%s]`, token)
_ = os.WriteFile(ConfigFile, []byte(binaryedgeToken), 0644)
defer os.RemoveAll(ConfigFile)
results, err := testutils.RunUncoverAndGetResults(debug, "-binaryedge", "1.1.1.1")
if err != nil {
return err
}
return expectResultsGreaterThanCount(results, 0)
}
14 changes: 10 additions & 4 deletions runner/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ type Options struct {
Publicwww goflags.StringSlice
HunterHow goflags.StringSlice
Google goflags.StringSlice
BinaryEdge goflags.StringSlice
DisableUpdateCheck bool
}

Expand All @@ -68,7 +69,7 @@ func ParseOptions() *Options {

flagSet.CreateGroup("input", "Input",
flagSet.StringSliceVarP(&options.Query, "query", "q", nil, "search query, supports: stdin,file,config input (example: -q 'example query', -q 'query.txt')", goflags.FileStringSliceOptions),
flagSet.StringSliceVarP(&options.Engine, "engine", "e", nil, "search engine to query (shodan,shodan-idb,fofa,censys,quake,hunter,zoomeye,netlas,publicwww,criminalip,hunterhow,google) (default shodan)", goflags.FileNormalizedStringSliceOptions),
flagSet.StringSliceVarP(&options.Engine, "engine", "e", nil, "search engine to query (shodan,shodan-idb,fofa,censys,quake,hunter,zoomeye,netlas,publicwww,criminalip,hunterhow,google,binaryedge) (default shodan)", goflags.FileNormalizedStringSliceOptions),
flagSet.StringSliceVarP(&options.AwesomeSearchQueries, "awesome-search-queries", "asq", nil, "use awesome search queries to discover exposed assets on the internet (example: -asq 'jira')", goflags.FileStringSliceOptions),
)

Expand All @@ -85,6 +86,7 @@ func ParseOptions() *Options {
flagSet.StringSliceVarP(&options.Publicwww, "publicwww", "pw", nil, "search query for publicwww (example: -publicwww 'query.txt')", goflags.FileStringSliceOptions),
flagSet.StringSliceVarP(&options.HunterHow, "hunterhow", "hh", nil, "search query for hunterhow (example: -hunterhow 'query.txt')", goflags.FileStringSliceOptions),
flagSet.StringSliceVarP(&options.Google, "google", "gg", nil, "search query for google (example: -google 'query.txt')", goflags.FileStringSliceOptions),
flagSet.StringSliceVarP(&options.BinaryEdge, "binaryedge", "be", nil, "search query for binaryedge (example: -binaryedge 'query.txt')", goflags.FileStringSliceOptions),
)

flagSet.CreateGroup("config", "Config",
Expand Down Expand Up @@ -155,7 +157,8 @@ func ParseOptions() *Options {
len(options.CriminalIP),
len(options.Publicwww),
len(options.HunterHow),
len(options.Google)) {
len(options.Google),
len(options.BinaryEdge)) {
options.Engine = append(options.Engine, "shodan")
}

Expand Down Expand Up @@ -223,7 +226,8 @@ func (options *Options) validateOptions() error {
len(options.CriminalIP),
len(options.Publicwww),
len(options.HunterHow),
len(options.Google)) {
len(options.Google),
len(options.BinaryEdge)) {
return errors.New("no query provided")
}

Expand All @@ -246,7 +250,8 @@ func (options *Options) validateOptions() error {
len(options.CriminalIP),
len(options.Publicwww),
len(options.HunterHow),
len(options.Google)) {
len(options.Google),
len(options.BinaryEdge)) {
return errors.New("no engine specified")
}

Expand Down Expand Up @@ -286,6 +291,7 @@ func appendAllQueries(options *Options) {
appendQuery(options, "publicwww", options.Publicwww...)
appendQuery(options, "hunterhow", options.HunterHow...)
appendQuery(options, "google", options.Google...)
appendQuery(options, "binaryedge", options.BinaryEdge...)
}

func (options *Options) useAwesomeSearchQueries(awesomeSearchQueries []string) error {
Expand Down
75 changes: 75 additions & 0 deletions sources/agent/binaryedge/binaryedge.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
package binaryedge

import (
"encoding/json"
"errors"
"fmt"
"net/http"
"net/url"

"github.com/projectdiscovery/uncover/sources"
)

const (
URL = "https://api.binaryedge.io/v2/query/ip/%s"
Size = 100
)

type Agent struct{}

func (agent *Agent) Name() string {
return "binaryedge"
}

func (agent *Agent) Query(session *sources.Session, query *sources.Query) (chan sources.Result, error) {
if session.Keys.BinaryEdgeToken == "" {
return nil, errors.New("empty binaryedge token")
}

results := make(chan sources.Result)
go func() {
defer close(results)
agent.query(session, query.Query, results)
}()

return results, nil
}

func (agent *Agent) query(session *sources.Session, searchQuery string, results chan sources.Result) {
resp, err := agent.queryURL(session, URL, searchQuery)
if err != nil {
results <- sources.Result{Source: agent.Name(), Error: err}
return
}
defer resp.Body.Close()

var apiResponse BinaryedgeResponse
if err := json.NewDecoder(resp.Body).Decode(&apiResponse); err != nil {
results <- sources.Result{Source: agent.Name(), Error: err}
return
}

for _, event := range apiResponse.Events {
for _, item := range event.Results {
output := sources.Result{
Source: agent.Name(),
IP: item.Target.IP,
Port: item.Target.Port,
}
if raw, err := json.Marshal(item); err == nil {
output.Raw = raw
}
results <- output
}
}
}

func (agent *Agent) queryURL(session *sources.Session, baseURL, searchQuery string) (*http.Response, error) {
urlWithQuery := fmt.Sprintf(baseURL, url.QueryEscape(searchQuery))
request, err := sources.NewHTTPRequest(http.MethodGet, urlWithQuery, nil)
if err != nil {
return nil, err
}
request.Header.Set("X-Key", session.Keys.BinaryEdgeToken)
return session.Do(request, agent.Name())
}
1,807 changes: 1,807 additions & 0 deletions sources/agent/binaryedge/example.json

Large diffs are not rendered by default.

32 changes: 32 additions & 0 deletions sources/agent/binaryedge/response.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
package binaryedge

type BinaryedgeResponse struct {
Total int `json:"total"`
Query string `json:"query"`
Events []BinaryedgeEvent `json:"events"`
}

type BinaryedgeEvent struct {
Results []BinaryedgeResult `json:"results"`
Port int `json:"port"`
}

type BinaryedgeResult struct {
Origin BinaryedgeOrigin `json:"origin"`
Target BinaryedgeTarget `json:"target"`
}

type BinaryedgeOrigin struct {
Module string `json:"module"`
Port int `json:"port"`
IP string `json:"ip"`
Type string `json:"type"`
Ts int64 `json:"ts"`
Country string `json:"country"`
}

type BinaryedgeTarget struct {
Protocol string `json:"protocol"`
Port int `json:"port"`
IP string `json:"ip"`
}
4 changes: 3 additions & 1 deletion sources/keys.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ type Keys struct {
HunterHowToken string
GoogleKey string
GoogleCX string
BinaryEdgeToken string
}

func (keys Keys) Empty() bool {
Expand All @@ -33,5 +34,6 @@ func (keys Keys) Empty() bool {
keys.PublicwwwToken == "" &&
keys.HunterHowToken == "" &&
keys.GoogleKey == "" &&
keys.GoogleCX == ""
keys.GoogleCX == "" &&
keys.BinaryEdgeToken == ""
}
6 changes: 6 additions & 0 deletions sources/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ type Provider struct {
Publicwww []string `yaml:"publicwww"`
HunterHow []string `yaml:"hunterhow"`
Google []string `yaml:"google"`
BinaryEdge []string `yaml:"binaryedge"`
}

// NewProvider loads provider keys from default location and env variables
Expand Down Expand Up @@ -108,6 +109,9 @@ func (provider *Provider) GetKeys() Keys {
keys.GoogleCX = parts[1]
}
}
if len(provider.BinaryEdge) > 0 {
keys.BinaryEdgeToken = provider.BinaryEdge[rand.Intn(len(provider.BinaryEdge))]
}

return keys
}
Expand Down Expand Up @@ -153,6 +157,7 @@ func (provider *Provider) LoadProviderKeysFromEnv() {
provider.Fofa = appendIfAllExists(provider.Fofa, "FOFA_EMAIL", "FOFA_KEY")
provider.Censys = appendIfAllExists(provider.Censys, "CENSYS_API_ID", "CENSYS_API_SECRET")
provider.Google = appendIfAllExists(provider.Google, "GOOGLE_API_KEY", "GOOGLE_API_CX")
provider.BinaryEdge = appendIfExists(provider.BinaryEdge, "BINARYEDGE_API_KEY")
}

// HasKeys returns true if at least one agent/source has keys
Expand All @@ -169,6 +174,7 @@ func (provider *Provider) HasKeys() bool {
len(provider.HunterHow) > 0,
len(provider.Google) > 0,
len(provider.Publicwww) > 0,
len(provider.BinaryEdge) > 0,
)
}

Expand Down
1 change: 1 addition & 0 deletions sources/session.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ var DefaultRateLimits = map[string]*ratelimit.Options{
"publicwww": {Key: "publicwww", MaxCount: 1, Duration: time.Minute},
"hunterhow": {Key: "hunterhow", MaxCount: 1, Duration: 3 * time.Second},
"google": {Key: "google", MaxCount: 1, Duration: 3 * time.Second},
"binaryedge": {Key: "binaryedge", MaxCount: 1, Duration: time.Second},
}

// Session handles session agent sessions
Expand Down
5 changes: 4 additions & 1 deletion uncover.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/projectdiscovery/gologger"
"github.com/projectdiscovery/uncover/sources"
"github.com/projectdiscovery/uncover/sources/agent/binaryedge"
"github.com/projectdiscovery/uncover/sources/agent/censys"
"github.com/projectdiscovery/uncover/sources/agent/criminalip"
"github.com/projectdiscovery/uncover/sources/agent/fofa"
Expand Down Expand Up @@ -75,6 +76,8 @@ func New(opts *Options) (*Service, error) {
s.Agents = append(s.Agents, &hunterhow.Agent{})
case "google":
s.Agents = append(s.Agents, &google.Agent{})
case "binaryedge":
s.Agents = append(s.Agents, &binaryedge.Agent{})
}
}
s.Provider = sources.NewProvider()
Expand Down Expand Up @@ -179,7 +182,7 @@ func (s *Service) ExecuteWithCallback(ctx context.Context, callback func(result
// AllAgents returns all supported uncover Agents
func (s *Service) AllAgents() []string {
return []string{
"shodan", "censys", "fofa", "shodan-idb", "quake", "hunter", "zoomeye", "netlas", "criminalip", "publicwww", "hunterhow", "google",
"shodan", "censys", "fofa", "shodan-idb", "quake", "hunter", "zoomeye", "netlas", "criminalip", "publicwww", "hunterhow", "google", "binaryedge",
}
}

Expand Down
Loading