1 /*
2 * Copyright (c) 2016, 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 the PAN ID Query Client.
32 */
33
34 #include "panid_query_client.hpp"
35
36 #if OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
37
38 #include "coap/coap_message.hpp"
39 #include "common/code_utils.hpp"
40 #include "common/debug.hpp"
41 #include "common/instance.hpp"
42 #include "common/locator_getters.hpp"
43 #include "common/logging.hpp"
44 #include "meshcop/meshcop.hpp"
45 #include "meshcop/meshcop_tlvs.hpp"
46 #include "thread/thread_netif.hpp"
47 #include "thread/uri_paths.hpp"
48
49 namespace ot {
50
PanIdQueryClient(Instance & aInstance)51 PanIdQueryClient::PanIdQueryClient(Instance &aInstance)
52 : InstanceLocator(aInstance)
53 , mCallback(nullptr)
54 , mContext(nullptr)
55 , mPanIdQuery(UriPath::kPanIdConflict, &PanIdQueryClient::HandleConflict, this)
56 {
57 Get<Tmf::Agent>().AddResource(mPanIdQuery);
58 }
59
SendQuery(uint16_t aPanId,uint32_t aChannelMask,const Ip6::Address & aAddress,otCommissionerPanIdConflictCallback aCallback,void * aContext)60 Error PanIdQueryClient::SendQuery(uint16_t aPanId,
61 uint32_t aChannelMask,
62 const Ip6::Address & aAddress,
63 otCommissionerPanIdConflictCallback aCallback,
64 void * aContext)
65 {
66 Error error = kErrorNone;
67 MeshCoP::ChannelMaskTlv channelMask;
68 Ip6::MessageInfo messageInfo;
69 Coap::Message * message = nullptr;
70
71 VerifyOrExit(Get<MeshCoP::Commissioner>().IsActive(), error = kErrorInvalidState);
72 VerifyOrExit((message = MeshCoP::NewMeshCoPMessage(Get<Tmf::Agent>())) != nullptr, error = kErrorNoBufs);
73
74 SuccessOrExit(error = message->InitAsPost(aAddress, UriPath::kPanIdQuery));
75 SuccessOrExit(error = message->SetPayloadMarker());
76
77 SuccessOrExit(
78 error = Tlv::Append<MeshCoP::CommissionerSessionIdTlv>(*message, Get<MeshCoP::Commissioner>().GetSessionId()));
79
80 channelMask.Init();
81 channelMask.SetChannelMask(aChannelMask);
82 SuccessOrExit(error = channelMask.AppendTo(*message));
83
84 SuccessOrExit(error = Tlv::Append<MeshCoP::PanIdTlv>(*message, aPanId));
85
86 messageInfo.SetSockAddr(Get<Mle::MleRouter>().GetMeshLocal16());
87 messageInfo.SetPeerAddr(aAddress);
88 messageInfo.SetPeerPort(Tmf::kUdpPort);
89 SuccessOrExit(error = Get<Tmf::Agent>().SendMessage(*message, messageInfo));
90
91 otLogInfoMeshCoP("sent panid query");
92
93 mCallback = aCallback;
94 mContext = aContext;
95
96 exit:
97 FreeMessageOnError(message, error);
98 return error;
99 }
100
HandleConflict(void * aContext,otMessage * aMessage,const otMessageInfo * aMessageInfo)101 void PanIdQueryClient::HandleConflict(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
102 {
103 static_cast<PanIdQueryClient *>(aContext)->HandleConflict(*static_cast<Coap::Message *>(aMessage),
104 *static_cast<const Ip6::MessageInfo *>(aMessageInfo));
105 }
106
HandleConflict(Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo)107 void PanIdQueryClient::HandleConflict(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo)
108 {
109 uint16_t panId;
110 Ip6::MessageInfo responseInfo(aMessageInfo);
111 uint32_t mask;
112
113 VerifyOrExit(aMessage.IsConfirmablePostRequest());
114
115 otLogInfoMeshCoP("received panid conflict");
116
117 SuccessOrExit(Tlv::Find<MeshCoP::PanIdTlv>(aMessage, panId));
118
119 VerifyOrExit((mask = MeshCoP::ChannelMaskTlv::GetChannelMask(aMessage)) != 0);
120
121 if (mCallback != nullptr)
122 {
123 mCallback(panId, mask, mContext);
124 }
125
126 SuccessOrExit(Get<Tmf::Agent>().SendEmptyAck(aMessage, responseInfo));
127
128 otLogInfoMeshCoP("sent panid query conflict response");
129
130 exit:
131 return;
132 }
133
134 } // namespace ot
135
136 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
137
