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
Start(void)46 Error BackboneTmfAgent::Start(void)
47 {
48 Error error = kErrorNone;
49
50 SuccessOrExit(error = Coap::Start(kBackboneUdpPort, OT_NETIF_BACKBONE));
51 SubscribeMulticast(Get<Local>().GetAllNetworkBackboneRoutersAddress());
52
53 exit:
54 return error;
55 }
56
Filter(const ot::Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo,void * aContext)57 Error BackboneTmfAgent::Filter(const ot::Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, void *aContext)
58 {
59 OT_UNUSED_VARIABLE(aMessage);
60
61 return static_cast<BackboneTmfAgent *>(aContext)->IsBackboneTmfMessage(aMessageInfo) ? kErrorNone : kErrorNotTmf;
62 }
63
IsBackboneTmfMessage(const Ip6::MessageInfo & aMessageInfo) const64 bool BackboneTmfAgent::IsBackboneTmfMessage(const Ip6::MessageInfo &aMessageInfo) const
65 {
66 const Ip6::Address &dst = aMessageInfo.GetSockAddr();
67 const Ip6::Address &src = aMessageInfo.GetPeerAddr();
68
69 // A Backbone TMF message must comply with following rules:
70 // The destination must be one of:
71 // 1. All Network BBRs (Link-Local scope)
72 // 2. All Domain BBRs (Link-Local scope)
73 // 3. A Backbone Link-Local address
74 // The source must be a Backbone Link-local address.
75 return (Get<BackboneRouter::Local>().IsEnabled() && src.IsLinkLocal() &&
76 (dst.IsLinkLocal() || dst == Get<BackboneRouter::Local>().GetAllNetworkBackboneRoutersAddress() ||
77 dst == Get<BackboneRouter::Local>().GetAllDomainBackboneRoutersAddress()));
78 }
79
SubscribeMulticast(const Ip6::Address & aAddress)80 void BackboneTmfAgent::SubscribeMulticast(const Ip6::Address &aAddress)
81 {
82 Error error = mSocket.JoinNetifMulticastGroup(OT_NETIF_BACKBONE, aAddress);
83
84 LogError("Backbone TMF subscribes", aAddress, error);
85 }
86
UnsubscribeMulticast(const Ip6::Address & aAddress)87 void BackboneTmfAgent::UnsubscribeMulticast(const Ip6::Address &aAddress)
88 {
89 Error error = mSocket.LeaveNetifMulticastGroup(OT_NETIF_BACKBONE, aAddress);
90
91 LogError("Backbone TMF unsubscribes", aAddress, error);
92 }
93
LogError(const char * aText,const Ip6::Address & aAddress,Error aError) const94 void BackboneTmfAgent::LogError(const char *aText, const Ip6::Address &aAddress, Error aError) const
95 {
96 OT_UNUSED_VARIABLE(aText);
97 OT_UNUSED_VARIABLE(aAddress);
98
99 if (aError == kErrorNone)
100 {
101 LogInfo("%s %s: %s", aText, aAddress.ToString().AsCString(), ErrorToString(aError));
102 }
103 else
104 {
105 LogWarn("%s %s: %s", aText, aAddress.ToString().AsCString(), ErrorToString(aError));
106 }
107 }
108
109 } // namespace BackboneRouter
110 } // namespace ot
111
112 #endif // OPENTHREAD_FTD && OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
113