summaryrefslogtreecommitdiffstats
path: root/src/VBox/NetworkServices/Dhcpd/Config.cpp
blob: b11e29fda75c7f9a00dbb91d5be05b081bf2233a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
/* $Id: Config.cpp $ */
/** @file
 * DHCP server - server configuration
 */

/*
 * Copyright (C) 2017-2019 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#include "Config.h"

#include <iprt/types.h>
#include <iprt/net.h>           /* NB: must come before getopt.h */
#include <iprt/getopt.h>
#include <iprt/path.h>
#include <iprt/message.h>
#include <iprt/string.h>
#include <iprt/uuid.h>

#include <VBox/com/com.h>

#include <iostream>

class ConfigFileError
  : public RTCError
{
public:
    ConfigFileError(const char *pszMessage)
      : RTCError(pszMessage) {}

    ConfigFileError(const RTCString &a_rstrMessage)
      : RTCError(a_rstrMessage) {}
};


Config::Config()
  : m_strHome(),
    m_strNetwork(),
    m_strBaseName(),
    m_strTrunk(),
    m_enmTrunkType(kIntNetTrunkType_Invalid),
    m_MacAddress(),
    m_IPv4Address(),
    m_IPv4Netmask(),
    m_IPv4PoolFirst(),
    m_IPv4PoolLast(),
    m_GlobalOptions(),
    m_VMMap()
{
    return;
}


int Config::init()
{
    int rc;

    rc = homeInit();
    if (RT_FAILURE(rc))
        return rc;

    return VINF_SUCCESS;
}


int Config::homeInit()
{
    int rc;

    /* pathname of ~/.VirtualBox or equivalent */
    char szHome[RTPATH_MAX];
    rc = com::GetVBoxUserHomeDirectory(szHome, sizeof(szHome), false);
    if (RT_FAILURE(rc))
    {
        LogDHCP(("unable to find VirtualBox home directory: %Rrs", rc));
        return rc;
    }

    m_strHome.assign(szHome);
    return VINF_SUCCESS;
}


void Config::setNetwork(const std::string &aStrNetwork)
{
    AssertReturnVoid(m_strNetwork.empty());

    m_strNetwork = aStrNetwork;
    sanitizeBaseName();
}


/*
 * Requires network name to be known as the log file name depends on
 * it.  Alternatively, consider passing the log file name via the
 * command line?
 */
int Config::logInit()
{
    int rc;
    size_t cch;

    if (m_strHome.empty() || m_strBaseName.empty())
        return VERR_GENERAL_FAILURE;

    /* default log file name */
    char szLogFile[RTPATH_MAX];
    cch = RTStrPrintf(szLogFile, sizeof(szLogFile),
                      "%s%c%s-Dhcpd.log",
                      m_strHome.c_str(), RTPATH_DELIMITER, m_strBaseName.c_str());
    if (cch >= sizeof(szLogFile))
        return VERR_BUFFER_OVERFLOW;


    /* get a writable copy of the base name */
    char szBaseName[RTPATH_MAX];
    rc = RTStrCopy(szBaseName, sizeof(szBaseName), m_strBaseName.c_str());
    if (RT_FAILURE(rc))
        return rc;

    /* sanitize base name some more to be usable in an environment variable name */
    for (char *p = szBaseName; *p != '\0'; ++p)
    {
        if (   *p != '_'
            && (*p < '0' || '9' < *p)
            && (*p < 'a' || 'z' < *p)
            && (*p < 'A' || 'Z' < *p))
        {
            *p = '_';
        }
    }


    /* name of the environment variable to control logging */
    char szEnvVarBase[128];
    cch = RTStrPrintf(szEnvVarBase, sizeof(szEnvVarBase),
                      "VBOXDHCP_%s_RELEASE_LOG", szBaseName);
    if (cch >= sizeof(szEnvVarBase))
        return VERR_BUFFER_OVERFLOW;


    rc = com::VBoxLogRelCreate("DHCP Server",
                               szLogFile,
                               RTLOGFLAGS_PREFIX_TIME_PROG,
                               "all all.restrict -default.restrict",
                               szEnvVarBase,
                               RTLOGDEST_FILE
#ifdef DEBUG
                               | RTLOGDEST_STDERR
#endif
                               ,
                               32768 /* cMaxEntriesPerGroup */,
                               0 /* cHistory */,
                               0 /* uHistoryFileTime */,
                               0 /* uHistoryFileSize */,
                               NULL /* pErrInfo */);

    return rc;
}


