dhcp4_srv.h 31.1 KB
Newer Older
1
// Copyright (C) 2011-2014 Internet Systems Consortium, Inc. ("ISC")
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
//
// 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.

#ifndef DHCPV4_SRV_H
#define DHCPV4_SRV_H

18
#include <dhcp/dhcp4.h>
19
20
#include <dhcp/pkt4.h>
#include <dhcp/option.h>
21
#include <dhcp/option_string.h>
22
#include <dhcp/option4_client_fqdn.h>
23
#include <dhcp/option_custom.h>
24
#include <dhcp_ddns/ncr_msg.h>
25
#include <dhcpsrv/d2_client_mgr.h>
26
27
#include <dhcpsrv/subnet.h>
#include <dhcpsrv/alloc_engine.h>
28
#include <hooks/callout_handle.h>
29
#include <dhcpsrv/daemon.h>
30
31
32

#include <boost/noncopyable.hpp>

33
#include <iostream>
34
#include <queue>
35
36
37

namespace isc {
namespace dhcp {
38

39
40
41
42
43
44
45
/// @brief Exception thrown when DHCID computation failed.
class DhcidComputeError : public isc::Exception {
public:
    DhcidComputeError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};

46
47
48
49
50
51
52
53
/// @brief DHCPv4 server service.
///
/// This singleton class represents DHCPv4 server. It contains all
/// top-level methods and routines necessary for server operation.
/// In particular, it instantiates IfaceMgr, loads or generates DUID
/// that is going to be used as server-identifier, receives incoming
/// packets, processes them, manages leases assignment and generates
/// appropriate responses.
54
55
///
/// This class does not support any controlling mechanisms directly.
56
/// See the derived \ref ControlledDhcpv4Srv class for support for
57
58
59
60
/// command and configuration updates over msgq.
///
/// For detailed explanation or relations between main(), ControlledDhcpv4Srv,
/// Dhcpv4Srv and other classes, see \ref dhcpv4Session.
61
class Dhcpv4Srv : public Daemon {
62

63
public:
64
65
66
67
68
69
70
71

    /// @brief defines if certain option may, must or must not appear
    typedef enum {
        FORBIDDEN,
        MANDATORY,
        OPTIONAL
    } RequirementLevel;

72
73
    /// @brief Default constructor.
    ///
74
    /// Instantiates necessary services, required to run DHCPv4 server.
75
76
    /// In particular, creates IfaceMgr that will be responsible for
    /// network interaction. Will instantiate lease manager, and load
Tomek Mrugalski's avatar
Tomek Mrugalski committed
77
78
    /// old or create new DUID. It is possible to specify alternate
    /// port on which DHCPv4 server will listen on. That is mostly useful
79
80
    /// for testing purposes. The Last two arguments of the constructor
    /// should be left at default values for normal server operation.
Marcin Siodelski's avatar
Marcin Siodelski committed
81
82
83
    /// They should be set to 'false' when creating an instance of this
    /// class for unit testing because features they enable require
    /// root privileges.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
84
85
    ///
    /// @param port specifies port number to listen on
86
87
    /// @param dbconfig Lease manager configuration string.  The default
    ///        of the "memfile" manager is used for testing.
88
    /// @param use_bcast configure sockets to support broadcast messages.
89
90
    /// @param direct_response_desired specifies if it is desired to
    /// use direct V4 traffic.
91
    Dhcpv4Srv(uint16_t port = DHCP4_SERVER_PORT,
92
              const char* dbconfig = "type=memfile universe=4",
93
94
              const bool use_bcast = true,
              const bool direct_response_desired = true);
95

96
    /// @brief Destructor. Used during DHCPv4 service shutdown.
97
    virtual ~Dhcpv4Srv();
98
99
100
101
102
103
104
105
106
107
108

