Tutorial B1 Building a SimpleSerial Project - Revision history

Adewar at 13:05, 29 July 2019

2019-07-29T13:05:26Z

Show changes

Adewar at 15:45, 1 October 2018

2018-10-01T15:45:35Z

Adewar at 17:12, 28 September 2018

2018-09-28T17:12:58Z

Adewar: /* Completing the Tutorial */

2018-09-28T16:05:32Z

‎Completing the Tutorial

Adewar at 16:03, 28 September 2018

2018-09-28T16:03:58Z

Adewar at 14:33, 28 September 2018

2018-09-28T14:33:39Z

Adewar at 14:05, 28 September 2018

2018-09-28T14:05:01Z

Adewar at 19:39, 27 September 2018

2018-09-27T19:39:52Z

Fheubach at 18:35, 1 May 2018

2018-05-01T18:35:31Z

Fheubach at 14:22, 1 May 2018

2018-05-01T14:22:41Z

@@ Line 37: / Line 37: @@
 : This is the response from the system. If data has been encrypted with a 'p' for example, the system will respond with the 'r' sequence automatically. So sending the earlier example means the result of the encryption was <code>cbbd4a2b34f2571758ff6a797e09859d</code>.
-<h2> Building the Basic Example </h2>
+<h2> Building the Basic Example </h2>For this example, we'll be working off of <code>simpleserial-base</code> firmware, which by default just echos the 16 bytes we send to the target back to us.{{CollapsibleSection
 {{CollapsibleSection
 |intro = === Building for CWLite with XMEGA Target ===
 |content= Building for XMEGA}}

@@ Line 22: / Line 22: @@
 <h2> What is SimpleSerial </h2>
-[[SimpleSerial]] is the communications protocol used for almost all of the ChipWhisperer demo project. It's a very basic serial protocol which can be easily implemented on most systems. This system communicates using a standard asyncronous serial protocol, 38400 baud, 8-N-1.
+[[SimpleSerial]] is the communications protocol used for almost all of the ChipWhisperer demo project. It's a very basic serial protocol which can be easily implemented on most systems. This system communicates using a standard asynchronous serial protocol, 38400 baud, 8-N-1.
 All messages are sent in ASCII-text, and are normally terminated with a line-feed ('\n'). This allows you to interact with the simpleserial system over a standard terminal emulator.

@@ Line 115: / Line 115: @@
 == Completing the Tutorial ==
-Now that the target has the modified firmware, there's only a few steps left to completing the tutorial:
+Now that the target has the modified firmware, there's only a few steps left to completing the tutorial. Note that if you've closed ChipWhisperer Capture since programming the device, you'll need to rerun the connect_cwlite_simpleserial.py and target setup scripts:
 # Open the status monitor under <i>Tools > Encryption Status Monitor</i>.
 # Resize the monitor window. The monitor will show sent &amp; received data to the target.

@@ Line 8: / Line 8: @@
 |capture hardware       = CW-Lite, CW-Lite 2-Part, CW-Pro
 |Target Device          =
-|Target Architecture    = XMEGA/ARM
+|Target Architecture    = XMEGA/ARM/Other
 |Hardware Crypto        = No
 |Purchase Hardware      =
@@ Line 88: / Line 88: @@
 <li>Rebuild the example using the <code>make</code> command. Remember you can press the up arrow on the keyboard to get recently typed commands in most OSes.</li></ol>
 {{CollapsibleSection
-|intro = === Completing Tutorial with CW1173 (Lite) With XMEGA===
+|intro = === CW1173 (Lite) Hardware Setup ===
-|content= Completing Tutorial with CW1173}}
+|content= CWLite HW Setup}}
 {{CollapsibleSection
-|intro = === Completing Tutorial with CW1173 (Lite) With ARM===
+|intro = === CW1200 (Pro) Hardware Setup ===
-|content= Completing Tutorial with CW1173 ARM}}
+|content= CW1200 HW Setup}}
 {{CollapsibleSection
-|intro = === Completing Tutorial with CW1173 (Lite) + UFO Board ===
+|intro = === CW308 (UFO) Hardware Setup ===
-|content= Completing Tutorial with CW1173 UFO Board}}
+|content= CW308 HW Setup}}
 {{CollapsibleSection
-|intro = === Completing Tutorial with CW1200 (Pro) ===
+|intro = === Programming the XMEGA Target ===
-|content= Completing Tutorial with CW1200}}
+|content= Programming XMEGA}}
 <h2> Conclusion </h2>

