exposer

command module
v0.0.0-...-e4b8eab Latest Latest
Warning

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

Go to latest
Published: Sep 29, 2023 License: BSD-2-Clause Imports: 26 Imported by: 0

README

Exp👁️ser

exposer is a go tool supported by uncover to perform query monitoring to different search engines, and storing results in Elasticsearch.

DependenciesInstallationInstallation with DockerUsageRunning Exposer


Dependencies

exposer requires a running Elasticsearch cluster to work properly. Information required to establish communication should be specified in config.yaml, or .env if running exposer via docker-compose.

Provider Configuration

Uncover requires API keys to the different search engiens to be used. Exposer will not run until one API key is specified at least. The provider configuration file should be located at $HOME/.config/uncover/provider-config.yaml

Installation Instructions

exposer requires go1.21 to install successfully. Run the following command to get the repo -

go install -v github.com/cheshireca7/exposer@latest
Before runnning
  1. Edit $HOME/.config/uncover/provider-config.yaml with API keys for search engines.
  2. Edit config.yaml file with the data regarding Elasticsearch communication, then move it to $HOME/.config/exposer/. An example configuration file could be as follows:
URL: "localhost:9200"
PROXY: "127.0.0.1:8080"
USERNAME: "elastic"
PASSWORD: "elastic"
  1. If required, move the Elasticsearch CA to be at $HOME/.config/exposer/http_ca.crt. Otherwise, exposer will accept insecure certificates, but it is not recommended.

Docker (WIP)

exposer has its own image that could be downloaded from Docker Hub

docker pull cheshireca7/exposer
Before runnning
  1. Edit $HOME/.config/uncover/provider-config.yaml with API keys for search engines.
docker run -it exposer vim ~/.config/uncover/provider-config.yaml
  1. Edit $HOME/.config/exposer/config.yaml file with the data regarding Elasticsearch communication.
docker run -it exposer vim ~/.config/exposer/config.yaml
  1. Get the certificate from the elasticsearch container and upload it to the exposer container
docker cp es01:/usr/share/elasticsearch/config/certs/http_ca.crt exposer:/root/.config/exposer/http_ca.crt

Docker compose

By running docker-compose, it will load a clear elasticsearch container, as well as exposer at once.

  1. Credentials for Elasticsearch communication should be set at docker/.env file, then run docker-compose up -d
  2. Edit $HOME/.config/uncover/provider-config.yaml with API keys for search engines.

Usage

exposer -h
Docker
docker run --net host -it exposer exposer -h

Running Exposer

Default run just require a query

exposer -q 'ssl:hackerone.com'

                                                                                      
                                                                                      
 ,adPPYba,  8b,     ,d8  8b,dPPYba,    ,adPPYba,   ,adPPYba,   ,adPPYba,  8b,dPPYba,  
a8P_____88   `Y8, ,8P'   88P'    "8a  a8"     "8a  I8[    ""  a8P_____88  88P'   "Y8  
8PP"""""""     )888(     88       d8  8b       d8   `"Y8ba,   8PP"""""""  88          
"8b,   ,aa   ,d8" "8b,   88b,   ,a8"  "8a,   ,a8"  aa    ]8I  "8b,   ,aa  88          
 `"Ybbd8"'  8P'     `Y8  88`YbbdP"'    `"YbbdP"'   `"YbbdP"'   `"Ybbd8"'  88          
                         88                                                           
                         88                                                           

-- Monitor your favorite services exposed to the Internet 👀


[INF] Creating new index: 2023-09-26-13-56-10_uncover_results
[INF] Monitoring query: 'ssl:hackerone.com'
[INF] Number of entries stored: 4

TODO

  • Interactive console to get more information about stored results
  • Improve installation

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

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