dhcp4_srv.cc 27.5 KB
Newer Older
1
// Copyright (C) 2011-2013 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/option_int_array.h>
21
#include <dhcp/pkt4.h>
22 23
#include <dhcp/duid.h>
#include <dhcp/hwaddr.h>
24 25
#include <dhcp4/dhcp4_log.h>
#include <dhcp4/dhcp4_srv.h>
26 27 28 29 30 31 32
#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>
33

34 35 36 37 38
#include <boost/algorithm/string/erase.hpp>

#include <iomanip>
#include <fstream>

39 40
using namespace isc;
using namespace isc::asiolink;
41 42 43
using namespace isc::dhcp;
using namespace isc::log;
using namespace std;
44

45 46 47 48 49 50 51 52 53 54 55 56
namespace isc {
namespace dhcp {

/// @brief file name of a server-id file
///
/// Server must store its server identifier in persistent storage that must not
/// change between restarts. This is name of the file that is created in dataDir
/// (see isc::dhcp::CfgMgr::getDataDir()). It is a text file that uses
/// regular IPv4 address, e.g. 192.0.2.1. Server will create it during
/// first run and then use it afterwards.
static const char* SERVER_ID_FILE = "b10-dhcp4-serverid";

57 58 59
// These are hardcoded parameters. Currently this is a skeleton server that only
// grants those options and a single, fixed, hardcoded lease.

60 61
Dhcpv4Srv::Dhcpv4Srv(uint16_t port, const char* dbconfig, const bool use_bcast,
                     const bool direct_response_desired) {
62
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_OPEN_SOCKET).arg(port);
63
    try {
64
        // First call to instance() will create IfaceMgr (it's a singleton)
65
        // it may throw something if things go wrong.
66
        // The 'true' value of the call to setMatchingPacketFilter imposes
67 68 69 70
        // that IfaceMgr will try to use the mechanism to respond directly
        // to the client which doesn't have address assigned. This capability
        // may be lacking on some OSes, so there is no guarantee that server
        // will be able to respond directly.
71
        IfaceMgr::instance().setMatchingPacketFilter(direct_response_desired);
72

73 74 75
        if (port) {
            // open sockets only if port is non-zero. Port 0 is used
            // for non-socket related testing.
76
            IfaceMgr::instance().openSockets4(port, use_bcast);
77
        }
78

79 80 81
        string srvid_file = CfgMgr::instance().getDataDir() + "/" + string(SERVER_ID_FILE);
        if (loadServerID(srvid_file)) {
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_START, DHCP4_SERVERID_LOADED)
82
                .arg(srvidToString(getServerID()))
83 84 85 86 87 88 89 90 91 92 93 94 95
                .arg(srvid_file);
        } else {
            generateServerID();
            LOG_INFO(dhcp4_logger, DHCP4_SERVERID_GENERATED)
                .arg(srvidToString(getServerID()))
                .arg(srvid_file);

            if (!writeServerID(srvid_file)) {
                LOG_WARN(dhcp4_logger, DHCP4_SERVERID_WRITE_FAIL)
                    .arg(srvid_file);
            }

        }
96

97 98 99 100 101 102 103 104 105
        // 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));

106
    } catch (const std::exception &e) {
107
        LOG_ERROR(dhcp4_logger, DHCP4_SRV_CONSTRUCT_ERROR).arg(e.what());
108 109 110
        shutdown_ = true;
        return;
    }
111

Tomek Mrugalski's avatar
Tomek Mrugalski committed
112
    shutdown_ = false;
113 114 115
}

Dhcpv4Srv::~Dhcpv4Srv() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
116
    IfaceMgr::instance().closeSockets();
117 118
}

119 120
void
Dhcpv4Srv::shutdown() {
121
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC, DHCP4_SHUTDOWN_REQUEST);
122 123 124
    shutdown_ = true;
}

