146 lines
7.0 KiB
Plaintext
146 lines
7.0 KiB
Plaintext
/**
|
||
@page SSL_Server SSL Server application
|
||
|
||
@verbatim
|
||
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
|
||
* @file mbedTLS/SSL_Server/readme.txt
|
||
* @author MCD Application Team
|
||
* @brief Description of SSL Server application.
|
||
******************************************************************************
|
||
*
|
||
* @attention
|
||
*
|
||
* Copyright (c) 2017 STMicroelectronics.
|
||
* All rights reserved.
|
||
*
|
||
* This software is licensed under terms that can be found in the LICENSE file
|
||
* in the root directory of this software component.
|
||
* If no LICENSE file comes with this software, it is provided AS-IS.
|
||
*
|
||
******************************************************************************
|
||
@endverbatim
|
||
|
||
@par Application Description
|
||
|
||
This application guides STM32Cube HAL API users to run an SSL Server application
|
||
based on mbedTLS crypto library and LwIP TCP/IP stack.
|
||
|
||
This application starts SSL server on the board waiting for connections from clients.
|
||
The board joins the local network using either a DHCP server or a static IP address.
|
||
Once done a green led is toggling informing that the server is ready.
|
||
|
||
As soon as a request from a client is received, the application establishes the secured
|
||
connection then sends the response to the client. the response is a HTML page with the text similar to:
|
||
|
||
"
|
||
mbed TLS Test Server
|
||
Successful connection using: TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA
|
||
"
|
||
|
||
it is possible to test this application via two scenarios:
|
||
|
||
Scenario 1:
|
||
===========
|
||
- the client is a PC with a web browser.
|
||
- the browser connects to the address https://BOARD_IP_ADDRESS:4433
|
||
- the afementioned string is displayed on the browser.
|
||
|
||
Scenario 2:
|
||
- the client is a second board (STM32F769I-Discovery), running the "SSL_Client" application.
|
||
- the second board connects to this application.
|
||
- the "webpage content" is displayed in text format on the LCD screen of the second board.
|
||
|
||
|
||
In both scenarios, the "SSL_Server" Application log is displayed on the LCD screen.
|
||
|
||
|
||
@note the Scenario 1 was tested using Google Chrome 52 and Internet Explorer 11, earlier versions of those
|
||
browsers may not work.
|
||
|
||
@note the ssl_server is not using a valid certificate to authentify, thus the browsers show a warning about
|
||
it, ignore that warning to let the application continue.
|
||
|
||
@note In this application the Ethernet Link ISR need the System tick interrupt
|
||
to configure the Ethernet MAC, so the Ethernet Link interrupt priority must be
|
||
set lower (numerically greater) than the Systick interrupt priority to ensure
|
||
that the System tick increments while executing the Ethernet Link ISR.
|
||
|
||
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
|
||
based on variable incremented in HAL time base ISR. This implies that if HAL_Delay() is called from
|
||
a peripheral ISR process, then the HAL time base interrupt must have higher priority (numerically lower)
|
||
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
|
||
To change the HAL time base interrupt priority you have to use HAL_NVIC_SetPriority() function.
|
||
|
||
@note The application needs to ensure that the HAL time base is always set to 1 millisecond
|
||
to have correct HAL operation.
|
||
|
||
@note The STM32F7xx devices can reach a maximum clock frequency of 216MHz but as this application uses SDRAM,
|
||
the system clock is limited to 200MHz. Indeed proper functioning of the SDRAM is only guaranteed
|
||
at a maximum system clock frequency of 200MHz.
|
||
|
||
For more details about this application, refer to UM1723 "STM32Cube mbedTLS application".
|
||
|
||
@par Keywords
|
||
|
||
Security, mbedTLS, HASH, RNG, CRYP, SSL Server, Crypto, TCP/IP, LwIP, AES 128,
|
||
AES 192, AES 256, Triple DES, MD5, SHA-1
|
||
|
||
@Note<74>If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
|
||
<20><><EFBFBD><EFBFBD><EFBFBD>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>The address and the size of cacheable buffers (shared between CPU and other masters) must be properly updated to be aligned to cache line size (32 bytes).
|
||
|
||
@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Even though the user must manage the cache coherence for read accesses.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>
|
||
|
||
@par Directory contents
|
||
|
||
- mbedTLS/SSL_Server/Inc/ethernetif.h header for ethernetif.c file
|
||
- mbedTLS/SSL_Server/Inc/main.h Main program header file
|
||
- mbedTLS/SSL_Server/Inc/config.h mbedTLS library configuration options
|
||
- mbedTLS/SSL_Server/Inc/FreeRTOSConfig.h FreeRTOS configuration options
|
||
- mbedTLS/SSL_Server/Inc/lwipopts.h LwIP stack configuration options
|
||
- mbedTLS/SSL_Server/Inc/stm32f7xx_it.h Interrupt handlers header file
|
||
- mbedTLS/SSL_Server/Inc/stm32f7xx_hal_conf.h Library Configuration file
|
||
- mbedTLS/SSL_Server/Inc/ssl_server.h header for ssl_server.c
|
||
- mbedTLS/SSL_Server/Src/main.c Main program
|
||
- mbedTLS/SSL_Server/Src/ssl_server.c SSL Server main thread
|
||
- mbedTLS/SSL_Server/Src/ethernetif.c Interfacing the LwIP stack to ETH driver
|
||
- mbedTLS/SSL_Server/Src/stm32f7xx_hal_msp.c HAL MSP module
|
||
- mbedTLS/SSL_Server/Src/stm32f7xx_it.c Interrupt handlers
|
||
- mbedTLS/SSL_Client/Src/stm32f7xx_hal_timebase_tim.c HAL time base functions
|
||
- mbedTLS/SSL_Server/Src/system_stm32f7xx.c STM32 system clock configuration file
|
||
- mbedTLS/SSL_Server/Src/net_sockets.c the TCP/IP socket API implemented over the LwIP stack.
|
||
|
||
@par Hardware and Software environment
|
||
|
||
- This application runs on STM32F769I-Discovery Devices.
|
||
|
||
- This application has been tested with two scenarios.
|
||
- Using a Host PC as a client.
|
||
- using two STM32F769I-Discovery boards the first as server, the second as client.
|
||
|
||
- Screnario 1:
|
||
- Remote PC Set-up
|
||
- Make sure that the PC is in the same local network as the baord.
|
||
- Web browser available on the PC.
|
||
|
||
- Screnario 2:
|
||
- a second STM32F769I-Discovery running the "mdedTLS/SSL_Server" application
|
||
|
||
- STM32F769I-Discovery Set-up
|
||
- Connect STM32F769I-Discovery to your local network (through a straight ethernet cable).
|
||
|
||
@par How to use it ?
|
||
|
||
In order to make the program work, you must do the following :
|
||
- Open your preferred toolchain
|
||
- Rebuild all files and load your image into target memory
|
||
- Run the application
|
||
- Use Scenario 1 or Scenario 2 described above.
|
||
|
||
|
||
*/ |