dhcp4_srv.cc 17 KB
Newer Older
1
// Copyright (C) 2011-2012 Internet Systems Consortium, Inc. ("ISC")
2 3 4 5 6 7 8 9 10 11 12 13 14
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

15
#include <asiolink/io_address.h>
16
#include <dhcp/dhcp4.h>
17
#include <dhcp/iface_mgr.h>
18
#include <dhcp/option4_addrlst.h>
19
#include <dhcp/option_int.h>
20
#include <dhcp/pkt4.h>
21 22
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
23 24
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
25 26 27 28 29 30 31
#include <dhcpsrv/utils.h>
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/lease_mgr.h>
#include <dhcpsrv/lease_mgr_factory.h>
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/utils.h>
#include <dhcpsrv/addr_utilities.h>
32 33 34

using namespace isc;
using namespace isc::asiolink;
35 36 37
using namespace isc::dhcp;
using namespace isc::log;
using namespace std;
38

39 40
// These are hardcoded parameters. Currently this is a skeleton server that only
// grants those options and a single, fixed, hardcoded lease.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
41 42 43 44
const std::string HARDCODED_GATEWAY = "192.0.2.1";
const std::string HARDCODED_DNS_SERVER = "192.0.2.2";
const std::string HARDCODED_DOMAIN_NAME = "isc.example.com";
const std::string HARDCODED_SERVER_ID = "192.0.2.1";
45

46
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const char* dbconfig) {
47
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
48
    try {
49
        // First call to instance() will create IfaceMgr (it's a singleton)
50 51
        // it may throw something if things go wrong
        IfaceMgr::instance();
52

53 54 55 56 57
        if (port) {
            // open sockets only if port is non-zero. Port 0 is used
            // for non-socket related testing.
            IfaceMgr::instance().openSockets4(port);
        }
58

59
        setServerID();
60

61 62 63 64 65 66 67 68 69
        // Instantiate LeaseMgr
        LeaseMgrFactory::create(dbconfig);
        LOG_INFO(dhcp4_logger, DHCP4_DB_BACKEND_STARTED)
            .arg(LeaseMgrFactory::instance().getType())
            .arg(LeaseMgrFactory::instance().getName());

        // Instantiate allocation engine
        alloc_engine_.reset(new AllocEngine(AllocEngine::ALLOC_ITERATIVE, 100));

70
    } catch (const std::exception &e) {
71
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
72 73 74
        shutdown_ = true;
        return;
    }
75

Tomek Mrugalski's avatar
Tomek Mrugalski committed
76
    shutdown_ = false;
77 78 79
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
80
    IfaceMgr::instance().closeSockets();
81 82
}

83
void Dhcpv4Srv::shutdown() {
84
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
85 86 87
    shutdown_ = true;
}

88 89
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
90
    while (!shutdown_) {
91 92 93
        /// @todo: calculate actual timeout once we have lease database
        int timeout = 1000;

Tomek Mrugalski's avatar
Tomek Mrugalski committed
94
        // client's message and server's response
95
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
96
        Pkt4Ptr rsp;
97

98 99 100 101 102 103
        try {
            query = IfaceMgr::instance().receive4(timeout);
        } catch (const std::exception& e) {
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_RECEIVE_FAIL).arg(e.what());
        }

104
        if (query) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
105 106
            try {
                query->unpack();
107

Tomek Mrugalski's avatar
Tomek Mrugalski committed
108
            } catch (const std::exception& e) {
109 110 111
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
112 113
                continue;
            }
114
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
115 116 117
                      .arg(serverReceivedPacketName(query->getType()))
                      .arg(query->getType())
                      .arg(query->getIface());
118 119 120
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
                      .arg(query->toText());

121 122 123 124
            switch (query->getType()) {
            case DHCPDISCOVER:
                rsp = processDiscover(query);
                break;
125

126 127 128
            case DHCPREQUEST:
                rsp = processRequest(query);
                break;
129

130 131 132
            case DHCPRELEASE:
                processRelease(query);
                break;
133

134 135 136
            case DHCPDECLINE:
                processDecline(query);
                break;
137

138 139 140
            case DHCPINFORM:
                processInform(query);
                break;
141

142
            default:
143 144 145 146
                // Only action is to output a message if debug is enabled,
                // and that will be covered by the debug statement before
                // the "switch" statement.
                ;
147 148 149
            }

            if (rsp) {
150 151 152 153 154 155 156 157 158
                if (rsp->getRemoteAddr().toText() == "0.0.0.0") {
                    rsp->setRemoteAddr(query->getRemoteAddr());
                }
                if (!rsp->getHops()) {
                    rsp->setRemotePort(DHCP4_CLIENT_PORT);
                } else {
                    rsp->setRemotePort(DHCP4_SERVER_PORT);
                }

159 160 161 162 163
                rsp->setLocalAddr(query->getLocalAddr());
                rsp->setLocalPort(DHCP4_SERVER_PORT);
                rsp->setIface(query->getIface());
                rsp->setIndex(query->getIndex());

164 165 166
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA,
                          DHCP4_RESPONSE_DATA)
                          .arg(rsp->getType()).arg(rsp->toText());
