forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSessionManager.cpp
1343 lines (1144 loc) · 52.9 KB
/
SessionManager.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
*
* Copyright (c) 2020-2021 Project CHIP Authors
* Copyright (c) 2013-2017 Nest Labs, Inc.
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* This file implements the CHIP Connection object that maintains a UDP connection.
* TODO This class should be extended to support TCP as well...
*
*/
#include "SessionManager.h"
#include <inttypes.h>
#include <string.h>
#include "transport/TraceMessage.h"
#include <app/util/basic-types.h>
#include <credentials/GroupDataProvider.h>
#include <inttypes.h>
#include <lib/core/CHIPKeyIds.h>
#include <lib/core/Global.h>
#include <lib/support/CodeUtils.h>
#include <lib/support/SafeInt.h>
#include <lib/support/logging/CHIPLogging.h>
#include <platform/CHIPDeviceLayer.h>
#include <protocols/Protocols.h>
#include <protocols/secure_channel/Constants.h>
#include <tracing/macros.h>
#include <transport/GroupPeerMessageCounter.h>
#include <transport/GroupSession.h>
#include <transport/SecureMessageCodec.h>
#include <transport/TracingStructs.h>
#include <transport/TransportMgr.h>
namespace chip {
using System::PacketBufferHandle;
using Transport::GroupPeerTable;
using Transport::PeerAddress;
using Transport::SecureSession;
namespace {
Global<GroupPeerTable> gGroupPeerTable;
/// RAII class for iterators that guarantees that Release() will be called
/// on the underlying type
template <typename Releasable>
class AutoRelease
{
public:
AutoRelease(Releasable * iter) : mIter(iter) {}
~AutoRelease() { Release(); }
Releasable * operator->() { return mIter; }
const Releasable * operator->() const { return mIter; }
bool IsNull() const { return mIter == nullptr; }
void Release()
{
VerifyOrReturn(mIter != nullptr);
mIter->Release();
mIter = nullptr;
}
private:
Releasable * mIter = nullptr;
};
// Helper function that strips off the interface ID from a peer address that is
// not an IPv6 link-local address. For any other address type we should rely on
// the device's routing table to route messages sent. Forcing messages down a
// specific interface might fail with "no route to host".
void CorrectPeerAddressInterfaceID(Transport::PeerAddress & peerAddress)
{
if (peerAddress.GetIPAddress().IsIPv6LinkLocal())
{
return;
}
peerAddress.SetInterface(Inet::InterfaceId::Null());
}
} // namespace
uint32_t EncryptedPacketBufferHandle::GetMessageCounter() const
{
PacketHeader header;
uint16_t headerSize = 0;
CHIP_ERROR err = header.Decode((*this)->Start(), (*this)->DataLength(), &headerSize);
if (err == CHIP_NO_ERROR)
{
return header.GetMessageCounter();
}
ChipLogError(Inet, "Failed to decode EncryptedPacketBufferHandle header with error: %" CHIP_ERROR_FORMAT, err.Format());
return 0;
}
SessionManager::SessionManager() : mState(State::kNotReady) {}
SessionManager::~SessionManager()
{
this->Shutdown();
}
CHIP_ERROR SessionManager::Init(System::Layer * systemLayer, TransportMgrBase * transportMgr,
Transport::MessageCounterManagerInterface * messageCounterManager,
chip::PersistentStorageDelegate * storageDelegate, FabricTable * fabricTable,
Crypto::SessionKeystore & sessionKeystore)
{
VerifyOrReturnError(mState == State::kNotReady, CHIP_ERROR_INCORRECT_STATE);
VerifyOrReturnError(transportMgr != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
VerifyOrReturnError(storageDelegate != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
VerifyOrReturnError(fabricTable != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
ReturnErrorOnFailure(fabricTable->AddFabricDelegate(this));
mState = State::kInitialized;
mSystemLayer = systemLayer;
mTransportMgr = transportMgr;
mMessageCounterManager = messageCounterManager;
mFabricTable = fabricTable;
mSessionKeystore = &sessionKeystore;
mSecureSessions.Init();
mGlobalUnencryptedMessageCounter.Init();
ReturnErrorOnFailure(mGroupClientCounter.Init(storageDelegate));
mTransportMgr->SetSessionManager(this);
#if INET_CONFIG_ENABLE_TCP_ENDPOINT
mConnCompleteCb = nullptr;
mConnClosedCb = nullptr;
#endif // INET_CONFIG_ENABLE_TCP_ENDPOINT
return CHIP_NO_ERROR;
}
void SessionManager::Shutdown()
{
if (mFabricTable != nullptr)
{
mFabricTable->RemoveFabricDelegate(this);
mFabricTable = nullptr;
}
// Ensure that we don't create new sessions as we iterate our session table.
mState = State::kNotReady;
// Just in case some consumer forgot to do it, expire all our secure
// sessions. Note that this stands a good chance of crashing with a
// null-deref if there are in fact any secure sessions left, since they will
// try to notify their exchanges, which will then try to operate on
// partially-shut-down objects.
ExpireAllSecureSessions();
// We don't have a safe way to check or affect the state of our
// mUnauthenticatedSessions. We can only hope they got shut down properly.
mMessageCounterManager = nullptr;
mSystemLayer = nullptr;
mTransportMgr = nullptr;
mCB = nullptr;
}
/**
* @brief Notification that a fabric was removed.
* This function doesn't call ExpireAllSessionsForFabric
* since the CASE session might still be open to send a response
* on the removed fabric.
*/
void SessionManager::FabricRemoved(FabricIndex fabricIndex)
{
gGroupPeerTable->FabricRemoved(fabricIndex);
}
CHIP_ERROR SessionManager::PrepareMessage(const SessionHandle & sessionHandle, PayloadHeader & payloadHeader,
System::PacketBufferHandle && message, EncryptedPacketBufferHandle & preparedMessage)
{
MATTER_TRACE_SCOPE("PrepareMessage", "SessionManager");
PacketHeader packetHeader;
bool isControlMsg = IsControlMessage(payloadHeader);
if (isControlMsg)
{
packetHeader.SetSecureSessionControlMsg(true);
}
if (sessionHandle->AllowsLargePayload())
{
VerifyOrReturnError(message->TotalLength() <= kMaxLargeAppMessageLen, CHIP_ERROR_MESSAGE_TOO_LONG);
}
else
{
VerifyOrReturnError(message->TotalLength() <= kMaxAppMessageLen, CHIP_ERROR_MESSAGE_TOO_LONG);
}
#if CHIP_PROGRESS_LOGGING
NodeId destination;
FabricIndex fabricIndex;
#endif // CHIP_PROGRESS_LOGGING
PeerAddress destination_address;
switch (sessionHandle->GetSessionType())
{
case Transport::Session::SessionType::kGroupOutgoing: {
auto groupSession = sessionHandle->AsOutgoingGroupSession();
auto * groups = Credentials::GetGroupDataProvider();
VerifyOrReturnError(nullptr != groups, CHIP_ERROR_INTERNAL);
const FabricInfo * fabric = mFabricTable->FindFabricWithIndex(groupSession->GetFabricIndex());
VerifyOrReturnError(fabric != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
packetHeader.SetDestinationGroupId(groupSession->GetGroupId());
packetHeader.SetMessageCounter(mGroupClientCounter.GetCounter(isControlMsg));
mGroupClientCounter.IncrementCounter(isControlMsg);
packetHeader.SetSessionType(Header::SessionType::kGroupSession);
NodeId sourceNodeId = fabric->GetNodeId();
packetHeader.SetSourceNodeId(sourceNodeId);
if (!packetHeader.IsValidGroupMsg())
{
return CHIP_ERROR_INTERNAL;
}
destination_address = Transport::PeerAddress::Multicast(fabric->GetFabricId(), groupSession->GetGroupId());
// Trace before any encryption
MATTER_LOG_MESSAGE_SEND(chip::Tracing::OutgoingMessageType::kGroupMessage, &payloadHeader, &packetHeader,
chip::ByteSpan(message->Start(), message->TotalLength()));
CHIP_TRACE_MESSAGE_SENT(payloadHeader, packetHeader, destination_address, message->Start(), message->TotalLength());
Crypto::SymmetricKeyContext * keyContext =
groups->GetKeyContext(groupSession->GetFabricIndex(), groupSession->GetGroupId());
VerifyOrReturnError(nullptr != keyContext, CHIP_ERROR_INTERNAL);
packetHeader.SetSessionId(keyContext->GetKeyHash());
CryptoContext::NonceStorage nonce;
CryptoContext::BuildNonce(nonce, packetHeader.GetSecurityFlags(), packetHeader.GetMessageCounter(), sourceNodeId);
CHIP_ERROR err = SecureMessageCodec::Encrypt(CryptoContext(keyContext), nonce, payloadHeader, packetHeader, message);
keyContext->Release();
ReturnErrorOnFailure(err);
#if CHIP_PROGRESS_LOGGING
destination = NodeIdFromGroupId(groupSession->GetGroupId());
fabricIndex = groupSession->GetFabricIndex();
#endif // CHIP_PROGRESS_LOGGING
}
break;
case Transport::Session::SessionType::kSecure: {
SecureSession * session = sessionHandle->AsSecureSession();
if (session == nullptr)
{
return CHIP_ERROR_NOT_CONNECTED;
}
MessageCounter & counter = session->GetSessionMessageCounter().GetLocalMessageCounter();
uint32_t messageCounter;
ReturnErrorOnFailure(counter.AdvanceAndConsume(messageCounter));
packetHeader
.SetMessageCounter(messageCounter) //
.SetSessionId(session->GetPeerSessionId()) //
.SetSessionType(Header::SessionType::kUnicastSession);
destination_address = session->GetPeerAddress();
// Trace before any encryption
MATTER_LOG_MESSAGE_SEND(chip::Tracing::OutgoingMessageType::kSecureSession, &payloadHeader, &packetHeader,
chip::ByteSpan(message->Start(), message->TotalLength()));
CHIP_TRACE_MESSAGE_SENT(payloadHeader, packetHeader, destination_address, message->Start(), message->TotalLength());
CryptoContext::NonceStorage nonce;
NodeId sourceNodeId = session->GetLocalScopedNodeId().GetNodeId();
CryptoContext::BuildNonce(nonce, packetHeader.GetSecurityFlags(), messageCounter, sourceNodeId);
ReturnErrorOnFailure(SecureMessageCodec::Encrypt(session->GetCryptoContext(), nonce, payloadHeader, packetHeader, message));
#if CHIP_PROGRESS_LOGGING
destination = session->GetPeerNodeId();
fabricIndex = session->GetFabricIndex();
#endif // CHIP_PROGRESS_LOGGING
}
break;
case Transport::Session::SessionType::kUnauthenticated: {
MessageCounter & counter = mGlobalUnencryptedMessageCounter;
uint32_t messageCounter;
ReturnErrorOnFailure(counter.AdvanceAndConsume(messageCounter));
packetHeader.SetMessageCounter(messageCounter);
Transport::UnauthenticatedSession * session = sessionHandle->AsUnauthenticatedSession();
switch (session->GetSessionRole())
{
case Transport::UnauthenticatedSession::SessionRole::kInitiator:
packetHeader.SetSourceNodeId(session->GetEphemeralInitiatorNodeID());
break;
case Transport::UnauthenticatedSession::SessionRole::kResponder:
packetHeader.SetDestinationNodeId(session->GetEphemeralInitiatorNodeID());
break;
}
auto unauthenticated = sessionHandle->AsUnauthenticatedSession();
destination_address = unauthenticated->GetPeerAddress();
// Trace after all headers are settled.
MATTER_LOG_MESSAGE_SEND(chip::Tracing::OutgoingMessageType::kUnauthenticated, &payloadHeader, &packetHeader,
chip::ByteSpan(message->Start(), message->TotalLength()));
CHIP_TRACE_MESSAGE_SENT(payloadHeader, packetHeader, destination_address, message->Start(), message->TotalLength());
ReturnErrorOnFailure(payloadHeader.EncodeBeforeData(message));
#if CHIP_PROGRESS_LOGGING
destination = kUndefinedNodeId;
fabricIndex = kUndefinedFabricIndex;
#endif // CHIP_PROGRESS_LOGGING
}
break;
default:
return CHIP_ERROR_INTERNAL;
}
#if CHIP_PROGRESS_LOGGING
CompressedFabricId compressedFabricId = kUndefinedCompressedFabricId;
if (fabricIndex != kUndefinedFabricIndex && mFabricTable != nullptr)
{
auto fabricInfo = mFabricTable->FindFabricWithIndex(fabricIndex);
if (fabricInfo)
{
compressedFabricId = fabricInfo->GetCompressedFabricId();
}
}
auto * protocolName = Protocols::GetProtocolName(payloadHeader.GetProtocolID());
auto * msgTypeName = Protocols::GetMessageTypeName(payloadHeader.GetProtocolID(), payloadHeader.GetMessageType());
//
// 32-bit value maximum = 10 chars + text preamble (6) + trailer (1) + null (1) + 2 buffer = 20
//
char ackBuf[20];
ackBuf[0] = '\0';
if (payloadHeader.GetAckMessageCounter().HasValue())
{
snprintf(ackBuf, sizeof(ackBuf), " (Ack:" ChipLogFormatMessageCounter ")", payloadHeader.GetAckMessageCounter().Value());
}
char addressStr[Transport::PeerAddress::kMaxToStringSize] = { 0 };
destination_address.ToString(addressStr);
// Work around pigweed not allowing more than 14 format args in a log
// message when using tokenized logs.
char typeStr[4 + 1 + 2 + 1];
snprintf(typeStr, sizeof(typeStr), "%04X:%02X", payloadHeader.GetProtocolID().GetProtocolId(), payloadHeader.GetMessageType());
//
// Legend that can be used to decode this log line can be found in messaging/README.md
//
ChipLogProgress(ExchangeManager,
"<<< [E:" ChipLogFormatExchangeId " S:%u M:" ChipLogFormatMessageCounter
"%s] (%s) Msg TX to %u:" ChipLogFormatX64 " [%04X] [%s] --- Type %s (%s:%s)",
ChipLogValueExchangeIdFromSentHeader(payloadHeader), sessionHandle->SessionIdForLogging(),
packetHeader.GetMessageCounter(), ackBuf, Transport::GetSessionTypeString(sessionHandle), fabricIndex,
ChipLogValueX64(destination), static_cast<uint16_t>(compressedFabricId), addressStr, typeStr, protocolName,
msgTypeName);
#endif
ReturnErrorOnFailure(packetHeader.EncodeBeforeData(message));
preparedMessage = EncryptedPacketBufferHandle::MarkEncrypted(std::move(message));
return CHIP_NO_ERROR;
}
CHIP_ERROR SessionManager::SendPreparedMessage(const SessionHandle & sessionHandle,
const EncryptedPacketBufferHandle & preparedMessage)
{
VerifyOrReturnError(mState == State::kInitialized, CHIP_ERROR_INCORRECT_STATE);
VerifyOrReturnError(!preparedMessage.IsNull(), CHIP_ERROR_INVALID_ARGUMENT);
Transport::PeerAddress multicastAddress; // Only used for the group case
const Transport::PeerAddress * destination;
switch (sessionHandle->GetSessionType())
{
case Transport::Session::SessionType::kGroupOutgoing: {
auto groupSession = sessionHandle->AsOutgoingGroupSession();
const FabricInfo * fabric = mFabricTable->FindFabricWithIndex(groupSession->GetFabricIndex());
VerifyOrReturnError(fabric != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
multicastAddress = Transport::PeerAddress::Multicast(fabric->GetFabricId(), groupSession->GetGroupId());
destination = &multicastAddress;
}
break;
case Transport::Session::SessionType::kSecure: {
// Find an active connection to the specified peer node
SecureSession * secure = sessionHandle->AsSecureSession();
// This marks any connection where we send data to as 'active'
secure->MarkActive();
destination = &secure->GetPeerAddress();
}
break;
case Transport::Session::SessionType::kUnauthenticated: {
auto unauthenticated = sessionHandle->AsUnauthenticatedSession();
unauthenticated->MarkActive();
destination = &unauthenticated->GetPeerAddress();
}
break;
default:
return CHIP_ERROR_INTERNAL;
}
PacketBufferHandle msgBuf = preparedMessage.CastToWritable();
VerifyOrReturnError(!msgBuf.IsNull(), CHIP_ERROR_INVALID_ARGUMENT);
VerifyOrReturnError(!msgBuf->HasChainedBuffer(), CHIP_ERROR_INVALID_MESSAGE_LENGTH);
#if CHIP_SYSTEM_CONFIG_MULTICAST_HOMING
if (sessionHandle->GetSessionType() == Transport::Session::SessionType::kGroupOutgoing)
{
chip::Inet::InterfaceIterator interfaceIt;
chip::Inet::InterfaceId interfaceId = chip::Inet::InterfaceId::Null();
chip::Inet::IPAddress addr;
bool interfaceFound = false;
while (interfaceIt.Next())
{
char name[chip::Inet::InterfaceId::kMaxIfNameLength];
interfaceIt.GetInterfaceName(name, chip::Inet::InterfaceId::kMaxIfNameLength);
if (interfaceIt.SupportsMulticast() && interfaceIt.IsUp())
{
interfaceId = interfaceIt.GetInterfaceId();
if (CHIP_NO_ERROR == interfaceId.GetLinkLocalAddr(&addr))
{
ChipLogDetail(Inet, "Interface %s has a link local address", name);
interfaceFound = true;
PacketBufferHandle tempBuf = msgBuf.CloneData();
VerifyOrReturnError(!tempBuf.IsNull(), CHIP_ERROR_INVALID_ARGUMENT);
VerifyOrReturnError(!tempBuf->HasChainedBuffer(), CHIP_ERROR_INVALID_MESSAGE_LENGTH);
destination = &(multicastAddress.SetInterface(interfaceId));
if (mTransportMgr != nullptr)
{
if (CHIP_NO_ERROR != mTransportMgr->SendMessage(*destination, std::move(tempBuf)))
{
ChipLogError(Inet, "Failed to send Multicast message on interface %s", name);
}
else
{
ChipLogDetail(Inet, "Successfully send Multicast message on interface %s", name);
}
}
}
}
}
if (!interfaceFound)
{
ChipLogError(Inet, "No valid Interface found.. Sending to the default one.. ");
}
else
{
// Always return No error, because we expect some interface to fails and others to always succeed (e.g. lo interface)
return CHIP_NO_ERROR;
}
}
#endif // CHIP_SYSTEM_CONFIG_MULTICAST_HOMING
if (mTransportMgr != nullptr)
{
CHIP_ERROR err = mTransportMgr->SendMessage(*destination, std::move(msgBuf));
#if CHIP_ERROR_LOGGING
if (err != CHIP_NO_ERROR)
{
char addressStr[Transport::PeerAddress::kMaxToStringSize] = { 0 };
destination->ToString(addressStr);
ChipLogError(Inet, "SendMessage() to %s failed: %" CHIP_ERROR_FORMAT, addressStr, err.Format());
}
#endif // CHIP_ERROR_LOGGING
return err;
}
ChipLogError(Inet, "The transport manager is not initialized. Unable to send the message");
return CHIP_ERROR_INCORRECT_STATE;
}
void SessionManager::ExpireAllSessions(const ScopedNodeId & node)
{
ChipLogDetail(Inet, "Expiring all sessions for node " ChipLogFormatScopedNodeId "!!", ChipLogValueScopedNodeId(node));
ForEachMatchingSession(node, [](auto * session) { session->MarkForEviction(); });
}
void SessionManager::ExpireAllSessionsForFabric(FabricIndex fabricIndex)
{
ChipLogDetail(Inet, "Expiring all sessions for fabric 0x%x!!", static_cast<unsigned>(fabricIndex));
ForEachMatchingSession(fabricIndex, [](auto * session) { session->MarkForEviction(); });
}
CHIP_ERROR SessionManager::ExpireAllSessionsOnLogicalFabric(const ScopedNodeId & node)
{
ChipLogDetail(Inet, "Expiring all sessions to peer " ChipLogFormatScopedNodeId " that are on the same logical fabric!!",
ChipLogValueScopedNodeId(node));
return ForEachMatchingSessionOnLogicalFabric(node, [](auto * session) { session->MarkForEviction(); });
}
CHIP_ERROR SessionManager::ExpireAllSessionsOnLogicalFabric(FabricIndex fabricIndex)
{
ChipLogDetail(Inet, "Expiring all sessions on the same logical fabric as fabric 0x%x!!", static_cast<unsigned>(fabricIndex));
return ForEachMatchingSessionOnLogicalFabric(fabricIndex, [](auto * session) { session->MarkForEviction(); });
}
void SessionManager::ExpireAllPASESessions()
{
ChipLogDetail(Inet, "Expiring all PASE sessions");
mSecureSessions.ForEachSession([&](auto session) {
if (session->GetSecureSessionType() == Transport::SecureSession::Type::kPASE)
{
session->MarkForEviction();
}
return Loop::Continue;
});
}
void SessionManager::ExpireAllSecureSessions()
{
mSecureSessions.ForEachSession([&](auto session) {
session->MarkForEviction();
return Loop::Continue;
});
}
void SessionManager::MarkSessionsAsDefunct(const ScopedNodeId & node, const Optional<Transport::SecureSession::Type> & type)
{
mSecureSessions.ForEachSession([&node, &type](auto session) {
if (session->IsActiveSession() && session->GetPeer() == node &&
(!type.HasValue() || type.Value() == session->GetSecureSessionType()))
{
session->MarkAsDefunct();
}
return Loop::Continue;
});
}
void SessionManager::UpdateAllSessionsPeerAddress(const ScopedNodeId & node, const Transport::PeerAddress & addr)
{
mSecureSessions.ForEachSession([&node, &addr](auto session) {
// Arguably we should only be updating active and defunct sessions, but there is no harm
// in updating evicted sessions.
if (session->GetPeer() == node && Transport::SecureSession::Type::kCASE == session->GetSecureSessionType())
{
session->SetPeerAddress(addr);
}
return Loop::Continue;
});
}
Optional<SessionHandle> SessionManager::AllocateSession(SecureSession::Type secureSessionType,
const ScopedNodeId & sessionEvictionHint)
{
VerifyOrReturnValue(mState == State::kInitialized, NullOptional);
return mSecureSessions.CreateNewSecureSession(secureSessionType, sessionEvictionHint);
}
CHIP_ERROR SessionManager::InjectPaseSessionWithTestKey(SessionHolder & sessionHolder, uint16_t localSessionId, NodeId peerNodeId,
uint16_t peerSessionId, FabricIndex fabric,
const Transport::PeerAddress & peerAddress, CryptoContext::SessionRole role)
{
NodeId localNodeId = kUndefinedNodeId;
Optional<SessionHandle> session = mSecureSessions.CreateNewSecureSessionForTest(
chip::Transport::SecureSession::Type::kPASE, localSessionId, localNodeId, peerNodeId, CATValues{}, peerSessionId, fabric,
GetLocalMRPConfig().ValueOr(GetDefaultMRPConfig()));
VerifyOrReturnError(session.HasValue(), CHIP_ERROR_NO_MEMORY);
SecureSession * secureSession = session.Value()->AsSecureSession();
secureSession->SetPeerAddress(peerAddress);
size_t secretLen = CHIP_CONFIG_TEST_SHARED_SECRET_LENGTH;
ByteSpan secret(reinterpret_cast<const uint8_t *>(CHIP_CONFIG_TEST_SHARED_SECRET_VALUE), secretLen);
ReturnErrorOnFailure(secureSession->GetCryptoContext().InitFromSecret(
*mSessionKeystore, secret, ByteSpan(), CryptoContext::SessionInfoType::kSessionEstablishment, role));
secureSession->GetSessionMessageCounter().GetPeerMessageCounter().SetCounter(Transport::PeerMessageCounter::kInitialSyncValue);
sessionHolder.Grab(session.Value());
return CHIP_NO_ERROR;
}
CHIP_ERROR SessionManager::InjectCaseSessionWithTestKey(SessionHolder & sessionHolder, uint16_t localSessionId,
uint16_t peerSessionId, NodeId localNodeId, NodeId peerNodeId,
FabricIndex fabric, const Transport::PeerAddress & peerAddress,
CryptoContext::SessionRole role, const CATValues & cats)
{
Optional<SessionHandle> session = mSecureSessions.CreateNewSecureSessionForTest(
chip::Transport::SecureSession::Type::kCASE, localSessionId, localNodeId, peerNodeId, cats, peerSessionId, fabric,
GetLocalMRPConfig().ValueOr(GetDefaultMRPConfig()));
VerifyOrReturnError(session.HasValue(), CHIP_ERROR_NO_MEMORY);
SecureSession * secureSession = session.Value()->AsSecureSession();
secureSession->SetPeerAddress(peerAddress);
size_t secretLen = CHIP_CONFIG_TEST_SHARED_SECRET_LENGTH;
ByteSpan secret(reinterpret_cast<const uint8_t *>(CHIP_CONFIG_TEST_SHARED_SECRET_VALUE), secretLen);
ReturnErrorOnFailure(secureSession->GetCryptoContext().InitFromSecret(
*mSessionKeystore, secret, ByteSpan(), CryptoContext::SessionInfoType::kSessionEstablishment, role));
secureSession->GetSessionMessageCounter().GetPeerMessageCounter().SetCounter(Transport::PeerMessageCounter::kInitialSyncValue);
sessionHolder.Grab(session.Value());
return CHIP_NO_ERROR;
}
void SessionManager::OnMessageReceived(const PeerAddress & peerAddress, System::PacketBufferHandle && msg,
Transport::MessageTransportContext * ctxt)
{
PacketHeader partialPacketHeader;
CHIP_ERROR err = partialPacketHeader.DecodeFixed(msg);
if (err != CHIP_NO_ERROR)
{
ChipLogError(Inet, "Failed to decode packet header: %" CHIP_ERROR_FORMAT, err.Format());
return;
}
if (partialPacketHeader.IsEncrypted())
{
if (partialPacketHeader.IsGroupSession())
{
SecureGroupMessageDispatch(partialPacketHeader, peerAddress, std::move(msg));
}
else
{
SecureUnicastMessageDispatch(partialPacketHeader, peerAddress, std::move(msg), ctxt);
}
}
else
{
UnauthenticatedMessageDispatch(partialPacketHeader, peerAddress, std::move(msg), ctxt);
}
}
#if INET_CONFIG_ENABLE_TCP_ENDPOINT
void SessionManager::HandleConnectionReceived(Transport::ActiveTCPConnectionState * conn)
{
char peerAddrBuf[chip::Transport::PeerAddress::kMaxToStringSize];
VerifyOrReturn(conn != nullptr);
conn->mPeerAddr.ToString(peerAddrBuf);
ChipLogProgress(Inet, "Received TCP connection request from %s.", peerAddrBuf);
Transport::AppTCPConnectionCallbackCtxt * appTCPConnCbCtxt = conn->mAppState;
if (appTCPConnCbCtxt != nullptr && appTCPConnCbCtxt->connReceivedCb != nullptr)
{
appTCPConnCbCtxt->connReceivedCb(conn);
}
}
void SessionManager::HandleConnectionAttemptComplete(Transport::ActiveTCPConnectionState * conn, CHIP_ERROR conErr)
{
VerifyOrReturn(conn != nullptr);
Transport::AppTCPConnectionCallbackCtxt * appTCPConnCbCtxt = conn->mAppState;
if (appTCPConnCbCtxt == nullptr)
{
TCPDisconnect(conn, /* shouldAbort = */ true);
return;
}
if (appTCPConnCbCtxt->connCompleteCb != nullptr)
{
appTCPConnCbCtxt->connCompleteCb(conn, conErr);
}
else
{
char peerAddrBuf[chip::Transport::PeerAddress::kMaxToStringSize];
conn->mPeerAddr.ToString(peerAddrBuf);
ChipLogProgress(Inet, "TCP Connection established with peer %s, but no registered handler. Disconnecting.", peerAddrBuf);
// Close the connection
TCPDisconnect(conn, /* shouldAbort = */ true);
}
}
void SessionManager::HandleConnectionClosed(Transport::ActiveTCPConnectionState * conn, CHIP_ERROR conErr)
{
VerifyOrReturn(conn != nullptr);
// Mark the corresponding secure sessions as defunct
mSecureSessions.ForEachSession([&](auto session) {
if (session->IsActiveSession() && session->GetTCPConnection() == conn)
{
SessionHandle handle(*session);
// Notify the SessionConnection delegate of the connection
// closure.
if (mConnDelegate != nullptr)
{
mConnDelegate->OnTCPConnectionClosed(handle, conErr);
}
// Dis-associate the connection from session by setting it to a
// nullptr.
session->SetTCPConnection(nullptr);
// Mark session as defunct
session->MarkAsDefunct();
}
return Loop::Continue;
});
// TODO: A mechanism to mark an unauthenticated session as unusable when
// the underlying connection is broken. Issue #32323
Transport::AppTCPConnectionCallbackCtxt * appTCPConnCbCtxt = conn->mAppState;
VerifyOrReturn(appTCPConnCbCtxt != nullptr);
if (appTCPConnCbCtxt->connClosedCb != nullptr)
{
appTCPConnCbCtxt->connClosedCb(conn, conErr);
}
}
CHIP_ERROR SessionManager::TCPConnect(const PeerAddress & peerAddress, Transport::AppTCPConnectionCallbackCtxt * appState,
Transport::ActiveTCPConnectionState ** peerConnState)
{
char peerAddrBuf[chip::Transport::PeerAddress::kMaxToStringSize];
peerAddress.ToString(peerAddrBuf);
if (mTransportMgr != nullptr)
{
ChipLogProgress(Inet, "Connecting over TCP with peer at %s.", peerAddrBuf);
return mTransportMgr->TCPConnect(peerAddress, appState, peerConnState);
}
ChipLogError(Inet, "The transport manager is not initialized. Unable to connect to peer at %s.", peerAddrBuf);
return CHIP_ERROR_INCORRECT_STATE;
}
CHIP_ERROR SessionManager::TCPDisconnect(const PeerAddress & peerAddress)
{
if (mTransportMgr != nullptr)
{
char peerAddrBuf[chip::Transport::PeerAddress::kMaxToStringSize];
peerAddress.ToString(peerAddrBuf);
ChipLogProgress(Inet, "Disconnecting TCP connection from peer at %s.", peerAddrBuf);
mTransportMgr->TCPDisconnect(peerAddress);
}
return CHIP_NO_ERROR;
}
void SessionManager::TCPDisconnect(Transport::ActiveTCPConnectionState * conn, bool shouldAbort)
{
if (mTransportMgr != nullptr && conn != nullptr)
{
char peerAddrBuf[chip::Transport::PeerAddress::kMaxToStringSize];
conn->mPeerAddr.ToString(peerAddrBuf);
ChipLogProgress(Inet, "Disconnecting TCP connection from peer at %s.", peerAddrBuf);
mTransportMgr->TCPDisconnect(conn, shouldAbort);
}
}
#endif // INET_CONFIG_ENABLE_TCP_ENDPOINT
void SessionManager::UnauthenticatedMessageDispatch(const PacketHeader & partialPacketHeader,
const Transport::PeerAddress & peerAddress, System::PacketBufferHandle && msg,
Transport::MessageTransportContext * ctxt)
{
MATTER_TRACE_SCOPE("Unauthenticated Message Dispatch", "SessionManager");
#if INET_CONFIG_ENABLE_TCP_ENDPOINT
if (peerAddress.GetTransportType() == Transport::Type::kTcp && ctxt->conn == nullptr)
{
ChipLogError(Inet, "Connection object is missing for received message.");
return;
}
#endif // INET_CONFIG_ENABLE_TCP_ENDPOINT
// Drop unsecured messages with privacy enabled.
if (partialPacketHeader.HasPrivacyFlag())
{
ChipLogError(Inet, "Dropping unauthenticated message with privacy flag set");
return;
}
PacketHeader packetHeader;
ReturnOnFailure(packetHeader.DecodeAndConsume(msg));
Optional<NodeId> source = packetHeader.GetSourceNodeId();
Optional<NodeId> destination = packetHeader.GetDestinationNodeId();
if ((source.HasValue() && destination.HasValue()) || (!source.HasValue() && !destination.HasValue()))
{
ChipLogProgress(Inet,
"Received malformed unsecure packet with source 0x" ChipLogFormatX64 " destination 0x" ChipLogFormatX64,
ChipLogValueX64(source.ValueOr(kUndefinedNodeId)), ChipLogValueX64(destination.ValueOr(kUndefinedNodeId)));
return; // ephemeral node id is only assigned to the initiator, there should be one and only one node id exists.
}
Optional<SessionHandle> optionalSession;
if (source.HasValue())
{
// Assume peer is the initiator, we are the responder.
optionalSession = mUnauthenticatedSessions.FindOrAllocateResponder(source.Value(), GetDefaultMRPConfig(), peerAddress);
if (!optionalSession.HasValue())
{
ChipLogError(Inet, "UnauthenticatedSession exhausted");
return;
}
}
else
{
// Assume peer is the responder, we are the initiator.
optionalSession = mUnauthenticatedSessions.FindInitiator(destination.Value(), peerAddress);
if (!optionalSession.HasValue())
{
ChipLogProgress(Inet, "Received unknown unsecure packet for initiator 0x" ChipLogFormatX64,
ChipLogValueX64(destination.Value()));
return;
}
}
const SessionHandle & session = optionalSession.Value();
Transport::UnauthenticatedSession * unsecuredSession = session->AsUnauthenticatedSession();
Transport::PeerAddress mutablePeerAddress = peerAddress;
CorrectPeerAddressInterfaceID(mutablePeerAddress);
unsecuredSession->SetPeerAddress(mutablePeerAddress);
SessionMessageDelegate::DuplicateMessage isDuplicate = SessionMessageDelegate::DuplicateMessage::No;
#if INET_CONFIG_ENABLE_TCP_ENDPOINT
// Associate the unauthenticated session with the connection, if not done already.
if (peerAddress.GetTransportType() == Transport::Type::kTcp)
{
Transport::ActiveTCPConnectionState * sessionConn = unsecuredSession->GetTCPConnection();
if (sessionConn == nullptr)
{
unsecuredSession->SetTCPConnection(ctxt->conn);
}
else
{
if (sessionConn != ctxt->conn)
{
ChipLogError(Inet, "Data received over wrong connection %p. Dropping it!", ctxt->conn);
return;
}
}
}
#endif // INET_CONFIG_ENABLE_TCP_ENDPOINT
unsecuredSession->MarkActiveRx();
PayloadHeader payloadHeader;
ReturnOnFailure(payloadHeader.DecodeAndConsume(msg));
// Verify message counter
CHIP_ERROR err = unsecuredSession->GetPeerMessageCounter().VerifyUnencrypted(packetHeader.GetMessageCounter());
if (err == CHIP_ERROR_DUPLICATE_MESSAGE_RECEIVED)
{
ChipLogDetail(Inet,
"Received a duplicate message with MessageCounter:" ChipLogFormatMessageCounter
" on exchange " ChipLogFormatExchangeId,
packetHeader.GetMessageCounter(), ChipLogValueExchangeIdFromReceivedHeader(payloadHeader));
isDuplicate = SessionMessageDelegate::DuplicateMessage::Yes;
err = CHIP_NO_ERROR;
}
else
{
// VerifyUnencrypted always returns one of CHIP_NO_ERROR or
// CHIP_ERROR_DUPLICATE_MESSAGE_RECEIVED.
unsecuredSession->GetPeerMessageCounter().CommitUnencrypted(packetHeader.GetMessageCounter());
}
if (mCB != nullptr)
{
MATTER_LOG_MESSAGE_RECEIVED(chip::Tracing::IncomingMessageType::kUnauthenticated, &payloadHeader, &packetHeader,
unsecuredSession, &peerAddress, chip::ByteSpan(msg->Start(), msg->TotalLength()));
CHIP_TRACE_MESSAGE_RECEIVED(payloadHeader, packetHeader, unsecuredSession, peerAddress, msg->Start(), msg->TotalLength());
mCB->OnMessageReceived(packetHeader, payloadHeader, session, isDuplicate, std::move(msg));
}
else
{
ChipLogError(Inet, "Received UNSECURED message was not processed.");
}
}
void SessionManager::SecureUnicastMessageDispatch(const PacketHeader & partialPacketHeader,
const Transport::PeerAddress & peerAddress, System::PacketBufferHandle && msg,
Transport::MessageTransportContext * ctxt)
{
MATTER_TRACE_SCOPE("Secure Unicast Message Dispatch", "SessionManager");
CHIP_ERROR err = CHIP_NO_ERROR;
#if INET_CONFIG_ENABLE_TCP_ENDPOINT
if (peerAddress.GetTransportType() == Transport::Type::kTcp && ctxt->conn == nullptr)
{
ChipLogError(Inet, "Connection object is missing for received message.");
return;
}
#endif // INET_CONFIG_ENABLE_TCP_ENDPOINT
Optional<SessionHandle> session = mSecureSessions.FindSecureSessionByLocalKey(partialPacketHeader.GetSessionId());
if (!session.HasValue())
{
ChipLogError(Inet, "Data received on an unknown session (LSID=%d). Dropping it!", partialPacketHeader.GetSessionId());
return;
}
Transport::SecureSession * secureSession = session.Value()->AsSecureSession();
Transport::PeerAddress mutablePeerAddress = peerAddress;
CorrectPeerAddressInterfaceID(mutablePeerAddress);
if (secureSession->GetPeerAddress() != mutablePeerAddress)
{
secureSession->SetPeerAddress(mutablePeerAddress);
}
#if INET_CONFIG_ENABLE_TCP_ENDPOINT
// Associate the secure session with the connection, if not done already.
if (peerAddress.GetTransportType() == Transport::Type::kTcp)
{
Transport::ActiveTCPConnectionState * sessionConn = secureSession->GetTCPConnection();
if (sessionConn == nullptr)
{
secureSession->SetTCPConnection(ctxt->conn);
}
else
{
if (sessionConn != ctxt->conn)
{
ChipLogError(Inet, "Data received over wrong connection %p. Dropping it!", ctxt->conn);
return;
}
}
}
#endif // INET_CONFIG_ENABLE_TCP_ENDPOINT
PayloadHeader payloadHeader;
// Drop secure unicast messages with privacy enabled.
if (partialPacketHeader.HasPrivacyFlag())
{
ChipLogError(Inet, "Dropping secure unicast message with privacy flag set");
return;
}
PacketHeader packetHeader;
ReturnOnFailure(packetHeader.DecodeAndConsume(msg));
SessionMessageDelegate::DuplicateMessage isDuplicate = SessionMessageDelegate::DuplicateMessage::No;
if (msg.IsNull())
{
ChipLogError(Inet, "Secure transport received Unicast NULL packet, discarding");
return;
}
// We need to allow through messages even on sessions that are pending
// evictions, because for some cases (UpdateNOC, RemoveFabric, etc) there
// can be a single exchange alive on the session waiting for a MRP ack, and
// we need to make sure to send the ack through. The exchange manager is
// responsible for ensuring that such messages do not lead to new exchange
// creation.
if (!secureSession->IsDefunct() && !secureSession->IsActiveSession() && !secureSession->IsPendingEviction())
{
ChipLogError(Inet, "Secure transport received message on a session in an invalid state (state = '%s')",
secureSession->GetStateStr());
return;
}
// Decrypt and verify the message before message counter verification or any further processing.
CryptoContext::NonceStorage nonce;
// PASE Sessions use the undefined node ID of all zeroes, since there is no node ID to use
// and the key is short-lived and always different for each PASE session.
CryptoContext::BuildNonce(nonce, packetHeader.GetSecurityFlags(), packetHeader.GetMessageCounter(),
secureSession->GetSecureSessionType() == SecureSession::Type::kCASE ? secureSession->GetPeerNodeId()
: kUndefinedNodeId);
if (SecureMessageCodec::Decrypt(secureSession->GetCryptoContext(), nonce, payloadHeader, packetHeader, msg) != CHIP_NO_ERROR)
{
ChipLogError(Inet, "Secure transport received message, but failed to decode/authenticate it, discarding");
return;
}
err =