int Config::complete()
{
    int rc;

    if (m_strNetwork.empty())
    {
        LogDHCP(("network name is not specified\n"));
        return false;
    }

    logInit();

    bool fMACGenerated = false;
    if (   m_MacAddress.au16[0] == 0
        && m_MacAddress.au16[1] == 0
        && m_MacAddress.au16[2] == 0)
    {
        RTUUID Uuid;
        RTUuidCreate(&Uuid);

        m_MacAddress.au8[0] = 0x08;
        m_MacAddress.au8[1] = 0x00;
        m_MacAddress.au8[2] = 0x27;
        m_MacAddress.au8[3] = Uuid.Gen.au8Node[3];
        m_MacAddress.au8[4] = Uuid.Gen.au8Node[4];
        m_MacAddress.au8[5] = Uuid.Gen.au8Node[5];

        LogDHCP(("MAC address is not specified: will use generated MAC %RTmac\n", &m_MacAddress));
        fMACGenerated = true;
    }

    /* unicast MAC address */
    if (m_MacAddress.au8[0] & 0x01)
    {
        LogDHCP(("MAC address is not unicast: %RTmac\n", &m_MacAddress));
        return VERR_GENERAL_FAILURE;
    }

    /* unicast IP address */
    if ((m_IPv4Address.au8[0] & 0xe0) == 0xe0)
    {
        LogDHCP(("IP address is not unicast: %RTnaipv4\n", m_IPv4Address.u));
        return VERR_GENERAL_FAILURE;
    }

    /* valid netmask */
    int iPrefixLengh;
    rc = RTNetMaskToPrefixIPv4(&m_IPv4Netmask, &iPrefixLengh);
    if (RT_FAILURE(rc) || iPrefixLengh == 0)
    {
        LogDHCP(("IP mask is not valid: %RTnaipv4\n", m_IPv4Netmask.u));
        return VERR_GENERAL_FAILURE;
    }

    /* first IP is from the same network */
    if ((m_IPv4PoolFirst.u & m_IPv4Netmask.u) != (m_IPv4Address.u & m_IPv4Netmask.u))
    {
        LogDHCP(("first pool address is outside the network %RTnaipv4/%d: %RTnaipv4\n",
                 (m_IPv4Address.u & m_IPv4Netmask.u), iPrefixLengh,
                 m_IPv4PoolFirst.u));
        return VERR_GENERAL_FAILURE;
    }

    /* last IP is from the same network */
    if ((m_IPv4PoolLast.u & m_IPv4Netmask.u) != (m_IPv4Address.u & m_IPv4Netmask.u))
    {
        LogDHCP(("last pool address is outside the network %RTnaipv4/%d: %RTnaipv4\n",
                 (m_IPv4Address.u & m_IPv4Netmask.u), iPrefixLengh,
                 m_IPv4PoolLast.u));
        return VERR_GENERAL_FAILURE;
    }

    /* the pool is valid */
    if (RT_N2H_U32(m_IPv4PoolLast.u) < RT_N2H_U32(m_IPv4PoolFirst.u))
    {
        LogDHCP(("pool range is invalid: %RTnaipv4 - %RTnaipv4\n",
                 m_IPv4PoolFirst.u, m_IPv4PoolLast.u));
        return VERR_GENERAL_FAILURE;
    }

    /* our own address is not inside the pool */
    if (   RT_N2H_U32(m_IPv4PoolFirst.u) <= RT_N2H_U32(m_IPv4Address.u)
        && RT_N2H_U32(m_IPv4Address.u)  <= RT_N2H_U32(m_IPv4PoolLast.u))
    {
        LogDHCP(("server address inside the pool range %RTnaipv4 - %RTnaipv4: %RTnaipv4\n",
                 m_IPv4PoolFirst.u, m_IPv4PoolLast.u, m_IPv4Address.u));
        return VERR_GENERAL_FAILURE;
    }

    if (!fMACGenerated)
        LogDHCP(("MAC address %RTmac\n", &m_MacAddress));
    LogDHCP(("IP address %RTnaipv4/%d\n", m_IPv4Address.u, iPrefixLengh));
    LogDHCP(("address pool %RTnaipv4 - %RTnaipv4\n", m_IPv4PoolFirst.u, m_IPv4PoolLast.u));

    return VINF_SUCCESS;
}