125 126
bool
Dhcpv4Srv::run() {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
127
    while (!shutdown_) {
128 129 130
        /// @todo: calculate actual timeout once we have lease database
        int timeout = 1000;

Tomek Mrugalski's avatar
Tomek Mrugalski committed
131
        // client's message and server's response
132
        Pkt4Ptr query;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
133
        Pkt4Ptr rsp;
134

135 136 137 138 139 140
        try {
            query = IfaceMgr::instance().receive4(timeout);
        } catch (const std::exception& e) {
            LOG_ERROR(dhcp4_logger, DHCP4_PACKET_RECEIVE_FAIL).arg(e.what());
        }

141
        if (query) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
142 143
            try {
                query->unpack();
144

Tomek Mrugalski's avatar
Tomek Mrugalski committed
145
            } catch (const std::exception& e) {
146 147 148
                // Failed to parse the packet.
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL,
                          DHCP4_PACKET_PARSE_FAIL).arg(e.what());
149 150
                continue;
            }
151
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, DHCP4_PACKET_RECEIVED)
152 153 154
                      .arg(serverReceivedPacketName(query->getType()))
                      .arg(query->getType())
                      .arg(query->getIface());
155 156 157
            LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_QUERY_DATA)
                      .arg(query->toText());

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
            try {
                switch (query->getType()) {
                case DHCPDISCOVER:
                    rsp = processDiscover(query);
                    break;

                case DHCPREQUEST:
                    rsp = processRequest(query);
                    break;

                case DHCPRELEASE:
                    processRelease(query);
                    break;

                case DHCPDECLINE:
                    processDecline(query);
                    break;

                case DHCPINFORM:
                    processInform(query);
                    break;

                default:
                    // Only action is to output a message if debug is enabled,
                    // and that is covered by the debug statement before the
                    // "switch" statement.
                    ;
                }
            } catch (const isc::Exception& e) {

                // Catch-all exception (at least for ones based on the isc
                // Exception class, which covers more or less all that
                // are explicitly raised in the BIND 10 code).  Just log
                // the problem and ignore the packet. (The problem is logged
                // as a debug message because debug is disabled by default -
                // it prevents a DDOS attack based on the sending of problem
                // packets.)
195 196 197 198 199 200 201 202 203 204
                if (dhcp4_logger.isDebugEnabled(DBG_DHCP4_BASIC)) {
                    std::string source = "unknown";
                    HWAddrPtr hwptr = query->getHWAddr();
                    if (hwptr) {
                        source = hwptr->toText();
                    }
                    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_BASIC,
                              DHCP4_PACKET_PROCESS_FAIL)
                              .arg(source).arg(e.what());
                }
205 206 207
            }

            if (rsp) {
208 209 210

                adjustRemoteAddr(query, rsp);

211 212 213 214 215 216
                if (!rsp->getHops()) {
                    rsp->setRemotePort(DHCP4_CLIENT_PORT);
                } else {
                    rsp->setRemotePort(DHCP4_SERVER_PORT);
                }

217 218 219 220 221
                rsp->setLocalAddr(query->getLocalAddr());
                rsp->setLocalPort(DHCP4_SERVER_PORT);
                rsp->setIface(query->getIface());
                rsp->setIndex(query->getIndex());

222 223 224
                LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA,
                          DHCP4_RESPONSE_DATA)
                          .arg(rsp->getType()).arg(rsp->toText());
225 226

                if (rsp->pack()) {
227 228
                    try {
                        IfaceMgr::instance().send(rsp);
Marcin Siodelski's avatar
Marcin Siodelski committed
229 230
                    } catch (const std::exception& e) {
                        LOG_ERROR(dhcp4_logger, DHCP4_PACKET_SEND_FAIL).arg(e.what());
231
                    }
232
                } else {
233
                    LOG_ERROR(dhcp4_logger, DHCP4_PACK_FAIL);
234 235 236
                }
            }
        }
237 238 239 240 241
    }

    return (true);
}