167 168

                if (rsp->pack()) {
169 170
                    try {
                        IfaceMgr::instance().send(rsp);
Marcin Siodelski's avatar
Marcin Siodelski committed
171 172
                    } catch (const std::exception& e) {
                        LOG_ERROR(dhcp4_logger, DHCP4_PACKET_SEND_FAIL).arg(e.what());
173
                    }
174
                } else {
175
                    LOG_ERROR(dhcp4_logger, DHCP4_PACK_FAIL);
176 177 178 179 180 181 182 183 184 185 186 187 188
                }
            }
        }

        // TODO add support for config session (see src/bin/auth/main.cc)
        //      so this daemon can be controlled from bob
    }

    return (true);
}

void
Dhcpv4Srv::setServerID() {
189 190 191
    /// @todo: implement this for real (see ticket #2588)
    serverid_ = OptionPtr(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                             IOAddress(HARDCODED_SERVER_ID)));
192 193
}

194
void Dhcpv4Srv::copyDefaultFields(const Pkt4Ptr& question, Pkt4Ptr& answer) {
195 196 197
    answer->setIface(question->getIface());
    answer->setIndex(question->getIndex());
    answer->setCiaddr(question->getCiaddr());
198

199 200
    answer->setSiaddr(IOAddress("0.0.0.0")); // explictly set this to 0
    answer->setHops(question->getHops());
201 202

    // copy MAC address
203
    answer->setHWAddr(question->getHWAddr());
204 205

    // relay address
206 207 208
    answer->setGiaddr(question->getGiaddr());

    if (question->getGiaddr().toText() != "0.0.0.0") {
209
        // relayed traffic
210
        answer->setRemoteAddr(question->getGiaddr());
211 212
    } else {
        // direct traffic
213
        answer->setRemoteAddr(question->getRemoteAddr());
214 215
    }

216 217 218 219
    OptionPtr client_id = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id) {
        answer->addOption(client_id);
    }
220 221
}

222 223
void Dhcpv4Srv::appendDefaultOptions(Pkt4Ptr& msg, uint8_t msg_type) {
    OptionPtr opt;
224 225 226

    // add Message Type Option (type 53)
    std::vector<uint8_t> tmp;
227
    tmp.push_back(static_cast<uint8_t>(msg_type));
228
    opt = OptionPtr(new Option(Option::V4, DHO_DHCP_MESSAGE_TYPE, tmp));
229 230
    msg->addOption(opt);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
231
    // DHCP Server Identifier (type 54)
232
    msg->addOption(getServerID());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
233

234 235 236 237
    // more options will be added here later
}


238 239
void Dhcpv4Srv::appendRequestedOptions(Pkt4Ptr& msg) {
    OptionPtr opt;
240

Tomek Mrugalski's avatar
Tomek Mrugalski committed
241 242
    // Domain name (type 15)
    vector<uint8_t> domain(HARDCODED_DOMAIN_NAME.begin(), HARDCODED_DOMAIN_NAME.end());
243
    opt = OptionPtr(new Option(Option::V4, DHO_DOMAIN_NAME, domain));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
244 245
    msg->addOption(opt);
    // TODO: Add Option_String class
246

Tomek Mrugalski's avatar
Tomek Mrugalski committed
247
    // DNS servers (type 6)
248
    opt = OptionPtr(new Option4AddrLst(DHO_DOMAIN_NAME_SERVERS, IOAddress(HARDCODED_DNS_SERVER)));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
249 250
    msg->addOption(opt);
}
251

252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
void Dhcpv4Srv::assignLease(const Pkt4Ptr& question, Pkt4Ptr& answer) {

    // We need to select a subnet the client is connected in.
    Subnet4Ptr subnet = selectSubnet(question);
    if (!subnet) {
        // This particular client is out of luck today. We do not have
        // information about the subnet he is connected to. This likely means
        // misconfiguration of the server (or some relays). We will continue to
        // process this message, but our response will be almost useless: no
        // addresses or prefixes, no subnet specific configuration etc. The only
        // thing this client can get is some global information (like DNS
        // servers).

        // perhaps this should be logged on some higher level? This is most likely
        // configuration bug.
        LOG_ERROR(dhcp4_logger, DHCP4_SUBNET_SELECTION_FAILED)
            .arg(question->getRemoteAddr().toText())
            .arg(serverReceivedPacketName(question->getType()));
        setMsgType(answer, DHCPNAK);
        answer->setYiaddr(IOAddress("0.0.0.0"));
        return;
    } else {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_SELECTED)
            .arg(subnet->toText());
    }
