lease_mgr.h 20.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
//
// 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 16 17
#ifndef __LEASE_MGR_H
#define __LEASE_MGR_H

18
#include <fstream>
19
#include <map>
20 21 22 23
#include <string>
#include <utility>
#include <vector>

24
#include <asiolink/io_address.h>
25
#include <boost/shared_ptr.hpp>
26
#include <dhcp/duid.h>
27 28
#include <dhcp/option.h>
#include <exceptions/exceptions.h>
29

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
/// @file dhcp/lease_mgr.h
/// @brief An abstract API for lease database
///
/// This file contains declarations of Lease4, Lease6 and LeaseMgr classes.
/// They are essential components of the interface to any database backend.
/// Each concrete database backend (e.g. MySQL) will define a class derived
/// from LeaseMgr class.
///
/// Failover considerations:
/// There are no intermediate plans to implement DHCPv4 failover
/// (draft-ietf-dhc-failover-12.txt). Currently (Oct. 2012) the DHCPv6 failover
/// is being defined in DHC WG in IETF (draft-ietf-dhcpv6-failover-requirements,
/// draft-ietf-dhcpv6-dailover-design), but the work is not advanced enough
/// for implementation plans yet. v4 failover requires additional parameters
/// to be kept with a lease. It is likely that v6 failover will require similar
/// fields. Such implementation will require database schema extension.
/// We have designed a way to expand/upgrade schemas during upgrades: a database
/// schema is versioned and sanity checks about required version will be done
/// upon start and/or upgrade. With this mechanism in place, we can add new
/// fields to the database. In particular we can use that capability to
/// introduce failover related fields.
///
/// However, there is another approach that can be reliably used to provide
/// failover, even without the actual failover protocol implemented. As the
/// first backend will use MySQL, we will be able to use Multi-Master capability
/// offered by MySQL and use two separatate Kea instances connecting to the
/// same database.
///
/// Nevertheless, we hope to have failover protocol eventually implemented in
/// the Kea.

61 62 63
namespace isc {
namespace dhcp {

64 65
/// @brief Exception thrown on failure to open database
class DbOpenError : public Exception {
66
public:
67 68 69 70
    DbOpenError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

71 72 73 74 75 76 77
/// @brief Exception thrown on failure to execute a database function
class DbOperationError : public Exception {
public:
    DbOperationError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

78 79 80 81
/// @brief specifies unique subnet identifier
/// @todo: Move this to subnet.h once ticket #2237 is merged
typedef uint32_t SubnetID;

82 83 84 85 86 87 88
/// @brief Structure that holds a lease for IPv4 address
///
/// For performance reasons it is a simple structure, not a class. If we chose
/// make it a class, all fields would have to made private and getters/setters
/// would be required. As this is a critical part of the code that will be used
/// extensively, direct access is warranted.
struct Lease4 {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
89 90
    /// IPv4 address
    isc::asiolink::IOAddress addr_;
91 92 93 94 95 96 97 98

    /// @brief Address extension
    ///
    /// It is envisaged that in some cases IPv4 address will be accompanied with some
    /// additional data. One example of such use are Address + Port solutions (or
    /// Port-restricted Addresses), where several clients may get the same address, but
    /// different port ranges. This feature is not expected to be widely used.
    /// Under normal circumstances, the value should be 0.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
99
    uint32_t ext_;
100 101

    /// @brief hardware address
102
    std::vector<uint8_t> hwaddr_;
103 104

    /// @brief client identifier
Tomek Mrugalski's avatar
Tomek Mrugalski committed
105
    boost::shared_ptr<ClientId> client_id_;
106

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
    /// @brief renewal timer
    ///
    /// Specifies renewal time. Although technically it is a property of IA container,
    /// not the address itself, since our data model does not define separate IA
    /// entity, we are keeping it in the lease. In case of multiple addresses/prefixes
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
    uint32_t t1_;

