lease_mgr.h 11.7 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 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
/// @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 {
    uint32_t addr_; /// IPv4 address

    /// @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.
    uint32_t ext_; /// address extension

    /// @brief hardware address
46
    std::vector<uint8_t> hwaddr_;
47 48

    /// @brief client identifier
49
    std::vector<uint8_t> client_id_;
50

51 52 53 54
    /// @brief valid lifetime
    ///
    /// Expressed as number of seconds since cltt
    uint32_t valid_lft_;
55 56 57 58 59 60 61

    /// @brief Recycle timer
    ///
    /// Typically, the lease return to free pool immediately after it is released
    /// or expired. This timer specifies number of seconds that it should be kept
    /// after release or expiration, in case the client returns. This feature is not
    /// currently used and this value is set to 0.
62
    uint32_t recycle_time_;
63 64 65 66

    /// @brief client last transmission time
    ///
    /// Specifies a timestamp, when last transmission from a client was received.
67
    time_t cltt_;
68 69 70 71

    /// @brief Pool identifier
    ///
    /// Specifies pool-id of the pool that the lease belongs to
72
    uint32_t pool_id_;
73 74 75 76

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
77
    bool fixed_;
78 79 80 81

    /// @brief client hostname
    ///
    /// This field may be empty
82
    std::string hostname_;
83 84

    /// @brief did we update AAAA record for this lease?
85
    bool fqdn_fwd_;
86

87 88
    /// @brief did we update PTR record for this lease?
    bool fqdn_rev_;
89 90 91

    /// @brief additional options stored with this lease
    ///
92 93 94
    /// This field is currently not used.
    /// @todo We need a way to store options in the databased.
    Option::OptionCollection options_;
95 96 97 98 99

    /// @brief Lease comments.
    ///
    /// Currently not used. It may be used for keeping comments made by the
    /// system administrator.
100
    std::string comments_;
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
};

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


/// @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).
    std::vector<uint8_t> hwaddr;

    /// @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.
    uint32_t preferred_lft;

    /// @brief valid lifetime
    uint32_t valid_lft;

    /// @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
    /// for the same IA, each must have consistent T1 and T2 values.
    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
    /// for the same IA, each must have consistent T1 and T2 values.
    uint32_t t2_;

    /// @brief Recycle timer
    ///
    /// Typically, the lease return to free pool immediately after it is released
    /// or expired. This timer specifies number of seconds that it should be kept
    /// after release or expiration, in case the client returns. This feature is not
    /// currently used and this value is set to 0.
179
    uint32_t recycle_time;
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

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

    /// @brief Pool identifier
    ///
    /// Specifies pool-id of the pool that the lease belongs to
    uint32_t pool_id;

    /// @brief Is this a fixed lease?
    ///
    /// Fixed leases are kept after they are released/expired.
    bool fixed;

    /// @brief client hostname
    ///
    /// This field may be empty
    std::string hostname;

    /// @brief did we update AAAA record for this lease?
    bool fqdn_fwd;

204
    /// @brief did we update PTR record for this lease?
205 206 207 208 209 210 211
    bool fqdn_rev;

    /// @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.
    /// @todo: Define this as a container of options
212
    std::string options;
213 214 215 216

    /// @brief /// comments on that lease
    ///
    /// (currently not used)
217
    std::string comments;
218 219 220 221 222 223 224 225 226
};

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


227
/// @brief Abstract Lease Manager
228
///
229 230 231 232
/// 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.
233 234 235
class LeaseMgr {
public:

236 237 238
    /// Client Hardware address
    typedef std::vector<uint8_t> HWAddr;

239 240
    /// @brief The sole lease manager constructor
    ///
241 242 243 244 245 246
    /// 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);
247 248

    /// @brief Destructor (closes file)
249
    virtual ~LeaseMgr();
250

251
    /// @brief Adds an IPv4 lease.
252 253
    ///
    /// @param lease lease to be added
254
    virtual bool addLease(Lease4Ptr lease) = 0;
255

256
    /// @brief Adds an IPv6 lease.
257 258
    ///
    /// @param lease lease to be added
259
    virtual bool addLease(Lease6Ptr lease) = 0;
260

261
    /// @brief Returns existing IPv4 lease for specified IPv4 address.
262 263 264
    ///
    /// @param addr address of the searched lease
    ///
265 266
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease4Ptr getLease4(isc::asiolink::IOAddress addr) const = 0;
267

268 269 270 271 272 273
    /// @brief Returns existing IPv4 lease for specified hardware address.
    ///
    /// @param hwaddr hardware address of the client
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease4Ptr getLease4(const HWAddr& hwaddr) const = 0;
274

275 276 277 278
    /// @brief Returns existing IPv4 lease for specified client-id
    ///
    /// @param clientid client identifier
    virtual Lease4Ptr getLease4(const ClientId& clientid) const = 0;
279

280
    /// @brief Returns existing IPv6 lease for a given IPv6 address.
281 282 283
    ///
    /// @param addr address of the searched lease
    ///
284 285
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease6Ptr getLease6(isc::asiolink::IOAddress addr) const = 0;
286

287 288 289 290 291 292 293
    /// @brief Returns existing IPv6 lease for a given DUID+IA combination
    ///
    /// @param duid client DUID
    /// @param iaid IA identifier
    ///
    /// @return smart pointer to the lease (or NULL if a lease is not found)
    virtual Lease6Ptr getLease6(const DUID& duid, uint32_t iaid) const = 0;
294

295 296 297 298 299 300
    /// @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;
301

302 303 304 305 306 307
    /// @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;
308 309 310 311 312 313

    /// @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
314
    virtual bool deleteLease4(uint32_t addr) = 0;
315 316 317 318 319 320

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

323 324 325 326
    /// @brief Returns backend name.
    ///
    /// Each backend have specific name, e.g. "mysql" or "sqlite".
    virtual std::string getName() const = 0;
327

328 329 330 331
    /// @brief Returns description of the backend.
    ///
    /// This description may be multiline text that describes the backend.
    virtual std::string getDescription() const = 0;
332

333 334
    /// @brief Returns backend version.
    virtual std::string getVersion() const = 0;
335

336
    /// @todo: Add pool management here
337

338 339
    /// @todo: Add host management here
protected:
340

341 342
    /// @brief list of parameters passed in dbconfig
    std::map<std::string, std::string> parameters_;
343
};
344 345 346 347 348


}; // end of isc::dhcp namespace

}; // end of isc namespace