fixes in initMessage(); code hygiene; comments

Author: rockcavera

src/dnsprotocol.nim

@@ -178,7 +178,7 @@ proc initResourceRecord*(name: string, `type`: Type, class: Class, ttl: int32,
   ##   `RDatas<dnsprotocol/types.html#RDatas>`_.
   ##
   ## **Note**
-  ## * `rdata` can be initialized as `nil`, but it is not recommended.
+  ## - `rdata` can be initialized as `nil`, but it is not recommended.
   result.name = name
 
   if 0 == len(result.name) or '.' != result.name[^1]:
@@ -221,17 +221,17 @@ proc initMessage*(header: Header, questions: Questions = @[],
 
   result.header.qdcount = len(result.questions).uint16
 
-  if len(result.questions) > 65535:
+  if len(result.answers) > 65535:
     raise newException(ValueError, "The number of answers exceeds 65535")
 
   result.header.ancount = len(result.answers).uint16
 
-  if len(result.questions) > 65535:
+  if len(result.authorities) > 65535:
     raise newException(ValueError, "The number of authorities exceeds 65535")
 
   result.header.nscount = len(result.authorities).uint16
 
-  if len(result.questions) > 65535:
+  if len(result.additionals) > 65535:
     raise newException(ValueError, "The number of additionals exceeds 65535")
 
   result.header.arcount = len(result.additionals).uint16
@@ -296,11 +296,9 @@ proc toBinMsg*(rr: ResourceRecord, ss: StringStream,
 
   rdataToBinMsg(rr.rdata, rr, ss, dictionary)
 
-  let aOffset = getPosition(ss)
-
-  #rr.rdlength = uint16(aOffset - (rdlengthOffset + 2))
-
-  let rdlength = uint16(aOffset - (rdlengthOffset + 2))
+  let
+    aOffset = getPosition(ss)
+    rdlength = uint16(aOffset - (rdlengthOffset + 2))
 
   setPosition(ss, rdlengthOffset)
 

src/dnsprotocol/rdatatypes.nim

@@ -76,9 +76,19 @@ type
 
   # END - RDatas specified in RFC-1886
 
+  # RDatas specified in RFC-2782 (https://www.rfc-editor.org/rfc/rfc2782)
+
+  RDataSRV* = ref object of RData
+    priority*: uint16 ## The priority of this target host.  A client MUST attempt to contact the target host with the lowest-numbered priority it can reach; target hosts with the same priority SHOULD be tried in an order defined by the weight field.  The range is 0-65535.  This is a 16 bit unsigned integer in network byte order.
+    weight*: uint16 ## A server selection mechanism.  The weight field specifies a relative weight for entries with the same priority. Larger weights SHOULD be given a proportionately higher probability of being selected. The range of this number is 0-65535.  This is a 16 bit unsigned integer in network byte order.
+    port*: uint16 ## The port on this target host of this service.  The range is 0- 65535.  This is a 16 bit unsigned integer in network byte order.
+    target*: string ## A <domain-name> which specifies a host willing to act as a mail exchange for the owner name.
+
+  # END - RDatas specified in RFC-2782
+
   # RDatas specified in RFC-8659 (https://tools.ietf.org/html/rfc8659)
 
-  CAAFlags* {.size: 1.} = object
+  CAAFlags* {.size: 1.} = object # /!\ I need to review! /!\ bitsize is buggy with mm refc and async
     when system.cpuEndian == bigEndian:
       issuerCritical* {.bitsize:1.}: bool ## Issuer Critical Flag:  If the value is set to "1", the Property is critical. A CA MUST NOT issue certificates for any FQDN if the Relevant RRset for that FQDN contains a CAA critical Property for an unknown or unsupported Property Tag.
       reserved* {.bitsize:7.}: uint8 ## Reserved for future use.
@@ -94,12 +104,6 @@ type
 
   # END - RDatas specified in RFC-8659
 
-  RDataSRV* = ref object of RData
-    priority*: uint16 ## The priority of this target host.  A client MUST attempt to contact the target host with the lowest-numbered priority it can reach; target hosts with the same priority SHOULD be tried in an order defined by the weight field.  The range is 0-65535.  This is a 16 bit unsigned integer in network byte order.
-    weight*: uint16 ## A server selection mechanism.  The weight field specifies a relative weight for entries with the same priority. Larger weights SHOULD be given a proportionately higher probability of being selected. The range of this number is 0-65535.  This is a 16 bit unsigned integer in network byte order.
-    port*: uint16 ## The port on this target host of this service.  The range is 0- 65535.  This is a 16 bit unsigned integer in network byte order.
-    target*: string ## A <domain-name> which specifies a host willing to act as a mail exchange for the owner name.
-
   # All RDatas
   RDatas* = RDataA|RDataNS|RDataMD|RDataMF|RDataCNAME|RDataSOA|RDataMB|RDataMG|
             RDataMR|RDataNULL|RDataWKS|RDataPTR|RDataHINFO|RDataMINFO|RDataMX|

src/dnsprotocol/types.nim

@@ -85,7 +85,7 @@ type
     #Notify = 4 ## Notify - RFC-1996
     #Update = 5 ## Update - RFC-2136
 
-  RCode* {.pure.} = enum ## Response code - this 4 bit field is set as part of responses. The values have the following interpretation:
+  RCode* {.pure.} = enum ## Response code - this 4 bit field is set as part of responses.
     NoError = 0 ## No error condition
     FormatError = 1 ## The name server was unable to interpret the query.
     ServerFailure = 2 ## The name server was unable to process this query due to a problem with the name server.
@@ -99,14 +99,14 @@ type
     #NOTZONE = 10 ## RFC-2136
 
   Flags* = object
-      qr*: QR ## A one bit field that specifies whether this message is a query (0), or a response (1).
-      opcode*: OpCode ## A four bit field that specifies kind of query in this message. This value is set by the originator of a query and copied into the response.
-      aa*: bool ## Authoritative Answer - this bit is valid in responses, and specifies that the responding name server is an authority for the domain name in question section. Note that the contents of the answer section may have multiple owner names because of aliases. The AA bit corresponds to the name which matches the query name, or the first owner name in the answer section.
-      tc*: bool ## TrunCation - specifies that this message was truncated due to length greater than that permitted on the transmission channel.
-      rd*: bool ## Recursion Desired - this bit may be set in a query and is copied into the response. If RD is set, it directs the name server to pursue the query recursively. Recursive query support is optional.
-      ra*: bool ## Recursion Available - this be is set or cleared in a response, and denotes whether recursive query support is available in the name server.
-      z*: uint8 ## Reserved for future use.  Must be zero in all queries and responses.
-      rcode*: RCode ## Response code - this 4 bit field is set as part of responses.
+    qr*: QR ## A one bit field that specifies whether this message is a query (0), or a response (1).
+    opcode*: OpCode ## A four bit field that specifies kind of query in this message. This value is set by the originator of a query and copied into the response.
+    aa*: bool ## Authoritative Answer - this bit is valid in responses, and specifies that the responding name server is an authority for the domain name in question section. Note that the contents of the answer section may have multiple owner names because of aliases. The AA bit corresponds to the name which matches the query name, or the first owner name in the answer section.
+    tc*: bool ## TrunCation - specifies that this message was truncated due to length greater than that permitted on the transmission channel.
+    rd*: bool ## Recursion Desired - this bit may be set in a query and is copied into the response. If RD is set, it directs the name server to pursue the query recursively. Recursive query support is optional.
+    ra*: bool ## Recursion Available - this be is set or cleared in a response, and denotes whether recursive query support is available in the name server.
+    z*: uint8 ## Reserved for future use.  Must be zero in all queries and responses.
+    rcode*: RCode ## Response code - this 4 bit field is set as part of responses.
 
   #[ https://github.com/nim-lang/Nim/issues/16313
   Flags* {.size: 2.} = object