include/modules/dns.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2013 Adam <Adam@anope.org>
   5  *   Copyright (C) 2003-2013 Anope Team <team@anope.org>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #pragma once
  21
  22 namespace DNS
  23 {
  24         /** Valid query types
  25          */
  26         enum QueryType
  27         {
  28                 /* Nothing */
  29                 QUERY_NONE,
  30                 /* A simple A lookup */
  31                 QUERY_A = 1,
  32                 /* A CNAME lookup */
  33                 QUERY_CNAME = 5,
  34                 /* Reverse DNS lookup */
  35                 QUERY_PTR = 12,
  36                 /* IPv6 AAAA lookup */
  37                 QUERY_AAAA = 28
  38         };
  39
  40         /** Flags that can be AND'd into DNSPacket::flags to receive certain values
  41          */
  42         enum
  43         {
  44                 QUERYFLAGS_QR = 0x8000,
  45                 QUERYFLAGS_OPCODE = 0x7800,
  46                 QUERYFLAGS_AA = 0x400,
  47                 QUERYFLAGS_TC = 0x200,
  48                 QUERYFLAGS_RD = 0x100,
  49                 QUERYFLAGS_RA = 0x80,
  50                 QUERYFLAGS_Z = 0x70,
  51                 QUERYFLAGS_RCODE = 0xF
  52         };
  53
  54         enum Error
  55         {
  56                 ERROR_NONE,
  57                 ERROR_UNKNOWN,
  58                 ERROR_UNLOADED,
  59                 ERROR_TIMEDOUT,
  60                 ERROR_NOT_AN_ANSWER,
  61                 ERROR_NONSTANDARD_QUERY,
  62                 ERROR_FORMAT_ERROR,
  63                 ERROR_SERVER_FAILURE,
  64                 ERROR_DOMAIN_NOT_FOUND,
  65                 ERROR_NOT_IMPLEMENTED,
  66                 ERROR_REFUSED,
  67                 ERROR_NO_RECORDS,
  68                 ERROR_INVALIDTYPE
  69         };
  70
  71         typedef uint16_t RequestId;
  72
  73         const int PORT = 53;
  74
  75         /**
  76          * The maximum value of a dns request id,
  77          * 16 bits wide, 0xFFFF.
  78          */
  79         const int MAX_REQUEST_ID = 0xFFFF;
  80
  81         class Exception : public ModuleException
  82         {
  83          public:
  84                 Exception(const std::string& message) : ModuleException(message) { }
  85         };
  86
  87         struct Question
  88         {
  89                 std::string name;
  90                 QueryType type;
  91
  92                 Question() : type(QUERY_NONE) { }
  93                 Question(const std::string& n, QueryType t) : name(n), type(t) { }
  94                 bool operator==(const Question& other) const { return ((name == other.name) && (type == other.type)); }
  95                 bool operator!=(const Question& other) const { return (!(*this == other)); }
  96
  97                 struct hash
  98                 {
  99                         size_t operator()(const Question& question) const
 100                         {
 101                                 return irc::insensitive()(question.name);
 102                         }
 103                 };
 104         };
 105
 106         struct ResourceRecord : Question
 107         {
 108                 unsigned int ttl;
 109                 std::string rdata;
 110                 time_t created;
 111
 112                 ResourceRecord(const std::string& n, QueryType t) : Question(n, t), ttl(0), created(ServerInstance->Time()) { }
 113                 ResourceRecord(const Question& question) : Question(question), ttl(0), created(ServerInstance->Time()) { }
 114         };
 115
 116         struct Query
 117         {
 118                 Question question;
 119                 std::vector<ResourceRecord> answers;
 120                 Error error;
 121                 bool cached;
 122
 123                 Query() : error(ERROR_NONE), cached(false) { }
 124                 Query(const Question& q) : question(q), error(ERROR_NONE), cached(false) { }
 125         };
 126
 127         class ReplySocket;
 128         class Request;
 129
 130         /** DNS manager
 131          */
 132         class Manager : public DataProvider
 133         {
 134          public:
 135                 Manager(Module* mod) : DataProvider(mod, "DNS") { }
 136
 137                 virtual void Process(Request* req) = 0;
 138                 virtual void RemoveRequest(Request* req) = 0;
 139                 virtual std::string GetErrorStr(Error) = 0;
 140         };
 141
 142         /** A DNS query.
 143          */
 144         class Request : public Timer, public Question
 145         {
 146          protected:
 147                 Manager* const manager;
 148          public:
 149                 /* Use result cache if available */
 150                 bool use_cache;
 151                 /* Request id */
 152                 RequestId id;
 153                 /* Creator of this request */
 154                 Module* const creator;
 155
 156                 Request(Manager* mgr, Module* mod, const std::string& addr, QueryType qt, bool usecache = true)
 157                         : Timer((ServerInstance->Config->dns_timeout ? ServerInstance->Config->dns_timeout : 5))
 158                         , Question(addr, qt)
 159                         , manager(mgr)
 160                         , use_cache(usecache)
 161                         , id(0)
 162                         , creator(mod)
 163                 {
 164                         ServerInstance->Timers.AddTimer(this);
 165                 }
 166
 167                 virtual ~Request()
 168                 {
 169                         manager->RemoveRequest(this);
 170                 }
 171
 172                 /** Called when this request succeeds
 173                  * @param r The query sent back from the nameserver
 174                  */
 175                 virtual void OnLookupComplete(const Query* req) = 0;
 176
 177                 /** Called when this request fails or times out.
 178                  * @param r The query sent back from the nameserver, check the error code.
 179                  */
 180                 virtual void OnError(const Query* req) { }
 181
 182                 /** Used to time out the query, calls OnError and asks the TimerManager
 183                  * to delete this request
 184                  */
 185                 bool Tick(time_t now)
 186                 {
 187                         Query rr(*this);
 188                         rr.error = ERROR_TIMEDOUT;
 189                         this->OnError(&rr);
 190                         delete this;
 191                         return false;
 192                 }
 193         };
 194
 195 } // namespace DNS