Simon Butcher | df81924 | 2015-08-19 19:33:27 +0100 | [diff] [blame] | 1 | # SHA-256 Hash Example |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 2 | |
| 3 | This application performs hashing of a buffer with SHA-256 using various APIs. It serves as a tutorial for the basic hashing APIs of mbed TLS. |
| 4 | |
| 5 | ## Pre-requisites |
| 6 | |
Irit Arkin | fb40410 | 2015-08-27 15:56:44 +0100 | [diff] [blame] | 7 | To build and run this example you must have: |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 8 | |
| 9 | * A computer with the following software installed: |
| 10 | * [CMake](http://www.cmake.org/download/). |
| 11 | * [yotta](https://github.com/ARMmbed/yotta). Please note that **yotta has its own set of dependencies**, listed in the [installation instructions](http://armmbed.github.io/yotta/#installing-on-windows). |
| 12 | * [Python](https://www.python.org/downloads/). |
Irit Arkin | fb40410 | 2015-08-27 15:56:44 +0100 | [diff] [blame] | 13 | * [The ARM GCC toolchain](https://launchpad.net/gcc-arm-embedded). |
| 14 | * A serial terminal emulator (Like screen, pySerial and cu). |
Simon Butcher | df81924 | 2015-08-19 19:33:27 +0100 | [diff] [blame] | 15 | * An [FRDM-K64F](http://developer.mbed.org/platforms/FRDM-K64F/) development board, or another board supported by mbed OS (in which case you'll have to substitute frdm-k64f-gcc with the appropriate target in the instructions below). |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 16 | * A micro-USB cable. |
| 17 | * If your OS is Windows, please follow the installation instructions [for the serial port driver](https://developer.mbed.org/handbook/Windows-serial-configuration). |
| 18 | |
| 19 | ## Getting started |
| 20 | |
Simon Butcher | df81924 | 2015-08-19 19:33:27 +0100 | [diff] [blame] | 21 | 1. Connect the FRDM-K64F to the computer with the micro-USB cable, being careful to use the "OpenSDA" connector on the target board. |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 22 | |
| 23 | 2. Navigate to the mbedtls directory supplied with your release and open a terminal. |
| 24 | |
| 25 | 3. Set the yotta target: |
| 26 | |
| 27 | ``` |
| 28 | yotta target frdm-k64f-gcc |
| 29 | ``` |
| 30 | |
Simon Butcher | a150050 | 2015-08-19 20:29:31 +0100 | [diff] [blame] | 31 | 4. Build mbedtls and the examples. This may take a long time if this is your first compilation: |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 32 | |
| 33 | ``` |
Simon Butcher | df81924 | 2015-08-19 19:33:27 +0100 | [diff] [blame] | 34 | $ yotta build |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 35 | ``` |
| 36 | |
Brian Daniels | 3c405ae | 2015-08-18 10:52:57 -0700 | [diff] [blame] | 37 | 5. Copy `build/frdm-k64f-gcc/test/mbedtls-test-example-hashing.bin` to your mbed board and wait until the LED next to the USB port stops blinking. |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 38 | |
Irit Arkin | fb40410 | 2015-08-27 15:56:44 +0100 | [diff] [blame] | 39 | 6. Start the serial terminal emulator and connect to the virtual serial port presented by FRDM-K64F. |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 40 | |
Irit Arkin | fb40410 | 2015-08-27 15:56:44 +0100 | [diff] [blame] | 41 | Use the following settings: |
| 42 | |
| 43 | * 115200 baud (not 9600). |
| 44 | * 8N1. |
| 45 | * No flow control. |
| 46 | |
| 47 | 7. Press the Reset button on the board. |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 48 | |
Brian Daniels | 3c405ae | 2015-08-18 10:52:57 -0700 | [diff] [blame] | 49 | 8. The output in the terminal window should look like: |
Manuel Pégourié-Gonnard | 63e7eba | 2015-07-28 14:17:48 +0200 | [diff] [blame] | 50 | |
| 51 | ``` |
| 52 | {{timeout;10}} |
| 53 | {{host_test_name;default}} |
| 54 | {{description;mbed TLS example on hashing}} |
| 55 | {{test_id;MBEDTLS_EX_HASHING}} |
| 56 | {{start}} |
| 57 | |
| 58 | |
| 59 | Method 1: 315f5bdb76d078c43b8ac0064e4a0164612b1fce77c869345bfc94c75894edd3 |
| 60 | Method 2: 315f5bdb76d078c43b8ac0064e4a0164612b1fce77c869345bfc94c75894edd3 |
| 61 | Method 3: 315f5bdb76d078c43b8ac0064e4a0164612b1fce77c869345bfc94c75894edd3 |
| 62 | Method 4: 315f5bdb76d078c43b8ac0064e4a0164612b1fce77c869345bfc94c75894edd3 |
| 63 | |
| 64 | DONE |
| 65 | {{success}} |
| 66 | {{end}} |
| 67 | ``` |