    /// @brief Main server processing loop.
    ///
    /// Main server processing loop. Receives incoming packets, verifies
    /// their correctness, generates appropriate answer (if needed) and
    /// transmits respones.
    ///
    /// @return true, if being shut down gracefully, fail if experienced
    ///         critical error.
    bool run();

109
    /// @brief Instructs the server to shut down.
110
111
    void shutdown();

112
113
114
115
116
    /// @brief Return textual type of packet received by server
    ///
    /// Returns the name of valid packet received by the server (e.g. DISCOVER).
    /// If the packet is unknown - or if it is a valid DHCP packet but not one
    /// expected to be received by the server (such as an OFFER), the string
117
    /// "UNKNOWN" is returned.  This method is used in debug messages.
118
119
120
121
    ///
    /// As the operation of the method does not depend on any server state, it
    /// is declared static.
    ///
122
123
    /// @todo: This should be named static Pkt4::getName()
    ///
124
125
126
127
128
129
130
    /// @param type DHCPv4 packet type
    ///
    /// @return Pointer to "const" string containing the packet name.
    ///         Note that this string is statically allocated and MUST NOT
    ///         be freed by the caller.
    static const char* serverReceivedPacketName(uint8_t type);

131
132
133
134
135
136
137
138
139
140
141
142
    ///
    /// @name Public accessors returning values required to (re)open sockets.
    ///
    /// These accessors must be public because sockets are reopened from the
    /// static configuration callback handler. This callback handler invokes
    /// @c ControlledDhcpv4Srv::openActiveSockets which requires parameters
    /// which has to be retrieved from the @c ControlledDhcpv4Srv object.
    /// They are retrieved using these public functions
    //@{
    ///
    /// @brief Get UDP port on which server should listen.
    ///
143
144
145
    /// Typically, server listens on UDP port number 67. Other ports are used
    /// for testing purposes only.
    ///
146
147
148
149
150
151
152
153
154
155
156
157
158
159
    /// @return UDP port on which server should listen.
    uint16_t getPort() const {
        return (port_);
    }

    /// @brief Return bool value indicating that broadcast flags should be set
    /// on sockets.
    ///
    /// @return A bool value indicating that broadcast should be used (if true).
    bool useBroadcast() const {
        return (use_bcast_);
    }
    //@}

160
161
162
163
164
165
166
167
168
169
170
    /// @brief Open sockets which are marked as active in @c CfgMgr.
    ///
    /// This function reopens sockets according to the current settings in the
    /// Configuration Manager. It holds the list of the interfaces which server
    /// should listen on. This function will open sockets on these interfaces
    /// only. This function is not exception safe.
    ///
    /// @param port UDP port on which server should listen.
    /// @param use_bcast should broadcast flags be set on the sockets.
    static void openActiveSockets(const uint16_t port, const bool use_bcast);

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
    /// @brief Starts DHCP_DDNS client IO if DDNS updates are enabled.
    ///
    /// If updates are enabled, it Instructs the D2ClientMgr singleton to
    /// enter send mode.  If D2ClientMgr encounters errors it may throw
    /// D2ClientErrors. This method does not catch exceptions.
    void startD2();

    /// @brief Implements the error handler for DHCP_DDNS IO errors
    ///
    /// Invoked when a NameChangeRequest send to b10-dhcp-ddns completes with
    /// a failed status.  These are communications errors, not data related
    /// failures.
    ///
    /// This method logs the failure and then suspends all further updates.
    /// Updating can only be restored by reconfiguration or restarting the
    /// server.  There is currently no retry logic so the first IO error that
    /// occurs will suspend updates.
    /// @todo We may wish to make this more robust or sophisticated.
    ///
    /// @param result Result code of the send operation.
    /// @param ncr NameChangeRequest which failed to send.
    virtual void d2ClientErrorHandler(const dhcp_ddns::
                                      NameChangeSender::Result result,
                                      dhcp_ddns::NameChangeRequestPtr& ncr);
195
protected:
196

197
198
199
200
201
202
203
    /// @name Functions filtering and sanity-checking received messages.
    ///
    /// @todo These functions are supposed to be moved to a new class which
    /// will manage different rules for accepting and rejecting messages.
    /// Perhaps ticket #3116 is a good opportunity to do it.
    ///
    //@{
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
    /// @brief Checks whether received message should be processed or discarded.
    ///
    /// This function checks whether received message should be processed or
    /// discarded. It should be called on the beginning of message processing
    /// (just after the message has been decoded). This message calls a number
    /// of other functions which check whether message should be processed,
    /// using different criteria.
    ///
    /// This function should be extended when new criteria for accepting
    /// received message have to be implemented. This function is meant to
    /// aggregate all early filtering checks on the received message. By having
    /// a single function like this, we are avoiding bloat of the server's main
    /// loop.
    ///
    /// @warning This function should remain exception safe.
    ///
    /// @param query Received message.
    ///
    /// @return true if the message should be further processed, or false if
    /// the message should be discarded.
    bool accept(const Pkt4Ptr& query) const;

