project-chip / connectedhomeip Goto Github PK

Problem

Distcheck fails on CI and locally.

Proposed Solution

Figure out what this does and fix it.

Problem

#125 removed rules to build some source files in the EFR32 platform.

EFR32/NetworkProvisioningServerImpl.cpp
EFR32/ThreadStackManagerImpl.cpp	
EFR32/GroupKeyStoreImpl.cpp
EFR32/Entropy.cpp
EFR32/SoftwareUpdateManagerImpl.cpp
EFR32/ConfigurationManagerImpl.cpp

Removed from src/platform/Makefile.am

Proposed Solution

Determine which bits are needed and how to bring them in.

Problem

#125 Removed OpenThread dependencies from efr32-chip.mk and in the platform code.
It also removed dependencies on missing SEGGER header files(ref: src/platform/EFR32/Logging.cpp) and so if a project adds EFR32_LOG_ENABLED to their CHIPProjectConfig.h the build will not work.

The missing SEGGER headers, for example, are part of OpenThread.

Proposed Solution

Figure out if OpenTread is a hard dependency for all EFR32 apps (followed the openweave demo example) and if not bring in the missing SEGGER dependencies and make sure EFR32_LOG_ENABLED can be set.

Problem

Implement code to convert a base45 string to a SetupPayload object.

[SC&T] OOB Pairing and Onboarding

This is a high level umbrella issue tracking work needed to support device onboarding.
Some of the sub-tasks are

• Initial device discovery (rendezvous) #128
• Setup a secure channel using PAKE #130
• Provision network credentials to accessory #131
• Establish operational credentials with accessory #132

Problem

No APIs exist in CHIP to support symmetric key based payload encryption

Proposed Solution

We are going to use existing code in the open source HAP ADK to implement encrypting the payload that gets sent over the wire. This issue tracks porting over the existing symmetric key based encryption from HAP ADK. This does NOT deal with the topic of how those keys are obtained / exchanged in the first place.

Specifically we should pull the code in these files from https://github.com/apple/HomeKitADK

1. PAL/Crypto/MbedTLS/HAPMbedTLS.c
2. PAL/Crypto/OpenSSL/HAPOpenSSL.c
3. PAL/HAPBase+Crypto.c
4. HAP/HAPSession.c : Some of the methods like HAPSessionEncryptControlMessage and HAPSessionEncryptControlMessageWithAAD if not everything

Problem

Platform library testing for EFR32 and nRF5 currently require the platforms' DKs to be installed.

Proposed Solution

• build mocks for each of the supported platforms
• add unit tests for the functionality that consume the mocks

Problem

#104 disabled TIME_SERVICE_TIME_SYNC at

and

#125 removed the TimeSync Service configuration from the EFR32 Platform Config.
Reference:

Proposed Solution

Check if these need to be enabled. If required, enable and fix the associated issues.

Problem

The platform code for EFR32 is imported. But it's not currently being built.

Proposed Solution

Import and fix makefiles for this platform.

Problem

Pretty check is failing build presently

Proposed Solution

Please fix :)

We should enable LGTM as soon as possible for all PRs:
https://github.com/marketplace/lgtm

This issue tracks Initial device discovery aka rendezvous.

Sub of TLF: [SC&T] Device Onboarding #127

Problem

//integrations/docker/images/* directories build and push to developer orgs, should point to something owned by project-chip.

Proposed Solution

create a docker.io org
update build.sh(s)
update any resulting docker-based builds to pull from official repositories

We also use Coverity, which supports public, open source projects free of charge. Between LGTM, clang static analysis, and Coverity, there is a non-overlapping Venn diagram of issues caught.

Originally posted by @gerickson in #37 (comment)

This is an umbrella radar tracking work needed for certificate compression

How do / can I run clang-tidy locally on my MacBook Pro? Is that mechanism different than what we use for CI?

Originally posted by @gerickson in #1

We should have a way to run clang-tidy locally

Problem

Per @robszewczyk - Need a way to enforce CLA is signed before a pull request can be approved by a developer

Proposed Solution

@robszewczyk fixes it :)

Problem

Could someone with experience update the BUILDING.md doc with workflow best practices?

• how to build the entire source,
• how to build a specific set of sub-folders / modules, add new source files,
• run & debug unit tests,
• run and analyze code coverage results,
• run formatting checks, etc.

Problem