242 243
bool
Dhcpv4Srv::loadServerID(const std::string& file_name) {
244

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
    // load content of the file into a string
    fstream f(file_name.c_str(), ios::in);
    if (!f.is_open()) {
        return (false);
    }

    string hex_string;
    f >> hex_string;
    f.close();

    // remove any spaces
    boost::algorithm::erase_all(hex_string, " ");

    try {
        IOAddress addr(hex_string);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
261
        if (!addr.isV4()) {
262 263 264 265 266 267 268 269 270 271
            return (false);
        }

        // Now create server-id option
        serverid_.reset(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER, addr));

    } catch(...) {
        // any kind of malformed input (empty string, IPv6 address, complete
        // garbate etc.)
        return (false);
272 273 274 275 276
    }

    return (true);
}

277 278
void
Dhcpv4Srv::generateServerID() {
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295

    const IfaceMgr::IfaceCollection& ifaces = IfaceMgr::instance().getIfaces();

    // Let's find suitable interface.
    for (IfaceMgr::IfaceCollection::const_iterator iface = ifaces.begin();
         iface != ifaces.end(); ++iface) {

        // Let's don't use loopback.
        if (iface->flag_loopback_) {
            continue;
        }

        // Let's skip downed interfaces. It is better to use working ones.
        if (!iface->flag_up_) {
            continue;
        }

296
        const Iface::AddressCollection addrs = iface->getAddresses();
297

298
        for (Iface::AddressCollection::const_iterator addr = addrs.begin();
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
             addr != addrs.end(); ++addr) {
            if (addr->getFamily() != AF_INET) {
                continue;
            }

            serverid_ = OptionPtr(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                                     *addr));
            return;
        }


    }

    isc_throw(BadValue, "No suitable interfaces for server-identifier found");
}

315 316
bool
Dhcpv4Srv::writeServerID(const std::string& file_name) {
317 318 319 320 321 322
    fstream f(file_name.c_str(), ios::out | ios::trunc);
    if (!f.good()) {
        return (false);
    }
    f << srvidToString(getServerID());
    f.close();
323
    return (true);
324 325
}

326
string
327
Dhcpv4Srv::srvidToString(const OptionPtr& srvid) {
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    if (!srvid) {
        isc_throw(BadValue, "NULL pointer passed to srvidToString()");
    }
    boost::shared_ptr<Option4AddrLst> generated =
        boost::dynamic_pointer_cast<Option4AddrLst>(srvid);
    if (!srvid) {
        isc_throw(BadValue, "Pointer to invalid option passed to srvidToString()");
    }

    Option4AddrLst::AddressContainer addrs = generated->getAddresses();
    if (addrs.size() != 1) {
        isc_throw(BadValue, "Malformed option passed to srvidToString(). "
                  << "Expected to contain a single IPv4 address.");
    }

    return (addrs[0].toText());
344 345
}

346 347
void
Dhcpv4Srv::copyDefaultFields(const Pkt4Ptr& question, Pkt4Ptr& answer) {
348 349 350
    answer->setIface(question->getIface());
    answer->setIndex(question->getIndex());
    answer->setCiaddr(question->getCiaddr());
351

352
    answer->setSiaddr(IOAddress("0.0.0.0")); // explicitly set this to 0
353
    answer->setHops(question->getHops());
354 355

    // copy MAC address
356
    answer->setHWAddr(question->getHWAddr());
357 358

    // relay address
359 360
    answer->setGiaddr(question->getGiaddr());

361
    // Let's copy client-id to response. See RFC6842.
362 363 364 365
    OptionPtr client_id = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id) {
        answer->addOption(client_id);
    }
366 367

    // If src/dest HW addresses are used by the packet filtering class
368 369 370 371 372 373
    // we need to copy them as well. There is a need to check that the
    // address being set is not-NULL because an attempt to set the NULL
    // HW would result in exception. If these values are not set, the
    // the default HW addresses (zeroed) should be generated by the
    // packet filtering class when creating Ethernet header for
    // outgoing packet.
