Skip to content

Latest commit

 

History

History

mpfs-user-crypto-rsa-services

README.md

PolarFire SoC MSS User Crypto RSA Services Example

This example project demonstrates the usage of the user crypto hardware block for the signature generation and verification using RSA service functions:

  • CALRSASignHash() is used to generate digital signature.
  • CALRSAVerifyHash() is used to verify the digital signature.

How to use this example

On connecting PolarFire SoC Video kit J12 to the host PC, you should see 4 COM port interfaces connected. To use this project configure the COM port interface1 as below:

  • 115200 baud
  • 8 data bits
  • 1 stop bit
  • no parity
  • no flow control

The example project will display instructions over the serial port. To execute the particular service, user has to select the options as shown over the serial port. This program displays the return data from User Crypto processor for digital signature generation and verification services.

Generate Digital Signature

Select option '1' to generate digital signature for RSA public-key cryptography service. This example project reads the message, hash type, RSA encoding, and private key from UART terminal and calls the CALRSASignHash() function, The CALRSASignHash() function performs signature generation for RSA public-key cryptography on the hash produced using the RSA encoding type. After successful completion, displays a success message along with the generated signature or displays a failure message.

Verify Digital Signature:

Select option '2' to verify digital signature for RSA public-key cryptography service. This example project reads the message, hash type, RSA encoding, public key, and signature value from UART terminal and calls the CALRSAVerifyHash() function. The CALRSAVerifyHash() function performs signature verification for RSA public-key cryptography on the hash produced from message using the RSA encoding type. After a successful completion, displays a success message along with the generated signature or displays a failure message.

Target Hardware

This example project is targeted at PolarFire SoC Video kit (MPFS250TS-1FCG1152I). The reference design for the PolarFire SoC video kit is available in the following GitHub repository: PolarFire® SoC Video Kit Reference Design.

The steps mentioned here can be used to generate a FlashPro Express job file from above mentioned tcl script.

This project provides build configurations and debug launchers as explained here

Configurations

  • PolarFire User Crypto Driver Configuration

    • config_user.h is a custom configuration file for PolarFire SoC CAL library. Following are the recommended configuration for config_user.h file.

      • Define g_user_crypto_base_address global variable as shown below. This will used to configure the PKX0_BASE (defined in config_user.h) and to connect to the User Crypto Co-processor in the Libero design.

      uint32_t g_user_crypto_base_addr 0x22000000UL;

      • SAT_LITTLE_ENDIAN - Endianness of the processor executing CAL Library customization definitions. These definitions enable the respective cryptographic services in the CAL which are supported by the User Crypto Processor. It is recommended that these definitions are not removed or changed unless required.

    • A symbol INC_STDINT_H is defined in project preprocessor setting. For more detail, please refer to caltypes.h file present in CAL folder.

NOTE:

  1. If you try to enter data values other than 0 - 9, a - f, A - F, an error message will be displayed on the serial terminal.
  2. You must enter all input data as whole bytes. If you enter the 128-bit key {1230...0} as 0x12 0x3 and press return, this will be treated as byte0 = 0x12, byte1 = 0x30, byte2-127 = 0x00.

Macro Script

A macro script is provided with this example which automatically enters the NIST vectors and associated data to verify the functionality. You can use rsa_services.ttl Tera Term Macro script present in project directory for testing RSA Signature Services example project.

NOTE:

  1. Tera Term Macros don’t work with Windows 10 build 14393.0. You should update to Windows 10 build 14393.0.105 or later.
  2. Before running Tera Term Macro script, set language as English (Setup->General->Language). Also setup transmit delay in (Setup->Serial port) to 5msec/char and 5msec/line.
  3. By default, Tera Term log will be stored in Tera Term installation Directory.

Silicon Revision Dependencies

This example is tested on PolarFire SoC Video kit (MPFS250TS-1FCG1152I).

CAL Library Src

The CAL source code is bound by license agreement. If you need access to the CAL source code, please contact FPGA_marketing@microchip.com for further details on NDA requirements.