1
1
# Domain Health (dh) CLI Tool
2
2
3
- A command-line interface tool for checking the email security configuration of a domain.
3
+ A command-line interface tool for checking and scoring the email security configuration of a domain.
4
4
5
5
## Features
6
6
7
7
- Checks mail provider (e.g., Google, Microsoft, Mimecast)
8
8
- Verifies SPF (Sender Policy Framework) records
9
9
- Checks DMARC (Domain-based Message Authentication, Reporting, and Conformance) configuration
10
10
- Verifies DKIM (DomainKeys Identified Mail) records
11
+ - Calculates a health score based on SPF, DMARC, and DKIM configurations
12
+ - Provides suggestions for improving email security
11
13
- Displays an easy-to-read summary of domain email security
12
14
13
15
## Usage
@@ -31,6 +33,33 @@ The tool provides a formatted table output including:
31
33
- SPF record status and trusted senders
32
34
- DMARC configuration
33
35
- DKIM record status
36
+ - Overall health score (out of 100)
37
+ - Breakdown of the health score
38
+ - Suggestions for improvement
39
+
40
+ ### Example Outputs
41
+
42
+ #### Healthy Domain Configuration
43
+
44
+ ![ Healthy Domain Output] ( images/healthy.png )
45
+
46
+ #### Unhealthy Domain Configuration
47
+
48
+ ![ Unhealthy Domain Output] ( images/unhealthy.png )
49
+
50
+ ## Health Score Calculation
51
+
52
+ The health score is calculated based on the following criteria:
53
+
54
+ - SPF: Up to 33 points
55
+ - 33 points for valid SPF with hard fail (-all)
56
+ - 29 points for valid SPF with soft fail (~ all)
57
+ - 25 points for valid SPF without explicit fail
58
+ - DMARC: Up to 34 points
59
+ - 34 points for p=reject
60
+ - 25 points for p=quarantine
61
+ - 20 points for p=none or no policy specified
62
+ - DKIM: 33 points for valid DKIM record
34
63
35
64
## Requirements
36
65
0 commit comments