@@ Line 38: / Line 38: @@
 <h2> Building the Basic Example </h2>
-<h3> Building For the XMEGA Target </h3>
+{{CollapsibleSection
-You'll need to have installed avr-gcc and avr-libc. You may have already done this by following the installation guide, or if using the ChipWhisperer-VM it comes prepared with avr-gcc already setup. See the [[Installing_ChipWhisperer]] guide for details.
+{{CollapsibleSection
+|intro = === Building for CWLite with Arm Target ===
-Once you have a working compiler (check by typing 'avr-gcc' at the command line - if using Windows you may need to setup a special batch file to provide you with a avr-gcc command prompt).
+|content= Building for Arm}}
-−
-<ol style="list-style-type: decimal;">
-<li>We want to use the existing SimpleSerial firmware as a base for our project, but we don't want to edit the existing firmware. Instead, we'll make a new project with a copy of this firmware. Copy the directory <code>simpleserial-base</code> which is found at <code>chipwhisperer/hardware/victims/firmware/</code> of the chipwhisperer release to a new directory called <code>simpleserial-base-lab1</code>. You must keep it in the same directory, as it will reference other files within that directory for the build process.</li>
-<li><dl>
-<dt>Open a terminal with avr-gcc in the path. If using Windows the sidebar on the [[Installing_ChipWhisperer]] page - you can either add WinAVR to your system path, or you can run the 'winavr.bat' file suggested.</dt></dl>
-</li>
-<li><p>Change the terminal to the newly copied directory. For example:</p>
-Windows:<pre>cd c:\chipwhisperer\hardware\victims\firmware\simpleserial-base-lab1</pre>
-Linux/macOS:<pre>cd chipwhisperer/hardware/victims/firmware/simpleserial-base-lab1</pre></li>
-<li><p>Then, run <code>make</code> to build the system. Make sure you specify which platform you're using as your target. For example, for the ChipWhisperer Lite target, run</p>
-<pre>make PLATFORM=CW303</pre>
-<p>Which should have the following output:</p>
-<pre>...Bunch of lines removed...
-Creating Extended Listing: simpleserial-base.lss
-avr-objdump -h -S -z simpleserial-base.elf &gt; simpleserial-base.lss
-−
-Creating Symbol Table: simpleserial-base.sym
-avr-nm -n simpleserial-base.elf &gt; simpleserial-base.sym
-−
-Size after:
-AVR Memory Usage
-----------------
-Device: atxmega128d3
-−
-Program:    1524 bytes (1.1% Full)
-(.text + .data + .bootloader)
-−
-Data:        224 bytes (2.7% Full)
-(.data + .bss + .noinit)
-−
-−
-Built for platform CW-Lite XMEGA
-−
--------- end --------</pre></li>
-Ensure that the "Built for platform ___" matches your target device.
-</ol>
-−
-<h3> Building for the ARM Target </h3>
-You'll need to have installed the GNU Embedded Toolchain for ARM. If you haven't yet, see the [[Installing_ChipWhisperer]] guide, specifically the '''Installing ARM Toolchain''' section, for details.
-−
-Once you have a working compiler (check by typing 'arm-none-eabi-gcc' at the command line).
-−
-<ol style="list-style-type: decimal;">
-<li>We want to use the existing SimpleSerial firmware as a base for our project, but we don't want to edit the existing firmware. Instead, we'll make a new project with a copy of this firmware. Copy the directory <code>simpleserial-base</code> which is found at <code>chipwhisperer/hardware/victims/firmware/</code> of the chipwhisperer release to a new directory called <code>simpleserial-base-lab1</code>. You must keep it in the same directory, as it will reference other files within that directory for the build process.</li>
-<li><dl>
-<dt>Open a terminal with arm-none-eabi-gcc in the path. If using Windows the sidebar on the [[Installing_ChipWhisperer]] page</dt></dl>
-</li>
-<li><p>Change the terminal to the newly copied directory. For example:</p>
-Windows:<pre>cd c:\chipwhisperer\hardware\victims\firmware\simpleserial-base-lab1</pre>
-Linux/macOS:<pre>cd chipwhisperer/hardware/victims/firmware/simpleserial-base-lab1</pre></li>
-<li><p>Then, run <code>make</code> to build the system. Make sure you specify which platform you're using as your target. For example, for the ChipWhisperer Lite target, run</p>
-<pre>make PLATFORM=CWLITEARM CRYPTO_TARGET=TINYAES128C</pre>
-<p>Which should have the following output:</p>
-<pre>...Bunch of lines removed...
-Linking: simpleserial-base-CWLITEARM.elf
-arm-none-eabi-gcc -mcpu=cortex-m4 -I. -mthumb -mfloat-abi=hard -mfpu=fpv4-sp-d16 -fmessage-length=0 -ffunction-sections -gdwarf-2 -DSS_VER=SS_VER_1_1 -DSTM32F303xC -DSTM32F3 -DSTM32 -DDEBUG -DHAL_TYPE=HAL_stm32f3 -DPLATFORM=CWLITEARM -DTINYAES128C -DF_CPU=7372800UL -Os -funsigned-char -funsigned-bitfields -fshort-enums -Wall -Wstrict-prototypes -Wa,-adhlns=objdir/simpleserial-base.o -I.././simpleserial/ -I.././hal -I.././hal/stm32f3 -I.././hal/stm32f3/CMSIS -I.././hal/stm32f3/CMSIS/core -I.././hal/stm32f3/CMSIS/device -I.././hal/stm32f4/Legacy -I.././crypto/ -I.././crypto/tiny-AES128-C -std=gnu99 -MMD -MP -MF .dep/simpleserial-base-CWLITEARM.elf.d objdir/simpleserial-base.o objdir/simpleserial.o objdir/stm32f3_hal.o objdir/stm32f3_hal_lowlevel.o objdir/stm32f3_sysmem.o objdir/aes.o objdir/aes-independant.o objdir/stm32f3_startup.o --output simpleserial-base-CWLITEARM.elf --specs=nano.specs -T .././hal/stm32f3/LinkerScript.ld -Wl,--gc-sections -lm -Wl,-Map=simpleserial-base-CWLITEARM.map,--cref   -lm
-−
-Creating load file for Flash: simpleserial-base-CWLITEARM.hex
-arm-none-eabi-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature simpleserial-base-CWLITEARM.elf simpleserial-base-CWLITEARM.hex
-−
-Creating load file for EEPROM: simpleserial-base-CWLITEARM.eep
-arm-none-eabi-objcopy -j .eeprom --set-section-flags=.eeprom="alloc,load" \
-        --change-section-lma .eeprom=0 --no-change-warnings -O ihex simpleserial-base-CWLITEARM.elf simpleserial-base-CWLITEARM.eep || exit 0
-−
-Creating Extended Listing: simpleserial-base-CWLITEARM.lss
-arm-none-eabi-objdump -h -S -z simpleserial-base-CWLITEARM.elf > simpleserial-base-CWLITEARM.lss
-−
-Creating Symbol Table: simpleserial-base-CWLITEARM.sym
-arm-none-eabi-nm -n simpleserial-base-CWLITEARM.elf > simpleserial-base-CWLITEARM.sym
-Size after:
-   text    data     bss     dec     hex filename
-       8    1296    5892    1704 simpleserial-base-CWLITEARM.elf
-+--------------------------------------------------------
-+ Built for platform CW-Lite Arm (STM32F3)
-+--------------------------------------------------------
-</pre></li>
-Ensure that the "Built for platform ___" matches your target device.
-</ol>
 <h2> Modifying the Basic Example </h2>

← Older revision		Revision as of 14:05, 28 September 2018
Line 15:		Line 15:

	This tutorial will introduce you to the 'simpleserial' communications system. It will show you how to perform different operations on data based on input from the ChipWhisperer software. This can be used for building your own system which you wish to 'break'.		This tutorial will introduce you to the 'simpleserial' communications system. It will show you how to perform different operations on data based on input from the ChipWhisperer software. This can be used for building your own system which you wish to 'break'.
		+
		+	For users of the ChipWhisperer Lite with ARM target, you'll want to ensure you have the latest updates to the ChipWhisperer platform. This can be done by using the ChipWhisperer Git Update program, or by using git to checkout the develop branch and pulling any updates.

	{{TOC\|limit=3}}		{{TOC\|limit=3}}

@@ Line 146: / Line 146: @@
 <li>You may wish to use the &quot;ChipWhisperer Virtual Machine&quot; on newer Windows systems, which does not require any of the above setup.</li></ol>
 </blockquote>
 {{Template:Tutorials}}
 [[Category:Tutorials]]

@@ Line 18: / Line 18: @@
 {{TOC|limit=3}}
-<h1> What is SimpleSerial </h1>
+<h2> What is SimpleSerial </h2>
 [[SimpleSerial]] is the communications protocol used for almost all of the ChipWhisperer demo project. It's a very basic serial protocol which can be easily implemented on most systems. This system communicates using a standard asyncronous serial protocol, 38400 baud, 8-N-1.
@@ Line 35: / Line 35: @@
 : This is the response from the system. If data has been encrypted with a 'p' for example, the system will respond with the 'r' sequence automatically. So sending the earlier example means the result of the encryption was <code>cbbd4a2b34f2571758ff6a797e09859d</code>.
-<h1> Building the Basic Example </h1>
+<h2> Building the Basic Example </h2>
 You'll need to have installed avr-gcc and avr-libc. You may have already done this by following the installation guide, or if using the ChipWhisperer-VM it comes prepared with avr-gcc already setup. See the [[Installing_ChipWhisperer]] guide for details.
@@ Line 77: / Line 77: @@
 </ol>
-<h1> Modifying the Basic Example </h1>
+<h2> Modifying the Basic Example </h2>
 At this point we want to modify the system to perform 'something' with the data, such that we can confirm the system is working. To do so, open the file <code>simpleserial-base.c</code> with a code editor such as ''Programmer's Notepad'' (which ships with WinAVR).
@@ Line 117: / Line 117: @@
 {{CollapsibleSection
-|intro = = Completing Tutorial with CW1173 (Lite) =
+|intro = === Completing Tutorial with CW1173 (Lite) ===
 |content= Completing Tutorial with CW1173}}
 {{CollapsibleSection
-|intro = = Completing Tutorial with CW1173 (Lite) + UFO Board =
+|intro = === Completing Tutorial with CW1173 (Lite) + UFO Board ===
 |content= Completing Tutorial with CW1173 UFO Board}}
 {{CollapsibleSection
-|intro = = Completing Tutorial with CW1200 (Pro) =
+|intro = === Completing Tutorial with CW1200 (Pro) ===
 |content= Completing Tutorial with CW1200}}
-<h1> Conclusion </h1>
+<h2> Conclusion </h2>
 In this tutorial you have learned how to build a custom program for the microcontroller on the ChipWhisperer target board. You have programmed the built .hex file into the microcontroller, and confirmed communications with the ChipWhisperer device.
@@ Line 135: / Line 134: @@
 In future labs you will build on this knowledge to attack specific instructions.
-<h1> Troubleshooting </h1>
+<h2> Troubleshooting </h2>
 Issues with compilation: