14#include <boost/algorithm/string.hpp>
15#include <boost/scoped_ptr.hpp>
44 uint32_t valid_lft,
SubnetID subnet_id, time_t cltt,
45 const bool fqdn_fwd,
const bool fqdn_rev,
46 const std::string& hostname,
const HWAddrPtr& hwaddr)
47 : addr_(addr), valid_lft_(valid_lft), current_valid_lft_(valid_lft),
48 reuseable_valid_lft_(0),
49 cltt_(cltt), current_cltt_(cltt), subnet_id_(subnet_id), pool_id_(0),
50 hostname_(
boost::algorithm::to_lower_copy(hostname)), fqdn_fwd_(fqdn_fwd),
51 fqdn_rev_(fqdn_rev), hwaddr_(hwaddr), state_(STATE_DEFAULT) {
60 return string(
"IA_NA");
62 return string(
"IA_TA");
64 return string(
"IA_PD");
68 tmp <<
"unknown (" << type <<
")";
79 }
else if (text ==
"IA_NA") {
82 }
else if (text ==
"IA_TA") {
85 }
else if (text ==
"IA_PD") {
100 return (
"expired-reclaimed");
107 std::ostringstream s;
108 s <<
"unknown (" << state <<
")";
134 return (boost::algorithm::iequals(
hostname_, other.hostname_) &&
157 " or it is not a string");
160 boost::scoped_ptr<asiolink::IOAddress> io_address;
164 }
catch (
const std::exception& ex) {
166 <<
" in the parsed lease");
169 lease->addr_ = *io_address;
175 " or it is not an integer");
178 if (subnet_id->intValue() <= 0) {
180 <<
" a positive integer");
181 }
else if (subnet_id->intValue() > numeric_limits<uint32_t>::max()) {
183 <<
" a 32 bit unsigned integer");
186 lease->subnet_id_ =
SubnetID(subnet_id->intValue());
195 if (pool_id->intValue() <= 0) {
197 <<
" a positive integer");
198 }
else if (pool_id->intValue() > numeric_limits<uint32_t>::max()) {
200 <<
" a 32 bit unsigned integer");
203 lease->pool_id_ = pool_id->intValue();
218 }
catch (
const std::exception& ex) {
220 << hw_address->stringValue() <<
" in the parsed lease");
228 " or it is not an integer");
231 if (cltt->intValue() <= 0) {
233 " positive integer in the parsed lease");
236 lease->cltt_ =
static_cast<time_t
>(cltt->intValue());
242 " or it is not an integer");
245 if (valid_lifetime->intValue() < 0) {
247 <<
" is negative in the parsed lease");
250 lease->valid_lft_ = valid_lifetime->intValue();
256 " or it is not a boolean value");
259 lease->fqdn_fwd_ = fqdn_fwd->boolValue();
265 " or it is not a boolean value");
268 lease->fqdn_rev_ = fqdn_rev->boolValue();
274 " or it is not a string value");
277 lease->hostname_ = hostname->stringValue();
278 boost::algorithm::to_lower(lease->hostname_);
284 " or it is not an integer");
289 <<
" must be in range [0.."
293 lease->state_ = state->intValue();
301 lease->setContext(ctx);
304 lease->updateCurrentExpirationTime();
314 to.current_cltt_ = from.cltt_;
315 to.current_valid_lft_ = from.valid_lft_;
321 const uint32_t valid_lifetime,
326 const std::string& hostname)
327 :
Lease(address, valid_lifetime, subnet_id, cltt, fqdn_fwd,
328 fqdn_rev, hostname, hw_address),
329 client_id_(client_id), remote_id_(), relay_id_() {
340const std::vector<uint8_t>&
343 static std::vector<uint8_t> empty_vec;
350const std::vector<uint8_t>&
353 static std::vector<uint8_t> empty_vec;
424 if (!lease->addr_.isV4()) {
429 if (!lease->hwaddr_) {
444 }
catch (
const std::exception& ex) {
446 << client_id->stringValue() <<
" in the parsed lease");
454 DuidPtr duid, uint32_t iaid, uint32_t preferred, uint32_t valid,
456 :
Lease(addr, valid, subnet_id, 0, false, false,
"", hwaddr),
457 type_(type), prefixlen_(prefixlen), iaid_(iaid), duid_(duid),
458 preferred_lft_(preferred), reuseable_preferred_lft_(0),
464 if (prefixlen != 128) {
475 DuidPtr duid, uint32_t iaid, uint32_t preferred, uint32_t valid,
476 SubnetID subnet_id,
const bool fqdn_fwd,
const bool fqdn_rev,
477 const std::string& hostname,
const HWAddrPtr& hwaddr,
479 :
Lease(addr, valid, subnet_id, 0,
480 fqdn_fwd, fqdn_rev, hostname, hwaddr),
481 type_(type), prefixlen_(prefixlen), iaid_(iaid), duid_(duid),
482 preferred_lft_(preferred), reuseable_preferred_lft_(0),
489 if (prefixlen != 128) {
501 HWAddrPtr()), type_(TYPE_NA), prefixlen_(0), iaid_(0),
502 duid_(
DuidPtr()), preferred_lft_(0), reuseable_preferred_lft_(0),
511const std::vector<uint8_t>&
514 static std::vector<uint8_t> empty_vec;
518 return (
duid_->getDuid());
536 ostringstream stream;
540 <<
static_cast<int>(
type_) <<
")\n"
541 <<
"Address: " <<
addr_ <<
"\n"
542 <<
"Prefix length: " <<
static_cast<int>(
prefixlen_) <<
"\n"
543 <<
"IAID: " <<
iaid_ <<
"\n"
546 <<
"Cltt: " <<
cltt_ <<
"\n"
547 <<
"DUID: " << (
duid_?
duid_->toText():
"(none)") <<
"\n"
548 <<
"Hardware addr: " << (
hwaddr_?
hwaddr_->toText(
false):
"(none)") <<
"\n"
554 stream <<
"User context: " <<
getContext()->str() <<
"\n";
557 return (stream.str());
562 ostringstream stream;
564 stream <<
"Address: " <<
addr_ <<
"\n"
566 <<
"Cltt: " <<
cltt_ <<
"\n"
567 <<
"Hardware addr: " << (
hwaddr_ ?
hwaddr_->toText(
false) :
"(none)") <<
"\n"
572 <<
"Relay ID: " << (
relay_id_.empty() ?
"(none)" :
574 <<
"Remote ID: " << (
remote_id_.empty() ?
"(none)" :
578 stream <<
"User context: " <<
getContext()->str() <<
"\n";
581 return (stream.str());
588 addr_ == other.addr_ &&
594 cltt_ == other.cltt_ &&
607 addr_ == other.addr_ &&
608 type_ == other.type_ &&
610 iaid_ == other.iaid_ &&
616 cltt_ == other.cltt_ &&
669 if (!lease->addr_.isV6()) {
677 " or it is not a string value");
680 lease->type_ =
textToType(lease_type->stringValue());
684 lease->prefixlen_ = 128;
689 " or it is not an integer");
692 if ((prefix_len->intValue() < 1) || (prefix_len->intValue() > 128)) {
694 <<
" must be in range of [1..128]");
697 lease->prefixlen_ =
static_cast<uint8_t
>(prefix_len->intValue());
704 " or it is not an integer");
707 if (iaid->intValue() < 0) {
711 lease->iaid_ =
static_cast<uint32_t
>(iaid->intValue());
717 " or it is not a string");
722 lease->duid_.reset(
new DUID(parsed_duid.getDuid()));
724 }
catch (
const std::exception& ex) {
726 << duid->stringValue() <<
" in the parsed lease");
733 " or is not an integer");
736 if (preferred_lft->intValue() < 0) {
738 <<
" must not be negative");
741 lease->preferred_lft_ =
static_cast<uint32_t
>(preferred_lft->intValue());
748 os << lease.toText();
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 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.
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.
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
A wrapper interface for the ASIO library.
std::ostream & operator<<(std::ostream &os, const IOAddress &address)
Insert the IOAddress as a string into stream.
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.
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.
string dumpAsHex(const uint8_t *data, size_t length)
Dumps a buffer of bytes as a string of hexadecimal digits.
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.
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.
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.
std::vector< uint8_t > remote_id_
Remote identifier for Bulk Lease Query.
std::vector< uint8_t > relay_id_
Relay identifier for Bulk Lease Query.
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.
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.
ExtendedInfoAction
Action on extended info tables.
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.
uint32_t pool_id_
The pool id.
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
static const uint32_t STATE_RELEASED
Released lease held in the database for lease affinity.
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.
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.