PageRenderTime 52ms CodeModel.GetById 16ms RepoModel.GetById 1ms app.codeStats 0ms

/desktop/core/ext-py/Twisted/twisted/names/client.py

https://github.com/jcrobak/hue
Python | 926 lines | 896 code | 6 blank | 24 comment | 0 complexity | c5c7c78d4c0a042f38037ec065ae0439 MD5 | raw file
  1. # -*- test-case-name: twisted.names.test.test_names -*-
  2. # Copyright (c) 2001-2008 Twisted Matrix Laboratories.
  3. # See LICENSE for details.
  4. """
  5. Asynchronous client DNS
  6. The functions exposed in this module can be used for asynchronous name
  7. resolution and dns queries.
  8. If you need to create a resolver with specific requirements, such as needing to
  9. do queries against a particular host, the L{createResolver} function will
  10. return an C{IResolver}.
  11. Future plans: Proper nameserver acquisition on Windows/MacOS,
  12. better caching, respect timeouts
  13. @author: Jp Calderone
  14. """
  15. import os
  16. import errno
  17. from zope.interface import implements
  18. # Twisted imports
  19. from twisted.python.runtime import platform
  20. from twisted.internet import error, defer, protocol, interfaces
  21. from twisted.python import log, failure
  22. from twisted.python.deprecate import getWarningMethod
  23. from twisted.names import dns, common
  24. from twisted.names.error import DNSFormatError, DNSServerError, DNSNameError
  25. from twisted.names.error import DNSNotImplementedError, DNSQueryRefusedError
  26. from twisted.names.error import DNSUnknownError
  27. class Resolver(common.ResolverBase):
  28. """
  29. @ivar _waiting: A C{dict} mapping tuple keys of query name/type/class to
  30. Deferreds which will be called back with the result of those queries.
  31. This is used to avoid issuing the same query more than once in
  32. parallel. This is more efficient on the network and helps avoid a
  33. "birthday paradox" attack by keeping the number of outstanding requests
  34. for a particular query fixed at one instead of allowing the attacker to
  35. raise it to an arbitrary number.
  36. @ivar _reactor: A provider of L{IReactorTCP}, L{IReactorUDP}, and
  37. L{IReactorTime} which will be used to set up network resources and
  38. track timeouts.
  39. """
  40. implements(interfaces.IResolver)
  41. index = 0
  42. timeout = None
  43. factory = None
  44. servers = None
  45. dynServers = ()
  46. pending = None
  47. connections = None
  48. resolv = None
  49. _lastResolvTime = None
  50. _resolvReadInterval = 60
  51. _errormap = {
  52. dns.EFORMAT: DNSFormatError,
  53. dns.ESERVER: DNSServerError,
  54. dns.ENAME: DNSNameError,
  55. dns.ENOTIMP: DNSNotImplementedError,
  56. dns.EREFUSED: DNSQueryRefusedError}
  57. def _getProtocol(self):
  58. getWarningMethod()(
  59. "Resolver.protocol is deprecated; use Resolver.queryUDP instead.",
  60. PendingDeprecationWarning,
  61. stacklevel=0)
  62. self.protocol = dns.DNSDatagramProtocol(self)
  63. return self.protocol
  64. protocol = property(_getProtocol)
  65. def __init__(self, resolv=None, servers=None, timeout=(1, 3, 11, 45)):
  66. """
  67. Construct a resolver which will query domain name servers listed in
  68. the C{resolv.conf(5)}-format file given by C{resolv} as well as
  69. those in the given C{servers} list. Servers are queried in a
  70. round-robin fashion. If given, C{resolv} is periodically checked
  71. for modification and re-parsed if it is noticed to have changed.
  72. @type servers: C{list} of C{(str, int)} or C{None}
  73. @param servers: If not None, interpreted as a list of (host, port)
  74. pairs specifying addresses of domain name servers to attempt to use
  75. for this lookup. Host addresses should be in IPv4 dotted-quad
  76. form. If specified, overrides C{resolv}.
  77. @type resolv: C{str}
  78. @param resolv: Filename to read and parse as a resolver(5)
  79. configuration file.
  80. @type timeout: Sequence of C{int}
  81. @param timeout: Default number of seconds after which to reissue the
  82. query. When the last timeout expires, the query is considered
  83. failed.
  84. @raise ValueError: Raised if no nameserver addresses can be found.
  85. """
  86. common.ResolverBase.__init__(self)
  87. from twisted.internet import reactor
  88. self._reactor = reactor
  89. self.timeout = timeout
  90. if servers is None:
  91. self.servers = []
  92. else:
  93. self.servers = servers
  94. self.resolv = resolv
  95. if not len(self.servers) and not resolv:
  96. raise ValueError, "No nameservers specified"
  97. self.factory = DNSClientFactory(self, timeout)
  98. self.factory.noisy = 0 # Be quiet by default
  99. self.connections = []
  100. self.pending = []
  101. self._waiting = {}
  102. self.maybeParseConfig()
  103. def __getstate__(self):
  104. d = self.__dict__.copy()
  105. d['connections'] = []
  106. d['_parseCall'] = None
  107. return d
  108. def __setstate__(self, state):
  109. self.__dict__.update(state)
  110. self.maybeParseConfig()
  111. def maybeParseConfig(self):
  112. if self.resolv is None:
  113. # Don't try to parse it, don't set up a call loop
  114. return
  115. try:
  116. resolvConf = file(self.resolv)
  117. except IOError, e:
  118. if e.errno == errno.ENOENT:
  119. # Missing resolv.conf is treated the same as an empty resolv.conf
  120. self.parseConfig(())
  121. else:
  122. raise
  123. else:
  124. mtime = os.fstat(resolvConf.fileno()).st_mtime
  125. if mtime != self._lastResolvTime:
  126. log.msg('%s changed, reparsing' % (self.resolv,))
  127. self._lastResolvTime = mtime
  128. self.parseConfig(resolvConf)
  129. # Check again in a little while
  130. self._parseCall = self._reactor.callLater(
  131. self._resolvReadInterval, self.maybeParseConfig)
  132. def parseConfig(self, resolvConf):
  133. servers = []
  134. for L in resolvConf:
  135. L = L.strip()
  136. if L.startswith('nameserver'):
  137. resolver = (L.split()[1], dns.PORT)
  138. servers.append(resolver)
  139. log.msg("Resolver added %r to server list" % (resolver,))
  140. elif L.startswith('domain'):
  141. try:
  142. self.domain = L.split()[1]
  143. except IndexError:
  144. self.domain = ''
  145. self.search = None
  146. elif L.startswith('search'):
  147. try:
  148. self.search = L.split()[1:]
  149. except IndexError:
  150. self.search = ''
  151. self.domain = None
  152. if not servers:
  153. servers.append(('127.0.0.1', dns.PORT))
  154. self.dynServers = servers
  155. def pickServer(self):
  156. """
  157. Return the address of a nameserver.
  158. TODO: Weight servers for response time so faster ones can be
  159. preferred.
  160. """
  161. if not self.servers and not self.dynServers:
  162. return None
  163. serverL = len(self.servers)
  164. dynL = len(self.dynServers)
  165. self.index += 1
  166. self.index %= (serverL + dynL)
  167. if self.index < serverL:
  168. return self.servers[self.index]
  169. else:
  170. return self.dynServers[self.index - serverL]
  171. def _connectedProtocol(self):
  172. """
  173. Return a new L{DNSDatagramProtocol} bound to a randomly selected port
  174. number.
  175. """
  176. if 'protocol' in self.__dict__:
  177. # Some code previously asked for or set the deprecated `protocol`
  178. # attribute, so it probably expects that object to be used for
  179. # queries. Give it back and skip the super awesome source port
  180. # randomization logic. This is actually a really good reason to
  181. # remove this deprecated backward compatibility as soon as
  182. # possible. -exarkun
  183. return self.protocol
  184. proto = dns.DNSDatagramProtocol(self)
  185. while True:
  186. try:
  187. self._reactor.listenUDP(dns.randomSource(), proto)
  188. except error.CannotListenError:
  189. pass
  190. else:
  191. return proto
  192. def connectionMade(self, protocol):
  193. self.connections.append(protocol)
  194. for (d, q, t) in self.pending:
  195. self.queryTCP(q, t).chainDeferred(d)
  196. del self.pending[:]
  197. def messageReceived(self, message, protocol, address = None):
  198. log.msg("Unexpected message (%d) received from %r" % (message.id, address))
  199. def _query(self, *args):
  200. """
  201. Get a new L{DNSDatagramProtocol} instance from L{_connectedProtocol},
  202. issue a query to it using C{*args}, and arrange for it to be
  203. disconnected from its transport after the query completes.
  204. @param *args: Positional arguments to be passed to
  205. L{DNSDatagramProtocol.query}.
  206. @return: A L{Deferred} which will be called back with the result of the
  207. query.
  208. """
  209. protocol = self._connectedProtocol()
  210. d = protocol.query(*args)
  211. def cbQueried(result):
  212. protocol.transport.stopListening()
  213. return result
  214. d.addBoth(cbQueried)
  215. return d
  216. def queryUDP(self, queries, timeout = None):
  217. """
  218. Make a number of DNS queries via UDP.
  219. @type queries: A C{list} of C{dns.Query} instances
  220. @param queries: The queries to make.
  221. @type timeout: Sequence of C{int}
  222. @param timeout: Number of seconds after which to reissue the query.
  223. When the last timeout expires, the query is considered failed.
  224. @rtype: C{Deferred}
  225. @raise C{twisted.internet.defer.TimeoutError}: When the query times
  226. out.
  227. """
  228. if timeout is None:
  229. timeout = self.timeout
  230. addresses = self.servers + list(self.dynServers)
  231. if not addresses:
  232. return defer.fail(IOError("No domain name servers available"))
  233. # Make sure we go through servers in the list in the order they were
  234. # specified.
  235. addresses.reverse()
  236. used = addresses.pop()
  237. d = self._query(used, queries, timeout[0])
  238. d.addErrback(self._reissue, addresses, [used], queries, timeout)
  239. return d
  240. def _reissue(self, reason, addressesLeft, addressesUsed, query, timeout):
  241. reason.trap(dns.DNSQueryTimeoutError)
  242. # If there are no servers left to be tried, adjust the timeout
  243. # to the next longest timeout period and move all the
  244. # "used" addresses back to the list of addresses to try.
  245. if not addressesLeft:
  246. addressesLeft = addressesUsed
  247. addressesLeft.reverse()
  248. addressesUsed = []
  249. timeout = timeout[1:]
  250. # If all timeout values have been used this query has failed. Tell the
  251. # protocol we're giving up on it and return a terminal timeout failure
  252. # to our caller.
  253. if not timeout:
  254. return failure.Failure(defer.TimeoutError(query))
  255. # Get an address to try. Take it out of the list of addresses
  256. # to try and put it ino the list of already tried addresses.
  257. address = addressesLeft.pop()
  258. addressesUsed.append(address)
  259. # Issue a query to a server. Use the current timeout. Add this
  260. # function as a timeout errback in case another retry is required.
  261. d = self._query(address, query, timeout[0], reason.value.id)
  262. d.addErrback(self._reissue, addressesLeft, addressesUsed, query, timeout)
  263. return d
  264. def queryTCP(self, queries, timeout = 10):
  265. """
  266. Make a number of DNS queries via TCP.
  267. @type queries: Any non-zero number of C{dns.Query} instances
  268. @param queries: The queries to make.
  269. @type timeout: C{int}
  270. @param timeout: The number of seconds after which to fail.
  271. @rtype: C{Deferred}
  272. """
  273. if not len(self.connections):
  274. address = self.pickServer()
  275. if address is None:
  276. return defer.fail(IOError("No domain name servers available"))
  277. host, port = address
  278. self._reactor.connectTCP(host, port, self.factory)
  279. self.pending.append((defer.Deferred(), queries, timeout))
  280. return self.pending[-1][0]
  281. else:
  282. return self.connections[0].query(queries, timeout)
  283. def filterAnswers(self, message):
  284. """
  285. Extract results from the given message.
  286. If the message was truncated, re-attempt the query over TCP and return
  287. a Deferred which will fire with the results of that query.
  288. If the message's result code is not L{dns.OK}, return a Failure
  289. indicating the type of error which occurred.
  290. Otherwise, return a three-tuple of lists containing the results from
  291. the answers section, the authority section, and the additional section.
  292. """
  293. if message.trunc:
  294. return self.queryTCP(message.queries).addCallback(self.filterAnswers)
  295. if message.rCode != dns.OK:
  296. return failure.Failure(self._errormap.get(message.rCode, DNSUnknownError)(message))
  297. return (message.answers, message.authority, message.additional)
  298. def _lookup(self, name, cls, type, timeout):
  299. """
  300. Build a L{dns.Query} for the given parameters and dispatch it via UDP.
  301. If this query is already outstanding, it will not be re-issued.
  302. Instead, when the outstanding query receives a response, that response
  303. will be re-used for this query as well.
  304. @type name: C{str}
  305. @type type: C{int}
  306. @type cls: C{int}
  307. @return: A L{Deferred} which fires with a three-tuple giving the
  308. answer, authority, and additional sections of the response or with
  309. a L{Failure} if the response code is anything other than C{dns.OK}.
  310. """
  311. key = (name, type, cls)
  312. waiting = self._waiting.get(key)
  313. if waiting is None:
  314. self._waiting[key] = []
  315. d = self.queryUDP([dns.Query(name, type, cls)], timeout)
  316. def cbResult(result):
  317. for d in self._waiting.pop(key):
  318. d.callback(result)
  319. return result
  320. d.addCallback(self.filterAnswers)
  321. d.addBoth(cbResult)
  322. else:
  323. d = defer.Deferred()
  324. waiting.append(d)
  325. return d
  326. # This one doesn't ever belong on UDP
  327. def lookupZone(self, name, timeout = 10):
  328. """
  329. Perform an AXFR request. This is quite different from usual
  330. DNS requests. See http://cr.yp.to/djbdns/axfr-notes.html for
  331. more information.
  332. """
  333. address = self.pickServer()
  334. if address is None:
  335. return defer.fail(IOError('No domain name servers available'))
  336. host, port = address
  337. d = defer.Deferred()
  338. controller = AXFRController(name, d)
  339. factory = DNSClientFactory(controller, timeout)
  340. factory.noisy = False #stfu
  341. connector = self._reactor.connectTCP(host, port, factory)
  342. controller.timeoutCall = self._reactor.callLater(
  343. timeout or 10, self._timeoutZone, d, controller,
  344. connector, timeout or 10)
  345. return d.addCallback(self._cbLookupZone, connector)
  346. def _timeoutZone(self, d, controller, connector, seconds):
  347. connector.disconnect()
  348. controller.timeoutCall = None
  349. controller.deferred = None
  350. d.errback(error.TimeoutError("Zone lookup timed out after %d seconds" % (seconds,)))
  351. def _cbLookupZone(self, result, connector):
  352. connector.disconnect()
  353. return (result, [], [])
  354. class AXFRController:
  355. timeoutCall = None
  356. def __init__(self, name, deferred):
  357. self.name = name
  358. self.deferred = deferred
  359. self.soa = None
  360. self.records = []
  361. def connectionMade(self, protocol):
  362. # dig saids recursion-desired to 0, so I will too
  363. message = dns.Message(protocol.pickID(), recDes=0)
  364. message.queries = [dns.Query(self.name, dns.AXFR, dns.IN)]
  365. protocol.writeMessage(message)
  366. def connectionLost(self, protocol):
  367. # XXX Do something here - see #3428
  368. pass
  369. def messageReceived(self, message, protocol):
  370. # Caveat: We have to handle two cases: All records are in 1
  371. # message, or all records are in N messages.
  372. # According to http://cr.yp.to/djbdns/axfr-notes.html,
  373. # 'authority' and 'additional' are always empty, and only
  374. # 'answers' is present.
  375. self.records.extend(message.answers)
  376. if not self.records:
  377. return
  378. if not self.soa:
  379. if self.records[0].type == dns.SOA:
  380. #print "first SOA!"
  381. self.soa = self.records[0]
  382. if len(self.records) > 1 and self.records[-1].type == dns.SOA:
  383. #print "It's the second SOA! We're done."
  384. if self.timeoutCall is not None:
  385. self.timeoutCall.cancel()
  386. self.timeoutCall = None
  387. if self.deferred is not None:
  388. self.deferred.callback(self.records)
  389. self.deferred = None
  390. from twisted.internet.base import ThreadedResolver as _ThreadedResolverImpl
  391. class ThreadedResolver(_ThreadedResolverImpl):
  392. def __init__(self, reactor=None):
  393. if reactor is None:
  394. from twisted.internet import reactor
  395. _ThreadedResolverImpl.__init__(self, reactor)
  396. # warnings.warn("twisted.names.client.ThreadedResolver is deprecated, use XXX instead.")
  397. class DNSClientFactory(protocol.ClientFactory):
  398. def __init__(self, controller, timeout = 10):
  399. self.controller = controller
  400. self.timeout = timeout
  401. def clientConnectionLost(self, connector, reason):
  402. pass
  403. def buildProtocol(self, addr):
  404. p = dns.DNSProtocol(self.controller)
  405. p.factory = self
  406. return p
  407. def createResolver(servers=None, resolvconf=None, hosts=None):
  408. """
  409. Create and return a Resolver.
  410. @type servers: C{list} of C{(str, int)} or C{None}
  411. @param servers: If not C{None}, interpreted as a list of addresses of
  412. domain name servers to attempt to use. Addresses should be in dotted-quad
  413. form.
  414. @type resolvconf: C{str} or C{None}
  415. @param resolvconf: If not C{None}, on posix systems will be interpreted as
  416. an alternate resolv.conf to use. Will do nothing on windows systems. If
  417. C{None}, /etc/resolv.conf will be used.
  418. @type hosts: C{str} or C{None}
  419. @param hosts: If not C{None}, an alternate hosts file to use. If C{None}
  420. on posix systems, /etc/hosts will be used. On windows, C:\windows\hosts
  421. will be used.
  422. @rtype: C{IResolver}
  423. """
  424. from twisted.names import resolve, cache, root, hosts as hostsModule
  425. if platform.getType() == 'posix':
  426. if resolvconf is None:
  427. resolvconf = '/etc/resolv.conf'
  428. if hosts is None:
  429. hosts = '/etc/hosts'
  430. theResolver = Resolver(resolvconf, servers)
  431. hostResolver = hostsModule.Resolver(hosts)
  432. else:
  433. if hosts is None:
  434. hosts = r'c:\windows\hosts'
  435. from twisted.internet import reactor
  436. bootstrap = _ThreadedResolverImpl(reactor)
  437. hostResolver = hostsModule.Resolver(hosts)
  438. theResolver = root.bootstrap(bootstrap)
  439. L = [hostResolver, cache.CacheResolver(), theResolver]
  440. return resolve.ResolverChain(L)
  441. theResolver = None
  442. def getResolver():
  443. """
  444. Get a Resolver instance.
  445. Create twisted.names.client.theResolver if it is C{None}, and then return
  446. that value.
  447. @rtype: C{IResolver}
  448. """
  449. global theResolver
  450. if theResolver is None:
  451. try:
  452. theResolver = createResolver()
  453. except ValueError:
  454. theResolver = createResolver(servers=[('127.0.0.1', 53)])
  455. return theResolver
  456. def getHostByName(name, timeout=None, effort=10):
  457. """
  458. Resolve a name to a valid ipv4 or ipv6 address.
  459. Will errback with C{DNSQueryTimeoutError} on a timeout, C{DomainError} or
  460. C{AuthoritativeDomainError} (or subclasses) on other errors.
  461. @type name: C{str}
  462. @param name: DNS name to resolve.
  463. @type timeout: Sequence of C{int}
  464. @param timeout: Number of seconds after which to reissue the query.
  465. When the last timeout expires, the query is considered failed.
  466. @type effort: C{int}
  467. @param effort: How many times CNAME and NS records to follow while
  468. resolving this name.
  469. @rtype: C{Deferred}
  470. """
  471. return getResolver().getHostByName(name, timeout, effort)
  472. def lookupAddress(name, timeout=None):
  473. """
  474. Perform an A record lookup.
  475. @type name: C{str}
  476. @param name: DNS name to resolve.
  477. @type timeout: Sequence of C{int}
  478. @param timeout: Number of seconds after which to reissue the query.
  479. When the last timeout expires, the query is considered failed.
  480. @rtype: C{Deferred}
  481. """
  482. return getResolver().lookupAddress(name, timeout)
  483. def lookupIPV6Address(name, timeout=None):
  484. """
  485. Perform an AAAA record lookup.
  486. @type name: C{str}
  487. @param name: DNS name to resolve.
  488. @type timeout: Sequence of C{int}
  489. @param timeout: Number of seconds after which to reissue the query.
  490. When the last timeout expires, the query is considered failed.
  491. @rtype: C{Deferred}
  492. """
  493. return getResolver().lookupIPV6Address(name, timeout)
  494. def lookupAddress6(name, timeout=None):
  495. """
  496. Perform an A6 record lookup.
  497. @type name: C{str}
  498. @param name: DNS name to resolve.
  499. @type timeout: Sequence of C{int}
  500. @param timeout: Number of seconds after which to reissue the query.
  501. When the last timeout expires, the query is considered failed.
  502. @rtype: C{Deferred}
  503. """
  504. return getResolver().lookupAddress6(name, timeout)
  505. def lookupMailExchange(name, timeout=None):
  506. """
  507. Perform an MX record lookup.
  508. @type name: C{str}
  509. @param name: DNS name to resolve.
  510. @type timeout: Sequence of C{int}
  511. @param timeout: Number of seconds after which to reissue the query.
  512. When the last timeout expires, the query is considered failed.
  513. @rtype: C{Deferred}
  514. """
  515. return getResolver().lookupMailExchange(name, timeout)
  516. def lookupNameservers(name, timeout=None):
  517. """
  518. Perform an NS record lookup.
  519. @type name: C{str}
  520. @param name: DNS name to resolve.
  521. @type timeout: Sequence of C{int}
  522. @param timeout: Number of seconds after which to reissue the query.
  523. When the last timeout expires, the query is considered failed.
  524. @rtype: C{Deferred}
  525. """
  526. return getResolver().lookupNameservers(name, timeout)
  527. def lookupCanonicalName(name, timeout=None):
  528. """
  529. Perform a CNAME record lookup.
  530. @type name: C{str}
  531. @param name: DNS name to resolve.
  532. @type timeout: Sequence of C{int}
  533. @param timeout: Number of seconds after which to reissue the query.
  534. When the last timeout expires, the query is considered failed.
  535. @rtype: C{Deferred}
  536. """
  537. return getResolver().lookupCanonicalName(name, timeout)
  538. def lookupMailBox(name, timeout=None):
  539. """
  540. Perform an MB record lookup.
  541. @type name: C{str}
  542. @param name: DNS name to resolve.
  543. @type timeout: Sequence of C{int}
  544. @param timeout: Number of seconds after which to reissue the query.
  545. When the last timeout expires, the query is considered failed.
  546. @rtype: C{Deferred}
  547. """
  548. return getResolver().lookupMailBox(name, timeout)
  549. def lookupMailGroup(name, timeout=None):
  550. """
  551. Perform an MG record lookup.
  552. @type name: C{str}
  553. @param name: DNS name to resolve.
  554. @type timeout: Sequence of C{int}
  555. @param timeout: Number of seconds after which to reissue the query.
  556. When the last timeout expires, the query is considered failed.
  557. @rtype: C{Deferred}
  558. """
  559. return getResolver().lookupMailGroup(name, timeout)
  560. def lookupMailRename(name, timeout=None):
  561. """
  562. Perform an MR record lookup.
  563. @type name: C{str}
  564. @param name: DNS name to resolve.
  565. @type timeout: Sequence of C{int}
  566. @param timeout: Number of seconds after which to reissue the query.
  567. When the last timeout expires, the query is considered failed.
  568. @rtype: C{Deferred}
  569. """
  570. return getResolver().lookupMailRename(name, timeout)
  571. def lookupPointer(name, timeout=None):
  572. """
  573. Perform a PTR record lookup.
  574. @type name: C{str}
  575. @param name: DNS name to resolve.
  576. @type timeout: Sequence of C{int}
  577. @param timeout: Number of seconds after which to reissue the query.
  578. When the last timeout expires, the query is considered failed.
  579. @rtype: C{Deferred}
  580. """
  581. return getResolver().lookupPointer(name, timeout)
  582. def lookupAuthority(name, timeout=None):
  583. """
  584. Perform an SOA record lookup.
  585. @type name: C{str}
  586. @param name: DNS name to resolve.
  587. @type timeout: Sequence of C{int}
  588. @param timeout: Number of seconds after which to reissue the query.
  589. When the last timeout expires, the query is considered failed.
  590. @rtype: C{Deferred}
  591. """
  592. return getResolver().lookupAuthority(name, timeout)
  593. def lookupNull(name, timeout=None):
  594. """
  595. Perform a NULL record lookup.
  596. @type name: C{str}
  597. @param name: DNS name to resolve.
  598. @type timeout: Sequence of C{int}
  599. @param timeout: Number of seconds after which to reissue the query.
  600. When the last timeout expires, the query is considered failed.
  601. @rtype: C{Deferred}
  602. """
  603. return getResolver().lookupNull(name, timeout)
  604. def lookupWellKnownServices(name, timeout=None):
  605. """
  606. Perform a WKS record lookup.
  607. @type name: C{str}
  608. @param name: DNS name to resolve.
  609. @type timeout: Sequence of C{int}
  610. @param timeout: Number of seconds after which to reissue the query.
  611. When the last timeout expires, the query is considered failed.
  612. @rtype: C{Deferred}
  613. """
  614. return getResolver().lookupWellKnownServices(name, timeout)
  615. def lookupService(name, timeout=None):
  616. """
  617. Perform an SRV record lookup.
  618. @type name: C{str}
  619. @param name: DNS name to resolve.
  620. @type timeout: Sequence of C{int}
  621. @param timeout: Number of seconds after which to reissue the query.
  622. When the last timeout expires, the query is considered failed.
  623. @rtype: C{Deferred}
  624. """
  625. return getResolver().lookupService(name, timeout)
  626. def lookupHostInfo(name, timeout=None):
  627. """
  628. Perform a HINFO record lookup.
  629. @type name: C{str}
  630. @param name: DNS name to resolve.
  631. @type timeout: Sequence of C{int}
  632. @param timeout: Number of seconds after which to reissue the query.
  633. When the last timeout expires, the query is considered failed.
  634. @rtype: C{Deferred}
  635. """
  636. return getResolver().lookupHostInfo(name, timeout)
  637. def lookupMailboxInfo(name, timeout=None):
  638. """
  639. Perform an MINFO record lookup.
  640. @type name: C{str}
  641. @param name: DNS name to resolve.
  642. @type timeout: Sequence of C{int}
  643. @param timeout: Number of seconds after which to reissue the query.
  644. When the last timeout expires, the query is considered failed.
  645. @rtype: C{Deferred}
  646. """
  647. return getResolver().lookupMailboxInfo(name, timeout)
  648. def lookupText(name, timeout=None):
  649. """
  650. Perform a TXT record lookup.
  651. @type name: C{str}
  652. @param name: DNS name to resolve.
  653. @type timeout: Sequence of C{int}
  654. @param timeout: Number of seconds after which to reissue the query.
  655. When the last timeout expires, the query is considered failed.
  656. @rtype: C{Deferred}
  657. """
  658. return getResolver().lookupText(name, timeout)
  659. def lookupResponsibility(name, timeout=None):
  660. """
  661. Perform an RP record lookup.
  662. @type name: C{str}
  663. @param name: DNS name to resolve.
  664. @type timeout: Sequence of C{int}
  665. @param timeout: Number of seconds after which to reissue the query.
  666. When the last timeout expires, the query is considered failed.
  667. @rtype: C{Deferred}
  668. """
  669. return getResolver().lookupResponsibility(name, timeout)
  670. def lookupAFSDatabase(name, timeout=None):
  671. """
  672. Perform an AFSDB record lookup.
  673. @type name: C{str}
  674. @param name: DNS name to resolve.
  675. @type timeout: Sequence of C{int}
  676. @param timeout: Number of seconds after which to reissue the query.
  677. When the last timeout expires, the query is considered failed.
  678. @rtype: C{Deferred}
  679. """
  680. return getResolver().lookupAFSDatabase(name, timeout)
  681. def lookupZone(name, timeout=None):
  682. """
  683. Perform an AXFR record lookup.
  684. @type name: C{str}
  685. @param name: DNS name to resolve.
  686. @type timeout: C{int}
  687. @param timeout: When this timeout expires, the query is considered failed.
  688. @rtype: C{Deferred}
  689. """
  690. # XXX: timeout here is not a list of ints, it is a single int.
  691. return getResolver().lookupZone(name, timeout)
  692. def lookupAllRecords(name, timeout=None):
  693. """
  694. ALL_RECORD lookup.
  695. @type name: C{str}
  696. @param name: DNS name to resolve.
  697. @type timeout: Sequence of C{int}
  698. @param timeout: Number of seconds after which to reissue the query.
  699. When the last timeout expires, the query is considered failed.
  700. @rtype: C{Deferred}
  701. """
  702. return getResolver().lookupAllRecords(name, timeout)
  703. def lookupNamingAuthorityPointer(name, timeout=None):
  704. """
  705. NAPTR lookup.
  706. @type name: C{str}
  707. @param name: DNS name to resolve.
  708. @type timeout: Sequence of C{int}
  709. @param timeout: Number of seconds after which to reissue the query.
  710. When the last timeout expires, the query is considered failed.
  711. @rtype: C{Deferred}
  712. """
  713. return getResolver().lookupNamingAuthorityPointer(name, timeout)