shodan

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

README

Shodan

Search internet-connected device information using Shodan, including host details, open ports, and services.

Configuration

Environment Variable CLI Flag Required Description
WARREN_SHODAN_API_KEY --shodan-api-key Yes Shodan API key
WARREN_SHODAN_BASE_URL --shodan-base-url No Base URL (default: https://api.shodan.io)

Available Functions

Function Description
shodan_host Get host information by IP address (open ports, services, banners)
shodan_domain Get domain information (subdomains, DNS records)
shodan_search Search the Shodan database using query syntax (with configurable result limit)

Setup

  1. Create an account at shodan.io
  2. Navigate to My Account to find your API key
  3. Set WARREN_SHODAN_API_KEY environment variable

The tool is automatically enabled when the API key is configured.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action

type Action struct {
	// contains filtered or unexported fields
}

func New

func New() *Action

func (*Action) Configure

func (x *Action) Configure(ctx context.Context) error

func (*Action) Flags

func (x *Action) Flags() []cli.Flag

func (*Action) Helper

func (x *Action) Helper() *cli.Command

func (*Action) LogValue

func (x *Action) LogValue() slog.Value

func (*Action) Name

func (x *Action) Name() string

func (*Action) Prompt

func (x *Action) Prompt(ctx context.Context) (string, error)

Prompt returns additional instructions for the system prompt

func (*Action) Run

func (x *Action) Run(ctx context.Context, name string, args map[string]any) (map[string]any, error)

func (*Action) Specs

func (x *Action) Specs(ctx context.Context) ([]gollem.ToolSpec, error)

Jump to

Keyboard shortcuts

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