more comments

Author: Alami-Amine

src/protocols/secure_channel/CASESession.cpp

@@ -853,7 +853,7 @@ CHIP_ERROR CASESession::SendSigma1()
             ReturnErrorOnFailure(GenerateSigmaResumeMIC(encodeSigma1Inputs.initiatorRandom, encodeSigma1Inputs.resumptionId,
                                                         ByteSpan(kKDFS1RKeyInfo), ByteSpan(kResume1MIC_Nonce), resumeMICSpan));
 
-            encodeSigma1Inputs.initiatorResumeMICSpan     = resumeMICSpan;
+            encodeSigma1Inputs.initiatorResumeMIC         = resumeMICSpan;
             encodeSigma1Inputs.sessionResumptionRequested = true;
         }
     }
@@ -897,8 +897,6 @@ CHIP_ERROR CASESession::EncodeSigma1(System::PacketBufferHandle & msg, EncodeSig
 {
     MATTER_TRACE_SCOPE("EncodeSigma1", "CASESession");
 
-    // The API Contract requires the passed PacketBufferHandle to be empty
-    VerifyOrReturnError(msg.IsNull(), CHIP_ERROR_INCORRECT_STATE);
     VerifyOrReturnError(input.initiatorEphPubKey != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
 
     size_t dataLen = EstimateStructOverhead(kSigmaParamRandomNumberSize,                 // initiatorRandom
@@ -932,7 +930,7 @@ CHIP_ERROR CASESession::EncodeSigma1(System::PacketBufferHandle & msg, EncodeSig
     if (input.sessionResumptionRequested)
     {
         ReturnErrorOnFailure(tlvWriter.Put(AsTlvContextTag(Sigma1Tags::kResumptionID), input.resumptionId));
-        ReturnErrorOnFailure(tlvWriter.Put(AsTlvContextTag(Sigma1Tags::kResume1MIC), input.initiatorResumeMICSpan));
+        ReturnErrorOnFailure(tlvWriter.Put(AsTlvContextTag(Sigma1Tags::kResume1MIC), input.initiatorResumeMIC));
     }
 
     ReturnErrorOnFailure(tlvWriter.EndContainer(outerContainerType));
@@ -1110,7 +1108,7 @@ CASESession::NextStep CASESession::HandleSigma1(System::PacketBufferHandle && ms
         parsedSigma1.resumptionId.size() == SessionResumptionStorage::kResumptionIdSize &&
         CHIP_NO_ERROR ==
             TryResumeSession(SessionResumptionStorage::ConstResumptionIdView(parsedSigma1.resumptionId.data()),
-                             parsedSigma1.initiatorResumeMICSpan, parsedSigma1.initiatorRandom))
+                             parsedSigma1.initiatorResumeMIC, parsedSigma1.initiatorRandom))
     {
         std::copy(parsedSigma1.initiatorRandom.begin(), parsedSigma1.initiatorRandom.end(), mInitiatorRandom);
         std::copy(parsedSigma1.resumptionId.begin(), parsedSigma1.resumptionId.end(), mResumeResumptionId.begin());
@@ -1175,8 +1173,6 @@ CHIP_ERROR CASESession::EncodeSigma2Resume(System::PacketBufferHandle & msgR2Res
 {
     MATTER_TRACE_SCOPE("EncodeSigma2Resume", "CASESession");
 
-    // The API Contract requires the passed PacketBufferHandle to be empty
-    VerifyOrReturnError(msgR2Resume.IsNull(), CHIP_ERROR_INCORRECT_STATE);
     VerifyOrReturnError(input.responderMrpConfig != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
 
     size_t maxDatalLen = EstimateStructOverhead(SessionResumptionStorage::kResumptionIdSize, // resumptionID
@@ -1338,8 +1334,6 @@ CHIP_ERROR CASESession::PrepareSigma2(EncodeSigma2Inputs & outSigma2Data)
 
 CHIP_ERROR CASESession::EncodeSigma2(System::PacketBufferHandle & msgR2, EncodeSigma2Inputs & input)
 {
-    // The API Contract requires the passed PacketBufferHandle to be empty
-    VerifyOrReturnError(msgR2.IsNull(), CHIP_ERROR_INCORRECT_STATE);
     VerifyOrReturnError(input.responderEphPubKey != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
     VerifyOrReturnError(input.msgR2Encrypted, CHIP_ERROR_INCORRECT_STATE);
     // Check if length of msgR2Encrypted is set and is at least larger than the MIC length
@@ -2351,8 +2345,8 @@ CHIP_ERROR CASESession::ParseSigma1(TLV::ContiguousBufferTLVReader & tlvReader,
     if (err == CHIP_NO_ERROR && tlvReader.GetTag() == AsTlvContextTag(Sigma1Tags::kResume1MIC))
     {
         resume1MICTagFound = true;
-        ReturnErrorOnFailure(tlvReader.GetByteView(outParsedSigma1.initiatorResumeMICSpan));
-        VerifyOrReturnError(outParsedSigma1.initiatorResumeMICSpan.size() == CHIP_CRYPTO_AEAD_MIC_LENGTH_BYTES,
+        ReturnErrorOnFailure(tlvReader.GetByteView(outParsedSigma1.initiatorResumeMIC));
+        VerifyOrReturnError(outParsedSigma1.initiatorResumeMIC.size() == CHIP_CRYPTO_AEAD_MIC_LENGTH_BYTES,
                             CHIP_ERROR_INVALID_CASE_PARAMETER);
         err = tlvReader.Next();
     }

src/protocols/secure_channel/CASESession.h

@@ -210,7 +210,7 @@ class DLL_EXPORT CASESession : public Messaging::UnsolicitedMessageHandler,
         ByteSpan destinationId;
         bool sessionResumptionRequested = false;
         ByteSpan resumptionId;
-        ByteSpan initiatorResumeMICSpan;
+        ByteSpan initiatorResumeMIC;
     };
 
     struct EncodeSigma1Inputs : Sigma1Param
@@ -251,12 +251,11 @@ class DLL_EXPORT CASESession : public Messaging::UnsolicitedMessageHandler,
      * @brief  Encodes a Sigma1 message into TLV format and allocates a buffer for it, which is owned by the PacketBufferHandle
      *outparam.
      *
-     * @param outMsg     PacketBufferHandle passed by reference. The handle must be empty prior to calling this method,
-     *              as a new buffer will be allocated and assigned to it within the method.
+     * @param outMsg     PacketBufferHandle passed by reference. A new buffer will be allocated and assigned to it within the
+     *method.
      *
      * @param inParam a struct containing all the values that will be encoded into TLV format
      *
-     * @note the passed PacketBufferHandle `outMsg` must not be holding an existing PacketBuffer.
      **/
     static CHIP_ERROR EncodeSigma1(System::PacketBufferHandle & outMsg, EncodeSigma1Inputs & inParam);
 
@@ -274,7 +273,7 @@ class DLL_EXPORT CASESession : public Messaging::UnsolicitedMessageHandler,
      * These values will be valid as long as the buffer that the passed-in tlvReader is reading from is valid.
      *
      * On success, either the sessionResumptionRequested field will be set to true
-     * and the resumptionID and initiatorResumeMICSpan fields will be set to
+     * and the resumptionID and initiatorResumeMIC fields will be set to
      * valid values, or the sessionResumptionRequested field will be set to false.
      */
     CHIP_ERROR ParseSigma1(TLV::ContiguousBufferTLVReader & tlvReader, ParsedSigma1 & parsedMessage);
@@ -283,12 +282,11 @@ class DLL_EXPORT CASESession : public Messaging::UnsolicitedMessageHandler,
      * @brief  Encodes a Sigma2 message into TLV format and allocates a buffer for it, which is owned by the PacketBufferHandle
      *outparam.
      *
-     * @param outMsg     PacketBufferHandle passed by reference. The handle must be empty prior to calling this method,
-     *              as a new buffer will be allocated and assigned to it within the method.
+     * @param outMsg     PacketBufferHandle passed by reference. A new buffer will be allocated and assigned to it within the
+     *method.
      *
      * @param inParam a struct containing all the values that will be encoded into TLV format
      *
-     * @note the passed PacketBufferHandle `outMsg` must be in a null state.
      **/
 
     static CHIP_ERROR EncodeSigma2(System::PacketBufferHandle & outMsg, EncodeSigma2Inputs & inParam);
@@ -297,12 +295,11 @@ class DLL_EXPORT CASESession : public Messaging::UnsolicitedMessageHandler,
      * @brief  Encodes a Sigma2_Resume message into TLV format and allocates a buffer for it, which is owned by the
      *PacketBufferHandle outparam.
      *
-     * @param outMsg     PacketBufferHandle passed by reference. The handle must be empty prior to calling this method,
-     *              as a new buffer will be allocated and assigned to it within the method.
+     * @param outMsg     PacketBufferHandle passed by reference. A new buffer will be allocated and assigned to it within the
+     *method.
      *
      * @param inParam a struct containing all the values that will be encoded into TLV format
      *
-     * @note the passed PacketBufferHandle `outMsg` must be in a null state.
      **/
     static CHIP_ERROR EncodeSigma2Resume(System::PacketBufferHandle & outMsg, EncodeSigma2ResumeInputs & inParam);
 

src/protocols/secure_channel/tests/TestCASESession.cpp

@@ -967,7 +967,7 @@ TEST_F(TestCASESession, EncodeSigma1Test)
                   CHIP_NO_ERROR);
 
         encodeParams.resumptionId               = ByteSpan(resumptionId.data(), resumptionId.size());
-        encodeParams.initiatorResumeMICSpan     = ByteSpan(encodeParams.initiatorResume1MICBuffer);
+        encodeParams.initiatorResumeMIC         = ByteSpan(encodeParams.initiatorResume1MICBuffer);
         encodeParams.sessionResumptionRequested = true;
 
         System::PacketBufferHandle msg2;
@@ -990,7 +990,7 @@ TEST_F(TestCASESession, EncodeSigma1Test)
             ByteSpan(encodeParams.initiatorEphPubKey->ConstBytes(), encodeParams.initiatorEphPubKey->Length())));
 
         EXPECT_TRUE(parseParams.resumptionId.data_equal(encodeParams.resumptionId));
-        EXPECT_TRUE(parseParams.initiatorResumeMICSpan.data_equal(encodeParams.initiatorResumeMICSpan));
+        EXPECT_TRUE(parseParams.initiatorResumeMIC.data_equal(encodeParams.initiatorResumeMIC));
         EXPECT_TRUE(parseParams.initiatorMrpParamsPresent);
     }
     // Release EphemeralKeyPair