CHIP currently uses WoBLE UUIDs. This needs to be updated.

Proposed Solution

Generate UUIDs for CHIP

Establish operational credentials with accessory

Sub of TLF: [SC&T] Device Onboarding #127

Problem

BLEManagerImpl.cpp computes device name using FabricState.LocalNodeId(). This was removed (and hardcoded to 0) in #104 for nRF5 and in #125 for EFR32.

Proposed Solution

Identify the correct replacement for LocalNodeId and use that to compute device name.

Code reference:
nRF5 -

Problem

#104 removed the following functions from GenericSoftwareUpdateManagerImpl.
SoftwareUpdateFailed
HandleStatusReport
HandleServiceBindingEvent
HandleResponse
OnKeyError
OnResponseTimeout

Proposed Solution

Evaluate if these functions are needed. If so, identify the replacement APIs for ExchangeContext, and Binding and reimplement these functions.

Problem

"Upstream" nlbuild-autotools has bug fixes, updates this project lacks

Proposed Solution

• apply git subtree magic
• document git subtree magic so that others may apply in future

Problem

#104 deleted implementation of HashLengthAndBase64Value() and corresponding calls to it. This was done because Platform::Security module is not available.

Proposed Solution

Reimplement the function with available APIs. Add the calls to function from where it was removed.

Deleted code reference:
https://github.com/project-chip/connectedhomeip/blob/master/src/include/platform/internal/GenericConfigurationManagerImpl.ipp#L1053

I tried the build instructions:

$ brew install make autoconf automake libtool
$ brew install llvm@9
$ git clean -fdx
$ ./bootstrap-configure
$ make -f Makefile-Standalone
# got an error at this point telling me to run make distclean
$ make distclean
$ make -f Makefile-Standalone
# Next I tried to run some tests (previous from Building.md)
$ cd src/setup_payload
$ make check
# got error: make: *** No rule to make target `check'. Stop.
# where 1-7 where run at top level directory

I then ran:

$ git clean -xdf
$ ./bootstrap-configure
$ make

And then make check worked

Once Marketplace access is available, we should enable:
https://github.com/marketplace/codecov

Problem

#104 hardcoded the lengths to 32 bytes. This was done as ChipDeviceDescriptor is not implemented yet.

https://github.com/project-chip/connectedhomeip/blob/master/src/include/platform/ConfigurationManager.h#L62

Proposed Solution

Once a device descriptor is implemented, read these two values from its configuration.

Problem

The following config items were removed from EFR32 CHIPDevicePlatformConfig.h files.

EFR32:

Proposed Solution

Figure out how to bring Thread Support back in.

Problem

#104 removed support for DeviceDescriptor. Due to this UserSelectedMode APIs in GenericConnectivityManagerImpl.h are returning dummy values.

Proposed Solution

Identify the replacement APIs for DeviceDescriptor, and reimplemented the following functions.
_IsUserSelectedModeActive
_SetUserSelectedMode
_GetUserSelectedModeTimeout
_SetUserSelectedModeTimeout

This is an umbrella issue tracking work to setup a secure channel using a PAKE

Sub of TLF: [SC&T] Device Onboarding #127

Problem

Per @robszewczyk we need to go over the CONTRIBUTING.md before opening up the repository.

Problem

mbedtls was removed from the efr32-app.mk

Proposed Solution

Figure out whether mbedtls is a hard dependency for all efr32 apps and test the demo app flow with this brought in.

Summary: Master seems broken for me.

Steps to reproduce:

1. clone repo
2. cd into repo
3. git clean -fdx
4. ./bootstrap-configure
5. make -f Makefile-Standalone

This is the error I am seeing -
checking whether make supports nested variables... yes
configure: error: source directory already configured; run "make distclean" there first
make: *** [build/x86_64-apple-darwin/config.status] Error 1

Problem

The platform code for nRF5 is imported. But it's not currently being built.

Proposed Solution

Import and fix makefiles for this platform.

Problem

Per @robszewczyk we need to update the main README.md file with final wording before going open source

Warning while compiling main build: https://github.com/project-chip/connectedhomeip/runs/499611869?check_suite_focus=true

../../third_party/lwip/repo/lwip/src/core/udp.c: In function ‘udp_sendto_if_src’:
63
../../third_party/lwip/repo/lwip/src/core/udp.c:869:26: warning: passing argument 2 of ‘netif_apply_pcb’ from incompatible pointer type [-Wincompatible-pointer-types]
64
   netif_apply_pcb(netif, pcb);
