lease_mgr.h 19.5 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 19 20
#include <string>
#include <fstream>
#include <vector>
21 22
#include <map>
#include <asiolink/io_address.h>
23
#include <boost/noncopyable.hpp>
24
#include <boost/shared_ptr.hpp>
25 26
#include <dhcp/option.h>
#include <dhcp/duid.h>
27
#include <dhcp/subnet.h>
28

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
/// @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.

60 61 62
namespace isc {
namespace dhcp {

63 64 65 66 67 68 69
/// @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
70 71
    /// IPv4 address
    isc::asiolink::IOAddress addr_;
72 73 74 75 76 77 78 79

    /// @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
80
    uint32_t ext_;
81 82

    /// @brief hardware address
83
    std::vector<uint8_t> hwaddr_;
84 85

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

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
    /// @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_;

106 107 108 109
    /// @brief valid lifetime
    ///
    /// Expressed as number of seconds since cltt
    uint32_t valid_lft_;
110 111 112 113

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

116
    /// @brief Subnet identifier
117
    ///
118 119
    /// Specifies subnet-id of the subnet that the lease belongs to
    SubnetID subnet_id_;
120 121 122 123

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
124
    bool fixed_;
125 126 127 128

    /// @brief client hostname
    ///
    /// This field may be empty
129
    std::string hostname_;
130 131

    /// @brief did we update AAAA record for this lease?
132
    bool fqdn_fwd_;
133

134 135
    /// @brief did we update PTR record for this lease?
    bool fqdn_rev_;
136 137 138 139 140

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

    /// @todo: Add DHCPv4 failover related fields here
144 145 146 147 148
};

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

149 150
/// @brief A collection of IPv4 leases.
typedef std::vector< boost::shared_ptr<Lease4Ptr> > Lease4Collection;
151 152 153 154 155 156 157 158 159 160 161 162 163 164

/// @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;

165 166 167 168
    Lease6(LeaseType type, const isc::asiolink::IOAddress& addr, DuidPtr duid,
           uint32_t iaid, uint32_t preferred, uint32_t valid, uint32_t t1,
           uint32_t t2, SubnetID subnet_id);

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    /// @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
192
    std::vector<uint8_t> hwaddr_;
193 194 195 196 197 198 199 200

    /// @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
201
    uint32_t preferred_lft_;
202 203

    /// @brief valid lifetime
Tomek Mrugalski's avatar
Tomek Mrugalski committed
204 205 206 207
    ///
    /// This parameter specified valid lifetime since the lease was assigned/renewed
    /// (cltt), expressed in seconds.
    uint32_t valid_lft_;
208 209 210 211 212 213

    /// @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
214 215
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
216 217
    /// This value will also be useful for failover to calculate the next expected
    /// client transmission time.
218 219 220 221 222 223 224
    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
225 226
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
227 228 229 230 231
    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
232
    time_t cltt_;
233

234
    /// @brief Subnet identifier
235
    ///
236 237
    /// Specifies subnet-id of the subnet that the lease belongs to
    SubnetID subnet_id_;
238 239 240 241

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
242
    bool fixed_;
243 244 245 246

    /// @brief client hostname
    ///
    /// This field may be empty
Tomek Mrugalski's avatar
Tomek Mrugalski committed
247
    std::string hostname_;
248 249

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

252
    /// @brief did we update PTR record for this lease?
Tomek Mrugalski's avatar
Tomek Mrugalski committed
253
    bool fqdn_rev_;
254

Tomek Mrugalski's avatar
Tomek Mrugalski committed
255
    /// @brief Lease comments
256
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
257 258
    /// This field is currently not used.
    std::string comments_;
259 260

    /// @todo: Add DHCPv6 failover related fields here
261 262 263 264 265 266 267 268
};

/// @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;

269 270
/// @brief A collection of IPv6 leases.
typedef std::vector< boost::shared_ptr<Lease6Ptr> > Lease6Collection;
271

272
/// @brief Abstract Lease Manager
273
///
274 275 276 277
/// 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.
278 279 280 281 282 283
///
/// This class is a meta-singleton. At any given time, there is only one
/// instance of any classes derived from that class. That is achieved with
/// defining only a single protected constructor, so every derived class has
/// to use it. Furthermore, this sole constructor registers the first instance
/// (and throws InvalidOperation if there is an attempt to create a second one).
284
class LeaseMgr : public boost::noncopyable {
285
public:
286 287 288
    /// Client Hardware address
    typedef std::vector<uint8_t> HWAddr;

289
    /// @brief returns a single instance of LeaseMgr
290
    ///
291 292 293 294 295 296 297 298
    /// LeaseMgr is a singleton and this method is the only way of
    /// accessing it. LeaseMgr must be create first using
    /// instantiate() method, otherwise instance() will throw
    /// InvalidOperation exception.
    /// @throw InvalidOperation if LeaseMgr not instantiated
    static LeaseMgr& instance();

