Class: Net::DNS::RR::Types

Inherits:
Object
  • Object
show all
Defined in:
lib/net/dns/rr/types.rb

Overview

This is an auxiliary class to handle RR type field in a DNS packet.

Constant Summary collapse

TYPES = 
{
  'SIGZERO' => 0, # RFC2931 consider this a pseudo type
  'A' => 1, # RFC 1035, Section 3.4.1
  'NS' => 2, # RFC 1035, Section 3.3.11
  'MD' => 3, # RFC 1035, Section 3.3.4 (obsolete)
  'MF' => 4, # RFC 1035, Section 3.3.5 (obsolete)
  'CNAME' => 5, # RFC 1035, Section 3.3.1
  'SOA' => 6, # RFC 1035, Section 3.3.13
  'MB' => 7, # RFC 1035, Section 3.3.3 (obsolete)
  'MG' => 8, # RFC 1035, Section 3.3.6 (obsolete)
  'MR' => 9, # RFC 1035, Section 3.3.8 (obsolete)
  'NULL' => 10, # RFC 1035, Section 3.3.10 (obsolete)
  'WKS' => 11, # RFC 1035, Section 3.4.2 (obsolete)
  'PTR' => 12, # RFC 1035, Section 3.3.12
  'HINFO' => 13, # RFC 1035, Section 3.3.2
  'MINFO' => 14, # RFC 1035, Section 3.3.7 (obsolete)
  'MX' => 15, # RFC 1035, Section 3.3.9
  'TXT' => 16, # RFC 1035, Section 3.3.14
  'RP' => 17, # RFC 1183, Section 2.2 (obsolete)
  'AFSDB' => 18, # RFC 1183, Section 1
  'X25' => 19, # RFC 1183, Section 3.1 (obsolete)
  'ISDN' => 20, # RFC 1183, Section 3.2 (obsolete)
  'RT' => 21, # RFC 1183, Section 3.3 (obsolete)
  'NSAP' => 22, # RFC 1706, Section 5 (obsolete)
  'NSAP_PTR' => 23, # RFC 1348 (obsolete) (obsolete)
  # The following 2 RRs are impemented in Net::DNS::SEC, TODO
  'SIG' => 24, # RFC 2535, Section 4.1 (obsolete)
  'KEY' => 25, # RFC 2535, Section 3.1 (obsolete)
  'PX' => 26, # RFC 2163, (obsolete)
  'GPOS' => 27, # RFC 1712 (obsolete)
  'AAAA' => 28, # RFC 1886, Section 2.1
  'LOC' => 29, # RFC 1876
  # The following RR is implemented in Net::DNS::SEC, TODO
  'NXT' => 30, # RFC 2535, Section 5.2 (obsolete)
  'EID' => 31, # draft-ietf-nimrod-dns-xx.txt (obsolete)
  'NIMLOC' => 32, # draft-ietf-nimrod-dns-xx.txt (obsolete)
  'SRV' => 33, # RFC 2052
  'ATMA' => 34, # ??? (obsolete)
  'NAPTR' => 35, # RFC 2168
  'KX' => 36, # RFC 2230
  'CERT' => 37, # RFC 2538
  'DNAME' => 39, # RFC 2672
  'OPT' => 41, # RFC 2671
  'APL' => 42, # RFC 3123 (obsolete)
  # The following 4 RRs are implemented in Net::DNS::SEC TODO
  'DS' => 43, # RFC 4034
  'SSHFP' => 44, # RFC 4255
  'IPSECKEY' => 45, # RFC 4025
  'RRSIG' => 46, # RFC 4034
  'NSEC' => 47, # RFC 4034
  'DNSKEY' => 48, # RFC 4034
  'DHCID' => 49, # RFC 4701
  'NSEC3' => 50, # RFC 5155
  'NSEC3PARAM' => 51, # RFC 5155
  'TLSA' => 52, # RFC 6698
  'SMIMEA' => 53, # RFC 8162
  'HIP' => 55, # RFC 8005
  'CDS' => 59, # RFC 7344
  'CDNSKEY' => 60, # RFC 7344
  'OPENPGPKEY' => 61, # RFC 7929
  'CSYNC' => 62, # RFC 7477
  'ZONEMD' => 63, # RFC 8976
  'SVCB' => 64, # RFC 9460
  'HTTPS' => 65, # RFC 9460
  'UINFO' => 100, # non-standard (obsolete)
  'UID' => 101, # non-standard (obsolete)
  'GID' => 102, # non-standard (obsolete)
  'UNSPEC' => 103, # non-standard (obsolete)
  'EUI48' => 108, # RFC 7043
  'EUI64' => 109, # RFC 7043
  'TKEY' => 249, # RFC 2930
  'TSIG' => 250, # RFC 2931
  'IXFR' => 251, # RFC 1995
  'AXFR' => 252, # RFC 1035
  'MAILB' => 253, # RFC 1035 (MB, MG, MR) (obsolete)
  'MAILA' => 254, # RFC 1035 (obsolete - see MX)
  'ANY' => 255, # RFC 1035
  'URI' => 256, # RFC 7553
  'CAA' => 257, # RFC 6844
}.freeze
TYPES_BY_NUMBER =

