Pyproject

.github/workflows/publish-to-test-pypi.yml

@@ -8,13 +8,14 @@ jobs:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@master
-        - name: Setup Python 3.9
+        - name: Setup Python 3.10
           uses: actions/setup-python@v1
           with:
-            python-version: 3.9
+            python-version: 3.10.15
         - name: Build ChipWhisperer
-          run: >-
-            python setup.py bdist
+          run: |
+            python -m pip install build
+            python -m build
         - name: Publish to pypi
           if: startsWith(github.ref, 'refs/tags')
           uses: pypa/gh-action-pypi-publish@master

.github/workflows/test_install.yml

@@ -0,0 +1,47 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Build Firmware
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the develop branch
+  push:
+    paths:
+      - 'hardware/victims/firmware/**'
+      - 'hardware/capture'
+      - '.github/workflows/build_firmware.yml'
+
+  pull_request:
+    paths:
+      - 'hardware/victims/firmware/**'
+      - 'hardware/capture'
+      - '.github/workflows/build_firmware.yml'
+
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  fwbuild:
+    # The type of runner that the job will run on
+    name: Build all firmware to make sure everything works
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      - name: Install compilers
+        run: >- 
+          sudo apt install -y make build-essential gcc-avr avr-libc gcc-arm-none-eabi
+      - name: Build firmware
+        run: >-
+          cd tests && bash test_fw_build.sh
+      - name: Build capture firmware
+        run: |
+          cd hardware/capture/chipwhisperer-lite/sam3u_fw/SAM3U_VendorExample/src
+          git submodule update --init naeusb
+          make -j
+          cd -
+          cd hardware/capture/chipwhisperer-nano/firmware/cwnano-firmware/src
+          git submodule update --init naeusb
+          make -j
+

.gitignore

@@ -36,16 +36,15 @@ docs/make.bat
 *.vcd
 *.fst
 **/.vscode/*
-**/*.bin
-**/*.eep
-**/*.elf
-**/*.hex
-**/*.lss
-**/*.map
-**/*.sym
+firmware/**/*.bin
+firmware/**/*.eep
+firmware/**/*.elf
+firmware/**/*.hex
+firmware/**/*.lss
+firmware/**/*.map
+firmware/**/*.sym
 *.o.s
 **/1
-**/version.txt
 
 # Explicit listing of the build artifacts so that they are not included in
 # commits

firmware/mcu/basic-passwdcheck/basic-passwdcheck.c

@@ -77,12 +77,12 @@ int main(void)
         my_puts("*****Safe-o-matic 3000 Booting...\n");
         //Print some fancy-sounding stuff so that attackers
         //will get scared and leave us alone
-        my_puts("Aligning bits........[DONE]\n");
-        delay_2_ms();
-        my_puts("Checking Cesium RNG..[DONE]\n");
-        delay_2_ms();
-        my_puts("Masquerading flash...[DONE]\n");
-        delay_2_ms();
+        // my_puts("Aligning bits........[DONE]\n");
+        // delay_2_ms();
+        // my_puts("Checking Cesium RNG..[DONE]\n");
+        // delay_2_ms();
+        // my_puts("Masquerading flash...[DONE]\n");
+        // delay_2_ms();
         my_puts("Decrypting database..[DONE]\n");
         delay_2_ms();
         my_puts("\n\n");

firmware/mcu/simpleserial-aes/pyocd.yml

@@ -0,0 +1,18 @@
+probes:
+  TG1001d4:
+    frequency: 200000000
+    ftdi.channel: 1
+    ftdi.gpio_dir_mask: 0x0038
+    ftdi.gpio_init_mask: 0x003b
+    ftdi.srst_mask: 0x0020
+    ftdi.trst_mask: 0x0020
+    ftdi.swd_en_mask: 0
+
+  50203220325531583330313237323034:
+    ftdi.channel: 1
+    ftdi.gpio_dir_mask: 0x001B
+    ftdi.gpio_init_mask: 0x001B
+    ftdi.std_en_mask: 0x0100
+    ftdi.stdio_en_mask: 0x0200
+#ftdi.gpio_dir_mask 0x003b
+#ftdi.gpio_init_mask 0x0038

openocd/lpc.cfg