374 375
    HWAddrPtr src_hw_addr = question->getLocalHWAddr();
    if (src_hw_addr) {
376
        answer->setLocalHWAddr(src_hw_addr);
377
    }
378
    HWAddrPtr dst_hw_addr = question->getRemoteHWAddr();
379
    if (dst_hw_addr) {
380
        answer->setRemoteHWAddr(dst_hw_addr);
381
    }
382 383
}

384 385
void
Dhcpv4Srv::appendDefaultOptions(Pkt4Ptr& msg, uint8_t msg_type) {
386
    OptionPtr opt;
387 388

    // add Message Type Option (type 53)
389
    msg->setType(msg_type);
390

Tomek Mrugalski's avatar
Tomek Mrugalski committed
391
    // DHCP Server Identifier (type 54)
392
    msg->addOption(getServerID());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
393

394 395 396
    // more options will be added here later
}

397 398
void
Dhcpv4Srv::appendRequestedOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {
399 400 401 402 403 404 405 406 407 408 409

    // Get the subnet relevant for the client. We will need it
    // to get the options associated with it.
    Subnet4Ptr subnet = selectSubnet(question);
    // If we can't find the subnet for the client there is no way
    // to get the options to be sent to a client. We don't log an
    // error because it will be logged by the assignLease method
    // anyway.
    if (!subnet) {
        return;
    }
410

411 412 413 414 415 416 417 418 419
    // try to get the 'Parameter Request List' option which holds the
    // codes of requested options.
    OptionUint8ArrayPtr option_prl = boost::dynamic_pointer_cast<
        OptionUint8Array>(question->getOption(DHO_DHCP_PARAMETER_REQUEST_LIST));
    // If there is no PRL option in the message from the client then
    // there is nothing to do.
    if (!option_prl) {
        return;
    }
420

421 422 423 424 425 426 427 428 429 430 431 432
    // Get the codes of requested options.
    const std::vector<uint8_t>& requested_opts = option_prl->getValues();
    // For each requested option code get the instance of the option
    // to be returned to the client.
    for (std::vector<uint8_t>::const_iterator opt = requested_opts.begin();
         opt != requested_opts.end(); ++opt) {
        Subnet::OptionDescriptor desc =
            subnet->getOptionDescriptor("dhcp4", *opt);
        if (desc.option) {
            msg->addOption(desc.option);
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
433
}
434

435 436 437 438 439 440 441 442 443
void
Dhcpv4Srv::appendBasicOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {
    // Identify options that we always want to send to the
    // client (if they are configured).
    static const uint16_t required_options[] = {
        DHO_SUBNET_MASK,
        DHO_ROUTERS,
        DHO_DOMAIN_NAME_SERVERS,
        DHO_DOMAIN_NAME };
444

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
    static size_t required_options_size =
        sizeof(required_options) / sizeof(required_options[0]);

    // Get the subnet.
    Subnet4Ptr subnet = selectSubnet(question);
    if (!subnet) {
        return;
    }

    // Try to find all 'required' options in the outgoing
    // message. Those that are not present will be added.
    for (int i = 0; i < required_options_size; ++i) {
        OptionPtr opt = msg->getOption(required_options[i]);
        if (!opt) {
            // Check whether option has been configured.
            Subnet::OptionDescriptor desc =
                subnet->getOptionDescriptor("dhcp4", required_options[i]);
            if (desc.option) {
                msg->addOption(desc.option);
            }
        }
    }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
467
}
468

469 470
void
Dhcpv4Srv::assignLease(const Pkt4Ptr& question, Pkt4Ptr& answer) {
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487

    // 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()));
488
        answer->setType(DHCPNAK);
489 490 491
        answer->setYiaddr(IOAddress("0.0.0.0"));
        return;
    }
492

493 494 495
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_SELECTED)
        .arg(subnet->toText());

496 497 498 499 500 501 502
    // 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
503

504
    IOAddress hint = question->getYiaddr();
505

506
    HWAddrPtr hwaddr = question->getHWAddr();
507

508 509 510 511 512 513
    // "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.
514
    bool fake_allocation = (question->getType() == DHCPDISCOVER);
515 516 517 518 519 520 521 522 523

    // 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) {
524 525
        // We have a lease! Let's set it in the packet and send it back to
        // the client.
526 527
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, fake_allocation?
                  DHCP4_LEASE_ADVERT:DHCP4_LEASE_ALLOC)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