    /// @brief rebinding timer
    ///
    /// Specifies rebinding time. Although technically it is a property of IA container,
    /// not the address itself, since our data model does not define separate IA
    /// entity, we are keeping it in the lease. In case of multiple addresses/prefixes
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
    uint32_t t2_;

125 126 127 128
    /// @brief valid lifetime
    ///
    /// Expressed as number of seconds since cltt
    uint32_t valid_lft_;
129 130 131 132

    /// @brief client last transmission time
    ///
    /// Specifies a timestamp, when last transmission from a client was received.
133
    time_t cltt_;
134

135
    /// @brief Subnet identifier
136
    ///
137 138
    /// Specifies subnet-id of the subnet that the lease belongs to
    SubnetID subnet_id_;
139 140 141 142

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
143
    bool fixed_;
144 145 146 147

    /// @brief client hostname
    ///
    /// This field may be empty
148
    std::string hostname_;
149 150

    /// @brief did we update AAAA record for this lease?
151
    bool fqdn_fwd_;
152

153 154
    /// @brief did we update PTR record for this lease?
    bool fqdn_rev_;
155 156 157 158 159

    /// @brief Lease comments.
    ///
    /// Currently not used. It may be used for keeping comments made by the
    /// system administrator.
160
    std::string comments_;
161 162

    /// @todo: Add DHCPv4 failover related fields here
163 164 165 166

    /// @brief Constructor
    ///
    /// Initialize fields that don't have a default constructor.
167
    /// @TODO Remove this
168
    Lease4() : addr_(0) {}
169 170 171 172 173
};

/// @brief Pointer to a Lease4 structure.
typedef boost::shared_ptr<Lease4> Lease4Ptr;

174 175
/// @brief A collection of IPv4 leases.
typedef std::vector< boost::shared_ptr<Lease4Ptr> > Lease4Collection;
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

/// @brief Structure that holds a lease for IPv6 address and/or prefix
///
/// For performance reasons it is a simple structure, not a class. Had we chose to
/// make it a class, all fields would have to be made private and getters/setters
/// would be required. As this is a critical part of the code that will be used
/// extensively, direct access rather than through getters/setters is warranted.
struct Lease6 {
    typedef enum {
        LEASE_IA_NA, /// the lease contains non-temporary IPv6 address
        LEASE_IA_TA, /// the lease contains temporary IPv6 address
        LEASE_IA_PD  /// the lease contains IPv6 prefix (for prefix delegation)
    } LeaseType;

    /// @brief specifies lease type (normal addr, temporary addr, prefix)
    LeaseType type_;

    /// IPv6 address
    isc::asiolink::IOAddress addr_;

    /// IPv6 prefix length (used only for PD)
    uint8_t prefixlen_;

    /// @brief IAID
    ///
    /// Identity Association IDentifier. DHCPv6 stores all addresses and prefixes
    /// in IA containers (IA_NA, IA_TA, IA_PD). Most containers may appear more
    /// than once in a message. To differentiate between them, IAID field is present
    uint32_t iaid_;

    /// @brief hardware address
    ///
    /// This field is not really used and is optional at best. The concept of identifying
    /// clients by their hardware address was replaced in DHCPv6 by DUID concept. Each
    /// client has its own unique DUID (DHCP Unique IDentifier). Furthermore, client's
    /// HW address is not always available, because client may be behind a relay (relay
    /// stores only link-local address).
Tomek Mrugalski's avatar
Tomek Mrugalski committed
213
    std::vector<uint8_t> hwaddr_;
214 215 216 217 218 219 220 221

    /// @brief client identifier
    boost::shared_ptr<DUID> duid_;

    /// @brief preferred lifetime
    ///
    /// This parameter specifies preferred lifetime since the lease was assigned/renewed
    /// (cltt), expressed in seconds.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
222
    uint32_t preferred_lft_;
223 224

    /// @brief valid lifetime
Tomek Mrugalski's avatar
Tomek Mrugalski committed
225 226 227 228
    ///
    /// This parameter specified valid lifetime since the lease was assigned/renewed
    /// (cltt), expressed in seconds.
    uint32_t valid_lft_;
229 230 231 232 233 234

