11#include <boost/algorithm/string.hpp>
12#include <boost/scoped_ptr.hpp>
40 uint32_t valid_lft,
SubnetID subnet_id, time_t cltt,
41 const bool fqdn_fwd,
const bool fqdn_rev,
42 const std::string& hostname,
const HWAddrPtr& hwaddr)
43 : addr_(addr), valid_lft_(valid_lft), current_valid_lft_(valid_lft),
44 reuseable_valid_lft_(0),
45 cltt_(cltt), current_cltt_(cltt), subnet_id_(subnet_id),
46 hostname_(
boost::algorithm::to_lower_copy(hostname)), fqdn_fwd_(fqdn_fwd),
47 fqdn_rev_(fqdn_rev), hwaddr_(hwaddr), state_(STATE_DEFAULT) {
57 return string(
"IA_NA");
59 return string(
"IA_TA");
61 return string(
"IA_PD");
65 tmp <<
"unknown (" << type <<
")";
76 }
else if (text ==
"IA_NA") {
79 }
else if (text ==
"IA_TA") {
82 }
else if (text ==
"IA_PD") {
97 return (
"expired-reclaimed");
102 std::ostringstream s;
103 s <<
"unknown (" << state <<
")";
153 " or it is not a string");
156 boost::scoped_ptr<asiolink::IOAddress> io_address;
160 }
catch (
const std::exception& ex) {
162 <<
" in the parsed lease");
165 lease->addr_ = *io_address;
171 " or it is not a number");
174 if (subnet_id->intValue() <= 0) {
176 <<
" a positive integer");
177 }
else if (subnet_id->intValue() > numeric_limits<uint32_t>::max()) {
179 <<
" a 32 bit unsigned integer");
182 lease->subnet_id_ =
SubnetID(subnet_id->intValue());
196 }
catch (
const std::exception& ex) {
198 << hw_address->stringValue() <<
" in the parsed lease");
206 " or it is not a number");
209 if (cltt->intValue() <= 0) {
211 " positive integer in the parsed lease");
214 lease->cltt_ =
static_cast<time_t
>(cltt->intValue());
220 " or it is not a number");
223 if (valid_lifetime->intValue() < 0) {
225 <<
" is negative in the parsed lease");
228 lease->valid_lft_ = valid_lifetime->intValue();
234 " or it is not a boolean value");
237 lease->fqdn_fwd_ = fqdn_fwd->boolValue();
243 " or it is not a boolean value");
246 lease->fqdn_rev_ = fqdn_rev->boolValue();
252 " or it is not a string value");
255 lease->hostname_ = hostname->stringValue();
256 boost::algorithm::to_lower(lease->hostname_);
262 " or it is not a number");
267 <<
" must be in range [0.."
271 lease->state_ = state->intValue();
279 lease->setContext(ctx);
282 lease->updateCurrentExpirationTime();
297 :
Lease(other.addr_, other.valid_lft_,
298 other.subnet_id_, other.cltt_, other.fqdn_fwd_,
299 other.fqdn_rev_, other.hostname_, other.hwaddr_) {
327 const uint32_t valid_lifetime,
332 const std::string& hostname)
334 :
Lease(address, valid_lifetime, subnet_id, cltt, fqdn_fwd,
335 fqdn_rev, hostname, hw_address),
336 client_id_(client_id) {
344const std::vector<uint8_t>&
347 static std::vector<uint8_t> empty_vec;
354const std::vector<uint8_t>&
357 static std::vector<uint8_t> empty_vec;
394 if (
this != &other) {
460 if (!lease->addr_.isV4()) {
465 if (!lease->hwaddr_) {
481 }
catch (
const std::exception& ex) {
483 << client_id->stringValue() <<
" in the parsed lease");
491 DuidPtr duid, uint32_t iaid, uint32_t preferred, uint32_t valid,
493 :
Lease(addr, valid, subnet_id, 0, false, false,
"", hwaddr),
494 type_(type), prefixlen_(prefixlen), iaid_(iaid), duid_(duid),
495 preferred_lft_(preferred), reuseable_preferred_lft_(0) {
505 DuidPtr duid, uint32_t iaid, uint32_t preferred, uint32_t valid,
506 SubnetID subnet_id,
const bool fqdn_fwd,
const bool fqdn_rev,
507 const std::string& hostname,
const HWAddrPtr& hwaddr,
509 :
Lease(addr, valid, subnet_id, 0,
510 fqdn_fwd, fqdn_rev, hostname, hwaddr),
511 type_(type), prefixlen_(prefixlen), iaid_(iaid), duid_(duid),
512 preferred_lft_(preferred), reuseable_preferred_lft_(0) {
523 HWAddrPtr()), type_(TYPE_NA), prefixlen_(0), iaid_(0),
524 duid_(
DuidPtr()), preferred_lft_(0), reuseable_preferred_lft_(0) {
532const std::vector<uint8_t>&
535 static std::vector<uint8_t> empty_vec;
539 return (
duid_->getDuid());
557 ostringstream stream;
561 <<
static_cast<int>(
type_) <<
")\n"
562 <<
"Address: " <<
addr_ <<
"\n"
563 <<
"Prefix length: " <<
static_cast<int>(
prefixlen_) <<
"\n"
564 <<
"IAID: " <<
iaid_ <<
"\n"
567 <<
"Cltt: " <<
cltt_ <<
"\n"
568 <<
"DUID: " << (
duid_?
duid_->toText():
"(none)") <<
"\n"
569 <<
"Hardware addr: " << (
hwaddr_?
hwaddr_->toText(
false):
"(none)") <<
"\n"
574 stream <<
"User context: " <<
getContext()->str() <<
"\n";
577 return (stream.str());
582 ostringstream stream;
584 stream <<
"Address: " <<
addr_ <<
"\n"
586 <<
"Cltt: " <<
cltt_ <<
"\n"
587 <<
"Hardware addr: " << (
hwaddr_ ?
hwaddr_->toText(
false) :
"(none)") <<
"\n"
593 stream <<
"User context: " <<
getContext()->str() <<
"\n";
596 return (stream.str());
680 if (!lease->addr_.isV6()) {
688 " or it is not a string value");
691 lease->type_ =
textToType(lease_type->stringValue());
698 " or it is not a number");
701 if ((prefix_len->intValue() < 1) || (prefix_len->intValue() > 128)) {
703 <<
" must be in range of [1..128]");
706 lease->prefixlen_ =
static_cast<uint8_t
>(prefix_len->intValue());
713 " or it is not a number");
716 if (iaid->intValue() < 0) {
720 lease->iaid_ =
static_cast<uint32_t
>(iaid->intValue());
726 " or it is not a string");
731 lease->duid_.reset(
new DUID(parsed_duid.
getDuid()));
733 }
catch (
const std::exception& ex) {
735 << duid->stringValue() <<
" in the parsed lease");
742 " or is not a number");
745 if (preferred_lft->intValue() < 0) {
747 <<
" must not be negative");
750 lease->preferred_lft_ =
static_cast<uint32_t
>(preferred_lft->intValue());
A generic exception that is thrown if a parameter given to a method is considered invalid in that con...
A generic exception that is thrown if a function is called in a prohibited way.
A generic exception that is thrown when an unexpected error condition occurs.
The IOAddress class represents an IP addresses (version agnostic)
std::string toText() const
Convert the address to a string.
static ElementPtr create(const Position &pos=ZERO_POSITION())
static ElementPtr createMap(const Position &pos=ZERO_POSITION())
Creates an empty MapElement type ElementPtr.
Holds Client identifier or client IPv4 address.
static ClientIdPtr fromText(const std::string &text)
Create client identifier from the textual format.
Holds DUID (DHCPv6 Unique Identifier)
static DUID fromText(const std::string &text)
Create DUID from the textual format.
static const DUID & EMPTY()
Defines the constant "empty" DUID.
const std::vector< uint8_t > & getDuid() const
Returns a const reference to the actual DUID value.
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
A wrapper interface for the ASIO library.
boost::shared_ptr< const Element > ConstElementPtr
boost::shared_ptr< Element > ElementPtr
boost::shared_ptr< DUID > DuidPtr
boost::shared_ptr< Lease6 > Lease6Ptr
Pointer to a Lease6 structure.
std::ostream & operator<<(std::ostream &os, const OpaqueDataTuple &tuple)
Inserts the OpaqueDataTuple as a string into stream.
boost::shared_ptr< HWAddr > HWAddrPtr
Shared pointer to a hardware address structure.
uint32_t SubnetID
Defines unique IPv4 or IPv6 subnet identifier.
boost::shared_ptr< Lease > LeasePtr
Pointer to the lease object.
boost::shared_ptr< ClientId > ClientIdPtr
Shared pointer to a Client ID.
@ HTYPE_ETHER
Ethernet 10Mbps.
boost::shared_ptr< Lease4 > Lease4Ptr
Pointer to a Lease4 structure.
bool nullOrEqualValues(const T &ptr1, const T &ptr2)
This function checks if two pointers are both null or both are non-null and they point to equal value...
bool equalValues(const T &ptr1, const T &ptr2)
This function checks if two pointers are non-null and values are equal.
Defines the logger used by the top-level component of kea-lfc.
data::ConstElementPtr getContext() const
Returns const pointer to the user context.
void contextToElement(data::ElementPtr map) const
Merge unparse a user_context object.
void setContext(const data::ConstElementPtr &ctx)
Sets user context.
Hardware type that represents information from DHCPv4 packet.
static HWAddr fromText(const std::string &text, const uint16_t htype=HTYPE_ETHER)
Creates instance of the hardware address from textual format.
std::vector< uint8_t > hwaddr_
Structure that holds a lease for IPv4 address.
ClientIdPtr client_id_
Client identifier.
void decline(uint32_t probation_period)
Sets IPv4 lease to declined state.
static std::string statesToText(const uint32_t state)
Returns name of the lease states specific to DHCPv4.
bool operator==(const Lease4 &other) const
Compare two leases for equality.
const std::vector< uint8_t > & getClientIdVector() const
Returns a client identifier.
virtual isc::data::ElementPtr toElement() const
Return the JSON representation of a lease.
bool belongsToClient(const HWAddrPtr &hw_address, const ClientIdPtr &client_id) const
Check if the lease belongs to the client with the given identifiers.
Lease4()
Default constructor.
Lease4 & operator=(const Lease4 &other)
Assignment operator.
virtual std::string toText() const
Convert lease to printable form.
static Lease4Ptr fromElement(const data::ConstElementPtr &element)
Returns pointer to the IPv4 lease created from JSON representation.
Structure that holds a lease for IPv6 address and/or prefix.
const std::vector< uint8_t > & getDuidVector() const
Returns a reference to a vector representing a DUID.
virtual std::string toText() const
Convert Lease to Printable Form.
bool operator==(const Lease6 &other) const
Compare two leases for equality.
static std::string statesToText(const uint32_t state)
Returns name of the lease states specific to DHCPv6.
Lease::Type type_
Lease type.
uint32_t reuseable_preferred_lft_
Remaining preferred lifetime.
uint32_t iaid_
Identity Association Identifier (IAID)
uint32_t preferred_lft_
Preferred lifetime.
DuidPtr duid_
Client identifier.
static Lease6Ptr fromElement(const data::ConstElementPtr &element)
Returns pointer to the IPv6 lease created from JSON representation.
uint8_t prefixlen_
IPv6 prefix length.
virtual isc::data::ElementPtr toElement() const
Return the JSON representation of a lease.
void decline(uint32_t probation_period)
Sets IPv6 lease to declined state.
a common structure for IPv4 and IPv6 leases
void updateCurrentExpirationTime()
Update lease current expiration time with new value, so that additional operations can be done withou...
bool hasIdenticalFqdn(const Lease &other) const
Returns true if the other lease has equal FQDN data.
static const uint32_t INFINITY_LFT
Infinity (means static, i.e. never expire)
uint32_t reuseable_valid_lft_
Remaining valid lifetime.
static std::string lifetimeToText(uint32_t lifetime)
Print lifetime.
bool stateDeclined() const
Indicates if the lease is in the "declined" state.
bool stateExpiredReclaimed() const
Indicates if the lease is in the "expired-reclaimed" state.
static const uint32_t STATE_DEFAULT
A lease in the default state.
uint32_t current_valid_lft_
Current valid lifetime.
SubnetID subnet_id_
Subnet identifier.
const std::vector< uint8_t > & getHWAddrVector() const
Returns raw (as vector) hardware address.
uint32_t valid_lft_
Valid lifetime.
static std::string basicStatesToText(const uint32_t state)
Returns name(s) of the basic lease state(s).
static const uint32_t STATE_DECLINED
Declined lease.
bool expired() const
returns true if the lease is expired
Lease(const isc::asiolink::IOAddress &addr, uint32_t valid_lft, SubnetID subnet_id, time_t cltt, const bool fqdn_fwd, const bool fqdn_rev, const std::string &hostname, const HWAddrPtr &hwaddr)
Constructor.
static const uint32_t STATE_EXPIRED_RECLAIMED
Expired and reclaimed lease.
Type
Type of lease or pool.
@ TYPE_TA
the lease contains temporary IPv6 address
@ TYPE_PD
the lease contains IPv6 prefix (for prefix delegation)
@ TYPE_NA
the lease contains non-temporary IPv6 address
static void syncCurrentExpirationTime(const Lease &from, Lease &to)
Sync lease current expiration time with new value from another lease, so that additional operations c...
std::string hostname_
Client hostname.
uint32_t state_
Holds the lease state(s).
int64_t getExpirationTime() const
Returns lease expiration time.
bool fqdn_fwd_
Forward zone updated?
time_t cltt_
Client last transmission time.
virtual std::string toText() const =0
Convert Lease to Printable Form.
static void fromElementCommon(const LeasePtr &lease, const data::ConstElementPtr &element)
Sets common (for v4 and v6) properties of the lease object.
static std::string typeToText(Type type)
returns text representation of a lease type
static Type textToType(const std::string &text)
Converts type name to the actual type.
HWAddrPtr hwaddr_
Client's MAC/hardware address.
bool fqdn_rev_
Reverse zone updated?
isc::asiolink::IOAddress addr_
IPv4 ot IPv6 address.
time_t current_cltt_
Current client last transmission time.