528
            .arg(lease->addr_.toText())
529
            .arg(client_id?client_id->toText():"(no client-id)")
Tomek Mrugalski's avatar
Tomek Mrugalski committed
530
            .arg(hwaddr?hwaddr->toText():"(no hwaddr info)");
531 532 533 534 535 536 537 538 539

        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);

        // Router (type 3)
540 541 542 543 544
        Subnet::OptionDescriptor opt_routers =
            subnet->getOptionDescriptor("dhcp4", DHO_ROUTERS);
        if (opt_routers.option) {
            answer->addOption(opt_routers.option);
        }
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562

        // 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());

563
        answer->setType(DHCPNAK);
564 565 566 567
        answer->setYiaddr(IOAddress("0.0.0.0"));
    }
}

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
void
Dhcpv4Srv::adjustRemoteAddr(const Pkt4Ptr& question, Pkt4Ptr& msg) {
    // Let's create static objects representing zeroed and broadcast
    // addresses. We will use them further in this function to test
    // other addresses against them. Since they are static, they will
    // be created only once.
    static const IOAddress zero_addr("0.0.0.0");
    static const IOAddress bcast_addr("255.255.255.255");

    // If received relayed message, server responds to the relay address.
    if (question->getGiaddr() != zero_addr) {
        msg->setRemoteAddr(question->getGiaddr());

    // If giaddr is 0 but client set ciaddr, server should unicast the
    // response to ciaddr.
    } else if (question->getCiaddr() != zero_addr) {
        msg->setRemoteAddr(question->getCiaddr());

    // We can't unicast the response to the client when sending NAK,
    // because we haven't allocated address for him. Therefore,
    // NAK is broadcast.
    } else if (msg->getType() == DHCPNAK) {
        msg->setRemoteAddr(bcast_addr);

    // If yiaddr is set it means that we have created a lease for a client.
593
    } else if (msg->getYiaddr() != zero_addr) {
594 595 596 597 598 599
        // If the broadcast bit is set in the flags field, we have to
        // send the response to broadcast address. Client may have requested it
        // because it doesn't support reception of messages on the interface
        // which doesn't have an address assigned. The other case when response
        // must be broadcasted is when our server does not support responding
        // directly to a client without address assigned.
600
        const bool bcast_flag = ((question->getFlags() & Pkt4::FLAG_BROADCAST_MASK) != 0);
601 602 603 604 605 606 607
        if (!IfaceMgr::instance().isDirectResponseSupported() || bcast_flag) {
            msg->setRemoteAddr(bcast_addr);

        // Client cleared the broadcast bit and we support direct responses
        // so we should unicast the response to a newly allocated address -
        // yiaddr.
        } else {
608
            msg->setRemoteAddr(msg->getYiaddr());
609 610 611 612 613 614 615 616 617 618 619 620 621

        }

    // In most cases, we should have the remote address found already. If we
    // found ourselves at this point, the rational thing to do is to respond
    // to the address we got the query from.
    } else {
        msg->setRemoteAddr(question->getRemoteAddr());

    }
}


622 623
OptionPtr
Dhcpv4Srv::getNetmaskOption(const Subnet4Ptr& subnet) {
624 625 626 627 628 629 630 631
    uint32_t netmask = getNetmask4(subnet->get().second);

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

    return (opt);
}

