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