    /// @brief Check if a message sent by directly connected client should be
    /// accepted or discared.
    ///
    /// This function checks if the received message is from directly connected
    /// client. If it is, it checks that it should be processed or discarded.
    ///
    /// Note that this function doesn't validate all addresses being carried in
    /// the message. The primary purpose of this function is to filter out
    /// direct messages in the local network for which there is no suitable
    /// subnet configured. For example, this function accepts unicast messages
    /// because unicasts may be used by clients located in remote networks to
    /// to renew existing leases. If their notion of address is wrong, the
    /// server will have to sent a NAK, instead of dropping the message.
    /// Detailed validation of such messages is performed at later stage of
    /// processing.
    ///
    /// This function accepts the following messages:
    /// - all valid relayed messages,
    /// - all unicast messages,
    /// - all broadcast messages received on the interface for which the
    /// suitable subnet exists (is configured).
    ///
248
    /// @param query Message sent by a client.
249
250
251
    ///
    /// @return true if message is accepted for further processing, false
    /// otherwise.
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
    bool acceptDirectRequest(const Pkt4Ptr& query) const;

    /// @brief Check if received message type is valid for the server to
    /// process.
    ///
    /// This function checks that the received message type belongs to the range
    /// of types regonized by the server and that the message of this type
    /// should be processed by the server.
    ///
    /// The messages types accepted for processing are:
    /// - Discover
    /// - Request
    /// - Release
    /// - Decline
    /// - Inform
    ///
    /// @param query Message sent by a client.
    ///
    /// @return true if message is accepted for further processing, false
    /// otherwise.
    bool acceptMessageType(const Pkt4Ptr& query) const;
273

274
275
276
277
278
279
280
281
282
283
284
285
286
287
    /// @brief Verifies if the server id belongs to our server.
    ///
    /// This function checks if the server identifier carried in the specified
    /// DHCPv4 message belongs to this server. If the server identifier option
    /// is absent or the value carried by this option is equal to one of the
    /// server identifiers used by the server, the true is returned. If the
    /// server identifier option is present, but it doesn't match any server
    /// identifier used by this server, the false value is returned.
    ///
    /// @param pkt DHCPv4 message which server identifier is to be checked.
    ///
    /// @return true, if the server identifier is absent or matches one of the
    /// server identifiers that the server is using; false otherwise.
    bool acceptServerId(const Pkt4Ptr& pkt) const;
288
    //@}
289

290
291
292
293
294
295
296
297
    /// @brief verifies if specified packet meets RFC requirements
    ///
    /// Checks if mandatory option is really there, that forbidden option
    /// is not there, and that client-id or server-id appears only once.
    ///
    /// @param pkt packet to be checked
    /// @param serverid expectation regarding server-id option
    /// @throw RFCViolation if any issues are detected
298
    static void sanityCheck(const Pkt4Ptr& pkt, RequirementLevel serverid);
299

300
301
302
303
304
305
    /// @brief Processes incoming DISCOVER and returns response.
    ///
    /// Processes received DISCOVER message and verifies that its sender
    /// should be served. In particular, a lease is selected and sent
    /// as an offer to a client if it should be served.
    ///
306
    /// @param discover DISCOVER message received from client
307
308
    ///
    /// @return OFFER message or NULL
309
    Pkt4Ptr processDiscover(Pkt4Ptr& discover);
310
311
312
313
314

    /// @brief Processes incoming REQUEST and returns REPLY response.
    ///
    /// Processes incoming REQUEST message and verifies that its sender
    /// should be served. In particular, verifies that requested lease
Tomek Mrugalski's avatar
Tomek Mrugalski committed
315
    /// is valid, not expired, not reserved, not used by other client and
316
317
    /// that requesting client is allowed to use it.
    ///
318
    /// Returns ACK message, NAK message, or NULL
319
320
321
    ///
    /// @param request a message received from client
    ///
322
    /// @return ACK or NAK message
323
    Pkt4Ptr processRequest(Pkt4Ptr& request);
324
325
326
327
328
329
330

    /// @brief Stub function that will handle incoming RELEASE messages.
    ///
    /// In DHCPv4, server does not respond to RELEASE messages, therefore
    /// this function does not return anything.
    ///
    /// @param release message received from client
331
    void processRelease(Pkt4Ptr& release);
332
333
334
335

