infrastructure-adapters-shodan

Shodan API client adapter — host/service/cert/vuln lookups, API-key auth

What it is for

Shodan API client adapter.

A pure API-client adapter over Shodan's host/DNS/vulnerability lookup endpoints (https://api.shodan.io). API-key auth only — the key rides as a key query parameter on every request, never as a header or bearer token (that's Shodan's own scheme, not a choice made here).

Lifted from plumber/src/collectors/shodan.rs (Gate 4.5 provenance, see CHANGELOG.md). Unlike four of its five sibling files in that source directory, shodan.rs never implemented plumber's Collector trait (renamed SourceIngest on this harvest, foundation-source-ingest) — it has no collect() -> CollectionResult-shaped method, only typed host/DNS/vuln lookups. This crate stays a pure client for the same reason: any SourceIngest implementation (mapping a ShodanHost into whatever domain result type a consumer wants) is a separate, higher-layer "Shodan collector" piece a later sprint can build on top of this one — see CHANGELOG.md for the full reasoning.

# Example

# async fn example() -> Result<(), infrastructure_adapters_shodan::ShodanError> {
let client = infrastructure_adapters_shodan::ShodanClient::from_api_key("YOUR_API_KEY")?;
let host = client.host("8.8.8.8").await?;
println!("{:?}", host.ports);
# Ok(())
# }

Capabilities

No public items.

How to use it

From this crate's own rustdoc:

# async fn example() -> Result<(), infrastructure_adapters_shodan::ShodanError> {
let client = infrastructure_adapters_shodan::ShodanClient::from_api_key("YOUR_API_KEY")?;
let host = client.host("8.8.8.8").await?;
println!("{:?}", host.ports);
# Ok(())
# }

Module structure

No public modules: the crate root is its whole surface.

Public surface

No public items.

Re-exports. Exported here, defined elsewhere.

Boundary

Depends on no other workspace tier.

Shares tier infrastructure with 82 other crates: infrastructure-acquire, infrastructure-adapters-google-calendar, infrastructure-adapters-google-gmail, infrastructure-adapters-google-places, infrastructure-adapters-google-trends, infrastructure-adapters-yelp, infrastructure-agent, infrastructure-ai, … (82 total).

_What this crate deliberately does NOT own is a judgment. No committed registry records one for it, so none is stated here._

Where it sits

Dependencies

Runtime, in this workspace.

Runtime, from outside the workspace.

Development, from outside the workspace.

Build. None.

Depended on by. Nothing in this workspace.

Signal flow — what reaches this crate, and what it reaches.

flowchart LR
  SELF["infrastructure-adapters-shodan"]
  SELF -->|runtime| n_infrastructure_fetcher["infrastructure-fetcher"]
  classDef self fill:#1f883d,stroke:#1f883d,color:#fff;
  class SELF self;

Feature flags

flowchart LR
  n_default["default"] --> n_secure_egress["secure-egress"]
  n_secure_egress["secure-egress"] --> n_dep_infrastructure_fetcher["dep:infrastructure-fetcher"]

Targets

Error model

No public error type was detected: no public item declares a type named *Error, and no public signature returns one.

Operational characteristics

No unsafe block, unsafe fn, unsafe impl or unsafe trait was found by the parser anywhere in this crate's source.

Configuration

No environment variable is read with a literal name anywhere in this crate. A variable whose key is computed at run time cannot be listed here, and is not claimed to be absent.

Related capabilities

No workspace crate depends on this one.

Verification

What the tests establish, by name:

• debug_does_not_leak_api_key — src/auth.rs
• default_config_is_invalid_without_a_key — src/auth.rs
• empty_key_is_invalid_even_if_enabled — src/auth.rs
• new_with_a_key_is_valid_and_enabled — src/auth.rs
• api_info_parses_successful_response — src/client.rs
• creating_a_client_with_a_valid_config_succeeds — src/client.rs
• creating_a_client_with_an_invalid_config_fails — src/client.rs
• dns_domain_parses_successful_response — src/client.rs
• dns_resolve_parses_successful_response — src/client.rs
• dns_reverse_parses_successful_response — src/client.rs
• from_api_key_succeeds — src/client.rs
• host_parses_successful_response — src/client.rs
• my_ip_strips_surrounding_quotes — src/client.rs
• non_success_status_becomes_typed_api_error — src/client.rs
• non_success_status_without_json_body_falls_back_to_http_status — src/client.rs
• rate_limit_enforces_minimum_interval_between_requests — src/client.rs
• strict_egress_client_is_constructible — src/client.rs
• url_embeds_path_and_key — src/client.rs
• url_with_params_embeds_key_and_extra_params — src/client.rs
• shodan_api_error_deserializes — src/types.rs
• shodan_api_info_deserializes — src/types.rs
• shodan_dns_domain_deserializes — src/types.rs
• shodan_host_deserializes_minimal_response — src/types.rs
• shodan_host_with_service_and_vuln_deserializes — src/types.rs
• shodan_service_defaults_transport_to_tcp_when_absent — src/types.rs
• shodan_service_deserializes_with_default_transport — src/types.rs

Documentation coverage

Metrics

pie showData
    title Rust source composition
    "Code" : 679
    "Blank or comment" : 323

Generation

Rendered by tools-corpus corpus readme from repository evidence alone, renderer schema 2, lexicon current. No model, network service or database was consulted. Regenerate with tools-corpus corpus readme --write; verify with --check.