https://github.com/name/dh

A lightweight CLI tool for production domain health checks.
https://github.com/name/dh

Last synced: about 18 hours ago
JSON representation

A lightweight CLI tool for production domain health checks.

• Host: GitHub
• URL: https://github.com/name/dh
• Owner: name
• License: gpl-3.0
• Created: 2024-08-26T14:35:17.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-03T22:56:11.000Z (4 months ago)
• Last Synced: 2024-11-12T13:11:48.712Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 102 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Domain Health (dh) CLI Tool

A command-line interface tool for checking and scoring the email security configuration of a domain.

## Features

- Checks mail provider (e.g., Google, Microsoft, Mimecast)

- Verifies SPF (Sender Policy Framework) records

- Checks DMARC (Domain-based Message Authentication, Reporting, and Conformance) configuration

- Verifies DKIM (DomainKeys Identified Mail) records

- Calculates a health score based on SPF, DMARC, and DKIM configurations

- Provides suggestions for improving email security

- Displays an easy-to-read summary of domain email security

## Usage

```shell

dh 

```

Example:

```shell

dh example.com

```

## Output

The tool provides a formatted table output including:

- Domain being checked

- Detected mail provider

- SPF record status and trusted senders

- DMARC configuration

- DKIM record status

- Overall health score (out of 100)

- Breakdown of the health score

- Suggestions for improvement

### Example Outputs

#### Healthy Domain Configuration

![Healthy Domain Output](images/healthy.png)

#### Unhealthy Domain Configuration

![Unhealthy Domain Output](images/unhealthy.png)

## Health Score Calculation

The health score is calculated based on the following criteria:

- SPF: Up to 33 points

  - 33 points for valid SPF with hard fail (-all)

  - 29 points for valid SPF with soft fail (~all)

  - 25 points for valid SPF without explicit fail

- DMARC: Up to 34 points

  - 34 points for p=reject

  - 25 points for p=quarantine

  - 20 points for p=none or no policy specified

- DKIM: 33 points for valid DKIM record

## Requirements

- Rust (latest stable version)

## Installation

1. Clone the repository

2. Run `cargo build --release`

3. The binary will be available in `target/release/dh`

## License

[GNU GENERAL PUBLIC LICENSE](LICENSE)