Skip to content

Commit 1ab3efd

Browse files
seanthegeekseanthegeek
committed
Update docs
1 parent f8bfdab commit 1ab3efd

File tree

3 files changed

+41
-68
lines changed

3 files changed

+41
-68
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A Python module, command line utility, and [web application](https://github.com/
1515
- SPF
1616
- Record validation
1717
- Counting of DNS lookups and void lookups
18-
- Counting of lookups per include
18+
- Counting of lookups per mechanism
1919
- DMARC
2020
- Validation and parsing of DMARC records
2121
- Shows warnings when the DMARC record is made ineffective by `pct` or `sp` values

‎docs/source/cli.md‎

Lines changed: 39 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ checkdmarc --skip-tls proton.me
4747
"base_domain": "proton.me",
4848
"dnssec": true,
4949
"soa": {
50-
"record": "ns1.proton.me. support.proton.me. 2025082186 1200 144 1814400 7200",
50+
"record": "ns1.proton.me. support.proton.me. 2025091157 1200 144 1814400 7200",
5151
"values": {
5252
"primary_nameserver": "ns1.proton.me",
5353
"rname_email_address": "support@proton.me",
54-
"serial": 2025082186,
54+
"serial": 2025091157,
5555
"refresh": 1200,
5656
"retry": 144,
5757
"expire": 1814400,
@@ -111,110 +111,83 @@ checkdmarc --skip-tls proton.me
111111
"mailsec.protonmail.ch"
112112
]
113113
},
114-
"warnings": [
115-
"MTA-STS policy lines should end with CRLF not LF"
116-
]
114+
"warnings": []
117115
},
118116
"spf": {
119117
"record": "v=spf1 include:_spf.protonmail.ch ~all",
120118
"valid": true,
121119
"dns_lookups": 2,
122-
"dns_void_lookups": 0,
120+
"void_dns_lookups": 0,
123121
"warnings": [],
124122
"parsed": {
125-
"pass": [],
126-
"neutral": [],
127-
"softfail": [],
128-
"fail": [],
129-
"include": [
123+
"mechanisms": [
130124
{
131-
"domain": "_spf.protonmail.ch",
125+
"mechanism": "include",
126+
"value": "_spf.protonmail.ch",
132127
"record": "v=spf1 ip4:185.70.40.0/24 ip4:185.70.41.0/24 ip4:185.70.43.0/24 ip4:79.135.106.0/24 ip4:79.135.107.0/24 ip4:109.224.244.0/24 include:_spf2.protonmail.ch ~all",
133-
"dns_lookups": 1,
134-
"dns_void_lookups": 0,
128+
"dns_lookups": 2,
129+
"void_dns_lookups": 0,
135130
"parsed": {
136-
"pass": [
131+
"mechanisms": [
137132
{
133+
"mechanism": "ip4",
138134
"value": "185.70.40.0/24",
139-
"mechanism": "ip4"
135+
"action": "pass"
140136
},
141137
{
138+
"mechanism": "ip4",
142139
"value": "185.70.41.0/24",
143-
"mechanism": "ip4"
140+
"action": "pass"
144141
},
145142
{
143+
"mechanism": "ip4",
146144
"value": "185.70.43.0/24",
147-
"mechanism": "ip4"
145+
"action": "pass"
148146
},
149147
{
148+
"mechanism": "ip4",
150149
"value": "79.135.106.0/24",
151-
"mechanism": "ip4"
150+
"action": "pass"
152151
},
153152
{
153+
"mechanism": "ip4",
154154
"value": "79.135.107.0/24",
155-
"mechanism": "ip4"
155+
"action": "pass"
156156
},
157157
{
158+
"mechanism": "ip4",
158159
"value": "109.224.244.0/24",
159-
"mechanism": "ip4"
160-
}
161-
],
162-
"neutral": [],
163-
"softfail": [],
164-
"fail": [],
165-
"include": [
160+
"action": "pass"
161+
},
166162
{
167-
"domain": "_spf2.protonmail.ch",
168-
"record": "v=spf1 ip4:51.89.119.103 ip4:91.134.188.129 ip4:51.77.79.158 ip4:54.38.221.122 ip4:188.165.51.139 ip4:54.36.149.183 ip4:85.9.206.169 ip4:85.9.210.45 ip4:51.83.17.38 ip4:57.129.93.249 ~all",
169-
"dns_lookups": 0,
170-
"dns_void_lookups": 0,
163+
"mechanism": "include",
164+
"value": "_spf2.protonmail.ch",
165+
"record": "v=spf1 ip4:85.9.206.169 ip4:85.9.210.45 ip4:188.165.51.139 ip4:57.129.93.249 ~all",
166+
"dns_lookups": 1,
167+
"void_dns_lookups": 0,
171168
"parsed": {
172-
"pass": [
173-
{
174-
"value": "51.89.119.103",
175-
"mechanism": "ip4"
176-
},
177-
{
178-
"value": "91.134.188.129",
179-
"mechanism": "ip4"
180-
},
181-
{
182-
"value": "51.77.79.158",
183-
"mechanism": "ip4"
184-
},
185-
{
186-
"value": "54.38.221.122",
187-
"mechanism": "ip4"
188-
},
189-
{
190-
"value": "188.165.51.139",
191-
"mechanism": "ip4"
192-
},
193-
{
194-
"value": "54.36.149.183",
195-
"mechanism": "ip4"
196-
},
169+
"mechanisms": [
197170
{
171+
"mechanism": "ip4",
198172
"value": "85.9.206.169",
199-
"mechanism": "ip4"
173+
"action": "pass"
200174
},
201175
{
176+
"mechanism": "ip4",
202177
"value": "85.9.210.45",
203-
"mechanism": "ip4"
178+
"action": "pass"
204179
},
205180
{
206-
"value": "51.83.17.38",
207-
"mechanism": "ip4"
181+
"mechanism": "ip4",
182+
"value": "188.165.51.139",
183+
"action": "pass"
208184
},
209185
{
186+
"mechanism": "ip4",
210187
"value": "57.129.93.249",
211-
"mechanism": "ip4"
188+
"action": "pass"
212189
}
213190
],
214-
"neutral": [],
215-
"softfail": [],
216-
"fail": [],
217-
"include": [],
218191
"redirect": null,
219192
"exp": null,
220193
"all": "softfail"
@@ -239,7 +212,7 @@ checkdmarc --skip-tls proton.me
239212
"valid": true,
240213
"location": "proton.me",
241214
"warnings": [
242-
"rua tag (destination for aggregate reports) not found"
215+
"rua tag (destination for aggregate reports) not found."
243216
],
244217
"tags": {
245218
"v": {

‎docs/source/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A Python module, command line utility, and [web application](https://github.com/
1515
- SPF
1616
- Record validation
1717
- Counting of DNS lookups and void lookups
18-
- Counting of lookups per include
18+
- Counting of lookups per mechanism
1919
- DMARC
2020
- Validation and parsing of DMARC records
2121
- Shows warnings when the DMARC record is made ineffective by `pct` or `sp` values

0 commit comments

Comments
 (0)