README.md
1# Authenticated Encryption Example
2
3This application performs authenticated encryption and authenticated decryption of a buffer. It serves as a tutorial for the basic authenticated encryption functions of mbed TLS.
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-authcrypt.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;10}}
53 {{host_test_name;default}}
54 {{description;mbed TLS example authcrypt}}
55 {{test_id;MBEDTLS_EX_AUTHCRYPT}}
56 {{start}}
57
58
59 plaintext message: 536f6d65207468696e67732061726520626574746572206c65667420756e7265616400
60 ciphertext: c57f7afb94f14c7977d785d08682a2596bd62ee9dcf216b8cccd997afee9b402f5de1739e8e6467aa363749ef39392e5c66622b01c7203ec0a3d14
61 decrypted: 536f6d65207468696e67732061726520626574746572206c65667420756e7265616400
62
63 DONE
64 {{success}}
65 {{end}}
66 ```
67
68The actual output for the ciphertext line will vary on each run because of the use of a random nonce in the encryption process.
69
