Restyle CASE spec refresh #8649

restyled-io · 2021-07-27T19:35:36Z

A duplicate of #8137 with additional commits that automatically address
incorrect style, created by Restyled.

⚠️ Even though this PR is not a Fork, it contains outside contributions.
Please review accordingly.

Since the original Pull Request was opened as a fork in a contributor's
repository, we are unable to create a Pull Request branching from it with only
the style fixes.

The following Restylers made fixes:

clang-format

To incorporate these changes, you can either:

Merge this Pull Request instead of the original, or

Ask your contributor to locally incorporate these commits and push them to
the original Pull Request

Expand for example instructions

```console
git remote add upstream https://github.com/project-chip/connectedhomeip.git
git fetch upstream pull/<this PR number>/head
git merge --ff-only FETCH_HEAD
git push
```

NOTE: As work continues on the original Pull Request, this process will
re-run and update (force-push) this Pull Request with updated style fixes as
necessary. If the style is fixed manually at any point (i.e. this process finds
no fixes to make), this Pull Request will be closed automatically.

Sorry if this was unexpected. To disable it, see our documentation.

…HMAC-SHA256 Algorithm in GenerateDestinationID method.

…alCredentialSet. Added CredentialsIndex parameter to AdminPairingTable's GetCredentials method. Removed FabricSecret. Removed kIPKInfo. Removed Deprecated ComputeIPK method - Replaced it with dummy RetrieveIPK method.

…to an actual OperationalCredentialSet method to retrieve a TrustedRootId, renamed kMAX_Hash_Length refs to kSHA256_Hash_Length to match the Spec.

This method will release the last certificate data in the set. Added call to ReleaseLastCert method during CASESession after a successful validation of the NOC certificate. Updated CASE Unit Tests to force 3 certificates maximum. This will guarantee that for the tests to work fine, CASESession must release the NOC certificate every time. CASESession: change LoadCerts to LoadCert - Only NOC is transferred during CASE Protocol. No need to handle ICA

… the NOC instead.

…ng a const ChipCertificateData type anymore to avoid confusion. Removed redundant comment from ReleaseLastCert method. Wrote some TODO items to update OperationalCredentialSet class in order to work with size_t variable counters: useful to index more than 255 Credentials. Update DestinationIDGeneration Test to use Spec's test vectors. Added static assert to check TBEData2 and TBEData3 Nonce Lengths : they must match. Added new method to Estimate TLV Struct overhead. Updated GenerateDestinationID to be stateless: now directly accesses the inputs as raw memory buffers. Updated HandleSigma methods to handle TLV tags sequentially. Removed redundant GetLength and GetType calls during TLV Reads. Renamed encryptionKeyId to initiatorSessionId and responderSessionId. Fixed typo in ENABLE_HSM_CASE_EPHEMERAL_KEY macro.

…cureSession, so it needs to be stored. Updated FindDestinationIDCandidate loop variables to size_t. Also updated names to reflect what they are indexing.

…. They can be overridden by the Unit Tests in order to feed in the test IPK vectors.

Update GetCertFabricId method to use UINT64_MAX macro as an invalid reference, and added a final sanity check to see if there were actually any fabricIds present in the certificate. Added doxygen to GetCredentials method.

todo · 2021-07-27T19:35:37Z

Switch to size_t whenever OperationalCredentialSet Class is updated to support more then 255 credentials per controller

connectedhomeip/src/controller/CHIPDevice.h

Lines 482 to 486 in 60a8fc4

    
           // TODO: Switch to size_t whenever OperationalCredentialSet Class is updated to support more then 255 credentials per controller 
        
           uint8_t mCredentialsIndex = 0; 
        
           PersistentStorageDelegate * mStorageDelegate = nullptr;

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

todo · 2021-07-27T19:35:41Z

switch mOpCredCount var type to size_t in order to allow more than 255 credentials per controller.

connectedhomeip/src/credentials/CHIPOperationalCredentials.h