Config *Config::hardcoded()
{
    int rc;

    std::unique_ptr<Config> config(new Config());
    rc = config->init();
    if (RT_FAILURE(rc))
        return NULL;

    config->setNetwork("HostInterfaceNetworking-vboxnet0");
    config->m_strTrunk.assign("vboxnet0");
    config->m_enmTrunkType = kIntNetTrunkType_NetFlt;

    config->m_MacAddress.au8[0] = 0x08;
    config->m_MacAddress.au8[1] = 0x00;
    config->m_MacAddress.au8[2] = 0x27;
    config->m_MacAddress.au8[3] = 0xa9;
    config->m_MacAddress.au8[4] = 0xcf;
    config->m_MacAddress.au8[5] = 0xef;


    config->m_IPv4Address.u = RT_H2N_U32_C(0xc0a838fe); /* 192.168.56.254 */
    config->m_IPv4Netmask.u = RT_H2N_U32_C(0xffffff00); /* 255.255.255.0 */

    /* flip to test naks */
#if 1
    config->m_IPv4PoolFirst.u = RT_H2N_U32_C(0xc0a8385a); /* 192.168.56.90 */
    config->m_IPv4PoolLast.u = RT_H2N_U32_C(0xc0a83863); /* 192.168.56.99 */
#else
    config->m_IPv4PoolFirst.u = RT_H2N_U32_C(0xc0a838c9); /* 192.168.56.201 */
    config->m_IPv4PoolLast.u = RT_H2N_U32_C(0xc0a838dc); /* 192.168.56.220 */
#endif

    rc = config->complete();
    AssertRCReturn(rc, NULL);

    return config.release();
}


/* compatibility with old VBoxNetDHCP */
static const RTGETOPTDEF g_aCompatOptions[] =
{
    { "--ip-address",     'i',   RTGETOPT_REQ_IPV4ADDR },
    { "--lower-ip",       'l',   RTGETOPT_REQ_IPV4ADDR },
    { "--mac-address",    'a',   RTGETOPT_REQ_MACADDR },
    { "--need-main",      'M',   RTGETOPT_REQ_BOOL },
    { "--netmask",        'm',   RTGETOPT_REQ_IPV4ADDR },
    { "--network",        'n',   RTGETOPT_REQ_STRING },
    { "--trunk-name",     't',   RTGETOPT_REQ_STRING },
    { "--trunk-type",     'T',   RTGETOPT_REQ_STRING },
    { "--upper-ip",       'u',   RTGETOPT_REQ_IPV4ADDR },
};