277

278 279 280 281 282 283 284
    // Get client-id option
    ClientIdPtr client_id;
    OptionPtr opt = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt) {
        client_id = ClientIdPtr(new ClientId(opt->getData()));
    }
    // client-id is not mandatory in DHCPv4
285

286
    IOAddress hint = question->getYiaddr();
287

288
    HWAddrPtr hwaddr = question->getHWAddr();
289

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
    // "Fake" allocation is processing of DISCOVER message. We pretend to do an
    // allocation, but we do not put the lease in the database. That is ok,
    // because we do not guarantee that the user will get that exact lease. If
    // the user selects this server to do actual allocation (i.e. sends REQUEST)
    // it should include this hint. That will help us during the actual lease
    // allocation.
    bool fake_allocation = false;
    if (question->getType() == DHCPDISCOVER) {
        fake_allocation = true;
    }

    // Use allocation engine to pick a lease for this client. Allocation engine
    // will try to honour the hint, but it is just a hint - some other address
    // may be used instead. If fake_allocation is set to false, the lease will
    // be inserted into the LeaseMgr as well.
    Lease4Ptr lease = alloc_engine_->allocateAddress4(subnet, client_id, hwaddr,
                                                      hint, fake_allocation);

    if (lease) {
        // We have a lease! Let's wrap its content into IA_NA option
        // with IAADDR suboption.
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, fake_allocation?
                  DHCP4_LEASE_ADVERT:DHCP4_LEASE_ALLOC)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
313
            .arg(lease->addr_.toText())
314
            .arg(client_id?client_id->toText():"(no client-id)")
Tomek Mrugalski's avatar
Tomek Mrugalski committed
315
            .arg(hwaddr?hwaddr->toText():"(no hwaddr info)");
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370

        answer->setYiaddr(lease->addr_);

        // IP Address Lease time (type 51)
        opt = OptionPtr(new Option(Option::V4, DHO_DHCP_LEASE_TIME));
        opt->setUint32(lease->valid_lft_);
        answer->addOption(opt);

        // @todo: include real router information here
        // Router (type 3)
        opt = OptionPtr(new Option4AddrLst(DHO_ROUTERS, IOAddress(HARDCODED_GATEWAY)));
        answer->addOption(opt);

        // Subnet mask (type 1)
        answer->addOption(getNetmaskOption(subnet));

        // @todo: send renew timer option (T1, option 58)
        // @todo: send rebind timer option (T2, option 59)

    } else {
        // Allocation engine did not allocate a lease. The engine logged
        // cause of that failure. The only thing left is to insert
        // status code to pass the sad news to the client.

        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, fake_allocation?
                  DHCP4_LEASE_ADVERT_FAIL:DHCP4_LEASE_ALLOC_FAIL)
            .arg(client_id?client_id->toText():"(no client-id)")
            .arg(hwaddr?hwaddr->toText():"(no hwaddr info)")
            .arg(hint.toText());

        setMsgType(answer, DHCPNAK);
        answer->setYiaddr(IOAddress("0.0.0.0"));
    }
}

OptionPtr Dhcpv4Srv::getNetmaskOption(const Subnet4Ptr& subnet) {
    uint32_t netmask = getNetmask4(subnet->get().second);

    OptionPtr opt(new OptionInt<uint32_t>(Option::V4,
                  DHO_SUBNET_MASK, netmask));

    return (opt);
}

