This package contains security tools for creating keys, creating certificates, signing user applications, and provisioning Cypress MCUs.

• Prerequisites
• Documentation
• Installing package
• Supported devices
• Interface and Usage
  • PSoC 64
  • CYW20829
  • XMC7100/7200
• Logging
• Installing libusb driver
• Known issues
• License and Contributions

¹ Specify --rev option for older revision of the silicon (e.g. $ cysecuretools -t cyw20829 --rev a0 <COMMAND>). Using the latest revision does not require specifying the option.

• General
  • Python 3.6 or later
• For PSoC 64 devices
  • Installed Cypress OpenOCD
  • Ensure the KitProg3 programming mode is CMSIS-DAP Bulk
  • Ensure the power selection jumper is set to provide 2.5 V to the power supply pin related to eFuse power. This voltage level is required to blow eFuses
• For CYW20829 devices
  • Installed Cypress OpenOCD
  • Ensure the KitProg3 programming mode is CMSIS-DAP Bulk
  • Ensure the power selection jumper is set to provide 2.5 V to the power supply pin related to eFuse power. This voltage level is required to blow eFuses

• PSoC64 Secure MCU Secure Boot SDK User Guide
• Changelog

Invoke pip install from the command line:

$ pip install cysecuretools

To update the already installed package:

$ pip install --upgrade --force-reinstall cysecuretools

Use device-list command for output of the supported devices list.

$ cysecuretools device-list

See README_PSOC64.md

See README_CYW20829.md

See README_XMC7XXX.md

Every time the tool is invoked, a new log file is created in the logs directory of the project. By default, the console output has INFO logging severity. The log file contains the DEBUG logging severity.

• Using the policy from version 4.0.0 in projects created by version 4.1.0 causes the CY_FB_INVALID_IMG_JWT_SIGNATURE error during re-provisioning on PSoC64-2M devices:

  ...
  ERROR : SFB status: CY_FB_INVALID_IMG_JWT_SIGNATURE: Invalid image certificate signature. Check the log for details

Workaround:

1. Open the policy file.
2. Navigate to section 1 of the boot_upgrade/firmware.
3. Set boot_auth and bootloader_keys as follows:

"boot_auth": [
    3
],
"bootloader_keys": [
    {
        "kid": 3,
        "key": "../keys/cy_pub_key.json"
    }
]

• During the installation of the package via pip on Mac OS Big Sur, the following exception is raised:

  ...
  distutils.errors.DistutilsError: Setup script exited with error: SandboxViolation:
  mkdir('/private/var/root/Library/Caches/com.apple.python/private/tmp/easy_install-y8c1npmz', 511) {}

  The package setup script has attempted to modify files on your system
  that are not within the EasyInstall build area, and has been aborted.

  This package cannot be safely installed by EasyInstall, and may not
  support alternate installation locations even if you run its setup
  script by hand.  Please inform the package's author and the EasyInstall
  maintainers to find out if a fix or workaround is available.

Solution: Upgrade the pip package running the following command from the terminal: python3 -m pip install --upgrade pip.

The software is provided under the Apache-2.0 license. Contributions to this project are accepted under the same license. This project contains code from other projects. The original license text is included in those source files.