OrgST-Microelectronics
/
STM32CubeF7
mirror of https://github.com/STMicroelectronics/STM32CubeF7.git
1
0
Fork 0
Code Issues Releases Wiki Activity
STM32CubeF7/Projects/STM32756G_EVAL/Applications/mbedTLS/SSL_Client/readme.txt

155 lines
7.6 KiB
Plaintext
Raw Permalink Blame History

/**
@page SSL_Client SSL Client application
@verbatim
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
* @file mbedTLS/SSL_Client/readme.txt
* @author MCD Application Team
* @brief Description of SSL Client 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 describes how to run an SSL client application based on mbedTLS
crypto library and LwIP TCP/IP stack.
Scenario 1:
===========
In this screnario the client (STM32756G-EVAL):
- connects to local network either through DHCP or static IP address.
- establishes a secured connected to the Host PC Server.
- sends an encrypted message to the server.
- receives an answser from the server.
Scenario 2:
===========
In this second scenario, the the client (STM32756G-EVAL):
- connects to local network either through DHCP or static IP address.
- establishes a secured connected to a second STM32756G-EVAL board running
the "SSL_Sever" application.
- sends an encrypted message to the second board.
- receives an answser from the server board.
Application logs are displayed on the LCD.
In case of sucess the green led is toggling.
In case of errors the red led is loggling.
Note : ETH_MDIO signal is connected to PA2 which is shared with other signals like SAI2_SCKB.
By default on STM32756G-EVAL board, PA2 is connected to SAI2_SCKB, so to connect PA2 to ETH_MDIO :
- jumper JP21 must be on the position 2-3
Note : ETH_MDC is connected to PC1 which is shared with other signals like SAI1_SDA.
By default on STM32756G-EVAL board, PC1 is connected to SAI1_SDA, so to connect PC1 to ETH_MDC :
- jumper JP22 must be on the position 2-3
@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 Client, 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_Client/Inc/ethernetif.h header for ethernetif.c file
- mbedTLS/SSL_Client/Inc/main.h Main program header file
- mbedTLS/SSL_Client/Inc/mbedtls_config.h mbedTLS library configuration options
- mbedTLS/SSL_Client/Inc/FreeRTOSConfig.h FreeRTOS configuration options
- mbedTLS/SSL_Client/Inc/lwipopts.h LwIP stack configuration options
- mbedTLS/SSL_Client/Inc/stm32f7xx_it.h Interrupt handlers header file
- mbedTLS/SSL_Client/Inc/stm32f7xx_hal_conf.h Library Configuration file
- mbedTLS/SSL_Client/Src/main.c Main program
- mbedTLS/SSL_Client/Src/ssl_client.c SSL client main thread
- mbedTLS/SSL_Client/Src/ethernetif.c Interfacing the LwIP stack to ETH driver
- mbedTLS/SSL_Client/Src/stm32f7xx_hal_msp.c HAL MSP module
- mbedTLS/SSL_Client/Src/stm32f7xx_it.c Interrupt handlers
- mbedTLS/SSL_Client/Src/stm32f7xx_hal_timebase_tim.c HAL time base functions
- mbedTLS/SSL_Client/Src/net_socket.c mbedTLS TCP/IP socket API implementation using LwIP.
- mbedTLS/SSL_Client/Src/system_stm32f7xx.c STM32 system clock configuration file
@par Hardware and Software environment
- This application runs on STM32F756xx Devices.
- This application has been tested with two scenarios.
- Using a Host PC as server, running a Fedora 23 operating System or similar.
- Using a Windows PC as server, running Windows 7 operating system or later.
- using two STM32756G-EVAL boards the first as server, the second as client.
- Scenario 1:
- Remote PC Set-up
- Make sure that the PC is in the same local network as the baord.
- Using a Linux Machine
- Download the mebedTLS source code from (https://tls.mbed.org/download/start/mbedtls-2.4.0-apache.tgz)
- build the mbedTLS package following the instructions in the https://github.com/ARMmbed/mbedtls#make
- Once done, run the server application "programs/ssl/ssl_server".
- Using a Windows Machine
- Follow the instructions in the file "Firmware\Utilities\PC_Software\ssl_server\readme.txt" to run the ssl_server application.
- the "ssl_server" will wait for remote connections.
- Screnario 2:
- a second STM32756G-EVAL running the "mdedTLS/SSL_Server" application
- STM32756G-EVAL Set-up
- Connect STM32756G-EVAL to your local network (through a straight ethernet cable).
- jumper JP21 must be on the position 2-3 (ETH_MDIO signal)
- jumper JP22 must be on the position 2-3 (ETH_MDC signal)
- If LED1 is used, jumper 24 must be on the position 2-3
@par How to use it ?
In order to make the program work, you must do the following :
- Open your preferred toolchain
- edit the file "main.h" setup the correct "SERVER_NAME"
- Rebuild all files and load your image into target memory
- Run the application.
@Note: 1 Please ensure that the remote PC IP address is the same IP address
as the one defined in main.h in the "SERVER_NAME", and the port number
used for the connection is the same as the one defined in "SERVER_PORT"
2 If using two boards for testing and the DHCP is enabled then the "SSL_Server" needs to be
run first, to get the board IP Address and use it in the "SSL_Client" application.
*/
Reference in New Issue View Git Blame Copy Permalink