blob: 553c3a618eb77b916af026691ecbeff0e83edfae [file] [log] [blame] [view]
Simon Butcherdf819242015-08-19 19:33:27 +01001# SHA-256 Hash Example
Manuel Pégourié-Gonnard63e7eba2015-07-28 14:17:48 +02002
3This 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 Arkinfb404102015-08-27 15:56:44 +01007To build and run this example you must have:
Manuel Pégourié-Gonnard63e7eba2015-07-28 14:17:48 +02008
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 Arkinfb404102015-08-27 15:56:44 +010013 * [The ARM GCC toolchain](https://launchpad.net/gcc-arm-embedded).
14 * A serial terminal emulator (Like screen, pySerial and cu).
Simon Butcherdf819242015-08-19 19:33:27 +010015* 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é-Gonnard63e7eba2015-07-28 14:17:48 +020016* 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 Butcherdf819242015-08-19 19:33:27 +0100211. 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é-Gonnard63e7eba2015-07-28 14:17:48 +020022
232. Navigate to the mbedtls directory supplied with your release and open a terminal.
24
253. Set the yotta target:
26
27 ```
28 yotta target frdm-k64f-gcc
29 ```
30
Simon Butchera1500502015-08-19 20:29:31 +0100314. Build mbedtls and the examples. This may take a long time if this is your first compilation:
Manuel Pégourié-Gonnard63e7eba2015-07-28 14:17:48 +020032
33 ```
Simon Butcherdf819242015-08-19 19:33:27 +010034 $ yotta build
Manuel Pégourié-Gonnard63e7eba2015-07-28 14:17:48 +020035 ```
36
Brian Daniels3c405ae2015-08-18 10:52:57 -0700375. 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é-Gonnard63e7eba2015-07-28 14:17:48 +020038
Irit Arkinfb404102015-08-27 15:56:44 +0100396. Start the serial terminal emulator and connect to the virtual serial port presented by FRDM-K64F.
Manuel Pégourié-Gonnard63e7eba2015-07-28 14:17:48 +020040
Irit Arkinfb404102015-08-27 15:56:44 +010041 Use the following settings:
42
43 * 115200 baud (not 9600).
44 * 8N1.
45 * No flow control.
46
477. Press the Reset button on the board.
Manuel Pégourié-Gonnard63e7eba2015-07-28 14:17:48 +020048
Brian Daniels3c405ae2015-08-18 10:52:57 -0700498. The output in the terminal window should look like:
Manuel Pégourié-Gonnard63e7eba2015-07-28 14:17:48 +020050
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 ```