keyhunter/pkg/recon/sources/binaryedge.go

package sources

import (
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"net/http"
	"net/url"
	"strings"
	"time"

	"golang.org/x/time/rate"

	"github.com/salvacybersec/keyhunter/pkg/providers"
	"github.com/salvacybersec/keyhunter/pkg/recon"
)

// BinaryEdgeSource implements recon.ReconSource against the BinaryEdge
// internet data API. It iterates provider keyword queries and emits a Finding
// per result event.
//
// A missing API key disables the source without error.
type BinaryEdgeSource struct {
	APIKey   string
	BaseURL  string
	Registry *providers.Registry
	Limiters *recon.LimiterRegistry
	client   *Client
}

// Compile-time assertion.
var _ recon.ReconSource = (*BinaryEdgeSource)(nil)

func (s *BinaryEdgeSource) Name() string         { return "binaryedge" }
func (s *BinaryEdgeSource) RateLimit() rate.Limit { return rate.Every(2 * time.Second) }
func (s *BinaryEdgeSource) Burst() int            { return 1 }
func (s *BinaryEdgeSource) RespectsRobots() bool  { return false }

// Enabled returns true only when APIKey is configured.
func (s *BinaryEdgeSource) Enabled(_ recon.Config) bool { return s.APIKey != "" }

// Sweep issues one BinaryEdge search request per provider keyword and emits
// a Finding for every result event.
func (s *BinaryEdgeSource) Sweep(ctx context.Context, _ string, out chan<- recon.Finding) error {
	if s.APIKey == "" {
		return nil
	}
	if s.client == nil {
		s.client = NewClient()
	}
	base := s.BaseURL
	if base == "" {
		base = "https://api.binaryedge.io"
	}

	queries := BuildQueries(s.Registry, "binaryedge")
	kwIndex := binaryedgeKeywordIndex(s.Registry)

	for _, q := range queries {
		if err := ctx.Err(); err != nil {
			return err
		}
		if s.Limiters != nil {
			if err := s.Limiters.Wait(ctx, s.Name(), s.RateLimit(), s.Burst(), false); err != nil {
				return err
			}
		}

		endpoint := fmt.Sprintf("%s/v2/query/search?query=%s&page=1",
			base, url.QueryEscape(q))
		req, err := http.NewRequestWithContext(ctx, http.MethodGet, endpoint, nil)
		if err != nil {
			return fmt.Errorf("binaryedge: build request: %w", err)
		}
		req.Header.Set("X-Key", s.APIKey)
		req.Header.Set("Accept", "application/json")

		resp, err := s.client.Do(ctx, req)
		if err != nil {
			if errors.Is(err, ErrUnauthorized) {
				return err
			}
			if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
				return err
			}
			continue
		}

		var parsed binaryedgeSearchResponse
		decErr := json.NewDecoder(resp.Body).Decode(&parsed)
		_ = resp.Body.Close()
		if decErr != nil {
			continue
		}

		provName := kwIndex[strings.ToLower(q)]
		for _, ev := range parsed.Events {
			f := recon.Finding{
				ProviderName: provName,
				Confidence:   "low",
				Source:       fmt.Sprintf("binaryedge://%s:%d", ev.Target.IP, ev.Target.Port),
				SourceType:   "recon:binaryedge",
				DetectedAt:   time.Now(),
			}
			select {
			case out <- f:
			case <-ctx.Done():
				return ctx.Err()
			}
		}
	}
	return nil
}

type binaryedgeSearchResponse struct {
	Events []binaryedgeEvent `json:"events"`
}

type binaryedgeEvent struct {
	Target binaryedgeTarget `json:"target"`
}

type binaryedgeTarget struct {
	IP   string `json:"ip"`
	Port int    `json:"port"`
}

// binaryedgeKeywordIndex maps lowercased keywords to provider names.
func binaryedgeKeywordIndex(reg *providers.Registry) map[string]string {
	m := make(map[string]string)
	if reg == nil {
		return m
	}
	for _, p := range reg.List() {
		for _, k := range p.Keywords {
			kl := strings.ToLower(strings.TrimSpace(k))
			if kl == "" {
				continue
			}
			if _, exists := m[kl]; !exists {
				m[kl] = p.Name
			}
		}
	}
	return m
}