Add txt manual verification (#74)

mailsac · Jan 11, 2022 · 477e8f7 · 477e8f7
1 parent ce70d9e
commit 477e8f7
Show file tree

Hide file tree

Showing 10 changed files with 125 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -72,3 +72,6 @@ _build/
 
 # python virtual envrionment
 venv/
+
+# mac os
+.DS_Store
diff --git a/help/dns_verification/dig_dkim_record.png b/help/dns_verification/dig_dkim_record.png
diff --git a/help/dns_verification/dig_dkim_record.txt b/help/dns_verification/dig_dkim_record.txt
@@ -0,0 +1,20 @@
+# dig TXT mailsacrelay._domainkey.example.com.
+
+; <<>> DiG 9.10.6 <<>> TXT mailsacrelay._domainkey.example.com.
+;; global options: +cmd
+;; Got answer:
+;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 16974
+;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
+
+;; OPT PSEUDOSECTION:
+; EDNS: version: 0, flags:; udp: 512
+;; QUESTION SECTION:
+;mailsacrelay._domainkey.example.com. IN TXT
+
+;; ANSWER SECTION:
+mailsacrelay._domainkey.example.com. 300 IN TXT "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCJDMFvVPqwytT8n1zJca32nyK+W/KWt/058H7Hf2FGhtNSmTQfDEhBVD5DwPNJsiMKyhWXFtyBZ8NcsDhFl/KYwLj7r9n6cRa2e3jbdr2OyUfbrlqJ1LrjiGc/rH48NJPX2uL7NNGIFBzYRyTxymvWGlchNh8gwQ8Pvedk9ZcueQIDAQAB"
+
+;; Query time: 109 msec
+;; SERVER: 192.168.1.1#53(192.168.1.1)
+;; WHEN: Tue Jan 11 07:00:32 PST 2022
+;; MSG SIZE  rcvd: 317
diff --git a/help/dns_verification/dig_mx_record.png b/help/dns_verification/dig_mx_record.png
diff --git a/help/dns_verification/dig_mx_record.txt b/help/dns_verification/dig_mx_record.txt
@@ -0,0 +1,21 @@
+# dig mx example.com
+
+; <<>> DiG 9.10.6 <<>> MX example.com
+;; global options: +cmd
+;; Got answer:
+;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 17410
+;; flags: qr rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 0, ADDITIONAL: 1
+
+;; OPT PSEUDOSECTION:
+; EDNS: version: 0, flags:; udp: 512
+;; QUESTION SECTION:
+;example.com.             IN      MX
+
+;; ANSWER SECTION:
+example.com.      300     IN      MX      1 in.mailsac.com.
+example.com.      300     IN      MX      5 alt.mailsac.com.
+
+;; Query time: 121 msec
+;; SERVER: 192.168.1.1#53(192.168.1.1)
+;; WHEN: Tue Jan 11 06:54:36 PST 2022
+;; MSG SIZE  rcvd: 96
diff --git a/help/dns_verification/dig_spf_record.png b/help/dns_verification/dig_spf_record.png
diff --git a/help/dns_verification/dig_spf_record.txt b/help/dns_verification/dig_spf_record.txt
@@ -0,0 +1,20 @@
+# dig TXT example.com
+
+; <<>> DiG 9.10.6 <<>> TXT example.com.
+;; global options: +cmd
+;; Got answer:
+;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 34522
+;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1
+
+;; OPT PSEUDOSECTION:
+; EDNS: version: 0, flags:; udp: 512
+;; QUESTION SECTION:
+;example.com.             IN      TXT
+
+;; ANSWER SECTION:
+example.com.      300     IN      TXT     "v=spf1 include:relays.mailsac.com ~all"
+
+;; Query time: 83 msec
+;; SERVER: 192.168.1.1#53(192.168.1.1)
+;; WHEN: Tue Jan 11 07:04:45 PST 2022
+;; MSG SIZE  rcvd: 97
diff --git a/help/dns_verification/dig_txt_record.png b/help/dns_verification/dig_txt_record.png
diff --git a/help/dns_verification/dig_txt_record.txt b/help/dns_verification/dig_txt_record.txt
@@ -0,0 +1,20 @@
+# dig txt example.com
+
+; <<>> DiG 9.10.6 <<>> txt example.com
+;; global options: +cmd
+;; Got answer:
+;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 15576
+;; flags: qr rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 0, ADDITIONAL: 1
+
+;; OPT PSEUDOSECTION:
+; EDNS: version: 0, flags:; udp: 512
+;; QUESTION SECTION:
+;example.com.             IN      TXT
+
+;; ANSWER SECTION:
+example.com.      3600    IN      TXT     "mailsac_0rlzMqMyDo2wDF6FuE0x54U5"
+
+;; Query time: 74 msec
+;; SERVER: 192.168.1.1#53(192.168.1.1)
+;; WHEN: Sun Jan 09 07:23:33 PST 2022
+;; MSG SIZE  rcvd: 142
diff --git a/help/dns_verification/dns_verification.rst b/help/dns_verification/dns_verification.rst
@@ -18,28 +18,57 @@ The command line tool `dig`, which is standard on most Linux distros
 and OSX, can be used to verify DNS records. Google hosts an `online
 version of dig <web based dig_>`_.
 
-MX Record Verification
-----------------------
+Domain Ownership TXT Record
+---------------------------
+
+Mailsac uses a TXT DNS record to verify domain ownership.
+
+The TXT DNS Record is unique per domain. The value of the required TXT
+record can be found in the Dashboard_ under Domains_, then click "Manage"
+and choose the "DNS Setup" tab.
+
+======== ================= ==================
+**Type** **Host**           **Value**
+TXT      example.com       mailsac_0rlzMqMyDo2wDF6FuE0x54U5 (Example)
+======== ================= ==================
+
+To verify a domain's TXT Record the command line tool `dig`
+(`web based dig`_) can be used. In this example, the domain
+`example.com` is being used.
+
+.. code-block:: bash
+
+   dig TXT example.com
+
+.. image:: dig_txt_record.png
+   :alt: Example result of dig TXT DNS Query
+
+The values in the ``ANSWER SECTION`` show that the records are configured
+correctly because it corresponds to the value in the table above.
+
+TXT Record Verification
+-----------------------
 
 The values of the MX Records are the :ref:`same <section_email_hosting>` for all
 Private and Public Domains hosted by Mailsac. The Host will be unique per
 domain.
 
 ======== ================= ==================
 **Type** **Host**           **Value**
-MX       dogtreats.msdc.co 1 in.mailsac.com
-MX       dogtreats.msdc.co 5 alt.mailsac.com
+MX       example.com       1 in.mailsac.com
+MX       example.com       5 alt.mailsac.com
 ======== ================= ==================
 
 To verify a domain's MX Records the command line tool `dig`
 (`web based dig`_) can be used. In this example, the domain
-`dogtreats.msdc.co` is being used.
+`example.com` is being used.
 
 .. code-block:: bash
 
-   dig MX dogtreats.msdc.co
+   dig MX example.com
 
 .. image:: dig_mx_record.png
+   :alt: Example result of dig MX DNS Query
 
 The values in the `ANSWER SECTION` show that the records are configured
 correctly because it corresponds to the value in the table above.
@@ -53,17 +82,18 @@ be found in the Dashboard_ under Domains_, then click "Manage" and choose the
 
 ======== ========================================== ========================
 **Type** **Host**                                   **Value**
-TXT      mailsacrelay._domainkey.dogtreats.msdc.co. v=DKIM1; k=rsa; p=MI....
+TXT      mailsacrelay._domainkey.example.com.       v=DKIM1; k=rsa; p=MI....
 ======== ========================================== ========================
 
 DKIM Records are a DNS TXT record and can be queried using the command line
 tool `dig` (`web based dig`_).
 
 .. code-block:: bash
 
-   dig TXT mailsacrelay._domainkey.dogtreats.msdc.co.
+   dig TXT mailsacrelay._domainkey.example.com.
 
 .. image:: dig_dkim_record.png
+   :alt: Example result of dig TXT DNS Query for DKIM
 
 The value in the `ANSWER SECTION` show that the DKIM record is configured
 correctly because it corresponds to the value of the provided DKIM record in
@@ -77,17 +107,18 @@ The Host will be unique per domain.
 
 ======== =================== ======================================
 **Type** **Host**            **Value**
-TXT      dogtreats.msdc.co.  v=spf1 include:relays.mailsac.com ~all
+TXT      example.com.        v=spf1 include:relays.mailsac.com ~all
 ======== =================== ======================================
 
 SPF Records are a DNS TXT record and can be queried using the command line
 tool `dig` (`web based dig`_).
 
 .. code-block:: bash
 
-   dig TXT dogtreats.msdc.co.
+   dig TXT example.com.
 
 .. image:: dig_spf_record.png
+   :alt: Example result of dig TXT DNS Query for SPF
 
 The values in the `ANSWER SECTION` shows that the record is configured
 correctly because it corresponds to the value in in the table above.