lease_mgr.h 17 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// 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.

#include <string>
#include <fstream>
#include <vector>
18 19
#include <map>
#include <asiolink/io_address.h>
20
#include <boost/shared_ptr.hpp>
21 22
#include <dhcp/option.h>
#include <dhcp/duid.h>
23 24 25 26

namespace isc {
namespace dhcp {

27 28 29 30
/// @brief specifies unique subnet identifier
/// @todo: Move this to subnet.h once ticket #2237 is merged
typedef uint32_t SubnetID;

31 32 33 34 35 36 37
/// @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
38 39
    /// IPv4 address
    isc::asiolink::IOAddress addr_;
40 41 42 43 44 45 46 47

    /// @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
48
    uint32_t ext_;
49 50

    /// @brief hardware address
51
    std::vector<uint8_t> hwaddr_;
52 53

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

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
    /// @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_;

74 75 76 77
    /// @brief valid lifetime
    ///
    /// Expressed as number of seconds since cltt
    uint32_t valid_lft_;
78 79 80 81

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

84
    /// @brief Subnet identifier
85
    ///
86 87
    /// Specifies subnet-id of the subnet that the lease belongs to
    SubnetID subnet_id_;
88 89 90 91

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
92
    bool fixed_;
93 94 95 96

    /// @brief client hostname
    ///
    /// This field may be empty
97
    std::string hostname_;
98 99

    /// @brief did we update AAAA record for this lease?
100
    bool fqdn_fwd_;
101

102 103
    /// @brief did we update PTR record for this lease?
    bool fqdn_rev_;
104 105 106

    /// @brief additional options stored with this lease
    ///
107 108 109
    /// This field is currently not used.
    /// @todo We need a way to store options in the databased.
    Option::OptionCollection options_;
110 111 112 113 114

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

    /// @todo: Add DHCPv4 failover related fields here
118 119 120 121 122
};

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

123 124
/// @brief A collection of IPv4 leases.
typedef std::vector< boost::shared_ptr<Lease4Ptr> > Lease4Collection;
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

/// @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
162
    std::vector<uint8_t> hwaddr_;
163 164 165 166 167 168 169 170

    /// @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
171
    uint32_t preferred_lft_;
172 173

    /// @brief valid lifetime
Tomek Mrugalski's avatar
Tomek Mrugalski committed
174 175 176 177
    ///
    /// This parameter specified valid lifetime since the lease was assigned/renewed
    /// (cltt), expressed in seconds.
    uint32_t valid_lft_;
178 179 180 181 182 183

    /// @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
184 185
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
186 187 188 189 190 191 192
    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
193 194
    /// for the same IA, each must have consistent T1 and T2 values. Specified in
    /// seconds since cltt.
195 196 197 198 199
    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
200
    time_t cltt_;
201

202
    /// @brief Subnet identifier
203
    ///
204 205
    /// Specifies subnet-id of the subnet that the lease belongs to
    SubnetID subnet_id_;
206 207 208 209

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
210
    bool fixed_;
211 212 213 214

    /// @brief client hostname
    ///
    /// This field may be empty
Tomek Mrugalski's avatar
Tomek Mrugalski committed
215
    std::string hostname_;
216 217

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

220
    /// @brief did we update PTR record for this lease?
Tomek Mrugalski's avatar
Tomek Mrugalski committed
221
    bool fqdn_rev_;
222 223 224 225 226

    /// @brief additional options stored with this lease
    ///
    /// That field is currently not used. We may keep extra options assigned
    /// for leasequery and possibly other purposes.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
227 228
    /// @todo We need a way to store options in the databased.
    Option::OptionCollection options_;
229

Tomek Mrugalski's avatar
Tomek Mrugalski committed
230
    /// @brief Lease comments
231
    ///
Tomek Mrugalski's avatar
Tomek Mrugalski committed
232 233
    /// This field is currently not used.
    std::string comments_;
234 235

    /// @todo: Add DHCPv6 failover related fields here
236 237 238 239 240 241 242 243
};

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

244 245
/// @brief A collection of IPv6 leases.
typedef std::vector< boost::shared_ptr<Lease6Ptr> > Lease6Collection;
246