Config *Config::compat(int argc, char **argv)
{
    RTGETOPTSTATE State;
    int rc;

    rc = RTGetOptInit(&State, argc, argv,
                      g_aCompatOptions, RT_ELEMENTS(g_aCompatOptions), 1,
                      RTGETOPTINIT_FLAGS_NO_STD_OPTS);
    AssertRCReturn(rc, NULL);

    std::unique_ptr<Config> config(new Config());
    rc = config->init();
    if (RT_FAILURE(rc))
        return NULL;

    for (;;)
    {
        RTGETOPTUNION Val;

        rc = RTGetOpt(&State, &Val);
        if (rc == 0)            /* done */
            break;

        switch (rc)
        {
            case 'a': /* --mac-address */
                if (   config->m_MacAddress.au16[0] != 0
                    || config->m_MacAddress.au16[1] != 0
                    || config->m_MacAddress.au16[2] != 0)
                {
                    RTMsgError("Duplicate --mac-address option");
                    return NULL;
                }
                config->m_MacAddress = Val.MacAddr;
                break;

            case 'i': /* --ip-address */
                if (config->m_IPv4Address.u != 0)
                {
                    RTMsgError("Duplicate --ip-address option");
                    return NULL;
                }
                config->m_IPv4Address = Val.IPv4Addr;
                break;

            case 'l': /* --lower-ip */
                if (config->m_IPv4PoolFirst.u != 0)
                {
                    RTMsgError("Duplicate --lower-ip option");
                    return NULL;
                }
                config->m_IPv4PoolFirst = Val.IPv4Addr;
                break;

            case 'M': /* --need-main */
                /* for backward compatibility, ignored */
                break;

            case 'm': /* --netmask */
                if (config->m_IPv4Netmask.u != 0)
                {
                    RTMsgError("Duplicate --netmask option");
                    return NULL;
                }
                config->m_IPv4Netmask = Val.IPv4Addr;
                break;

            case 'n': /* --network */
                if (!config->m_strNetwork.empty())
                {
                    RTMsgError("Duplicate --network option");
                    return NULL;
                }
                config->setNetwork(Val.psz);
                break;

            case 't': /* --trunk-name */
                if (!config->m_strTrunk.empty())
                {
                    RTMsgError("Duplicate --trunk-name option");
                    return NULL;
                }
                config->m_strTrunk.assign(Val.psz);
                break;

            case 'T': /* --trunk-type */
                if (config->m_enmTrunkType != kIntNetTrunkType_Invalid)
                {
                    RTMsgError("Duplicate --trunk-type option");
                    return NULL;
                }
                else if (strcmp(Val.psz, "none") == 0)
                    config->m_enmTrunkType = kIntNetTrunkType_None;
                else if (strcmp(Val.psz, "whatever") == 0)
                    config->m_enmTrunkType = kIntNetTrunkType_WhateverNone;
                else if (strcmp(Val.psz, "netflt") == 0)
                    config->m_enmTrunkType = kIntNetTrunkType_NetFlt;
                else if (strcmp(Val.psz, "netadp") == 0)
                    config->m_enmTrunkType = kIntNetTrunkType_NetAdp;
                else
                {
                    RTMsgError("Unknown trunk type '%s'", Val.psz);
                    return NULL;
                }
                break;

            case 'u': /* --upper-ip */
                if (config->m_IPv4PoolLast.u != 0)
                {
                    RTMsgError("Duplicate --upper-ip option");
                    return NULL;
                }
                config->m_IPv4PoolLast = Val.IPv4Addr;
                break;

            case VINF_GETOPT_NOT_OPTION:
                RTMsgError("%s: Unexpected command line argument", Val.psz);
                return NULL;

            default:
                RTGetOptPrintError(rc, &Val);
                return NULL;
        }
    }

    rc = config->complete();
    if (RT_FAILURE(rc))
        return NULL;

    return config.release();
}


#define DHCPD_GETOPT_COMMENT 256 /* No short option for --comment */
static const RTGETOPTDEF g_aOptions[] =
{
    { "--config",       'c',                  RTGETOPT_REQ_STRING },
    { "--comment",      DHCPD_GETOPT_COMMENT, RTGETOPT_REQ_STRING }
};


Config *Config::create(int argc, char **argv)
{
    RTGETOPTSTATE State;
    int rc;

    rc = RTGetOptInit(&State, argc, argv,
                      g_aOptions, RT_ELEMENTS(g_aOptions), 1,
                      RTGETOPTINIT_FLAGS_NO_STD_OPTS);
    AssertRCReturn(rc, NULL);

    std::unique_ptr<Config> config;
    for (;;)
    {
        RTGETOPTUNION Val;

        rc = RTGetOpt(&State, &Val);
        if (rc == 0)            /* done */
            break;

        switch (rc)
        {
            case 'c': /* --config */
                if (config.get() != NULL)
                {
                    printf("Duplicate option: --config '%s'\n", Val.psz);
                    return NULL;
                }

                printf("reading config from %s\n", Val.psz);
                config.reset(Config::read(Val.psz));
                if (config.get() == NULL)
                    return NULL;

                break;

            case DHCPD_GETOPT_COMMENT: /* --comment */
                /* The sole purpose of this option is to allow identification of DHCP
                 * server instances in the process list. We ignore the required string
                 * argument of this option.
                 */
                continue;

            case VINF_GETOPT_NOT_OPTION:
                RTMsgError("Unexpected command line argument: '%s'", Val.psz);
                return NULL;

            default:
                RTGetOptPrintError(rc, &Val);
                return NULL;
        }
    }

    if (config.get() == NULL)
        return NULL;

    rc = config->complete();
    if (RT_FAILURE(rc))
        return NULL;

    return config.release();
}


