The highest tagged major version is v2.

sources

package

v1.4.2 Latest Latest Go to latest Published: Aug 31, 2023 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/wjlin0/pathScan

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DefaultQuery(query string, engine string) string
func GetHostname(u string) (string, error)
func GetProxyFunc(proxy, auth string) (func(*http.Request) (*url.URL, error), error)
func MatchSubdomains(domain string, html string, fuzzy bool) []string
func NewHTTPRequest(method, url string, body io.Reader) (*retryablehttp.Request, error)
func ParseProxyAuth(auth string) (string, string, bool)
type Agent
type Keys
- func (keys Keys) Empty() bool
type Provider
- func NewProvider() *Provider
type Query
type Result
type Session
- func NewSession(keys *Keys, retryMax, timeout, rateLimit int, engines []string, ...) (*Session, error)
- func (s *Session) Do(request *retryablehttp.Request, source string) (*http.Response, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// UncoverConfigDir Todo: replace from utils with ConfigDirOrDefault
	UncoverConfigDir = filepath.Join(folderutil.HomeDirOrDefault("."), ".config/pathScan")
	// DefaultProviderConfigLocation where keys and config of providers is stored
	DefaultProviderConfigLocation = filepath.Join(UncoverConfigDir, "provider-config.yaml")
)

View Source

var DefaultRateLimits = map[string]*ratelimit.Options{
	"shodan":     {Key: "shodan", MaxCount: 1, Duration: time.Second},
	"shodan-idb": {Key: "shodan-idb", MaxCount: 1, Duration: time.Second},
	"fofa":       {Key: "fofa", MaxCount: 1, Duration: time.Second},
	"censys":     {Key: "censys", MaxCount: 1, Duration: 3 * time.Second},
	"quake":      {Key: "quake", MaxCount: 1, Duration: time.Second},
	"hunter":     {Key: "hunter", MaxCount: 15, Duration: time.Second},
	"zoomeye":    {Key: "zoomeye", MaxCount: 1, Duration: time.Second},
	"netlas":     {Key: "netlas", MaxCount: 1, Duration: time.Second},
	"criminalip": {Key: "criminalip", MaxCount: 1, Duration: time.Second},
	"publicwww":  {Key: "publicwww", MaxCount: 1, Duration: time.Minute},
	"hunterhow":  {Key: "hunterhow", MaxCount: 1, Duration: 3 * time.Second},
}

DefaultRateLimits of all/most of uncover are hardcoded by default to improve performance engine is not present in default ratelimits then user given ratelimit from cli options is used

Functions ¶

func DefaultQuery ¶

func DefaultQuery(query string, engine string) string

func GetHostname ¶

func GetHostname(u string) (string, error)

func GetProxyFunc ¶

func GetProxyFunc(proxy, auth string) (func(*http.Request) (*url.URL, error), error)

GetProxyFunc 辅助函数：获取代理设置函数

func MatchSubdomains ¶

func MatchSubdomains(domain string, html string, fuzzy bool) []string

func NewHTTPRequest ¶

func NewHTTPRequest(method, url string, body io.Reader) (*retryablehttp.Request, error)

func ParseProxyAuth ¶

func ParseProxyAuth(auth string) (string, string, bool)

Types ¶

type Agent ¶

type Agent interface {
	Query(*Session, *Query) (chan Result, error)
	Name() string
}

type Keys ¶

type Keys struct {
	CensysToken     string
	CensysSecret    string
	Shodan          string
	FofaEmail       string
	FofaKey         string
	QuakeToken      string
	HunterToken     string
	ZoomEyeToken    string
	NetlasToken     string
	CriminalIPToken string
	PublicwwwToken  string
	HunterHowToken  string
	BinaryToken     string
}

func (Keys) Empty ¶

func (keys Keys) Empty() bool

type Provider ¶

type Provider struct {
	Shodan     []string `yaml:"shodan"`
	Censys     []string `yaml:"censys"`
	Fofa       []string `yaml:"fofa"`
	Quake      []string `yaml:"quake"`
	Hunter     []string `yaml:"hunter"`
	ZoomEye    []string `yaml:"zoomeye"`
	Netlas     []string `yaml:"netlas"`
	CriminalIP []string `yaml:"criminalip"`
	Publicwww  []string `yaml:"publicwww"`
	HunterHow  []string `yaml:"hunterhow"`
	Binary     []string `yaml:"binary"`
}

func NewProvider ¶

func NewProvider() *Provider

NewProvider loads provider keys from default location and env variables

func (*Provider) GetKeys ¶

func (provider *Provider) GetKeys() Keys

func (*Provider) HasKeys ¶

func (provider *Provider) HasKeys() bool

HasKeys returns true if at least one agent/source has keys

func (*Provider) LoadProviderConfig ¶

func (provider *Provider) LoadProviderConfig(location string) error

LoadProviderConfig LoadProvidersFrom loads provider config from given location

func (*Provider) LoadProviderKeysFromEnv ¶

func (provider *Provider) LoadProviderKeysFromEnv()

LoadProviderKeysFromEnv loads provider keys from env variables

type Query ¶

type Query struct {
	Query string
	Limit int
}

type Result ¶

type Result struct {
	Timestamp int64  `json:"timestamp" csv:"timestamp"`
	Source    string `json:"source" csv:"source"`
	IP        string `json:"ip" csv:"IP"`
	Port      int    `json:"port" csv:"port"`
	Host      string `json:"host" csv:"host"`
	Url       string `json:"url" csv:"url"`
	Raw       []byte `json:"-" csv:"-"`
	Error     error  `json:"-" csv:"-"`
}

func (*Result) HostPort ¶

func (result *Result) HostPort() string

func (*Result) IpPort ¶

func (result *Result) IpPort() string

func (*Result) JSON ¶

func (result *Result) JSON() string

func (*Result) RawData ¶

func (result *Result) RawData() string

type Session ¶

type Session struct {
	Keys       *Keys
	Client     *retryablehttp.Client
	RetryMax   int
	RateLimits *ratelimit.MultiLimiter
}

Session handles session agent sessions

func NewSession ¶

func NewSession(keys *Keys, retryMax, timeout, rateLimit int, engines []string, duration time.Duration, proxy, proxyAuth string) (*Session, error)

func (*Session) Do ¶

func (s *Session) Do(request *retryablehttp.Request, source string) (*http.Response, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
agent
anubis
binary
bing
censys
chinaz
criminalip
fofa
google
hunter
hunterhow
ip138
netlas
publicwww
qianxun
quake
rapiddns
shodan
shodanidb
sitedossier
zoomeye

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL