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/as_core_type.hpp"
40 #include "common/code_utils.hpp"
41 #include "common/debug.hpp"
42 #include "common/locator_getters.hpp"
43 #include "common/log.hpp"
44 #include "instance/instance.hpp"
45 #include "meshcop/meshcop.hpp"
46 #include "meshcop/meshcop_tlvs.hpp"
47 #include "thread/thread_netif.hpp"
48 #include "thread/uri_paths.hpp"
49
50 namespace ot {
51
52 RegisterLogModule("PanIdQueryClnt");
53
PanIdQueryClient(Instance & aInstance)54 PanIdQueryClient::PanIdQueryClient(Instance &aInstance)
55 : InstanceLocator(aInstance)
56 {
57 }
58
SendQuery(uint16_t aPanId,uint32_t aChannelMask,const Ip6::Address & aAddress,otCommissionerPanIdConflictCallback aCallback,void * aContext)59 Error PanIdQueryClient::SendQuery(uint16_t aPanId,
60 uint32_t aChannelMask,
61 const Ip6::Address &aAddress,
62 otCommissionerPanIdConflictCallback aCallback,
63 void *aContext)
64 {
65 Error error = kErrorNone;
66 Tmf::MessageInfo messageInfo(GetInstance());
67 Coap::Message *message = nullptr;
68
69 VerifyOrExit(Get<MeshCoP::Commissioner>().IsActive(), error = kErrorInvalidState);
70 VerifyOrExit((message = Get<Tmf::Agent>().NewPriorityMessage()) != nullptr, error = kErrorNoBufs);
71
72 SuccessOrExit(error = message->InitAsPost(aAddress, kUriPanIdQuery));
73 SuccessOrExit(error = message->SetPayloadMarker());
74
75 SuccessOrExit(
76 error = Tlv::Append<MeshCoP::CommissionerSessionIdTlv>(*message, Get<MeshCoP::Commissioner>().GetSessionId()));
77
78 SuccessOrExit(error = MeshCoP::ChannelMaskTlv::AppendTo(*message, aChannelMask));
79
80 SuccessOrExit(error = Tlv::Append<MeshCoP::PanIdTlv>(*message, aPanId));
81
82 messageInfo.SetSockAddrToRlocPeerAddrTo(aAddress);
83 SuccessOrExit(error = Get<Tmf::Agent>().SendMessage(*message, messageInfo));
84
85 LogInfo("Sent %s", UriToString<kUriPanIdQuery>());
86
87 mCallback.Set(aCallback, aContext);
88
89 exit:
90 FreeMessageOnError(message, error);
91 return error;
92 }
93
94 template <>
HandleTmf(Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo)95 void PanIdQueryClient::HandleTmf<kUriPanIdConflict>(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo)
96 {
97 uint16_t panId;
98 uint32_t mask;
99
100 VerifyOrExit(aMessage.IsConfirmablePostRequest());
101
102 LogInfo("Received %s", UriToString<kUriPanIdConflict>());
103
104 SuccessOrExit(Tlv::Find<MeshCoP::PanIdTlv>(aMessage, panId));
105
106 SuccessOrExit(MeshCoP::ChannelMaskTlv::FindIn(aMessage, mask));
107
108 mCallback.InvokeIfSet(panId, mask);
109
110 SuccessOrExit(Get<Tmf::Agent>().SendEmptyAck(aMessage, aMessageInfo));
111
112 LogInfo("Sent %s response", UriToString<kUriPanIdConflict>());
113
114 exit:
115 return;
116 }
117
118 } // namespace ot
119
120 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
121