@@ -0,0 +1,56 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+source [find target/swj-dp.tcl]
+adapter speed 1000
+if { [info exists CHIPNAME] } {
+	set _CHIPNAME $CHIPNAME
+} else {
+	set _CHIPNAME lpc55xx
+}
+if { [info exists CPUTAPID] } {
+	set _CPUTAPID $CPUTAPID
+} else {
+	# Cortex-M33 SWD DPIDR
+	set _CPUTAPID 0x6ba02477
+}
+swj_newdap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf -expected-id $_CPUTAPID
+dap create $_CHIPNAME.dap -chain-position $_CHIPNAME.cpu
+set _TARGETNAME $_CHIPNAME.cpu
+target create $_TARGETNAME cortex_m -endian little -dap $_CHIPNAME.dap
+# Reserved RAM regions for ROM functions
+# 0x14000000 -- 0x14003fff
+# 0x30001000 -- 0x30007fff
+#
+# Use 16 KiB of SRAM2 (on LPC553x) for working area
+if { [info exists WORKAREASIZE] } {
+	set _WORKAREASIZE $WORKAREASIZE
+} else {
+	set _WORKAREASIZE 0x4000
+}
+$_TARGETNAME configure -work-area-phys 0x20008000 \
+	-work-area-size $_WORKAREASIZE -work-area-backup 0
+if { [info exists FLASH_API_ADDRESS] } {
+	set _FLASH_API_ADDRESS $FLASH_API_ADDRESS
+} else {
+	set _FLASH_API_ADDRESS 0
+}
+# Using SRST is not recommended as that also resets the debug domain
+if {![using_hla]} {
+	cortex_m reset_config sysresetreq
+}
+proc init_reset { mode } {
+	if { $mode ne "run" } {
+		halt
+		wp 0x50000040 4 r
+		resume
+	}
+}
+$_TARGETNAME configure -event reset-end { catch { rwp 0x50000040 } }
+# Run this to initiate a debug session with a target that doesn't have
+# valid firmware on flash
+proc lpc55xx_start_debug_session { } {
+	global _CHIPNAME
+	$_CHIPNAME.dap apreg 2 0 0x21
+	$_CHIPNAME.dap apreg 2 4 7
+	$_CHIPNAME.cpu arp_examine
+}
+flash bank $_TARGETNAME.flash lpc55xx 0x00000000 0 0 0 0 $_FLASH_API_ADDRESS

pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools >= 61.0", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+#version = "0.0.1"  # Remove any existing version parameter.
+dynamic = ["version"]
+description="ChipWhisperer Side-Channel Analysis Tool"
+name = "chipwhisperer"
+authors=[{name="Colin O'Flynn", email="[email protected]"}]
+requires-python = ">=3.9"
+dependencies = [
+        "configobj",
+        "pyserial",
+        "numpy",
+        "libusb1",
+        "ECpy",
+        "fastdtw",
+        "Cython",
+        "tqdm",
+        "libusb1",
+]
+license = {file = "LICENSE.txt"}
+readme = "README.md"
+
+[project.optional-dependencies]
+trace = ["software"]
+
+[project.urls]
+Homepage = "https://www.chipwhisperer.com"
+Documentation = "https://chipwhisperer.readthedocs.io/en/latest/"
+Repository = "https://github.com/newaetech/chipwhisperer"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["software"]
+
+[tool.setuptools.dynamic]
+version = {attr = "chipwhisperer.__version__"}

software/chipwhisperer/__init__.py