    /// @brief Stub function that will handle incoming DHCPDECLINE messages.
    ///
    /// @param decline message received from client
336
    void processDecline(Pkt4Ptr& decline);
337
338
339

    /// @brief Stub function that will handle incoming INFORM messages.
    ///
340
    /// @param inform message received from client
341
    Pkt4Ptr processInform(Pkt4Ptr& inform);
342

343
344
345
346
347
348
349
    /// @brief Copies default parameters from client's to server's message
    ///
    /// Some fields are copied from client's message into server's response,
    /// e.g. client HW address, number of hops, transaction-id etc.
    ///
    /// @param question any message sent by client
    /// @param answer any message server is going to send as response
350
    void copyDefaultFields(const Pkt4Ptr& question, Pkt4Ptr& answer);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
351
352
353
354

    /// @brief Appends options requested by client.
    ///
    /// This method assigns options that were requested by client
Tomek Mrugalski's avatar
Tomek Mrugalski committed
355
    /// (sent in PRL) or are enforced by server.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
356
    ///
357
    /// @param question DISCOVER or REQUEST message from a client.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
358
    /// @param msg outgoing message (options will be added here)
359
    void appendRequestedOptions(const Pkt4Ptr& question, Pkt4Ptr& msg);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
360

361
362
363
364
365
366
367
368
369
    /// @brief Appends requested vendor options as requested by client.
    ///
    /// This method is similar to \ref appendRequestedOptions(), but uses
    /// vendor options. The major difference is that vendor-options use
    /// its own option spaces (there may be more than one distinct set of vendor
    /// options, each with unique vendor-id). Vendor options are requested
    /// using separate options within their respective vendor-option spaces.
    ///
    /// @param question DISCOVER or REQUEST message from a client.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
370
    /// @param answer outgoing message (options will be added here)
371
372
    void appendRequestedVendorOptions(const Pkt4Ptr& question, Pkt4Ptr& answer);

Tomek Mrugalski's avatar
Tomek Mrugalski committed
373
374
375
376
377
378
    /// @brief Assigns a lease and appends corresponding options
    ///
    /// This method chooses the most appropriate lease for reqesting
    /// client and assigning it. Options corresponding to the lease
    /// are added to specific message.
    ///
379
380
381
382
    /// @param question DISCOVER or REQUEST message from client
    /// @param answer OFFER or ACK/NAK message (lease options will be added here)
    void assignLease(const Pkt4Ptr& question, Pkt4Ptr& answer);

383
384
385
386
387
388
389
390
391
392
393
394
395
    /// @brief Append basic options if they are not present.
    ///
    /// This function adds the following basic options if they
    /// are not yet added to the message:
    /// - Subnet Mask,
    /// - Router,
    /// - Name Server,
    /// - Domain Name.
    ///
    /// @param question DISCOVER or REQUEST message from a client.
    /// @param msg the message to add options to.
    void appendBasicOptions(const Pkt4Ptr& question, Pkt4Ptr& msg);

396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
    /// @brief Processes Client FQDN and Hostname Options sent by a client.
    ///
    /// Client may send Client FQDN or Hostname option to communicate its name
    /// to the server. Server may use this name to perform DNS update for the
    /// lease being assigned to a client. If server takes responsibility for
    /// updating DNS for a client it may communicate it by sending the Client
    /// FQDN or Hostname %Option back to the client. Server select a different
    /// name than requested by a client to update DNS. In such case, the server
    /// stores this different name in its response.
    ///
    /// Client should not send both Client FQDN and Hostname options. However,
    /// if client sends both options, server should prefer Client FQDN option
    /// and ignore the Hostname option. If Client FQDN option is not present,
    /// the Hostname option is processed.
    ///
    /// The Client FQDN %Option is processed by this function as described in
    /// RFC4702.
    ///
    /// In response to a Hostname %Option sent by a client, the server may send
    /// Hostname option with the same or different hostname. If different
    /// hostname is sent, it is an indication to the client that server has
    /// overridden the client's preferred name and will rather use this
    /// different name to update DNS. However, since Hostname option doesn't
    /// carry an information whether DNS update will be carried by the server
    /// or not, the client is responsible for checking whether DNS update
    /// has been performed.
    ///
    /// After successful processing options stored in the first parameter,
    /// this function may add Client FQDN or Hostname option to the response
    /// message. In some cases, server may cease to add any options to the
    /// response, i.e. when server doesn't support DNS updates.
    ///
428
429
430
    /// This function does not throw. It simply logs the debug message if the
    /// processing of the FQDN or Hostname failed.
    ///
431
432
433
434
    /// @param query A DISCOVER or REQUEST message from a cient.
    /// @param [out] answer A response message to be sent to a client.
    void processClientName(const Pkt4Ptr& query, Pkt4Ptr& answer);

435
436
437
438
439
440
441
442
    /// @brief this is a prefix added to the contend of vendor-class option
    ///
    /// If incoming packet has a vendor class option, its content is
    /// prepended with this prefix and then interpreted as a class.
    /// For example, a packet that sends vendor class with value of "FOO"
    /// will cause the packet to be assigned to class VENDOR_CLASS_FOO.
    static const std::string VENDOR_CLASS_PREFIX;

443
444
445
private:
    /// @brief Process Client FQDN %Option sent by a client.
    ///
446
447
448
449
450
451
    /// This function is called by the @c Dhcpv4Srv::processClientName when
    /// the client has sent the FQDN option in its message to the server.
    /// It comprises the actual logic to parse the FQDN option and prepare
    /// the FQDN option to be sent back to the client in the server's
    /// response.
    ///
452
    /// @param fqdn An DHCPv4 Client FQDN %Option sent by a client.
453
    /// @param [out] answer A response message to be sent to a client.
454
455
    void processClientFqdnOption(const Option4ClientFqdnPtr& fqdn,
                                 Pkt4Ptr& answer);
456
457
458