    /// @brief T1 timer
    ///
    /// Specifies renewal time. Although technically it is a property of IA container,
    /// not the address itself, since our data model does not define separate IA
    /// entity, we are keeping it in the lease. In case of multiple addresses/prefixes
Tomek Mrugalski's avatar
Tomek Mrugalski committed
235 236
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
237 238 239 240 241 242 243
    uint32_t t1_;

    /// @brief T2 timer
    ///
    /// Specifies rebinding time. Although technically it is a property of IA container,
    /// not the address itself, since our data model does not define separate IA
    /// entity, we are keeping it in the lease. In case of multiple addresses/prefixes
Tomek Mrugalski's avatar
Tomek Mrugalski committed
244 245
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
246 247 248 249 250
    uint32_t t2_;

    /// @brief client last transmission time
    ///
    /// Specifies a timestamp, when last transmission from a client was received.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
251
    time_t cltt_;
252

253
    /// @brief Subnet identifier
254
    ///
255 256
    /// Specifies subnet-id of the subnet that the lease belongs to
    SubnetID subnet_id_;
257 258 259 260

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
261
    bool fixed_;
262 263 264 265

    /// @brief client hostname
    ///
    /// This field may be empty
Tomek Mrugalski's avatar
Tomek Mrugalski committed
266
    std::string hostname_;
267 268

    /// @brief did we update AAAA record for this lease?
Tomek Mrugalski's avatar
Tomek Mrugalski committed
269
    bool fqdn_fwd_;
270

271
    /// @brief did we update PTR record for this lease?
Tomek Mrugalski's avatar
Tomek Mrugalski committed
272
    bool fqdn_rev_;
273

Tomek Mrugalski's avatar
Tomek Mrugalski committed
274
    /// @brief Lease comments
275
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
276 277
    /// This field is currently not used.
    std::string comments_;
278 279

    /// @todo: Add DHCPv6 failover related fields here
280 281 282 283

    /// @brief Constructor
    ///
    /// Initialize fields that don't have a default constructor.
284
    Lease6() : addr_("::") {}
285 286 287 288 289 290 291 292
};

/// @brief Pointer to a Lease6 structure.
typedef boost::shared_ptr<Lease6> Lease6Ptr;

/// @brief Const pointer to a Lease6 structure.
typedef boost::shared_ptr<const Lease6> ConstLease6Ptr;

293 294
/// @brief A collection of IPv6 leases.
typedef std::vector< boost::shared_ptr<Lease6Ptr> > Lease6Collection;
295

296
/// @brief Abstract Lease Manager
297
///
298 299 300 301
/// This is an abstract API for lease database backends. It provides unified
/// interface to all backends. As this is an abstract class, it should not
/// be used directly, but rather specialized derived class should be used
/// instead.
302 303 304
class LeaseMgr {
public:

305 306 307
    /// Client Hardware address
    typedef std::vector<uint8_t> HWAddr;

308 309 310
    /// Database configuration parameter map
    typedef std::map<std::string, std::string> ParameterMap;

311 312
    /// @brief The sole lease manager constructor
    ///
313 314 315
    /// @param parameters A data structure relating keywords and values
    ///        concerned with the database.
    LeaseMgr(const ParameterMap& parameters);
316 317

    /// @brief Destructor (closes file)
318
    virtual ~LeaseMgr();
319

320
    /// @brief Adds an IPv4 lease.
321 322
    ///
    /// @param lease lease to be added
323 324 325 326 327 328
    ///
    /// @result true if the lease was added, false if not (because a lease
    ///         with the same address was already there).
    ///
    /// @exception DbOperationError Database function failed
    virtual bool addLease(const Lease4Ptr& lease) = 0;
329

330
    /// @brief Adds an IPv6 lease.
331 332
    ///
    /// @param lease lease to be added
333 334 335 336 337 338
    ///
    /// @result true if the lease was added, false if not (because a lease
    ///         with the same address was already there).
    ///
    /// @exception DbOperationError Database function failed
    virtual bool addLease(const Lease6Ptr& lease) = 0;
339

340
    /// @brief Returns IPv4 lease for specified IPv4 address and subnet_id
341 342 343 344 345 346 347 348 349
    ///
    /// This method is used to get a lease for specific subnet_id. There can be
    /// at most one lease for any given subnet, so this method returns a single
    /// pointer.
    ///
    /// @param addr address of the searched lease
    /// @param subnet_id ID of the subnet the lease must belong to
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
350
    virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress& addr,
351 352 353 354 355 356 357 358 359 360
                                SubnetID subnet_id) const = 0;

