envoy/README.md

79 lines
1.6 KiB
Markdown
Raw Normal View History

2024-05-30 02:41:53 +00:00
# Envoy
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
Envoy is a Shodan API wrapper made in Rust
## Examples
```
cargo run --example basic <key>
cargo run --example proxy <key> <proxy>
```
## API implementation
[Shodan API documentation](https://developer.shodan.io/api)
#### Search Methods
- [x] /shodan/host/{ip}
- [x] /shodan/host/count
- [ ] /shodan/host/search
- [x] /shodan/host/search/facets
- [x] /shodan/host/search/filters
- [x] /shodan/host/search/tokens
#### On-Demand Scanning
- [x] /shodan/ports
- [x] /shodan/protocols
- [ ] /shodan/scan
- [ ] /shodan/scan/internet
- [x] /shodan/scan/{id}
#### Network Alerts
- [ ] /shodan/alert
- [ ] /shodan/alert/{id}/info
- [ ] /shodan/alert/{id}
- [ ] /shodan/alert/info
- [ ] /shodan/alert/triggers
- [ ] /shodan/alert/{id}/trigger/{trigger}
- [ ] /shodan/alert/{id}/trigger/{trigger}/ignore/{service}
- [ ] /shodan/alert/{id}/notifier/{notifier_id}
#### Notifiers
- [ ] /notifier
- [ ] /notifier/provider
- [ ] /notifier/{id}
#### Directory Methods
- [x] /shodan/query
- [x] /shodan/query/search
- [x] /shodan/query/tags
#### Bulk Data
- [ ] /shodan/data
- [ ] /shodan/data/{dataset}
#### Manage Organization
- [ ] /org
- [ ] /org/member/{user}
#### Account Methods
- [x] /account/profile
#### DNS Methods
- [x] /dns/domain/{domain}
- [x] /dns/resolve
- [x] /dns/reverse
#### Utility Methods
- [x] /tools/httpheaders
- [x] /tools/myip
### API Status Methods
- [x] /api-info
### Other
- [ ] Document examples for method
## Disclaimer
###### Developers are not responsible for any misuse