@@ -8,7 +8,7 @@
 
 Main module for ChipWhisperer.
 """
-from .version import __version__
+__version__ = '5.7.0'
 
 try:
     import usb1 # type: ignore

software/chipwhisperer/capture/scopes/OpenADC.py

@@ -147,7 +147,7 @@ def _getFWPy(self):
             from ...hardware.firmware.cwlite import fwver
         elif cw_type == "cw1200":
             from ...hardware.firmware.cw1200 import fwver # type: ignore
-        elif cw_type in ["cwhusky", "cwhusky-plus"]:
+        elif cw_type in ["cwhusky", "cwhuskyplus"]:
             from ...hardware.firmware.cwhusky import fwver # type: ignore
         else:
             raise ValueError('Unknown cw_type: %s' % cw_type)
@@ -419,7 +419,7 @@ def _getCWType(self) -> str:
             elif "CW1200" in hwInfoVer:
                 return "cw1200"
             elif "Husky-Plus" in hwInfoVer:
-                return "cwhusky-plus"
+                return "cwhuskyplus"
             elif "Husky" in hwInfoVer:
                 return "cwhusky"
             else:
@@ -440,7 +440,7 @@ def get_name(self):
             return "ChipWhisperer Pro"
         elif name == "cwhusky":
             return "ChipWhisperer Husky"
-        elif name == "cwhusky-plus":
+        elif name == "cwhuskyplus":
             return "ChipWhisperer Husky Plus"
 
     def adc_test(self, samples=131070, reps=3, verbose=False):
@@ -659,7 +659,7 @@ def con(self, sn=None, idProduct=None, bitstream=None, force=False, prog_speed=1
         self.sc = OpenADCInterface(self.scopetype.ser, self.scopetype.registers) # important to instantiate this before other FPGA components, since this does an FPGA reset
         self.hwinfo = HWInformation(self.sc)
         cwtype = self._getCWType()
-        if cwtype in ["cwhusky", "cwhusky-plus"]:
+        if cwtype in ["cwhusky", "cwhuskyplus"]:
             self.sc._is_husky = True
         self.sc._setReset(True)
         self.sc._setReset(False)
@@ -683,7 +683,7 @@ def con(self, sn=None, idProduct=None, bitstream=None, force=False, prog_speed=1
             self.SAD = ChipWhispererSAD.ChipWhispererSAD(self.sc)
             self.decode_IO = ChipWhispererDecodeTrigger.ChipWhispererDecodeTrigger(self.sc)
 
-        if cwtype in ["cwhusky", "cwhusky-plus"]:
+        if cwtype in ["cwhusky", "cwhuskyplus"]:
             # self.pll = ChipWhispererHuskyClock.CDCI6214(self.sc)
             self._fpga_clk = ClockSettings(self.sc, hwinfo=self.hwinfo, is_husky=True)
             self.glitch_drp1 = XilinxDRP(self.sc, "CG1_DRP_DATA", "CG1_DRP_ADDR", "CG1_DRP_RESET")
@@ -715,7 +715,7 @@ def con(self, sn=None, idProduct=None, bitstream=None, force=False, prog_speed=1
             self._fpga_clk._is_husky = True
             self.sc._is_husky = True
             self.adc.bits_per_sample = 12
-            if cwtype == "cwhusky-plus":
+            if cwtype == "cwhuskyplus":
                 self._is_husky_plus = True
                 self.LA._is_husky_plus = True
         else:
@@ -730,7 +730,7 @@ def con(self, sn=None, idProduct=None, bitstream=None, force=False, prog_speed=1
             self.io = self.advancedSettings.cwEXTRA.gpiomux
             self.trigger = self.advancedSettings.cwEXTRA.triggermux
             self.glitch = self.advancedSettings.glitch.glitchSettings
-            if cwtype in ['cwhusky', 'cwhusky-plus']:
+            if cwtype in ['cwhusky', 'cwhuskyplus']:
                 # TODO: cleaner way to do this?
                 self.glitch.pll = self.clock.pll
                 self.clock.pll._glitch = self.glitch
@@ -739,7 +739,7 @@ def con(self, sn=None, idProduct=None, bitstream=None, force=False, prog_speed=1
             if cwtype == "cw1200":
                 self.trigger = self.advancedSettings.cwEXTRA.protrigger
 
-        if cwtype in ["cwhusky", "cwhusky-plus"]:
+        if cwtype in ["cwhusky", "cwhuskyplus"]:
             # these are the power-up defaults, but just in case e.g. test script left these on:
             self.adc.test_mode = False
             self.ADS4128.mode = 'normal'

software/chipwhisperer/capture/scopes/cwhardware/ChipWhispererExtra.py

@@ -165,7 +165,7 @@ def __init__(self, oa, cwtype):
             hasPLL=False
             hasAux=True
             hasUserio=False
-        elif cwtype in ["cwhusky", "cwhusky-plus"]:
+        elif cwtype in ["cwhusky", "cwhuskyplus"]:
             hasFPAFPB=False
             hasGlitchOut=True
             hasPLL=False
@@ -188,7 +188,7 @@ def __init__(self, oa, cwtype):
         self.protrigger = ProTrigger(self)
         self.huskytrigger = HuskyTrigger(self)
 
-        if cwtype in ["cwhusky", "cwhusky-plus"]:
+        if cwtype in ["cwhusky", "cwhuskyplus"]:
             self.gpiomux._is_husky = True
             self.triggermux._is_husky = True
             self._addr_trigsrc_size = 2