    /// @brief Returns an IPv4 lease for specified IPv4 address
    ///
    /// This method return a lease that is associated with a given address.
    /// For other query types (by hardware addr, by client-id) there can be
    /// several leases in different subnets (e.g. for mobile clients that
    /// got address in different subnets). However, for a single address
    /// there can be only one lease, so this method returns a pointer to
    /// a single lease, not a container of leases.
361 362
    ///
    /// @param addr address of the searched lease
363
    /// @param subnet_id ID of the subnet the lease must belong to
364
    ///
365
    /// @return smart pointer to the lease (or NULL if a lease is not found)
366
    virtual Lease4Ptr getLease4(const isc::asiolink::IOAddress& addr) const = 0;
367

368 369 370 371 372 373
    /// @brief Returns existing IPv4 leases for specified hardware address.
    ///
    /// Although in the usual case there will be only one lease, for mobile
    /// clients or clients with multiple static/fixed/reserved leases there
    /// can be more than one. Thus return type is a container, not a single
    /// pointer.
374 375 376
    ///
    /// @param hwaddr hardware address of the client
    ///
377 378 379 380 381 382 383 384 385 386 387 388 389
    /// @return lease collection
    virtual Lease4Collection getLease4(const HWAddr& hwaddr) const = 0;

    /// @brief Returns existing IPv4 leases for specified hardware address
    ///        and a subnet
    ///
    /// There can be at most one lease for a given HW address in a single
    /// pool, so this method with either return a single lease or NULL.
    ///
    /// @param hwaddr hardware address of the client
    /// @param subnet_id identifier of the subnet that lease must belong to
    ///
    /// @return a pointer to the lease (or NULL if a lease is not found)
390
    virtual Lease4Ptr getLease4(const HWAddr& hwaddr,
391
                                SubnetID subnet_id) const = 0;
392

393 394
    /// @brief Returns existing IPv4 lease for specified client-id
    ///
395 396 397 398 399
    /// Although in the usual case there will be only one lease, for mobile
    /// clients or clients with multiple static/fixed/reserved leases there
    /// can be more than one. Thus return type is a container, not a single
    /// pointer.
    ///
400
    /// @param clientid client identifier
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    ///
    /// @return lease collection
    virtual Lease4Collection getLease4(const ClientId& clientid) const = 0;

    /// @brief Returns existing IPv4 lease for specified client-id
    ///
    /// There can be at most one lease for a given HW address in a single
    /// pool, so this method with either return a single lease or NULL.
    ///
    /// @param clientid client identifier
    /// @param subnet_id identifier of the subnet that lease must belong to
    ///
    /// @return a pointer to the lease (or NULL if a lease is not found)
    virtual Lease4Ptr getLease4(const ClientId& clientid,
                                SubnetID subnet_id) const = 0;
416

417
    /// @brief Returns existing IPv6 lease for a given IPv6 address.
418
    ///
419 420 421 422
    /// For a given address, we assume that there will be only one lease.
    /// The assumtion here is that there will not be site or link-local
    /// addresses used, so there is no way of having address duplication.
    ///
423 424
    /// @param addr address of the searched lease
    ///
425
    /// @return smart pointer to the lease (or NULL if a lease is not found)
426
    virtual Lease6Ptr getLease6(const isc::asiolink::IOAddress& addr) const = 0;
427

428 429 430 431 432 433 434 435 436 437 438
    /// @brief Returns existing IPv6 leases for a given DUID+IA combination
    ///
    /// Although in the usual case there will be only one lease, for mobile
    /// clients or clients with multiple static/fixed/reserved leases there
    /// can be more than one. Thus return type is a container, not a single
    /// pointer.
    ///
    /// @param duid client DUID
    /// @param iaid IA identifier
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
439
    virtual Lease6Collection getLease6(const DUID& duid,
440 441
                                       uint32_t iaid) const = 0;

442 443 444 445
    /// @brief Returns existing IPv6 lease for a given DUID+IA combination
    ///
    /// @param duid client DUID
    /// @param iaid IA identifier
446
    /// @param subnet_id subnet id of the subnet the lease belongs to
447 448
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
449 450
    virtual Lease6Ptr getLease6(const DUID& duid, uint32_t iaid,
                                SubnetID subnet_id) const = 0;
451

452 453 454 455 456
    /// @brief Updates IPv4 lease.
    ///
    /// @param lease4 The lease to be updated.
    ///
    /// If no such lease is present, an exception will be thrown.
457
    virtual void updateLease4(const Lease4Ptr& lease4) = 0;
458

459 460 461 462 463
    /// @brief Updates IPv4 lease.
    ///
    /// @param lease4 The lease to be updated.
    ///
    /// If no such lease is present, an exception will be thrown.
464
    virtual void updateLease6(const Lease6Ptr& lease6) = 0;
465 466 467 468 469 470

