aboutsummaryrefslogtreecommitdiff
path: root/src/backbone_router/nd_proxy.hpp
blob: a7b70b85a6b2fba419afe2dbce7c60df0eb7090e (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
/*
 *    Copyright (c) 2020, The OpenThread Authors.
 *    All rights reserved.
 *
 *    Redistribution and use in source and binary forms, with or without
 *    modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the copyright holder nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *    POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file
 *   This file includes definition for ICMPv6 Neighbor Advertisement (ND) proxy management.
 */

#ifndef ND_PROXY_HPP_
#define ND_PROXY_HPP_

#if OTBR_ENABLE_DUA_ROUTING

#ifdef __APPLE__
#define __APPLE_USE_RFC_3542
#endif

#include <inttypes.h>
#include <libnetfilter_queue/libnetfilter_queue.h>
#include <map>
#include <netinet/in.h>
#include <set>
#include <string>

#include <openthread/backbone_router_ftd.h>

#include "common/mainloop.hpp"
#include "common/types.hpp"
#include "ncp/ncp_openthread.hpp"

namespace otbr {
namespace BackboneRouter {

/**
 * @addtogroup border-router-bbr
 *
 * @brief
 *   This module includes definition for ND Proxy manager.
 *
 * @{
 */

/**
 * This class implements ND Proxy manager.
 *
 */
class NdProxyManager : public MainloopProcessor
{
public:
    /**
     * This constructor initializes a NdProxyManager instance.
     *
     */
    explicit NdProxyManager(otbr::Ncp::ControllerOpenThread &aNcp)
        : mNcp(aNcp)
        , mIcmp6RawSock(-1)
        , mUnicastNsQueueSock(-1)
        , mNfqHandler(nullptr)
        , mNfqQueueHandler(nullptr)
    {
    }

    /**
     * This method initializes a ND Proxy manager instance.
     *
     */
    void Init(void);

    /**
     * This method enables the ND Proxy manager.
     *
     * @param[in] aDomainPrefix  The Domain Prefix.
     *
     */
    void Enable(const Ip6Prefix &aDomainPrefix);

    /**
     * This method disables the ND Proxy manager.
     *
     */
    void Disable(void);

    /**
     * This method updates the mainloop context.
     *
     * @param[inout]  aMainloop  A reference to the mainloop to be updated.
     *
     */
    void Update(MainloopContext &aMainloop) override;

    /**
     * This method processes mainloop events.
     *
     * @param[in]  aMainloop  A reference to the mainloop context.
     *
     */
    void Process(const MainloopContext &aMainloop) override;

    /**
     * This method handles a Backbone Router ND Proxy event.
     *
     * @param[in] aEvent    The Backbone Router ND Proxy event type.
     * @param[in] aDua      The Domain Unicast Address of the ND Proxy, or `nullptr` if @p `aEvent` is
     *                      `OT_BACKBONE_ROUTER_NDPROXY_CLEARED`.
     *
     */
    void HandleBackboneRouterNdProxyEvent(otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua);

    /**
     * This method returns if the ND Proxy manager is enabled.
     *
     * @returns  If the ND Proxy manager is enabled;
     *
     */
    bool IsEnabled(void) const { return mIcmp6RawSock >= 0; }

private:
    enum
    {
        kMaxICMP6PacketSize = 1500, ///< Max size of an ICMP6 packet in bytes.
    };

    void       SendNeighborAdvertisement(const Ip6Address &aTarget, const Ip6Address &aDst);
    otbrError  UpdateMacAddress(void);
    otbrError  InitIcmp6RawSocket(void);
    void       FiniIcmp6RawSocket(void);
    otbrError  InitNetfilterQueue(void);
    void       FiniNetfilterQueue(void);
    void       ProcessMulticastNeighborSolicition(void);
    void       ProcessUnicastNeighborSolicition(void);
    void       JoinSolicitedNodeMulticastGroup(const Ip6Address &aTarget) const;
    void       LeaveSolicitedNodeMulticastGroup(const Ip6Address &aTarget) const;
    static int HandleNetfilterQueue(struct nfq_q_handle *aNfQueueHandler,
                                    struct nfgenmsg *    aNfMsg,
                                    struct nfq_data *    aNfData,
                                    void *               aContext);
    int HandleNetfilterQueue(struct nfq_q_handle *aNfQueueHandler, struct nfgenmsg *aNfMsg, struct nfq_data *aNfData);

    otbr::Ncp::ControllerOpenThread &mNcp;
    std::set<Ip6Address>             mNdProxySet;
    uint32_t                         mBackboneIfIndex;
    int                              mIcmp6RawSock;
    int                              mUnicastNsQueueSock;
    struct nfq_handle *              mNfqHandler;      ///< A pointer to an NFQUEUE handler.
    struct nfq_q_handle *            mNfqQueueHandler; ///< A pointer to a newly created queue.
    MacAddress                       mMacAddress;
    Ip6Prefix                        mDomainPrefix;
};

/**
 * @}
 */

} // namespace BackboneRouter
} // namespace otbr

#endif // OTBR_ENABLE_DUA_ROUTING
#endif // ND_PROXY_HPP_