void Dhcpv4Srv::setMsgType(Pkt4Ptr& pkt, uint8_t dhcp_type) {
    OptionPtr opt = pkt->getOption(DHO_DHCP_MESSAGE_TYPE);
    if (opt) {
        // There is message type option already, update it
        opt->setUint8(dhcp_type);
    } else {
        // There is no message type option yet, add it
        std::vector<uint8_t> tmp(1, dhcp_type);
        opt = OptionPtr(new Option(Option::V4, DHO_DHCP_MESSAGE_TYPE, tmp));
        pkt->addOption(opt);
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
371
}
372

373 374
Pkt4Ptr Dhcpv4Srv::processDiscover(Pkt4Ptr& discover) {
    Pkt4Ptr offer = Pkt4Ptr
Tomek Mrugalski's avatar
Tomek Mrugalski committed
375
        (new Pkt4(DHCPOFFER, discover->getTransid()));
376

Tomek Mrugalski's avatar
Tomek Mrugalski committed
377 378 379 380
    copyDefaultFields(discover, offer);
    appendDefaultOptions(offer, DHCPOFFER);
    appendRequestedOptions(offer);

381
    assignLease(discover, offer);
382 383

    return (offer);
384 385
}

386 387
Pkt4Ptr Dhcpv4Srv::processRequest(Pkt4Ptr& request) {
    Pkt4Ptr ack = Pkt4Ptr
388 389 390 391
        (new Pkt4(DHCPACK, request->getTransid()));

    copyDefaultFields(request, ack);
    appendDefaultOptions(ack, DHCPACK);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
392
    appendRequestedOptions(ack);
393

394
    assignLease(request, ack);
395 396

    return (ack);
397 398
}

399
void Dhcpv4Srv::processRelease(Pkt4Ptr& release) {
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    ClientIdPtr client_id;
    OptionPtr opt = release->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt) {
        client_id = ClientIdPtr(new ClientId(opt->getData()));
    }

    Lease4Ptr lease = LeaseMgrFactory::instance().getLease4(release->getYiaddr());

    if (!lease) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE_FAIL_NO_LEASE)
            .arg(release->getYiaddr().toText())
            .arg(release->getHWAddr()->toText())
            .arg(client_id ? client_id->toText() : "(no client-id)");
        return;
    }

    if (lease->hwaddr_ != release->getHWAddr()->hwaddr_) {
        // @todo: Print hwaddr from lease as part of ticket #2589
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE_FAIL_WRONG_HWADDR)
            .arg(release->getYiaddr().toText())
            .arg(client_id ? client_id->toText() : "(no client-id)")
            .arg(release->getHWAddr()->toText());
        return;
    }

    if (lease->client_id_ && client_id && *lease->client_id_ != *client_id) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE_FAIL_WRONG_CLIENT_ID)
            .arg(release->getYiaddr().toText())
            .arg(client_id->toText())
            .arg(lease->client_id_->toText());
        return;
    }

    if (LeaseMgrFactory::instance().deleteLease(lease->addr_)) {
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_RELEASE)
            .arg(lease->addr_.toText())
            .arg(client_id ? client_id->toText() : "(no client-id)")
            .arg(release->getHWAddr()->toText());
    } else {
        LOG_ERROR(dhcp4_logger, DHCP4_RELEASE_FAIL)
            .arg(lease->addr_.toText())
            .arg(client_id ? client_id->toText() : "(no client-id)")
            .arg(release->getHWAddr()->toText());
    }
444
}
445

446
void Dhcpv4Srv::processDecline(Pkt4Ptr& decline) {
447 448 449
    /// TODO: Implement this.
}

450
Pkt4Ptr Dhcpv4Srv::processInform(Pkt4Ptr& inform) {
451
    /// TODO: Currently implemented echo mode. Implement this for real
452 453
    return (inform);
}
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484

const char*
Dhcpv4Srv::serverReceivedPacketName(uint8_t type) {
    static const char* DISCOVER = "DISCOVER";
    static const char* REQUEST = "REQUEST";
    static const char* RELEASE = "RELEASE";
    static const char* DECLINE = "DECLINE";
    static const char* INFORM = "INFORM";
    static const char* UNKNOWN = "UNKNOWN";

    switch (type) {
    case DHCPDISCOVER:
        return (DISCOVER);

    case DHCPREQUEST:
        return (REQUEST);

    case DHCPRELEASE:
        return (RELEASE);

    case DHCPDECLINE:
        return (DECLINE);

    case DHCPINFORM:
        return (INFORM);

    default:
        ;
    }
    return (UNKNOWN);
}
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514

Subnet4Ptr Dhcpv4Srv::selectSubnet(const Pkt4Ptr& question) {
    Subnet4Ptr subnet = CfgMgr::instance().getSubnet4(question->getRemoteAddr());

    return (subnet);
}

void Dhcpv4Srv::sanityCheck(const Pkt4Ptr& pkt, RequirementLevel serverid) {
    OptionPtr server_id = pkt->getOption(DHO_DHCP_SERVER_IDENTIFIER);
    switch (serverid) {
    case FORBIDDEN:
        if (server_id) {
            isc_throw(RFCViolation, "Server-id option was not expected, but "
                      << "received in " << serverReceivedPacketName(pkt->getType()));
        }
        break;

    case MANDATORY:
        if (!server_id) {
            isc_throw(RFCViolation, "Server-id option was expected, but not "
                      " received in message "
                      << serverReceivedPacketName(pkt->getType()));
        }
        break;

    case OPTIONAL:
        // do nothing here
        ;
    }
}