Skip to content

Commit

Permalink
update roots
Browse files Browse the repository at this point in the history
  • Loading branch information
careyjames committed Oct 13, 2023
1 parent 07a6997 commit b959c8c
Show file tree
Hide file tree
Showing 8 changed files with 157 additions and 46 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[español](https://github.com/careyjames/DNS-Scout/blob/main/README(espa%C3%B1ol).md)

DNS Scout is a DNS security tool that helps you find and fix DNS problems with email flow. It is easy to use and can be used by both IT professionals and beginners. DNS Scout can help you improve your email security, prevent email spoofing, and troubleshoot email delivery problems.
DNS Scout is a DNS troubleshooting tool that helps you get your email to the inbox. It checks SPF, DMARC, and MX records, and it is for both pros and beginners. DNS Scout is compatible with macOS, Ubuntu, and Kali Linux.

<img src="example-domain.png" alt="Example DNS records" width="800">

Expand Down
3 changes: 3 additions & 0 deletions bin/DNS-Scout-v5.8.tar.gz
Git LFS file not shown
72 changes: 72 additions & 0 deletions bin/README(español).md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# DNS-Scout 🇨🇴 Carey James Balboa - Mac Help Nashville, Inc.
DNS Scout para Linux/MacOS extrae y muestra los registros DNS en una salida de consola codificada por colores que es fácil de ver y copiar/pegar.

Registrador, NS, MX, SPF, DMARC, ASN y PTR para un fácil reconocimiento y resolución de problemas de DNS.

<img src="example-domain.png" alt="Example DNS records" width="800">

<img src="example-IP.png" alt="Example IP records" width="800">

## Características:

**Salida curada para mayor claridad:**
DNS Scout se destaca por filtrar la información no esencial, presentando a los usuarios una vista más limpia y enfocada de los datos DNS, y optimizando para la claridad y la relevancia.

**Interfaz CLI interactiva mejorada:**
DNS Scout aprovecha ```readline``` para ofrecer una interfaz de línea de comandos avanzada que es **fácil de ver y copiar/pegar.**

**Ciclado de memoria basado en sesión:**
La interfaz interactiva de DNS Scout tiene una función de ciclo de memoria, controlada por las teclas de flecha arriba y abajo. Ayuda a navegar rápidamente por las búsquedas recientes de la sesión. Esta función es útil cuando se realizan varias búsquedas y se necesita consultar una entrada anterior.

**Búsqueda de WHOIS simplificada:**
DNS Scout analiza de manera eficiente los datos de registro de dominios, presentando al usuario detalles del registrador y servidores de nombres concisos, eliminando el desorden que se ve típicamente en las salidas WHOIS sin procesar.

**Visualización clara de registros TXT:**
DNS Scout enumera los registros TXT en un formato fácil de digerir, lo que hace que tareas como la revisión de la verificación de SPF o DMARC sean más sencillas.

**Registrador**
Servidores de nombres NS
**Registros MX**
**Muestra registros TXT, útiles para verificar la verificación de dominio, la configuración de SPF, etc.**
**Registros DMARC**
**PTR**
**ASN**
**Datos DNS exactos, sin desplazamiento**

### Guía de instalación de DNS Scout
#### Instalación manual de Nerd para MacOS/Linux
Requisitos previos: Go 1.21
Para aquellos que les gusta ensuciarse las manos:

1. Descargar el binario:
Descargue el binario compilado para su sistema operativo desde la página Releases: https://github.com/careyjames/dns-scout/releases.

2. Hazlo ejecutable:
Después de descargar, navegue al directorio de descarga y ejecute:

```chmod +x dns-scout-<version>``` (macos-silicon linux-amd64)

3. Mover a PATH:
Mueva el ejecutable a un directorio en la PATH de su sistema. Por ejemplo, puede moverlo a ```/usr/local/bin/``` en un sistema basado en Unix/Mac:
```sudo mv dns-scout /usr/local/bin/```

4. Obtén un token gratuito o de pago de ```https://ipinfo.io```

5. Ejecutar DNS Scout:
Abra una nueva ventana de terminal y escriba dns-scout para comenzar a usar la herramienta.

¡Eso es! Ha instalado manualmente DNS-Scout como un verdadero nerd.

**Aquí hay un desglose de cómo cada método de almacenamiento del token de API podría ser útil:**

Variable de entorno: útil para usuarios que ejecutan el programa en un entorno controlado como un servidor, donde establecer variables de entorno es una práctica común.
La secuencia de comandos ```/share/setup-api-token.sh``` les sería útil.

Argumento de línea de comandos: útil para aquellos que desean especificar diferentes tokens de API para diferentes ejecuciones sin cambiar las variables de entorno. Podría ser útil para pruebas.

Almacenado en un archivo: ideal para usuarios habituales que desean establecer el token de API una vez y olvidarlo. El token se leerá de un archivo en el directorio de inicio del usuario, lo que lo hace conveniente para ellos.

**Si estás en MacOS**, ve a Ajustes del sistema > Seguridad y privacidad y dale a ```dns-scout-<version>``` permisos.

<img src="dev-not-verified.png" alt="Dev not Verified" width="800">
<img src="mac-click-allow.png" alt="Example IP records" width="800">
80 changes: 80 additions & 0 deletions bin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# DNS-Scout 🇺🇸 Carey James Balboa - Mac Help Nashville, Inc.
![Build Status](https://github.com/careyjames/DNS-Scout/actions/workflows/go.yml/badge.svg?branch=main)
[![Code Climate](https://codeclimate.com/github/careyjames/DNS-Scout/badges/gpa.svg)](https://codeclimate.com/github/careyjames/DNS-Scout)
[![Dependabot status](https://api.dependabot.com/status?host=github&repo=careyjames/DNS-Scout)](https://api.dependabot.com/status?host=github&repo=careyjames/DNS-Scout)

[español](https://github.com/careyjames/DNS-Scout/blob/main/README(espa%C3%B1ol).md)

DNS Scout is a DNS troubleshooting tool that helps you get your email to the inbox. It checks SPF, DMARC, and MX records, and it is for both pros and beginners. DNS Scout is compatible with macOS, Ubuntu, and Kali Linux.

<img src="example-domain.png" alt="Example DNS records" width="800">

<img src="example-IP.png" alt="Example IP records" width="800">

## Features:

**Curated Output for Clarity:**
DNS Scout stands out by filtering out non-essential information, presenting users with a cleaner,
more focused view of the DNS data, and optimizing for clarity and relevance.

**Enhanced Interactive CLI Interface:**
DNS Scout leverages ```readline``` to offer an advanced command-line interface
that's **easy to see and copy/paste**
**Session-based Memory Cycling**
DNS Scout's interactive interface has a memory cycle feature, controlled by the up and down arrow keys.
It helps navigate recent lookups for the session quickly.
This feature is useful when conducting multiple lookups, and you need to refer to a previous entry.

**Streamlined WHOIS Lookup:**
DNS Scout efficiently parses domain registration data, presenting the user with concise registrar details and name servers, eliminating the clutter typically seen in raw WHOIS outputs.

**Clear TXT Record Display:**
DNS Scout lists TXT records in an easily digestible format,
making tasks like SPF or DMARC verification review more straightforward.

**Registrar**
**NS Name Servers**
**MX Records**
**Displays TXT Records**, useful for checking domain verification, SPF settings, etc.
**DMARC Records**
**PTR**
**ASN**
**Exact DNS data, no scrolling**

### Installation Guide for DNS Scout

#### Manual MacOS/Linux Nerd Install
Prerequisites: Go 1.21
For those who like to get their hands dirty:

1. **Download the Binary**:
Download the compiled binary for your operating system from the [Releases](https://github.com/careyjames/dns-scout/releases) page.

2. **Make It Executable**:
After downloading, navigate to the download directory and run:
```chmod +x dns-scout-<version>``` (macos-silicon linux-amd64)

3. **Move to PATH**:
Move the executable to a directory in your system's PATH. For example, you can move it to `/usr/local/bin/` on a Unix-based system:
```sudo mv dns-scout /usr/local/bin/```

4. **Get free or paid token from ipinfo.io**

5. **Run DNS Scout**:
Open a new terminal window and type `dns-scout` to start using the tool.

That's it! You've manually installed DNS-Scout like a true nerd.

**Here's a breakdown of how each method of storing the API token could be useful:**

Environment Variable: Useful for users running the program in a controlled environment like a server,
where setting environment variables is common practice.
The ```/share/setup-api-token.sh``` script would be helpful for them.

Command-Line Argument: Useful for those who wish to specify different API tokens for different runs without changing environment variables. It could be useful for testing.

Stored in a File: Ideal for regular users who want to set the API token once and forget it. The token will be read from a file in the user's home directory, making it convenient for them.

**If you are on MacOS**, go to System Settings > Security & Privacy and give ```dns-scout-<version>``` permissions.
<img src="dev-not-verified.png" alt="Dev not Verified" width="800">
<img src="mac-click-allow.png" alt="Example IP records" width="800">
10 changes: 1 addition & 9 deletions bin/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,6 @@

# Step 1: Compile the Go code
echo "Compiling Go code..."
go build -v -o ../bin/dns-scout main.go

# Step 2: Create the directory structure
echo "Creating directory structure..."
mkdir -p ../bin/DNS-Scout/share

# Step 4: Copy the shell script to share/
echo "Copying shell script to share/..."
cp ../share/setup-api-token.sh ../bin/DNS-Scout/share/setup-api-token.sh
go build -v -o dns-scout ../main.go

echo "Build complete."
Binary file modified bin/dns-scout
Binary file not shown.
File renamed without changes.
36 changes: 0 additions & 36 deletions share/setup-api-token.sh

This file was deleted.

0 comments on commit b959c8c

Please sign in to comment.