1 /*
2 * Copyright (c) 2020, The OpenThread Authors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the copyright holder nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file
31 * This file implements Backbone Thread Management Framework (TMF) functionalities.
32 */
33
34 #include "backbone_tmf.hpp"
35
36 #if OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
37
38 #include "common/locator_getters.hpp"
39 #include "common/log.hpp"
40
41 namespace ot {
42 namespace BackboneRouter {
43
44 RegisterLogModule("Bbr");
45
BackboneTmfAgent(Instance & aInstance)46 BackboneTmfAgent::BackboneTmfAgent(Instance &aInstance)
47 : Coap::Coap(aInstance)
48 {
49 SetInterceptor(&Filter, this);
50 SetResourceHandler(&HandleResource);
51 }
52
Start(void)53 Error BackboneTmfAgent::Start(void)
54 {
55 Error error = kErrorNone;
56
57 SuccessOrExit(error = Coap::Start(kBackboneUdpPort, Ip6::kNetifBackbone));
58 LogInfo("Start listening on port %u", kBackboneUdpPort);
59 SubscribeMulticast(Get<Local>().GetAllNetworkBackboneRoutersAddress());
60
61 exit:
62 return error;
63 }
64
HandleResource(CoapBase & aCoapBase,const char * aUriPath,ot::Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo)65 bool BackboneTmfAgent::HandleResource(CoapBase &aCoapBase,
66 const char *aUriPath,
67 ot::Coap::Message &aMessage,
68 const Ip6::MessageInfo &aMessageInfo)
69 {
70 return static_cast<BackboneTmfAgent &>(aCoapBase).HandleResource(aUriPath, aMessage, aMessageInfo);
71 }
72
HandleResource(const char * aUriPath,ot::Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo)73 bool BackboneTmfAgent::HandleResource(const char *aUriPath,
74 ot::Coap::Message &aMessage,
75 const Ip6::MessageInfo &aMessageInfo)
76 {
77 OT_UNUSED_VARIABLE(aMessage);
78 OT_UNUSED_VARIABLE(aMessageInfo);
79
80 bool didHandle = true;
81 Uri uri = UriFromPath(aUriPath);
82
83 #define Case(kUri, Type) \
84 case kUri: \
85 Get<Type>().HandleTmf<kUri>(aMessage, aMessageInfo); \
86 break
87
88 switch (uri)
89 {
90 #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE
91 Case(kUriBackboneQuery, Manager);
92 Case(kUriBackboneAnswer, Manager);
93 #endif
94
95 default:
96 didHandle = false;
97 break;
98 }
99
100 #undef Case
101
102 return didHandle;
103 }
104
Filter(const ot::Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo,void * aContext)105 Error BackboneTmfAgent::Filter(const ot::Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, void *aContext)
106 {
107 OT_UNUSED_VARIABLE(aMessage);
108
109 return static_cast<BackboneTmfAgent *>(aContext)->IsBackboneTmfMessage(aMessageInfo) ? kErrorNone : kErrorNotTmf;
110 }
111
IsBackboneTmfMessage(const Ip6::MessageInfo & aMessageInfo) const112 bool BackboneTmfAgent::IsBackboneTmfMessage(const Ip6::MessageInfo &aMessageInfo) const
113 {
114 const Ip6::Address &dst = aMessageInfo.GetSockAddr();
115 const Ip6::Address &src = aMessageInfo.GetPeerAddr();
116
117 // A Backbone TMF message must comply with following rules:
118 // The destination must be one of:
119 // 1. All Network BBRs (Link-Local scope)
120 // 2. All Domain BBRs (Link-Local scope)
121 // 3. A Backbone Link-Local address
122 // The source must be a Backbone Link-local address.
123 return (Get<BackboneRouter::Local>().IsEnabled() && src.IsLinkLocal() &&
124 (dst.IsLinkLocal() || dst == Get<BackboneRouter::Local>().GetAllNetworkBackboneRoutersAddress() ||
125 dst == Get<BackboneRouter::Local>().GetAllDomainBackboneRoutersAddress()));
126 }
127
SubscribeMulticast(const Ip6::Address & aAddress)128 void BackboneTmfAgent::SubscribeMulticast(const Ip6::Address &aAddress)
129 {
130 Error error = mSocket.JoinNetifMulticastGroup(Ip6::kNetifBackbone, aAddress);
131
132 LogError("Backbone TMF subscribes", aAddress, error);
133 }
134
UnsubscribeMulticast(const Ip6::Address & aAddress)135 void BackboneTmfAgent::UnsubscribeMulticast(const Ip6::Address &aAddress)
136 {
137 Error error = mSocket.LeaveNetifMulticastGroup(Ip6::kNetifBackbone, aAddress);
138
139 LogError("Backbone TMF unsubscribes", aAddress, error);
140 }
141
LogError(const char * aText,const Ip6::Address & aAddress,Error aError) const142 void BackboneTmfAgent::LogError(const char *aText, const Ip6::Address &aAddress, Error aError) const
143 {
144 OT_UNUSED_VARIABLE(aText);
145 OT_UNUSED_VARIABLE(aAddress);
146
147 if (aError == kErrorNone)
148 {
149 LogInfo("%s %s: %s", aText, aAddress.ToString().AsCString(), ErrorToString(aError));
150 }
151 else
152 {
153 LogWarn("%s %s: %s", aText, aAddress.ToString().AsCString(), ErrorToString(aError));
154 }
155 }
156
157 } // namespace BackboneRouter
158 } // namespace ot
159
160 #endif // OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
161