    /// @brief Destructor
299
    virtual ~LeaseMgr();
300

301
    /// @brief Adds an IPv4 lease.
302 303
    ///
    /// @param lease lease to be added
304
    virtual bool addLease(Lease4Ptr lease) = 0;
305

306
    /// @brief Adds an IPv6 lease.
307 308
    ///
    /// @param lease lease to be added
309
    virtual bool addLease(Lease6Ptr lease) = 0;
310

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
    /// @brief Returns existing IPv4 lease for specified IPv4 address and subnet_id
    ///
    /// 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)
    virtual Lease4Ptr getLease4(isc::asiolink::IOAddress addr,
                                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.
332 333
    ///
    /// @param addr address of the searched lease
334
    /// @param subnet_id ID of the subnet the lease must belong to
335
    ///
336 337
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease4Ptr getLease4(isc::asiolink::IOAddress addr) const = 0;
338

339 340 341 342 343 344
    /// @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.
345 346 347
    ///
    /// @param hwaddr hardware address of the client
    ///
348 349 350 351 352 353 354 355 356 357 358 359 360
    /// @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)
361
    virtual Lease4Ptr getLease4(const HWAddr& hwaddr,
362
                                SubnetID subnet_id) const = 0;
363

364 365
    /// @brief Returns existing IPv4 lease for specified client-id
    ///
366 367 368 369 370
    /// 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.
    ///
371
    /// @param clientid client identifier
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
    ///
    /// @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;
387

388
    /// @brief Returns existing IPv6 lease for a given IPv6 address.
389
    ///
390 391 392 393
    /// 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.
    ///
394 395
    /// @param addr address of the searched lease
    ///
396 397
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease6Ptr getLease6(isc::asiolink::IOAddress addr) const = 0;
398

399 400 401 402 403 404 405 406 407 408 409
    /// @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)
410
    virtual Lease6Collection getLease6(const DUID& duid,
411 412
                                       uint32_t iaid) const = 0;

413 414 415 416
    /// @brief Returns existing IPv6 lease for a given DUID+IA combination
    ///
    /// @param duid client DUID
    /// @param iaid IA identifier
417
    /// @param subnet_id subnet id of the subnet the lease belongs to
418 419
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
420 421
    virtual Lease6Ptr getLease6(const DUID& duid, uint32_t iaid,
                                SubnetID subnet_id) const = 0;
422

423 424 425 426 427 428
    /// @brief Updates IPv4 lease.
    ///
    /// @param lease4 The lease to be updated.
    ///
    /// If no such lease is present, an exception will be thrown.
    virtual void updateLease4(Lease4Ptr lease4) = 0;
429

430 431 432 433 434 435
    /// @brief Updates IPv4 lease.
    ///
    /// @param lease4 The lease to be updated.
    ///
    /// If no such lease is present, an exception will be thrown.
    virtual void updateLease6(Lease6Ptr lease6) = 0;
436 437 438 439 440 441

    /// @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
442
    virtual bool deleteLease4(uint32_t addr) = 0;
443 444 445 446 447 448

    /// @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
449
    virtual bool deleteLease6(isc::asiolink::IOAddress addr) = 0;
450

451 452 453 454
    /// @brief Returns backend name.
    ///
    /// Each backend have specific name, e.g. "mysql" or "sqlite".
    virtual std::string getName() const = 0;
455

456 457 458 459
    /// @brief Returns description of the backend.
    ///
    /// This description may be multiline text that describes the backend.
    virtual std::string getDescription() const = 0;
460

461
    /// @brief Returns backend version.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
462 463 464 465 466 467 468 469 470
    ///
    /// @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)
471
    /// Also if B>C, some database upgrade procedure may be triggered
472
    virtual std::string getVersion() const = 0;
473

474
    /// @todo: Add host management here
Tomek Mrugalski's avatar
Tomek Mrugalski committed
475 476 477
    /// As host reservation is outside of scope for 2012, support for hosts
    /// is currently postponed.

478
protected:
479 480
    /// @brief The sole lease manager constructor
    ///
481 482 483 484 485 486
    /// dbconfig is a generic way of passing parameters. Parameters are passed
    /// in the "name=value" format, separated by spaces. Values may be enclosed
    /// in double quotes, if needed. This ctor guarantees that there will be
    /// only one instance of any derived classes. If there is a second instance
    /// being created with the first one still around, it will throw
    /// InvalidOperation.
487 488
    ///
    /// @param dbconfig database configuration
489
    /// @throw InvalidOperation when trying to create second LeaseMgr
490 491
    LeaseMgr(const std::string& dbconfig);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
492 493
    /// @brief returns value of the parameter
    std::string getParameter(const std::string& name) const;
494

495
    /// @brief list of parameters passed in dbconfig
Tomek Mrugalski's avatar
Tomek Mrugalski committed
496 497 498 499
    ///
    /// 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.
500
    std::map<std::string, std::string> parameters_;
501 502

    static LeaseMgr* instance_;
503
};
504 505 506 507

}; // end of isc::dhcp namespace

}; // end of isc namespace
508 509

#endif // LEASE_MGR_H