Config *Config::read(const char *pszFileName)
{
    int rc;

    if (pszFileName == NULL || pszFileName[0] == '\0')
        return NULL;

    xml::Document doc;
    try
    {
        xml::XmlFileParser parser;
        parser.read(pszFileName, doc);
    }
    catch (const xml::EIPRTFailure &e)
    {
        LogDHCP(("%s\n", e.what()));
        return NULL;
    }
    catch (const RTCError &e)
    {
        LogDHCP(("%s\n", e.what()));
        return NULL;
    }
    catch (...)
    {
        LogDHCP(("Unknown exception while reading and parsing '%s'\n",
                 pszFileName));
        return NULL;
    }

    std::unique_ptr<Config> config(new Config());
    rc = config->init();
    if (RT_FAILURE(rc))
        return NULL;

    try
    {
        config->parseConfig(doc.getRootElement());
    }
    catch (const RTCError &e)
    {
        LogDHCP(("%s\n", e.what()));
        return NULL;
    }
    catch (...)
    {
        LogDHCP(("Unexpected exception\n"));
        return NULL;
    }

    return config.release();
}


void Config::parseConfig(const xml::ElementNode *root)
{
    if (root == NULL)
        throw ConfigFileError("Empty config file");

    /*
     * XXX: NAMESPACE API IS COMPLETELY BROKEN, SO IGNORE IT FOR NOW
     */
    if (!root->nameEquals("DHCPServer"))
    {
        const char *name = root->getName();
        throw ConfigFileError(RTCStringFmt("Unexpected root element \"%s\"",
                                           name ? name : "(null)"));
    }

    parseServer(root);

    /** @todo r=bird: Visual C++ 2010 does not grok this use of 'auto'. */
    // XXX: debug
    for (optmap_t::const_iterator it = m_GlobalOptions.begin(); it != m_GlobalOptions.end(); ++it) {
        std::shared_ptr<DhcpOption> opt(it->second);

        octets_t data;
        opt->encode(data);

        bool space = false;
        for (octets_t::const_iterator itData = data.begin(); itData != data.end(); ++itData) {
            uint8_t c = *itData;
            if (space)
                std::cout << " ";
            else
                space = true;
            std::cout << (int)c;
        }
        std::cout << std::endl;
    }
}


static void getIPv4AddrAttribute(const xml::ElementNode *pNode, const char *pcszAttrName,
                                 RTNETADDRIPV4 *pAddr)
{
    RTCString strAddr;
    bool fHasAttr = pNode->getAttributeValue(pcszAttrName, &strAddr);
    if (!fHasAttr)
        throw ConfigFileError(RTCStringFmt("%s attribute missing",
                                           pcszAttrName));

    int rc = RTNetStrToIPv4Addr(strAddr.c_str(), pAddr);
    if (RT_FAILURE(rc))
        throw ConfigFileError(RTCStringFmt("%s attribute invalid",
                                           pcszAttrName));
}


void Config::parseServer(const xml::ElementNode *server)
{
    /*
     * DHCPServer attributes
     */
    RTCString strNetworkName;
    bool fHasNetworkName = server->getAttributeValue("networkName", &strNetworkName);
    if (!fHasNetworkName)
        throw ConfigFileError("DHCPServer/@networkName missing");

    setNetwork(strNetworkName.c_str());

    RTCString strTrunkType;
    if (!server->getAttributeValue("trunkType", &strTrunkType))
        throw ConfigFileError("DHCPServer/@trunkType missing");
    if (strTrunkType == "none")
        m_enmTrunkType = kIntNetTrunkType_None;
    else if (strTrunkType == "whatever")
        m_enmTrunkType = kIntNetTrunkType_WhateverNone;
    else if (strTrunkType == "netflt")
        m_enmTrunkType = kIntNetTrunkType_NetFlt;
    else if (strTrunkType == "netadp")
        m_enmTrunkType = kIntNetTrunkType_NetAdp;
    else
        throw ConfigFileError(RTCStringFmt("Invalid DHCPServer/@trunkType value: %s", strTrunkType.c_str()));

    if (   m_enmTrunkType == kIntNetTrunkType_NetFlt
        || m_enmTrunkType == kIntNetTrunkType_NetAdp)
    {
        RTCString strTrunk;
        if (!server->getAttributeValue("trunkName", &strTrunk))
            throw ConfigFileError("DHCPServer/@trunkName missing");
        m_strTrunk = strTrunk.c_str();
    }
    else
        m_strTrunk = "";

    getIPv4AddrAttribute(server, "IPAddress", &m_IPv4Address);
    getIPv4AddrAttribute(server, "networkMask", &m_IPv4Netmask);
    getIPv4AddrAttribute(server, "lowerIP", &m_IPv4PoolFirst);
    getIPv4AddrAttribute(server, "upperIP", &m_IPv4PoolLast);

    /*
     * DHCPServer children
     */
    xml::NodesLoop it(*server);
    const xml::ElementNode *node;
    while ((node = it.forAllNodes()) != NULL)
    {
        /*
         * Global options
         */
        if (node->nameEquals("Options"))
        {
            parseGlobalOptions(node);
        }

        /*
         * Per-VM configuration
         */
        else if (node->nameEquals("Config"))
        {
            parseVMConfig(node);
        }
    }
}