Pre-initialize the inverted hash to avoid runtime inversion

TYPES.invert.freeze
@@default =

The default value when type is nil in Resource Records

TYPES["A"]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type) ⇒ Types

Creates a new object representing an RR type. Performs some checks on the argument validity too. Il type is nil, the default value is ANY or the one set with Types.default=



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/net/dns/rr/types.rb', line 144

def initialize(type)
  case type
  when String
    # type in the form "A" or "NS"
    new_from_string(type.upcase)
  when Integer
    # type in numeric form
    new_from_num(type)
  when nil
    # default type, control with Types.default=
    @str = TYPES_BY_NUMBER[@@default]
    @num = @@default
  else
    raise ArgumentError, "Wrong type class: #{type.class}"
  end
end

Class Method Details

.default ⇒ Object 



93
94
95
 
# File 'lib/net/dns/rr/types.rb', line 93

def self.default
  @@default
end

.default=(str) ⇒ Object

Be able to control the default type to assign when type is nil. Default to A



99
100
101
102
103
104
105
 
# File 'lib/net/dns/rr/types.rb', line 99

def self.default=(str)
  if TYPES.key? str
    @@default = TYPES[str]
  else
    raise ArgumentError, "Unknown type #{str}"
  end
end

.regexp ⇒ Object

Gives in output the keys from the Types hash in a format suited for regexps



136
137
138
139
 
# File 'lib/net/dns/rr/types.rb', line 136

def self.regexp
  # Longest ones go first, so the regex engine will match AAAA before A.
  TYPES.keys.sort { |a, b| b.length <=> a.length }.join("|")
end

.to_str(type) ⇒ Object

Returns the type in string format, as “A” or “NS”, given the numeric value



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/net/dns/rr/types.rb', line 121

def self.to_str(type)
  case type
  when Integer
    if TYPES_BY_NUMBER.key? type
      TYPES_BY_NUMBER[type]
    else
      raise ArgumentError, "Unknown type number #{type}"
    end
  else
    raise ArgumentError, "Wrong type class: #{type.class}"
  end
end

.valid?(type) ⇒ Boolean

Checks whether type is a valid RR type.

Returns:

  • (Boolean) 


108
109
110
111
112
113
114
115
116
117
 
# File 'lib/net/dns/rr/types.rb', line 108

def self.valid?(type)
  case type
  when String
    TYPES.key?(type)
  when Integer
    TYPES_BY_NUMBER.key?(type)
  else
    raise ArgumentError, "Wrong type class: #{type.class}"
  end
end

Instance Method Details

#inspect ⇒ Object

Returns the type in number format (default for normal use)



163
164
165
 
# File 'lib/net/dns/rr/types.rb', line 163

def inspect
  @num
end

#to_i ⇒ Object

Returns the type in numeric format, usable by the pack methods for data transfers



175
176
177
 
# File 'lib/net/dns/rr/types.rb', line 175

def to_i
  @num.to_i
end

#to_s ⇒ Object

Returns the type in string format, i.d. “A” or “NS” or such a string.



169
170
171
 
# File 'lib/net/dns/rr/types.rb', line 169

def to_s
  @str
end

#to_str ⇒ Object 



179
180
181
 
# File 'lib/net/dns/rr/types.rb', line 179

def to_str
  @num.to_s
end