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

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

• General
  • Python 3.8 - 3.12
  • Installed Infineon OpenOCD
• For PSoC 64 / CYW20829 / CYW89829 devices
  • 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

The installation of ModusToolbox™ Software 3.1 includes the correct version of Python and CySecureTools 5.0.0. The latest version of CySecureTools is 6.0.0. To update the package from the ModusToolbox™ shell (for Windows users):

• In the ModusToolbox™ GUI open the terminal by clicking the Terminal tab in the bottom pane.
• Then, select a project in the Project Explorer to open a shell in the project directory.
• Enter the following command: $ pip install --upgrade --force-reinstall edgeprotecttools

Install Python 3.12 on your computer. You can download it from https://www.python.org/downloads/.

Set up the appropriate environment variable(s) for your operating system.

If Python 2.7 is also installed, make sure that Python312 and Python312\Scripts have higher priority in the PATH than CPython27.

Most distributions of Linux should already have python2 and python3 installed. To verify that python by default points to python3 run:

$ python --version

If python3 is not set as default, run the following commands. The number at the end of each command denotes a priority:

$ update-alternatives --install /usr/bin/python python /usr/bin/python2.7 1
$ update-alternatives --install /usr/bin/python python /usr/bin/python3.12 2

By default, python points to /usr/bin/python, which is python2. To make python and pip resolve to python3 versions, execute the following from command line:

$ echo 'alias python=python3' >> ~/.bash_profile
$ echo 'alias pip=pip3' >> ~/.bash_profile
$ source ~/.bash_profile
$ python --version
Python 3.12.3
$ pip --version
pip 24.0 from
/Library/Frameworks/Python.framework/Versions/3.12/lib/python3.12/site-packages/pip (python 3.12)

Note: If you use a shell other than bash, update its profile file accordingly. For example ~/.zshrc if you use zsh instead of ~/.bash_profile.

Make sure that you have the latest version of pip installed, use the following command.

$ python -m pip install --upgrade pip

Run the following command in your terminal window.

$ python -m pip install cysecuretools

To update the already installed package:

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

Note 1: During installation, you may see errors saying that cysecuretools requires package version X, but you have package version Y which is incompatible. In most cases, these can be safely ignored.

Note 2: You can use the following command to show the path to the installed package python -m pip show 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 has 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.