632 633
Pkt4Ptr
Dhcpv4Srv::processDiscover(Pkt4Ptr& discover) {
634
    Pkt4Ptr offer = Pkt4Ptr
Tomek Mrugalski's avatar
Tomek Mrugalski committed
635
        (new Pkt4(DHCPOFFER, discover->getTransid()));
636

Tomek Mrugalski's avatar
Tomek Mrugalski committed
637 638
    copyDefaultFields(discover, offer);
    appendDefaultOptions(offer, DHCPOFFER);
639
    appendRequestedOptions(discover, offer);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
640

641
    assignLease(discover, offer);
642

643 644 645 646 647
    // There are a few basic options that we always want to
    // include in the response. If client did not request
    // them we append them for him.
    appendBasicOptions(discover, offer);

648
    return (offer);
649 650
}

651 652
Pkt4Ptr
Dhcpv4Srv::processRequest(Pkt4Ptr& request) {
653
    Pkt4Ptr ack = Pkt4Ptr
654 655 656 657
        (new Pkt4(DHCPACK, request->getTransid()));

    copyDefaultFields(request, ack);
    appendDefaultOptions(ack, DHCPACK);
658
    appendRequestedOptions(request, ack);
659

660
    assignLease(request, ack);
661

662 663 664 665 666
    // There are a few basic options that we always want to
    // include in the response. If client did not request
    // them we append them for him.
    appendBasicOptions(request, ack);

667
    return (ack);
668 669
}

670 671
void
Dhcpv4Srv::processRelease(Pkt4Ptr& release) {
672 673

    // Try to find client-id
674 675 676 677 678 679
    ClientIdPtr client_id;
    OptionPtr opt = release->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt) {
        client_id = ClientIdPtr(new ClientId(opt->getData()));
    }

680 681 682 683 684 685 686 687 688 689 690 691
    try {
        // Do we have a lease for that particular address?
        Lease4Ptr lease = LeaseMgrFactory::instance().getLease4(release->getYiaddr());

        if (!lease) {
            // No such lease - bogus release
            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;
        }
692

693 694 695 696 697 698 699 700 701 702
        // Does the hardware address match? We don't want one client releasing
        // second client's leases.
        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;
        }
703

704 705 706 707 708 709 710 711 712
        // Does the lease have client-id info? If it has, then check it with what
        // the client sent us.
        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;
        }
713

714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
        // Ok, hw and client-id match - let's release the lease.
        if (LeaseMgrFactory::instance().deleteLease(lease->addr_)) {

            // Release successful - we're done here
            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 {

            // Release failed -
            LOG_ERROR(dhcp4_logger, DHCP4_RELEASE_FAIL)
                .arg(lease->addr_.toText())
                .arg(client_id ? client_id->toText() : "(no client-id)")
                .arg(release->getHWAddr()->toText());
        }
    } catch (const isc::Exception& ex) {
        // Rethrow the exception with a bit more data.
        LOG_ERROR(dhcp4_logger, DHCP4_RELEASE_EXCEPTION)
            .arg(ex.what())
            .arg(release->getYiaddr());
735 736
    }

737
}
738

739
void
740
Dhcpv4Srv::processDecline(Pkt4Ptr& /* decline */) {
741 742 743
    /// TODO: Implement this.
}

744 745
Pkt4Ptr
Dhcpv4Srv::processInform(Pkt4Ptr& inform) {
746
    /// TODO: Currently implemented echo mode. Implement this for real
747 748
    return (inform);
}
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

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);
}
780

781 782
Subnet4Ptr
Dhcpv4Srv::selectSubnet(const Pkt4Ptr& question) {
783

784 785 786 787 788 789 790 791 792 793 794
    // Is this relayed message?
    IOAddress relay = question->getGiaddr();
    if (relay.toText() == "0.0.0.0") {

        // Yes: Use relay address to select subnet
        return (CfgMgr::instance().getSubnet4(relay));
    } else {

        // No: Use client's address to select subnet
        return (CfgMgr::instance().getSubnet4(question->getRemoteAddr()));
    }
795 796
}

797 798
void
Dhcpv4Srv::sanityCheck(const Pkt4Ptr& pkt, RequirementLevel serverid) {
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
    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
        ;
    }
}
821 822 823

}   // namespace dhcp
}   // namespace isc