    /// @brief Deletes a lease.
    ///
    /// @param addr IPv4 address of the lease to be deleted.
    ///
    /// @return true if deletion was successful, false if no such lease exists
471
    virtual bool deleteLease4(const isc::asiolink::IOAddress& addr) = 0;
472 473 474 475 476 477

    /// @brief Deletes a lease.
    ///
    /// @param addr IPv4 address of the lease to be deleted.
    ///
    /// @return true if deletion was successful, false if no such lease exists
478
    virtual bool deleteLease6(const isc::asiolink::IOAddress& addr) = 0;
479

480 481 482 483
    /// @brief Returns backend name.
    ///
    /// Each backend have specific name, e.g. "mysql" or "sqlite".
    virtual std::string getName() const = 0;
484

485 486 487 488
    /// @brief Returns description of the backend.
    ///
    /// This description may be multiline text that describes the backend.
    virtual std::string getDescription() const = 0;
489

490
    /// @brief Returns backend version.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
491
    ///
492 493 494
    /// @return Version number as a pair of unsigned integers.  "first" is the
    ///         major version number, "second" the minor number.
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
495 496 497 498 499 500 501 502
    /// @todo: We will need to implement 3 version functions eventually:
    /// A. abstract API version
    /// B. backend version
    /// C. database version (stored in the database scheme)
    ///
    /// and then check that:
    /// B>=A and B=C (it is ok to have newer backend, as it should be backward
    /// compatible)
503
    /// Also if B>C, some database upgrade procedure may be triggered
504
    virtual std::pair<uint32_t, uint32_t> getVersion() const = 0;
505

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
    /// @brief Commit Transactions
    ///
    /// Commits all pending database operations.  On databases that don't
    /// support transactions, this is a no-op.
    ///
    /// @exception DbOperationError if the commit failed.
    virtual void commit() = 0;

    /// @brief Rollback Transactions
    ///
    /// Rolls back all pending database operations.  On databases that don't
    /// support transactions, this is a no-op.
    ///
    /// @exception DbOperationError if the rollback failed.
    virtual void rollback() = 0;

522
    /// @todo: Add host management here
Tomek Mrugalski's avatar
Tomek Mrugalski committed
523 524 525
    /// As host reservation is outside of scope for 2012, support for hosts
    /// is currently postponed.

526
protected:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
527 528
    /// @brief returns value of the parameter
    std::string getParameter(const std::string& name) const;
529

530
    /// @brief list of parameters passed in dbconfig
Tomek Mrugalski's avatar
Tomek Mrugalski committed
531 532 533 534
    ///
    /// That will be mostly used for storing database name, username,
    /// password and other parameters required for DB access. It is not
    /// intended to keep any DHCP-related parameters.
535
    ParameterMap parameters_;
536
};
537 538 539

}; // end of isc::dhcp namespace
}; // end of isc namespace
540 541

#endif // __LEASE_MGR_H