    /// @brief Process Hostname %Option sent by a client.
    ///
459
460
461
462
463
464
    /// This function is called by the @c DHcpv4Srv::processClientName when
    /// the client has sent the Hostname option in its message to the server.
    /// It comprises the actual logic to parse the Hostname option and
    /// prepare the Hostname option to be sent back to the client in the
    /// server's response.
    ///
465
    /// @param opt_hostname An @c OptionString object encapsulating the Hostname
466
    /// %Option.
467
    /// @param [out] answer A response message to be sent to a client.
468
    void processHostnameOption(const OptionStringPtr& opt_hostname,
469
                               Pkt4Ptr& answer);
470
471

protected:
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489

    /// @brief Creates NameChangeRequests which correspond to the lease
    /// which has been acquired.
    ///
    /// If this function is called whe an existing lease is renewed, it
    /// may generate NameChangeRequest to remove existing DNS entries which
    /// correspond to the old lease instance. This function may cease to
    /// generate NameChangeRequests if the notion of the client's FQDN hasn't
    /// changed between an old and new lease.
    ///
    /// @param lease A pointer to the new lease which has been acquired.
    /// @param old_lease A pointer to the instance of the old lease which has
    /// been replaced by the new lease passed in the first argument. The NULL
    /// value indicates that the new lease has been allocated, rather than
    /// lease being renewed.
    void createNameChangeRequests(const Lease4Ptr& lease,
                                  const Lease4Ptr& old_lease);

490
491
    /// @brief Creates the NameChangeRequest and adds to the queue for
    /// processing.
492
    ///
493
494
495
496
    /// This creates the @c isc::dhcp_ddns::NameChangeRequest; emits a
    /// the debug message which indicates whether the request being added is
    /// to remove DNS entry or add a new entry; and then sends the request
    /// to the D2ClientMgr for transmission to b10-dhcp-ddns.
497
    ///
498
    /// @param chg_type A type of the NameChangeRequest (ADD or REMOVE).
499
500
    /// @param lease A lease for which the NameChangeRequest is created and
    /// queued.
501
502
    void queueNameChangeRequest(const isc::dhcp_ddns::NameChangeType chg_type,
                                const Lease4Ptr& lease);
503

504
505
506
507
508
    /// @brief Attempts to renew received addresses
    ///
    /// Attempts to renew existing lease. This typically includes finding a lease that
    /// corresponds to the received address. If no such lease is found, a status code
    /// response is generated.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
509
    ///
510
511
512
    /// @param renew client's message asking for renew
    /// @param reply server's response (ACK or NAK)
    void renewLease(const Pkt4Ptr& renew, Pkt4Ptr& reply);
Tomek Mrugalski's avatar
Tomek Mrugalski committed
513

514
515
    /// @brief Appends default options to a message
    ///
516
517
518
519
    /// Currently it is only a Message Type option. This function does not add
    /// the Server Identifier option as this option must be added using
    /// @c Dhcpv4Srv::appendServerID.
    ///
520
    ///
521
522
    /// @param msg message object (options will be added to it)
    /// @param msg_type specifies message type
523
    void appendDefaultOptions(Pkt4Ptr& msg, uint8_t msg_type);
524

525
526
    /// @brief Adds server identifier option to the server's response.
    ///
527
    /// This method adds a server identifier to the DHCPv4 message. It epxects
528
529
530
531
532
533
534
535
536
537
538
    /// that the local (source) address is set for this message. If address is
    /// not set, it will throw an exception. This method also expects that the
    /// server identifier option is not present in the specified message.
    /// Otherwise, it will throw an exception on attempt to add a duplicate
    /// server identifier option.
    ///
    /// @note This method doesn't throw exceptions by itself but the underlying
    /// classes being used my throw. The reason for this method to not sanity
    /// check the specified message is that it is meant to be called internally
    /// by the @c Dhcpv4Srv class.
    ///
539
540
541
    /// @note This method is static because it is not dependent on the class
    /// state.
    ///
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
    /// @param [out] response DHCPv4 message to which the server identifier
    /// option should be added.
    static void appendServerID(const Pkt4Ptr& response);

