dhcp4_srv.cc 18.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

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

40 41
// 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
42 43 44 45
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";
46

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

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

60
        setServerID();
61

62 63 64 65 66 67 68 69 70
        // 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));

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            if (rsp) {
151 152 153 154 155 156 157 158 159
                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);
                }

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

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

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

        // 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() {
190 191 192
    /// @todo: implement this for real (see ticket #2588)
    serverid_ = OptionPtr(new Option4AddrLst(DHO_DHCP_SERVER_IDENTIFIER,
                                             IOAddress(HARDCODED_SERVER_ID)));
193 194
}

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

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

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

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

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

217
    // Let's copy client-id to response. See RFC6842.
218 219 220 221
    OptionPtr client_id = question->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (client_id) {
        answer->addOption(client_id);
    }
222 223
}

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

    // add Message Type Option (type 53)
228
    msg->setType(msg_type);
229

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

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


237 238 239 240 241 242 243 244 245 246 247 248
void Dhcpv4Srv::appendRequestedOptions(const Pkt4Ptr& question, Pkt4Ptr& msg) {

    // 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;
    }
249

250 251 252 253 254 255 256 257 258
    // 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;
    }
259

260 261 262 263 264 265 266 267 268 269 270 271
    // 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
272
}
273

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
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()));
292
        answer->setType(DHCPNAK);
293 294 295
        answer->setYiaddr(IOAddress("0.0.0.0"));
        return;
    }
296

297 298 299
    LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL_DATA, DHCP4_SUBNET_SELECTED)
        .arg(subnet->toText());

300 301 302 303 304 305 306
    // 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
307

308
    IOAddress hint = question->getYiaddr();
309

310
    HWAddrPtr hwaddr = question->getHWAddr();
311

312 313 314 315 316 317
    // "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.
318
    bool fake_allocation = (question->getType() == DHCPDISCOVER);
319 320 321 322 323 324 325 326 327

    // 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) {
328 329
        // We have a lease! Let's set it in the packet and send it back to
        // the client.
330 331
        LOG_DEBUG(dhcp4_logger, DBG_DHCP4_DETAIL, fake_allocation?
                  DHCP4_LEASE_ADVERT:DHCP4_LEASE_ALLOC)
Tomek Mrugalski's avatar
Tomek Mrugalski committed
332
            .arg(lease->addr_.toText())
333
            .arg(client_id?client_id->toText():"(no client-id)")
Tomek Mrugalski's avatar
Tomek Mrugalski committed
334
            .arg(hwaddr?hwaddr->toText():"(no hwaddr info)");
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

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

365
        answer->setType(DHCPNAK);
366 367 368 369 370 371 372 373 374 375 376 377 378
        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);
}

379 380
Pkt4Ptr Dhcpv4Srv::processDiscover(Pkt4Ptr& discover) {
    Pkt4Ptr offer = Pkt4Ptr
Tomek Mrugalski's avatar
Tomek Mrugalski committed
381
        (new Pkt4(DHCPOFFER, discover->getTransid()));
382

Tomek Mrugalski's avatar
Tomek Mrugalski committed
383 384
    copyDefaultFields(discover, offer);
    appendDefaultOptions(offer, DHCPOFFER);
385
    appendRequestedOptions(discover, offer);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
386

387
    assignLease(discover, offer);
388 389

    return (offer);
390 391
}

392 393
Pkt4Ptr Dhcpv4Srv::processRequest(Pkt4Ptr& request) {
    Pkt4Ptr ack = Pkt4Ptr
394 395 396 397
        (new Pkt4(DHCPACK, request->getTransid()));

    copyDefaultFields(request, ack);
    appendDefaultOptions(ack, DHCPACK);
398
    appendRequestedOptions(request, ack);
399

400
    assignLease(request, ack);
401 402

    return (ack);
403 404
}

405
void Dhcpv4Srv::processRelease(Pkt4Ptr& release) {
406 407

    // Try to find client-id
408 409 410 411 412 413
    ClientIdPtr client_id;
    OptionPtr opt = release->getOption(DHO_DHCP_CLIENT_IDENTIFIER);
    if (opt) {
        client_id = ClientIdPtr(new ClientId(opt->getData()));
    }

414 415 416 417 418 419 420 421 422 423 424 425
    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;
        }
426

427 428 429 430 431 432 433 434 435 436
        // 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;
        }
437

438 439 440 441 442 443 444 445 446
        // 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;
        }
447

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
        // 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());
469 470
    }

471
}
472

473
void Dhcpv4Srv::processDecline(Pkt4Ptr& decline) {
474 475 476
    /// TODO: Implement this.
}

477
Pkt4Ptr Dhcpv4Srv::processInform(Pkt4Ptr& inform) {
478
    /// TODO: Currently implemented echo mode. Implement this for real
479 480
    return (inform);
}
481 482 483 484 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

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);
}
512 513 514

Subnet4Ptr Dhcpv4Srv::selectSubnet(const Pkt4Ptr& question) {

515 516 517 518 519 520 521 522 523 524 525
    // 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()));
    }
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
}

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