void Config::parseGlobalOptions(const xml::ElementNode *options)
{
    xml::NodesLoop it(*options);
    const xml::ElementNode *node;
    while ((node = it.forAllNodes()) != NULL)
    {
        if (node->nameEquals("Option"))
        {
            parseOption(node, m_GlobalOptions);
        }
        else
        {
            throw ConfigFileError(RTCStringFmt("Unexpected element \"%s\"",
                                               node->getName()));
        }
    }
}


/*
 * VM Config entries are generated automatically from VirtualBox.xml
 * with the MAC fetched from the VM config.  The client id is nowhere
 * in the picture there, so VM config is indexed with plain RTMAC, not
 * ClientId (also see getOptions below).
 */
void Config::parseVMConfig(const xml::ElementNode *config)
{
    RTMAC mac;
    int rc;

    RTCString strMac;
    bool fHasMac = config->getAttributeValue("MACAddress", &strMac);
    if (!fHasMac)
        throw ConfigFileError(RTCStringFmt("Config missing MACAddress attribute"));

    rc = parseMACAddress(mac, strMac);
    if (RT_FAILURE(rc))
    {
        throw ConfigFileError(RTCStringFmt("Malformed MACAddress attribute \"%s\"",
                                           strMac.c_str()));
    }

    vmmap_t::iterator vmit( m_VMMap.find(mac) );
    if (vmit != m_VMMap.end())
    {
        throw ConfigFileError(RTCStringFmt("Duplicate Config for MACAddress \"%s\"",
                                           strMac.c_str()));
    }

    optmap_t &vmopts = m_VMMap[mac];

    xml::NodesLoop it(*config);
    const xml::ElementNode *node;
    while ((node = it.forAllNodes()) != NULL)
        if (node->nameEquals("Option"))
            parseOption(node, vmopts);
        else
            throw ConfigFileError(RTCStringFmt("Unexpected element \"%s\"",
                                               node->getName()));
}


int Config::parseMACAddress(RTMAC &aMac, const RTCString &aStr)
{
    RTMAC mac;
    int rc;

    rc = RTNetStrToMacAddr(aStr.c_str(), &mac);
    if (RT_FAILURE(rc))
        return rc;
    if (rc == VWRN_TRAILING_CHARS)
        return VERR_INVALID_PARAMETER;

    aMac = mac;
    return VINF_SUCCESS;
}


int Config::parseClientId(OptClientId &aId, const RTCString &aStr)
{
    RT_NOREF(aId, aStr);
    return VERR_GENERAL_FAILURE;
}


/*
 * Parse <Option/> element and add the option to the specified optmap.
 */