247
/// @brief Abstract Lease Manager
248
///
249 250 251 252
/// 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.
253 254 255
class LeaseMgr {
public:

256 257 258
    /// Client Hardware address
    typedef std::vector<uint8_t> HWAddr;

259 260
    /// @brief The sole lease manager constructor
    ///
261 262 263 264 265 266
    /// 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.
    ///
    /// @param dbconfig database configuration
    LeaseMgr(const std::string& dbconfig);
267 268

    /// @brief Destructor (closes file)
269
    virtual ~LeaseMgr();
270

271
    /// @brief Adds an IPv4 lease.
272 273
    ///
    /// @param lease lease to be added
274
    virtual bool addLease(Lease4Ptr lease) = 0;
275

276
    /// @brief Adds an IPv6 lease.
277 278
    ///
    /// @param lease lease to be added
279
    virtual bool addLease(Lease6Ptr lease) = 0;
280

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
    /// @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.
302 303
    ///
    /// @param addr address of the searched lease
304
    /// @param subnet_id ID of the subnet the lease must belong to
305
    ///
306 307
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease4Ptr getLease4(isc::asiolink::IOAddress addr) const = 0;
308

309 310 311 312 313 314
    /// @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.
315 316 317
    ///
    /// @param hwaddr hardware address of the client
    ///
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    /// @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)
    virtual Lease4Ptr getLease4(const HWAddr& hwaddr, 
                                SubnetID subnet_id) const = 0;
333

334 335
    /// @brief Returns existing IPv4 lease for specified client-id
    ///
336 337 338 339 340
    /// 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.
    ///
341
    /// @param clientid client identifier
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
    ///
    /// @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;
357

358
    /// @brief Returns existing IPv6 lease for a given IPv6 address.
359
    ///
360 361 362 363
    /// 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.
    ///
364 365
    /// @param addr address of the searched lease
    ///
366 367
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease6Ptr getLease6(isc::asiolink::IOAddress addr) const = 0;
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382
    /// @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)
    virtual Lease6Collection getLease6(const DUID& duid, 
                                       uint32_t iaid) const = 0;

383 384 385 386
    /// @brief Returns existing IPv6 lease for a given DUID+IA combination
    ///
    /// @param duid client DUID
    /// @param iaid IA identifier
387
    /// @param subnet_id subnet id of the subnet the lease belongs to
388 389
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
390 391
    virtual Lease6Ptr getLease6(const DUID& duid, uint32_t iaid,
                                SubnetID subnet_id) const = 0;
392

393 394 395 396 397 398
    /// @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;
399

400 401 402 403 404 405
    /// @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;
406 407 408 409 410 411

    /// @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
412
    virtual bool deleteLease4(uint32_t addr) = 0;
413 414 415 416 417 418

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

421 422 423 424
    /// @brief Returns backend name.
    ///
    /// Each backend have specific name, e.g. "mysql" or "sqlite".
    virtual std::string getName() const = 0;
425

426 427 428 429
    /// @brief Returns description of the backend.
    ///
    /// This description may be multiline text that describes the backend.
    virtual std::string getDescription() const = 0;
430

431
    /// @brief Returns backend version.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
432 433 434 435 436 437 438 439 440
    ///
    /// @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)
441
    /// Also if B>C, some database upgrade procedure may be triggered
442
    virtual std::string getVersion() const = 0;
443

444
    /// @todo: Add host management here
Tomek Mrugalski's avatar
Tomek Mrugalski committed
445 446 447
    /// As host reservation is outside of scope for 2012, support for hosts
    /// is currently postponed.

448
protected:
Tomek Mrugalski's avatar
Tomek Mrugalski committed
449 450
    /// @brief returns value of the parameter
    std::string getParameter(const std::string& name) const;
451

452
    /// @brief list of parameters passed in dbconfig
Tomek Mrugalski's avatar
Tomek Mrugalski committed
453 454 455 456
    ///
    /// 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.
457
    std::map<std::string, std::string> parameters_;
458
};
459 460 461 462 463


}; // end of isc::dhcp namespace

}; // end of isc namespace