    /// @brief Set IP/UDP and interface parameters for the DHCPv4 response.
    ///
    /// This method sets the following parameters for the DHCPv4 message being
    /// sent to a client:
    /// - client unicast or a broadcast address,
    /// - client or relay port,
    /// - server address,
    /// - server port,
    /// - name and index of the interface which is to be used to send the
    /// message.
    ///
    /// Internally it calls the @c Dhcpv4Srv::adjustRemoteAddr to figure
    /// out the destination address (client unicast address or broadcast
    /// address).
    ///
    /// The destination port is always DHCPv4 client (68) or relay (67) port,
562
    /// depending if the response will be sent directly to a client.
563
564
565
566
567
568
569
570
571
572
    ///
    /// The source port is always set to DHCPv4 server port (67).
    ///
    /// The interface selected for the response is always the same as the
    /// one through which the query has been received.
    ///
    /// The source address for the response is the IPv4 address assigned to
    /// the interface being used to send the response. This function uses
    /// @c IfaceMgr to get the socket bound to the IPv4 address on the
    /// particular interface.
573
574
575
    ///
    /// @note This method is static because it is not dependent on the class
    /// state.
576
577
    static void adjustIfaceData(const Pkt4Ptr& query, const Pkt4Ptr& response);

578
579
580
581
582
583
584
585
586
587
588
589
590
    /// @brief Sets remote addresses for outgoing packet.
    ///
    /// This method sets the local and remote addresses on outgoing packet.
    /// The addresses being set depend on the following conditions:
    /// - has incoming packet been relayed,
    /// - is direct response to a client without address supported,
    /// - type of the outgoing packet,
    /// - broadcast flag set in the incoming packet.
    ///
    /// @warning This method does not check whether provided packet pointers
    /// are valid. Make sure that pointers are correct before calling this
    /// function.
    ///
591
592
593
    /// @note This method is static because it is not dependent on the class
    /// state.
    ///
594
    /// @param question instance of a packet received by a server.
595
596
597
598
    /// @param [out] response response packet which addresses are to be
    /// adjusted.
    static void adjustRemoteAddr(const Pkt4Ptr& question,
                                 const Pkt4Ptr& response);
599

600
601
602
603
604
605
606
    /// @brief converts server-id to text
    /// Converts content of server-id option to a text representation, e.g.
    /// "192.0.2.1"
    ///
    /// @param opt option that contains server-id
    /// @return string representation
    static std::string srvidToString(const OptionPtr& opt);
607

608
    /// @brief Computes DHCID from a lease.
609
    ///
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
    /// This method creates an object which represents DHCID. The DHCID value
    /// is computed as described in RFC4701. The section 3.3. of RFC4701
    /// specifies the DHCID RR Identifier Type codes:
    /// - 0x0000 The 1 octet htype followed by glen octets of chaddr
    /// - 0x0001 The data octets from the DHCPv4 client's Client Identifier
    /// option.
    /// - 0x0002 The client's DUID.
    ///
    /// Currently this function supports first two of these identifiers.
    /// The 0x0001 is preferred over the 0x0000 - if the client identifier
    /// option is present, the former is used. If the client identifier
    /// is absent, the latter is used.
    ///
    /// @todo Implement support for 0x0002 DHCID identifier type.
    ///
625
    /// @param lease A pointer to the structure describing a lease.
626
    /// @return An object encapsulating DHCID to be used for DNS updates.
627
    /// @throw DhcidComputeError If the computation of the DHCID failed.
628
    static isc::dhcp_ddns::D2Dhcid computeDhcid(const Lease4Ptr& lease);
629

630
631
632
633
    /// @brief Selects a subnet for a given client's packet.
    ///
    /// @param question client's message
    /// @return selected subnet (or NULL if no suitable subnet was found)
634
    isc::dhcp::Subnet4Ptr selectSubnet(const Pkt4Ptr& question) const;
635

636
637
    /// indicates if shutdown is in progress. Setting it to true will
    /// initiate server shutdown procedure.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
638
    volatile bool shutdown_;
639

640
641
642
643
644
645
646
647
648
649
650
651
    /// @brief dummy wrapper around IfaceMgr::receive4
    ///
    /// This method is useful for testing purposes, where its replacement
    /// simulates reception of a packet. For that purpose it is protected.
    virtual Pkt4Ptr receivePacket(int timeout);