Lines 266 to 269 in 60a8fc4

    
               // TODO: switch mOpCredCount var type to size_t in order to allow more than 255 credentials per controller. 
        
               uint8_t mOpCredCount;              /**< Number of certificates in mOpCreds 
        
                                                   array. We maintain the invariant that all 
        
                                                   the slots at indices less than

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

todo · 2021-07-27T19:35:43Z

Remove TrustedRootId indexing - Replace it with size_t index.

connectedhomeip/src/credentials/CHIPOperationalCredentials.h

Lines 281 to 284 in 60a8fc4

    
               // TODO: Remove TrustedRootId indexing - Replace it with size_t index. 
        
               const NodeCredential * GetNodeCredentialAt(const CertificateKeyId & trustedRootId) const; 
        
               P256Keypair * GetNodeKeypairAt(const CertificateKeyId & trustedRootId); 
        
           };

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

todo · 2021-07-27T19:35:46Z

move this constant over to src/crypto/CHIPCryptoPAL.h - name it CHIP_CRYPTO_AEAD_MIC_LENGTH_BYTES

connectedhomeip/src/protocols/secure_channel/CASESession.cpp

Lines 61 to 68 in 60a8fc4

    
           // TODO: move this constant over to src/crypto/CHIPCryptoPAL.h - name it CHIP_CRYPTO_AEAD_MIC_LENGTH_BYTES 
        
           constexpr size_t kTAGSize = 16; 
        
           constexpr size_t kDestinationMessageLen = kSigmaParamRandomNumberSize + kP256_PublicKey_Length + sizeof(FabricId) + sizeof(NodeId); 
        
           #ifdef ENABLE_HSM_HKDF 
        
           using HKDF_sha_crypto = HKDF_shaHSM; 
        
           #else

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

todo · 2021-07-27T19:35:49Z

move this constant over to src/crypto/CHIPCryptoPAL.h - name it CHIP_CRYPTO_SYMMETRIC_KEY_LENGTH_BYTES

connectedhomeip/src/protocols/secure_channel/CASESession.h

Lines 49 to 52 in 60a8fc4

    
           // TODO: move this constant over to src/crypto/CHIPCryptoPAL.h - name it CHIP_CRYPTO_SYMMETRIC_KEY_LENGTH_BYTES 
        
           constexpr uint16_t kAEADKeySize = 16; 
        
           constexpr uint16_t kSigmaParamRandomNumberSize = 32;

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

todo · 2021-07-27T19:35:52Z

Remove this list. Replace it with an actual method to retrieve an IPK list (e.g. from a Crypto Store API)

connectedhomeip/src/protocols/secure_channel/CASESession.h

Lines 296 to 306 in 60a8fc4

    
                   // TODO: Remove this list. Replace it with an actual method to retrieve an IPK list (e.g. from a Crypto Store API) 
        
                   static uint8_t sIPKList[][kIPKSize] = { 
        
                       { 0 }, /* Corresponds to the FabricID for the Commissioning Example. All zeros. */ 
        
                   }; 
        
                   static ByteSpan ipkListSpan[] = { ByteSpan(sIPKList[0]) }; 
        
                   return ipkListSpan; 
        
               } 
        
               virtual size_t GetIPKListEntries() const { return 1; } 
        
           }; 
        
           typedef struct CASESessionSerialized

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

todo · 2021-07-27T19:35:55Z

Remove this list. Replace it with an actual method to retrieve an IPK list (e.g. from a Crypto Store API)

connectedhomeip/src/protocols/secure_channel/tests/TestCASESession.cpp

Lines 108 to 118 in 60a8fc4

    
                   // TODO: Remove this list. Replace it with an actual method to retrieve an IPK list (e.g. from a Crypto Store API) 
        
                   static uint8_t sIPKList[][kIPKSize] = { 
        
                       { 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 0x1D, 
        
                         0x1D }, /* Corresponds to the FabricID for the Node01_01 Test Vector */ 
        
                   }; 
        
                   static ByteSpan ipkListSpan[] = { ByteSpan(sIPKList[0]) }; 
        
                   return ipkListSpan; 
        
               } 
        
               size_t GetIPKListEntries() const override { return 1; } 
        
           };

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

todo · 2021-07-27T19:35:58Z

Rename KeyID to SessionID

connectedhomeip/src/transport/PeerConnectionState.h

Lines 71 to 74 in 60a8fc4

    
           // TODO: Rename KeyID to SessionID 
        
           uint16_t GetLocalKeyID() const { return mLocalKeyID; } 
        
           void SetLocalKeyID(uint16_t id) { mLocalKeyID = id; }

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

jpk233 added 18 commits July 21, 2021 08:23

CASE spec refresh

96a6476

Remove TrustedRootID from Sigma messages. Replce HKDF algorithm with …

ba1b1c4

…HMAC-SHA256 Algorithm in GenerateDestinationID method.

cast 1 to uint8_t to avoid compiler errors on other platforms

93d1898

Fix uint8_t conversion

9d704eb

Replace CASETLVTags with TLV::ContextTag ID, switch unsafe statement …

5c4b7fd

…to an actual OperationalCredentialSet method to retrieve a TrustedRootId, renamed kMAX_Hash_Length refs to kSHA256_Hash_Length to match the Spec.

Add GenerateDestinationID Test

8961dcc

remove fabricId parameters/methods from CASESession. Retrieve it from…

046d088

… the NOC instead.

Update casesession with latest comments

2fe6806

Trigger Build

5a7ed0f

added IPK to CASESession Serializable data: IPK is needed to DeriveSe…

8779929

…cureSession, so it needs to be stored. Updated FindDestinationIDCandidate loop variables to size_t. Also updated names to reflect what they are indexing.

Added CASESession protected API (Virtual) to get the IPK List Entries…

6f492fd

…. They can be overridden by the Unit Tests in order to feed in the test IPK vectors.

Merge branch 'master' into case

8f4b2b2

Update for fabric class rename

56d5fb9

Restyling

0cda2c4

Replace mCredentialsIndex pointer to an actual uint8_t variable.

cbcf488

Update GetCertFabricId method to use UINT64_MAX macro as an invalid reference, and added a final sanity check to see if there were actually any fabricIds present in the certificate. Added doxygen to GetCredentials method.

restyled-io bot added the restyled label Jul 27, 2021

boring-cyborg bot added controller crypto transport labels Jul 27, 2021

jpk233 and others added 2 commits July 27, 2021 15:42

Merge branch 'master' into case

e156802

Restyled by clang-format

c583249

restyled-io bot force-pushed the restyled/pull-8137 branch from 60a8fc4 to c583249 Compare July 27, 2021 19:43

restyled-io bot closed this Jul 28, 2021

restyled-io bot deleted the restyled/pull-8137 branch July 28, 2021 00:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restyle CASE spec refresh #8649

Restyle CASE spec refresh #8649

restyled-io bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

Restyle CASE spec refresh #8649

Restyle CASE spec refresh #8649

Conversation

restyled-io bot commented Jul 27, 2021

todo bot commented Jul 27, 2021

Switch to size_t whenever OperationalCredentialSet Class is updated to support more then 255 credentials per controller

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

todo bot commented Jul 27, 2021

switch mOpCredCount var type to size_t in order to allow more than 255 credentials per controller.

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

todo bot commented Jul 27, 2021

Remove TrustedRootId indexing - Replace it with size_t index.

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

todo bot commented Jul 27, 2021

move this constant over to src/crypto/CHIPCryptoPAL.h - name it CHIP_CRYPTO_AEAD_MIC_LENGTH_BYTES

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

todo bot commented Jul 27, 2021

move this constant over to src/crypto/CHIPCryptoPAL.h - name it CHIP_CRYPTO_SYMMETRIC_KEY_LENGTH_BYTES

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

todo bot commented Jul 27, 2021

Remove this list. Replace it with an actual method to retrieve an IPK list (e.g. from a Crypto Store API)

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

todo bot commented Jul 27, 2021

Remove this list. Replace it with an actual method to retrieve an IPK list (e.g. from a Crypto Store API)

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

todo bot commented Jul 27, 2021

Rename KeyID to SessionID

This comment was generated by todo based on a TODO comment in 60a8fc4 in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.

This comment was generated by todo based on a `TODO` comment in `60a8fc4` in #8649. cc @project-chip.