README.md
1# mbed TLS Selftest Example
2
3This application runs the various selftest functions of individual mbed TLS components. It serves as a basic sanity check to verify operation of mbed TLS on your platform. In the future, a wider portion of the mbed TLS test suite will become part of this example application.
4
5## Pre-requisites
6
7To build and run this example you must have:
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/).
13 * [The ARM GCC toolchain](https://launchpad.net/gcc-arm-embedded).
14 * A serial terminal emulator (Like screen, pySerial and cu).
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).
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
211. Connect the FRDM-K64F to the computer with the micro-USB cable, being careful to use the "OpenSDA" connector on the target board.
22
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
314. Build mbedtls and the examples. This may take a long time if this is your first compilation:
32
33 ```
34 $ yotta build
35 ```
36
375. Copy `build/frdm-k64f-gcc/test/mbedtls-test-example-selftest.bin` to your mbed board and wait until the LED next to the USB port stops blinking.
38
396. Start the serial terminal emulator and connect to the virtual serial port presented by FRDM-K64F.
40
41 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.
48
498. The output in the terminal window should look like:
50
51 ```
52 {{timeout;40}}
53 {{host_test_name;default}}
54 {{description;mbed TLS selftest program}}
55 {{test_id;MBEDTLS_SELFTEST}}
56 {{start}}
57
58 SHA-224 test #1: passed
59 SHA-224 test #2: passed
60 SHA-224 test #3: passed
61 SHA-256 test #1: passed
62 SHA-256 test #2: passed
63 SHA-256 test #3: passed
64
65 [ ... several lines omitted ... ]
66
67 CTR_DRBG (PR = TRUE) : passed
68 CTR_DRBG (PR = FALSE): passed
69
70 HMAC_DRBG (PR = True) : passed
71 HMAC_DRBG (PR = False) : passed
72
73 ECP test #1 (constant op_count, base point G): passed
74 ECP test #2 (constant op_count, other point): passed
75
76 ENTROPY test: passed
77
78 [ All tests passed ]
79
80 {{success}}
81 {{end}}
82 ```
83