    /// @brief dummy wrapper around IfaceMgr::send()
    ///
    /// This method is useful for testing purposes, where its replacement
    /// simulates transmission of a packet. For that purpose it is protected.
    virtual void sendPacket(const Pkt4Ptr& pkt);

652
653
654
655
656
657
658
659
660
661
662
663
    /// @brief Implements a callback function to parse options in the message.
    ///
    /// @param buf a A buffer holding options in on-wire format.
    /// @param option_space A name of the option space which holds definitions
    /// of to be used to parse options in the packets.
    /// @param [out] options A reference to the collection where parsed options
    /// will be stored.
    /// @return An offset to the first byte after last parsed option.
    size_t unpackOptions(const OptionBuffer& buf,
                         const std::string& option_space,
                         isc::dhcp::OptionCollection& options);

664
665
666
667
668
669
670
    /// @brief Assigns incoming packet to zero or more classes.
    ///
    /// @note For now, the client classification is very simple. It just uses
    /// content of the vendor-class-identifier option as a class. The resulting
    /// class will be stored in packet (see @ref isc::dhcp::Pkt4::classes_ and
    /// @ref isc::dhcp::Pkt4::inClass).
    ///
671
672
673
674
675
676
677
678
679
680
681
682
    /// @param pkt packet to be classified
    void classifyPacket(const Pkt4Ptr& pkt);

    /// @brief Performs packet processing specific to a class
    ///
    /// This processing is a likely candidate to be pushed into hooks.
    ///
    /// @param query incoming client's packet
    /// @param rsp server's response
    /// @return true if successful, false otherwise (will prevent sending response)
    bool classSpecificProcessing(const Pkt4Ptr& query, const Pkt4Ptr& rsp);

683
private:
684
685

    /// @brief Constructs netmask option based on subnet4
686
    /// @param subnet subnet for which the netmask will be calculated
687
688
689
690
    ///
    /// @return Option that contains netmask information
    static OptionPtr getNetmaskOption(const Subnet4Ptr& subnet);

691
692
693
694
695
696
697
698
699
    /// @brief Implements the error handler for socket open failure.
    ///
    /// This callback function is installed on the @c isc::dhcp::IfaceMgr
    /// when IPv4 sockets are being open. When socket fails to open for
    /// any reason, this function is called. It simply logs the error message.
    ///
    /// @param errmsg An error message containing a cause of the failure.
    static void ifaceMgrSocket4ErrorHandler(const std::string& errmsg);

700
701
702
703
704
705
    /// @brief Allocation Engine.
    /// Pointer to the allocation engine that we are currently using
    /// It must be a pointer, because we will support changing engines
    /// during normal operation (e.g. to use different allocators)
    boost::shared_ptr<AllocEngine> alloc_engine_;

706
707
708
    uint16_t port_;  ///< UDP port number on which server listens.
    bool use_bcast_; ///< Should broadcast be enabled on sockets (if true).

709
710
711
712
    /// Indexes for registered hook points
    int hook_index_pkt4_receive_;
    int hook_index_subnet4_select_;
    int hook_index_pkt4_send_;
713
714
715
716
717
718
};

}; // namespace isc::dhcp
}; // namespace isc

#endif // DHCP4_SRV_H