User Tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
labs:codebreaker [2020/03/31 14:29] ee220ta [Exercise #3 - Decrypt and Display a Message] |
labs:codebreaker [2020/06/08 09:29] (current) nelson |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | <color red> | ||
| - | NOTE: changes have been made to the lab below. Items you no longer are required to do are shown with a <del>strikethrough</del>. | ||
| - | </color> | ||
| - | |||
| ====== Codebreaker ====== | ====== Codebreaker ====== | ||
| - | <color blue>Below is a link to Prof Nelson's lab introduction video. If you missed it at the start of lab you can watch it here. Or, even if you were present at the start of lab you can go back and review it as you work through the lab to help answer questions along the way. BUT, it is not substitute for also carefully reading the lab assignment itself.\\ \\ | ||
| - | |||
| - | * [[https://expl.ai/UWMRSDW | ExplainEverything.com website presentation]] | ||
| - | </color> | ||
| - | ===== Overview ===== | ||
| In this lab you will be given a secret message that has been encrypted with a secret key. You will create a circuit that tries every possible key until you find out which key successfully decrypts the message. | In this lab you will be given a secret message that has been encrypted with a secret key. You will create a circuit that tries every possible key until you find out which key successfully decrypts the message. | ||
| Line 18: | Line 9: | ||
| The progression of the exercises is: | The progression of the exercises is: | ||
| - | * <del>Exercise 1: Set up your project, and draw a message of your choosing on the screen.</del> | + | * Exercise 1: Set up your project, and draw a message of your choosing on the screen. |
| - | * Exercise 2 and 3: You will be given an encrypted message, and the decryption key. You will decrypt the message, and display the decrypted message <del>on the screen</del> via simulation. | + | * Exercise 2 and 3: You will be given an encrypted message, and the decryption key. You will decrypt the message, and display the decrypted message on the screen. |
| - | * Exercise 4: You will be given an encrypted message, but not the decryption key. You will search through all keys to find the key that properly decrypts a given message, and then display the decoded message <del>on the screen</del> via simulation. | + | * Exercise 4: You will be given an encrypted message, but not the decryption key. You will search through all keys to find the key that properly decrypts a given message, and then display the decoded message on the screen. |
| ===== Learning Outcomes ===== | ===== Learning Outcomes ===== | ||
| * Implement a state machine using behavioral SystemVerilog | * Implement a state machine using behavioral SystemVerilog | ||
| Line 82: | Line 73: | ||
| * The [[resources:char_drawer|CharDrawer]] module. You provide this module with a 128-bit ASCII message, a starting (x, y) coordinate, and a ''start'' signal. It will output (x,y) pixel values that when connected to the ''BitmapToVga'' module, will draw the message on the screen. You will be given a top-level that connects these two modules together, so you only need to worry about sending the correct inputs to the ''CharDrawer'' module. | * The [[resources:char_drawer|CharDrawer]] module. You provide this module with a 128-bit ASCII message, a starting (x, y) coordinate, and a ''start'' signal. It will output (x,y) pixel values that when connected to the ''BitmapToVga'' module, will draw the message on the screen. You will be given a top-level that connects these two modules together, so you only need to worry about sending the correct inputs to the ''CharDrawer'' module. | ||
| - | You should use your 7 segment controller from a previous lab for this. | ||
| Line 107: | Line 97: | ||
| Look over the top-level module, and make sure you understand how it works. The module contains: | Look over the top-level module, and make sure you understand how it works. The module contains: | ||
| - | * A ''clk_generator'' instance, that generates a 25MHz clock needed by the VGA display. | + | * A ''clk_generator'' instance, that generates a 25MHz clock needed by the VGA display. |
| * A ''BitmapToVga'' instance, that controls the VGA outputs, and has inputs that allow you to modify the pixel colors of the bitmap that is displayed over VGA. | * A ''BitmapToVga'' instance, that controls the VGA outputs, and has inputs that allow you to modify the pixel colors of the bitmap that is displayed over VGA. | ||
| * A ''CharDrawer'' instance, that is connected to the ''BitmapToVga'', that is used to draw messages to the bitmap, and thus the VGA display. | * A ''CharDrawer'' instance, that is connected to the ''BitmapToVga'', that is used to draw messages to the bitmap, and thus the VGA display. | ||
| Line 120: | Line 110: | ||
| - Create an appropriate constraints file for all of the top-level ports. | - Create an appropriate constraints file for all of the top-level ports. | ||
| - Add all other necessary modules to your project. You will need to expand the modules in the Design Sources list to make sure you have included all necessary modules. For this lab, you only need to create the ''Codebreaker'' module (ports listed below). All other modules have been given to you, or were created in previous labs. | - Add all other necessary modules to your project. You will need to expand the modules in the Design Sources list to make sure you have included all necessary modules. For this lab, you only need to create the ''Codebreaker'' module (ports listed below). All other modules have been given to you, or were created in previous labs. | ||
| - | - <del>In this first exercise, your Codebreaker module will be very simple:</del> | + | - In this first exercise, your Codebreaker module will be very simple: |
| - | - <del>Drive the ''key_display'' and ''stopwatch_run'' outputs to 0.</del> | + | - Drive the ''key_display'' and ''stopwatch_run'' outputs to 0. |
| - | - <del>Drive the ''plaintext_to_draw'' output to a message of your choice to draw on the screen (the ''CharDrawer'' can only draw upper case letters, digits and spaces. </del> | + | - Drive the ''plaintext_to_draw'' output to a message of your choice to draw on the screen (the ''CharDrawer'' can only draw upper case letters, digits and spaces. |
| - | - <del>Connect the ''draw_plaintext'' output to the ''start'' input.</del> | + | - Connect the ''draw_plaintext'' output to the ''start'' input. |
| Line 138: | Line 128: | ||
| - | <del>**Pass-off:** Generate the bitstream and program the board. You can use the **+** button on the monitors in the lab to switch them to the VGA input. Verify that your message is displayed after you press ''btnc''. You don't need to show it to the TAs.</del> | + | **Pass-off:** Generate the bitstream and program the board. You can use the **+** button on the monitors in the lab to switch them to the VGA input. Verify that your message is displayed after you press ''btnc''. You don't need to show it to the TAs. |
| ---- | ---- | ||
| Line 167: | Line 157: | ||
| * It is good to choose meaningful state names (not S1, S2, etc.) This will help you reason about and debug your state machine. | * It is good to choose meaningful state names (not S1, S2, etc.) This will help you reason about and debug your state machine. | ||
| - | **Pass-off**: <del>Show</del> Use Zoom to share your state machine with the TA and get feedback. | + | **Pass-off**: Show the TA your state machine. |
| + | |||
| ---- | ---- | ||
| Line 174: | Line 166: | ||
| - | Implement your state machine in your ''Codebreaker'' module. Test your design with the following 128-bit cyphertext and 24-bit key. You should get a readable message <del>on the display</del> in your simulation. You should be simulating codebreaker_top and using your own tcl file. | + | Implement your state machine in your ''Codebreaker'' module. Test your design with the following 128-bit cyphertext and 24-bit key. You should get a readable message on the display. |
| <code SystemVerilog> | <code SystemVerilog> | ||
| Line 181: | Line 173: | ||
| </code> | </code> | ||
| - | Use simulation to debug your design when necessary. A **reset time of at least 400 ns is required** to allow the clk_generator module to begin functioning properly and get a clk signal to your Codebreaker module. Remember to use the signals of codebreaker_top and not Codebreaker in your tcl script ('CPU_RESETN' and not 'reset'). | + | Use simulation to debug your design when necessary. |
| + | For this exercise you can continue to connect 0 to the ''key_display'' and ''stopwatch_run'' outputs. Since your state machine is now assigning a value to ''draw_plaintext'', make sure you don't still have it connected to the ''start'' input. | ||
| - | <del>For this exercise you can continue to connect 0 to the ''key_display'' and ''stopwatch_run'' outputs. Since your state machine is now assigning a value to ''draw_plaintext'', make sure you don't still have it connected to the ''start'' input.</del> | + | **Pass-off:** Show the TA the decoded message being displayed on the monitor. |
| - | + | ||
| - | **Pass-off:** <del>Show the TA the decoded message being displayed on the monitor.</del> <color red> Include a screenshot of the simulation showing the decoded message in the lab report. In order to make the decoded message be in ASCII instead of hex, change the radix of the plaintext_to_draw to be ASCII (right click it in the simulation window to get to radix menu). How take a screenshot will depend on your local computer (the one you are sitting at, NOT the computer that is actually running Vivado. For example, searching for "Windows 10 screenshot" will bring up many articles on how to make screenshots in Windows. Similar mechanisms will apply to any type of computer you might be working on. Further, if you decide you need to concatenate multiple PDF files into one to attach, there are many online sites that will do it for you. Further, there are many tools you can use on your own system to do it. </color> | + | |
| ---- | ---- | ||
| Line 208: | Line 199: | ||
| // Check that each byte of the plaintext is A-Z,0-9 or space. | // Check that each byte of the plaintext is A-Z,0-9 or space. | ||
| logic plaintext_is_ascii; | logic plaintext_is_ascii; | ||
| - | assign plaintext_is_ascii = ((plaintext_to_draw[127:120] >= "A" && plaintext_to_draw[127:120] <= "Z") || (plaintext_to_draw[127:120] >= "0" && plaintext_to_draw[127:120] <= "9") || (plaintext_to_draw[127:120] == " ")) && | + | assign plaintext_is_ascii = ((plaintext[127:120] >= "A" && plaintext[127:120] <= "Z") || (plaintext[127:120] >= "0" && plaintext[127:120] <= "9") || (plaintext[127:120] == " ")) && |
| - | ((plaintext_to_draw[119:112] >= "A" && plaintext_to_draw[119:112] <= "Z") || (plaintext_to_draw[119:112] >= "0" && plaintext_to_draw[119:112] <= "9") || (plaintext_to_draw[119:112] == " ")) && | + | ((plaintext[119:112] >= "A" && plaintext[119:112] <= "Z") || (plaintext[119:112] >= "0" && plaintext[119:112] <= "9") || (plaintext[119:112] == " ")) && |
| - | ((plaintext_to_draw[111:104] >= "A" && plaintext_to_draw[111:104] <= "Z") || (plaintext_to_draw[111:104] >= "0" && plaintext_to_draw[111:104] <= "9") || (plaintext_to_draw[111:104] == " ")) && | + | ((plaintext[111:104] >= "A" && plaintext[111:104] <= "Z") || (plaintext[111:104] >= "0" && plaintext[111:104] <= "9") || (plaintext[111:104] == " ")) && |
| - | ((plaintext_to_draw[103:96] >= "A" && plaintext_to_draw[103:96] <= "Z") || (plaintext_to_draw[103:96] >= "0" && plaintext_to_draw[103:96] <= "9") || (plaintext_to_draw[103:96] == " ")) && | + | ((plaintext[103:96] >= "A" && plaintext[103:96] <= "Z") || (plaintext[103:96] >= "0" && plaintext[103:96] <= "9") || (plaintext[103:96] == " ")) && |
| - | ((plaintext_to_draw[95:88] >= "A" && plaintext_to_draw[95:88] <= "Z") || (plaintext_to_draw[95:88] >= "0" && plaintext_to_draw[95:88] <= "9") || (plaintext_to_draw[95:88] == " ")) && | + | ((plaintext[95:88] >= "A" && plaintext[95:88] <= "Z") || (plaintext[95:88] >= "0" && plaintext[95:88] <= "9") || (plaintext[95:88] == " ")) && |
| - | ((plaintext_to_draw[87:80] >= "A" && plaintext_to_draw[87:80] <= "Z") || (plaintext_to_draw[87:80] >= "0" && plaintext_to_draw[87:80] <= "9") || (plaintext_to_draw[87:80] == " ")) && | + | ((plaintext[87:80] >= "A" && plaintext[87:80] <= "Z") || (plaintext[87:80] >= "0" && plaintext[87:80] <= "9") || (plaintext[87:80] == " ")) && |
| - | ((plaintext_to_draw[79:72] >= "A" && plaintext_to_draw[79:72] <= "Z") || (plaintext_to_draw[79:72] >= "0" && plaintext_to_draw[79:72] <= "9") || (plaintext_to_draw[79:72] == " ")) && | + | ((plaintext[79:72] >= "A" && plaintext[79:72] <= "Z") || (plaintext[79:72] >= "0" && plaintext[79:72] <= "9") || (plaintext[79:72] == " ")) && |
| - | ((plaintext_to_draw[71:64] >= "A" && plaintext_to_draw[71:64] <= "Z") || (plaintext_to_draw[71:64] >= "0" && plaintext_to_draw[71:64] <= "9") || (plaintext_to_draw[71:64] == " ")) && | + | ((plaintext[71:64] >= "A" && plaintext[71:64] <= "Z") || (plaintext[71:64] >= "0" && plaintext[71:64] <= "9") || (plaintext[71:64] == " ")) && |
| - | ((plaintext_to_draw[63:56] >= "A" && plaintext_to_draw[63:56] <= "Z") || (plaintext_to_draw[63:56] >= "0" && plaintext_to_draw[63:56] <= "9") || (plaintext_to_draw[63:56] == " ")) && | + | ((plaintext[63:56] >= "A" && plaintext[63:56] <= "Z") || (plaintext[63:56] >= "0" && plaintext[63:56] <= "9") || (plaintext[63:56] == " ")) && |
| - | ((plaintext_to_draw[55:48] >= "A" && plaintext_to_draw[55:48] <= "Z") || (plaintext_to_draw[55:48] >= "0" && plaintext_to_draw[55:48] <= "9") || (plaintext_to_draw[55:48] == " ")) && | + | ((plaintext[55:48] >= "A" && plaintext[55:48] <= "Z") || (plaintext[55:48] >= "0" && plaintext[55:48] <= "9") || (plaintext[55:48] == " ")) && |
| - | ((plaintext_to_draw[47:40] >= "A" && plaintext_to_draw[47:40] <= "Z") || (plaintext_to_draw[47:40] >= "0" && plaintext_to_draw[47:40] <= "9") || (plaintext_to_draw[47:40] == " ")) && | + | ((plaintext[47:40] >= "A" && plaintext[47:40] <= "Z") || (plaintext[47:40] >= "0" && plaintext[47:40] <= "9") || (plaintext[47:40] == " ")) && |
| - | ((plaintext_to_draw[39:32] >= "A" && plaintext_to_draw[39:32] <= "Z") || (plaintext_to_draw[39:32] >= "0" && plaintext_to_draw[39:32] <= "9") || (plaintext_to_draw[39:32] == " ")) && | + | ((plaintext[39:32] >= "A" && plaintext[39:32] <= "Z") || (plaintext[39:32] >= "0" && plaintext[39:32] <= "9") || (plaintext[39:32] == " ")) && |
| - | ((plaintext_to_draw[31:24] >= "A" && plaintext_to_draw[31:24] <= "Z") || (plaintext_to_draw[31:24] >= "0" && plaintext_to_draw[31:24] <= "9") || (plaintext_to_draw[31:24] == " ")) && | + | ((plaintext[31:24] >= "A" && plaintext[31:24] <= "Z") || (plaintext[31:24] >= "0" && plaintext[31:24] <= "9") || (plaintext[31:24] == " ")) && |
| - | ((plaintext_to_draw[23:16] >= "A" && plaintext_to_draw[23:16] <= "Z") || (plaintext_to_draw[23:16] >= "0" && plaintext_to_draw[23:16] <= "9") || (plaintext_to_draw[23:16] == " ")) && | + | ((plaintext[23:16] >= "A" && plaintext[23:16] <= "Z") || (plaintext[23:16] >= "0" && plaintext[23:16] <= "9") || (plaintext[23:16] == " ")) && |
| - | ((plaintext_to_draw[15:8] >= "A" && plaintext_to_draw[15:8] <= "Z") || (plaintext_to_draw[15:8] >= "0" && plaintext_to_draw[15:8] <= "9") || (plaintext_to_draw[15:8] == " ")) && | + | ((plaintext[15:8] >= "A" && plaintext[15:8] <= "Z") || (plaintext[15:8] >= "0" && plaintext[15:8] <= "9") || (plaintext[15:8] == " ")) && |
| - | ((plaintext_to_draw[7:0] >= "A" && plaintext_to_draw[7:0] <= "Z") || (plaintext_to_draw[7:0] >= "0" && plaintext_to_draw[7:0] <= "9") || (plaintext_to_draw[7:0] == " ")); | + | ((plaintext[7:0] >= "A" && plaintext[7:0] <= "Z") || (plaintext[7:0] >= "0" && plaintext[7:0] <= "9") || (plaintext[7:0] == " ")); |
| </code> | </code> | ||
| Line 229: | Line 220: | ||
| - | <del>Test</del> Simulate your brute-force design on the cyphertext below. HINT: the key is 000005 - be sure your circuit finds that one. | + | Test your brute-force design on the cyphertext and key from the last exercise. Use simulation when necessary to help debug your design. |
| - | <code SystemVerilog> | ||
| - | assign cyphertext = 128'hca7d05cd7e096d91acaf6fd347ef4994; | ||
| - | </code> | ||
| - | <color red> Include a screenshot of your simulation waveforms demonstrating that your simulation works and finds the correct key (be sure both the key and resulting decoded text are visible in the simulation). </color> | + | **Final Pass-Off:** Chose one of the cyphertexts below, decode the message, and display it on the VGA display. |
| - | **<del>Final</del> Pass-Off:** Choose two of the cyphertexts below, decode the message, and <del>display it on the VGA display</del> demonstrate that it works via simulation. NOTE: the cyphertexts were encoded using a key fairly close to 0 to minimize simulation time. Thus, if your search has not found the key prior to it reaching the value of 30, then you have a problem in your design and you can kill the simulation and start debugging your design. | + | <code Verilog> |
| + | assign cyphertext = 128'ha13a3ab3071897088f3233a58d6238bb; | ||
| + | assign cyphertext = 128'hb8935bbf5f819bcfec46da11d5393d4f; | ||
| + | assign cyphertext = 128'h396d6e70500754ff726bd5fb963998ce; | ||
| + | assign cyphertext = 128'h189f2800aac06ce4a74292bffe33fd2c; | ||
| + | assign cyphertext = 128'h19b39b044dc39c4e98f9dfb44a0b7c11; | ||
| + | </code> | ||
| - | <color red>Be sure the original cyphertext, decoded text, and the resulting key are visible in your simulation waveforms. </color> | + | /* "BRUTE FORCE RC4" key = 24'hAAAAAA; |
| + | "EZ KEY IS 000300" key = 24'h000300; | ||
| + | "THAT TOOK FORVER" key = 24'hFFFFFF; | ||
| + | " I PICKED NUM 4 " key = 24'h123456; | ||
| + | "YOU CRACK ME UP " key = 24'h6DB6DB; | ||
| + | */ | ||
| + | /* | ||
| <code Verilog> | <code Verilog> | ||
| assign cyphertext = 128'hca91b1577f34443894de1001885d6aa5; | assign cyphertext = 128'hca91b1577f34443894de1001885d6aa5; | ||
| Line 248: | Line 248: | ||
| assign cyphertext = 128'hbd6a2012369d963f18802a8a70ca7ec7; | assign cyphertext = 128'hbd6a2012369d963f18802a8a70ca7ec7; | ||
| </code> | </code> | ||
| + | */ | ||
| /* Small keys for simulation: | /* Small keys for simulation: | ||
| "BRUTE FORCE RC4" key = 24'h000009; | "BRUTE FORCE RC4" key = 24'h000009; | ||
| Line 256: | Line 256: | ||
| "YOU CRACK ME UP " key = 24'h000007; | "YOU CRACK ME UP " key = 24'h000007; | ||
| */ | */ | ||
| - | |||
| - | ==== Exercise #5 - Synthesize and Implement ==== | ||
| - | Synthesize and implement your design. | ||
| - | |||
| - | <color red>Submit your synthesis logs to LearningSuite to demonstrate that you had no errors or critical warnings and, therefore, that your design *should work in all likelihood in hardware.</color> | ||
| - | |||
| - | //Go to the tab "Reports" at the bottom of the screen. The report will likely be called "synth_#_synth_synthesis_report_#". | ||
| - | Print to PDF as you would other SV modules and submit to learning suite.// | ||
| - | |||
| - | <color red>For the synthesis and implementation logs, explain the source of any CRITICAL WARNING messages and why they are OK. </color> | ||
| <color red>Submit your ''Codebreaker'' SystemVerilog module using the code submission on Learning Suite.</color> (Make sure your SystemVerilog conforms to the lab SystemVerilog coding standards). | <color red>Submit your ''Codebreaker'' SystemVerilog module using the code submission on Learning Suite.</color> (Make sure your SystemVerilog conforms to the lab SystemVerilog coding standards). | ||
| Line 274: | Line 264: | ||
| ===== Personal Exploration ===== | ===== Personal Exploration ===== | ||
| - | * <del>Try creating your own encrypted message. You can use [[https://cryptii.com/pipes/rc4-encryption]]. Set the mode to encode, be sure your input string is 16 characters and your key is 3 bytes. Keep in mind, the byte order of the key is reversed; for example, if you choose a key of "AABBCC" on the website, the resulting key will be 24'hCCBBAA in the SystemVerilog implementation. The plaintext/cyphertext doesn't need to be re-ordered.</del> | + | * Try creating your own encrypted message. You can use [[https://cryptii.com/pipes/rc4-encryption]]. Set the mode to encode, be sure your input string is 16 characters and your key is 3 bytes. Keep in mind, the byte order of the key is reversed; for example, if you choose a key of "AABBCC" on the website, the resulting key will be 24'hCCBBAA in the SystemVerilog implementation. The plaintext/cyphertext doesn't need to be re-ordered. |
| - | * <del>Look through the ''CharDrawer'' SystemVerilog module and explore how it works. </del> | + | * Look through the ''CharDrawer'' SystemVerilog module and explore how it works. |
| - | * <del>Look through the RC4 decryption module, and see how it implements the algorithm described on the RC4 Wikipedia page.</del> | + | * Look through the RC4 decryption module, and see how it implements the algorithm described on the RC4 Wikipedia page. |
| - | * <del>Move the message to be drawn in a different location on the screen, and change the color.</del> | + | * Move the message to be drawn in a different location on the screen, and change the color. |
| - | * <del>**Challenge:** Speed up the brute-force algorithm by using 2 or 4 simultaneous RC4 decryption instances, and have each of them try a different part of the key space. Stop as soon as any of the modules find the correct key.</del> | + | * **Challenge:** Speed up the brute-force algorithm by using 2 or 4 simultaneous RC4 decryption instances, and have each of them try a different part of the key space. Stop as soon as any of the modules find the correct key. |