65
                          ^~~
66
In file included from ../../third_party/lwip/repo/lwip/src/include/lwip/udp.h:46:0,
67
                 from ../../third_party/lwip/repo/lwip/src/core/udp.c:52:
68
../../third_party/lwip/repo/lwip/src/include/lwip/netif.h:371:6: note: expected ‘struct ip_pcb *’ but argument is of type ‘struct udp_pcb *’
69
 void netif_apply_pcb(struct netif *netif, struct ip_pcb *pcb);
70
      ^~~~~~~~~~~~~~~
71

This is an umbrella issue tracking work needed to provision network credentials to accessory

Sub of TLF: [SC&T] Device Onboarding #127

Problem

The following files are not being built, as they are heavily dependent on removed code (as part of #104 )

ConfigurationManagerImpl.cpp
ThreadStackManagerImpl.cpp
GroupKeyStoreImpl.cpp
SoftwareUpdateManagerImpl.cpp
Entropy.cpp

Removed from src/platform/Makefile.am

Proposed Solution

Fix the code, and add to makefile.

Problem

developer@17af346013fa:~/connectedhomeip$ ./bootstrap-configure
./bootstrap-configure: 42: ./bootstrap-configure: pushd: not found

Proposed Solution

bootstrap incorrectly uses #!/bin/sh at the top, but it's using a bash capability. Needs to be changed to !#/bin/bash

Problem

A new implementation of device layer for Linux/Posix platform is needed.

Proposed Solution

Implement the new device layer.

Tracking list for the solution [@turon]:

• Addd initial PlatformMgr: select loop, entropy, time [PR #614]
• Add ConfigurationManager and FileStore support [#738]
• Add ConnectivityManager and WiFi support [#739]
• Extend ConnectivityManager with Thread support [#740]
• Add BleManager support for Linux (bluez) [#741]
• Add BleManager for Darwin
• Add support for process termination [#742]
• Extend tests
• Add example app

Problem

Add support to generate the manual entry code.

Config is in, we should have this enabled for PRs:
https://github.com/marketplace/restyled-io

Awaiting GitHub marketplace access

You might find OpenThread's scripts around clang-format useful:

• https://github.com/openthread/openthread/blob/master/script/make-pretty
• https://github.com/openthread/openthread/blob/master/script/clang-format.sh
• https://github.com/openthread/openthread/blob/master/script/clang-format-check.sh

Originally posted by @jwhui in #2 (comment)

Problem

#125 removed the TimeSync Service configuration from the EFR32 Platform Config.
Reference:

Proposed Solution

Figure out what needs to be done to bring this support back in

Problem

#125 removed the following library dependencies from efr32-chip.mk

- Removed: linking with warm
- Removed: linking with mincrypt
- Removed: linking with uECC

#125 also removed the following library dependencies and extra sources from efr32-app.mk

- Removed: linking with freertos
- Removed: References to linker scripts
- Removed: References to extra source files like $(EFR32_SDK_ROOT)/util/third_party/mbedtls/sl_crypto/src/trng.c

Proposed Solution

These are very likely required for any CHIP based app to actually work on the EFR32 platform. Figure out how to bring them back.

Let's move to travis for build steps. Waiting on ability to enable it from the market place.

Problem

#104 removed support for DeviceDescriptor from ConfigurationManager. That in turn removed the implementation for _GetQRCodeString().

Proposed Solution

Identify the correct/new API that replaces DeviceDescriptor. Re-implement _GetQRCodeString using this API.

Problem

#104 removed HandleSessionEstablished from GenericPlatformManagerImpl, as it was dependent on ChipSecurityManager. This code may need to be resurrected.

Proposed Solution

Evaluate if the code is needed. If so, redefine the function interface and implement it.

Code Reference: https://github.com/project-chip/connectedhomeip/blob/master/src/include/platform/internal/GenericPlatformManagerImpl.ipp#L307

Problem

Build is failing here:

https://github.com/project-chip/connectedhomeip/runs/528993246?check_suite_focus=true

Assigning @gerickson & @rwalker-apple to talk about process, and the fix here :)

With the new automake based build system, each build leaves many untracked files in the tree.
It also overwrites the BuildConfig.h that's included in the tree. This file can most likely be removed.