Class: Resolv::DNS
- Inherits:
-
Object
- Object
- Resolv::DNS
- Defined in:
- lib/resolv.rb
Overview
Resolv::DNS is a DNS stub resolver.
Information taken from the following places:
-
STD0013
-
RFC 1035
-
etc.
Defined Under Namespace
Modules: Label, OpCode, RCode Classes: Config, DecodeError, EncodeError, Message, Name, Query, Requester, Resource
Constant Summary collapse
- Port =
Default DNS Port
53
- UDPSize =
Default DNS UDP packet size
512
- DNSThreadGroup =
Group of DNS resolver threads (obsolete)
ThreadGroup.new
- RequestID =
{}
- RequestIDMutex =
Mutex.new
Class Method Summary collapse
-
.allocate_request_id(host, port) ⇒ Object
:nodoc:.
-
.bind_random_port(udpsock, bind_host = "0.0.0.0")) ⇒ Object
:nodoc:.
-
.free_request_id(host, port, id) ⇒ Object
:nodoc:.
-
.open(*args) ⇒ Object
Creates a new DNS resolver.
-
.random(arg) ⇒ Object
:nodoc:.
-
.rangerand(range) ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#close ⇒ Object
Closes the DNS resolver.
-
#each_address(name) ⇒ Object
Iterates over all IP addresses for
name
retrieved from the DNS resolver. -
#each_name(address) ⇒ Object
Iterates over all hostnames for
address
retrieved from the DNS resolver. -
#each_resource(name, typeclass, &proc) ⇒ Object
Iterates over all
typeclass
DNS resources forname
. -
#extract_resources(msg, name, typeclass) ⇒ Object
:nodoc:.
-
#getaddress(name) ⇒ Object
Gets the IP address of
name
from the DNS resolver. -
#getaddresses(name) ⇒ Object
Gets all IP addresses for
name
from the DNS resolver. -
#getname(address) ⇒ Object
Gets the hostname for
address
from the DNS resolver. -
#getnames(address) ⇒ Object
Gets all hostnames for
address
from the DNS resolver. -
#getresource(name, typeclass) ⇒ Object
Look up the
typeclass
DNS resource ofname
. -
#getresources(name, typeclass) ⇒ Object
Looks up all
typeclass
DNS resources forname
. -
#initialize(config_info = nil) ⇒ DNS
constructor
Creates a new DNS resolver.
-
#lazy_initialize ⇒ Object
:nodoc:.
-
#make_requester ⇒ Object
:nodoc:.
Constructor Details
Class Method Details
.allocate_request_id(host, port) ⇒ Object
:nodoc:
572 573 574 575 576 577 578 579 580 581 582 |
# File 'lib/resolv.rb', line 572 def self.allocate_request_id(host, port) # :nodoc: id = nil RequestIDMutex.synchronize { h = (RequestID[[host, port]] ||= {}) begin id = rangerand(0x0000..0xffff) end while h[id] h[id] = true } id end |
.bind_random_port(udpsock, bind_host = "0.0.0.0")) ⇒ Object
:nodoc:
596 597 598 599 600 601 602 603 |
# File 'lib/resolv.rb', line 596 def self.bind_random_port(udpsock, bind_host="0.0.0.0") # :nodoc: begin port = rangerand(1024..65535) udpsock.bind(bind_host, port) rescue Errno::EADDRINUSE retry end end |
.free_request_id(host, port, id) ⇒ Object
:nodoc:
584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/resolv.rb', line 584 def self.free_request_id(host, port, id) # :nodoc: RequestIDMutex.synchronize { key = [host, port] if h = RequestID[key] h.delete id if h.empty? RequestID.delete key end end } end |
.open(*args) ⇒ Object
Creates a new DNS resolver. See Resolv::DNS.new for argument details.
Yields the created DNS resolver to the block, if given, otherwise returns it.
303 304 305 306 307 308 309 310 311 |
# File 'lib/resolv.rb', line 303 def self.open(*args) dns = new(*args) return dns unless block_given? begin yield dns ensure dns.close end end |
.random(arg) ⇒ Object
:nodoc:
546 547 548 |
# File 'lib/resolv.rb', line 546 def self.random(arg) # :nodoc: rand(arg) end |
.rangerand(range) ⇒ Object
:nodoc:
560 561 562 563 564 565 566 567 |
# File 'lib/resolv.rb', line 560 def self.rangerand(range) # :nodoc: base = range.begin len = range.end - range.begin if !range.exclude_end? len += 1 end base + random(len) end |
Instance Method Details
#close ⇒ Object
Closes the DNS resolver.
347 348 349 350 351 352 353 |
# File 'lib/resolv.rb', line 347 def close @mutex.synchronize { if @initialized @initialized = false end } end |
#each_address(name) ⇒ Object
Iterates over all IP addresses for name
retrieved from the DNS resolver.
name
can be a Resolv::DNS::Name or a String. Retrieved addresses will be a Resolv::IPv4 or Resolv::IPv6
385 386 387 388 |
# File 'lib/resolv.rb', line 385 def each_address(name) each_resource(name, Resource::IN::A) {|resource| yield resource.address} each_resource(name, Resource::IN::AAAA) {|resource| yield resource.address} end |
#each_name(address) ⇒ Object
Iterates over all hostnames for address
retrieved from the DNS resolver.
address
must be a Resolv::IPv4, Resolv::IPv6 or a String. Retrieved names will be Resolv::DNS::Name instances.
420 421 422 423 424 425 426 427 428 429 430 431 432 |
# File 'lib/resolv.rb', line 420 def each_name(address) case address when Name ptr = address when IPv4::Regex ptr = IPv4.create(address).to_name when IPv6::Regex ptr = IPv6.create(address).to_name else raise ResolvError.new("cannot interpret as address: #{address}") end each_resource(ptr, Resource::IN::PTR) {|resource| yield resource.name} end |
#each_resource(name, typeclass, &proc) ⇒ Object
Iterates over all typeclass
DNS resources for name
. See #getresource for argument details.
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'lib/resolv.rb', line 476 def each_resource(name, typeclass, &proc) lazy_initialize requester = make_requester senders = {} begin @config.resolv(name) {|candidate, tout, nameserver| msg = Message.new msg.rd = 1 msg.add_question(candidate, typeclass) unless sender = senders[[candidate, nameserver]] sender = senders[[candidate, nameserver]] = requester.sender(msg, candidate, nameserver) end reply, reply_name = requester.request(sender, tout) case reply.rcode when RCode::NoError extract_resources(reply, reply_name, typeclass, &proc) return when RCode::NXDomain raise Config::NXDomain.new(reply_name.to_s) else raise Config::OtherResolvError.new(reply_name.to_s) end } ensure requester.close end end |
#extract_resources(msg, name, typeclass) ⇒ Object
:nodoc:
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 |
# File 'lib/resolv.rb', line 514 def extract_resources(msg, name, typeclass) # :nodoc: if typeclass < Resource::ANY n0 = Name.create(name) msg.each_answer {|n, ttl, data| yield data if n0 == n } end yielded = false n0 = Name.create(name) msg.each_answer {|n, ttl, data| if n0 == n case data when typeclass yield data yielded = true when Resource::CNAME n0 = data.name end end } return if yielded msg.each_answer {|n, ttl, data| if n0 == n case data when typeclass yield data end end } end |
#getaddress(name) ⇒ Object
Gets the IP address of name
from the DNS resolver.
name
can be a Resolv::DNS::Name or a String. Retrieved address will be a Resolv::IPv4 or Resolv::IPv6
361 362 363 364 |
# File 'lib/resolv.rb', line 361 def getaddress(name) each_address(name) {|address| return address} raise ResolvError.new("DNS result has no information for #{name}") end |
#getaddresses(name) ⇒ Object
Gets all IP addresses for name
from the DNS resolver.
name
can be a Resolv::DNS::Name or a String. Retrieved addresses will be a Resolv::IPv4 or Resolv::IPv6
372 373 374 375 376 |
# File 'lib/resolv.rb', line 372 def getaddresses(name) ret = [] each_address(name) {|address| ret << address} return ret end |
#getname(address) ⇒ Object
Gets the hostname for address
from the DNS resolver.
address
must be a Resolv::IPv4, Resolv::IPv6 or a String. Retrieved name will be a Resolv::DNS::Name.
396 397 398 399 |
# File 'lib/resolv.rb', line 396 def getname(address) each_name(address) {|name| return name} raise ResolvError.new("DNS result has no information for #{address}") end |
#getnames(address) ⇒ Object
Gets all hostnames for address
from the DNS resolver.
address
must be a Resolv::IPv4, Resolv::IPv6 or a String. Retrieved names will be Resolv::DNS::Name instances.
407 408 409 410 411 |
# File 'lib/resolv.rb', line 407 def getnames(address) ret = [] each_name(address) {|name| ret << name} return ret end |
#getresource(name, typeclass) ⇒ Object
Look up the typeclass
DNS resource of name
.
name
must be a Resolv::DNS::Name or a String.
typeclass
should be one of the following:
-
Resolv::DNS::Resource::IN::A
-
Resolv::DNS::Resource::IN::AAAA
-
Resolv::DNS::Resource::IN::ANY
-
Resolv::DNS::Resource::IN::CNAME
-
Resolv::DNS::Resource::IN::HINFO
-
Resolv::DNS::Resource::IN::MINFO
-
Resolv::DNS::Resource::IN::MX
-
Resolv::DNS::Resource::IN::NS
-
Resolv::DNS::Resource::IN::PTR
-
Resolv::DNS::Resource::IN::SOA
-
Resolv::DNS::Resource::IN::TXT
-
Resolv::DNS::Resource::IN::WKS
Returned resource is represented as a Resolv::DNS::Resource instance, i.e. Resolv::DNS::Resource::IN::A.
457 458 459 460 |
# File 'lib/resolv.rb', line 457 def getresource(name, typeclass) each_resource(name, typeclass) {|resource| return resource} raise ResolvError.new("DNS result has no information for #{name}") end |
#getresources(name, typeclass) ⇒ Object
Looks up all typeclass
DNS resources for name
. See #getresource for argument details.
466 467 468 469 470 |
# File 'lib/resolv.rb', line 466 def getresources(name, typeclass) ret = [] each_resource(name, typeclass) {|resource| ret << resource} return ret end |
#lazy_initialize ⇒ Object
:nodoc:
334 335 336 337 338 339 340 341 342 |
# File 'lib/resolv.rb', line 334 def lazy_initialize # :nodoc: @mutex.synchronize { unless @initialized @config.lazy_initialize @initialized = true end } self end |
#make_requester ⇒ Object
:nodoc:
505 506 507 508 509 510 511 512 |
# File 'lib/resolv.rb', line 505 def make_requester # :nodoc: nameserver_port = @config.nameserver_port if nameserver_port.length == 1 Requester::ConnectedUDP.new(*nameserver_port[0]) else Requester::UnconnectedUDP.new(*nameserver_port) end end |