void Config::parseOption(const xml::ElementNode *option, optmap_t &optmap)
{
    int rc;

    uint8_t u8Opt;
    RTCString strName;
    bool fHasName = option->getAttributeValue("name", &strName);
    if (fHasName)
    {
        const char *pcszName = strName.c_str();

        rc = RTStrToUInt8Full(pcszName, 10, &u8Opt);
        if (rc != VINF_SUCCESS) /* no warnings either */
            throw ConfigFileError(RTCStringFmt("Bad option \"%s\"", pcszName));

    }
    else
        throw ConfigFileError("missing option name");


    uint32_t u32Enc = 0;        /* XXX: DhcpOptEncoding_Legacy */
    RTCString strEncoding;
    bool fHasEncoding = option->getAttributeValue("encoding", &strEncoding);
    if (fHasEncoding)
    {
        const char *pcszEnc = strEncoding.c_str();

        rc = RTStrToUInt32Full(pcszEnc, 10, &u32Enc);
        if (rc != VINF_SUCCESS) /* no warnings either */
            throw ConfigFileError(RTCStringFmt("Bad encoding \"%s\"", pcszEnc));

        switch (u32Enc)
        {
        case 0:                 /* XXX: DhcpOptEncoding_Legacy */
        case 1:                 /* XXX: DhcpOptEncoding_Hex */
            break;
        default:
            throw ConfigFileError(RTCStringFmt("Unknown encoding \"%s\"", pcszEnc));
        }
    }


    /* value may be omitted for OptNoValue options like rapid commit */
    RTCString strValue;
    option->getAttributeValue("value", &strValue);

    /* XXX: TODO: encoding, handle hex */
    DhcpOption *opt = DhcpOption::parse(u8Opt, u32Enc, strValue.c_str());
    if (opt == NULL)
        throw ConfigFileError(RTCStringFmt("Bad option \"%s\"", strName.c_str()));

    optmap << opt;
}


/*
 * Set m_strBaseName to sanitized version of m_strNetwork that can be
 * used in a path component.
 */
void Config::sanitizeBaseName()
{
    int rc;

    if (m_strNetwork.empty())
        return;

    char szBaseName[RTPATH_MAX];
    rc = RTStrCopy(szBaseName, sizeof(szBaseName), m_strNetwork.c_str());
    if (RT_FAILURE(rc))
        return;

    for (char *p = szBaseName; *p != '\0'; ++p)
    {
        if (RTPATH_IS_SEP(*p))
        {
            *p = '_';
        }
    }

    m_strBaseName.assign(szBaseName);
}


optmap_t Config::getOptions(const OptParameterRequest &reqOpts,
                            const ClientId &id,
                            const OptVendorClassId &vendor) const
{
    optmap_t optmap;

    const optmap_t *vmopts = NULL;
    vmmap_t::const_iterator vmit( m_VMMap.find(id.mac()) );
    if (vmit != m_VMMap.end())
        vmopts = &vmit->second;

    RT_NOREF(vendor); /* not yet */


    optmap << new OptSubnetMask(m_IPv4Netmask);

    const OptParameterRequest::value_t& reqValue = reqOpts.value();
    for (octets_t::const_iterator itOptReq = reqValue.begin(); itOptReq != reqValue.end(); ++itOptReq)
    {
        uint8_t optreq = *itOptReq;
        std::cout << ">>> requested option " << (int)optreq << std::endl;

        if (optreq == OptSubnetMask::optcode)
        {
            std::cout << "... always supplied" << std::endl;
            continue;
        }

        if (vmopts != NULL)
        {
            optmap_t::const_iterator it( vmopts->find(optreq) );
            if (it != vmopts->end())
            {
                optmap << it->second;
                std::cout << "... found in VM options" << std::endl;
                continue;
            }
        }

        optmap_t::const_iterator it( m_GlobalOptions.find(optreq) );
        if (it != m_GlobalOptions.end())
        {
            optmap << it->second;
            std::cout << "... found in global options" << std::endl;
            continue;
        }

        // std::cout << "... not found" << std::endl;
    }


    /* XXX: testing ... */
    if (vmopts != NULL)
    {
        for (optmap_t::const_iterator it = vmopts->begin(); it != vmopts->end(); ++it) {
            std::shared_ptr<DhcpOption> opt(it->second);
            if (optmap.count(opt->optcode()) == 0 && opt->optcode() > 127)
            {
                optmap << opt;
                std::cout << "... forcing VM option " << (int)opt->optcode() << std::endl;
            }
        }
    }

    for (optmap_t::const_iterator it = m_GlobalOptions.begin(); it != m_GlobalOptions.end(); ++it) {
        std::shared_ptr<DhcpOption> opt(it->second);
        if (optmap.count(opt->optcode()) == 0 && opt->optcode() > 127)
        {
            optmap << opt;
            std::cout << "... forcing global option " << (int)opt->optcode() << std::endl;
        }
    }

    return optmap;
}