IGPS

Image Generation And Programming Scripts for Arbel BMC

How to use

IGPS is written for Python 3.7

Make sure you have it installed and added to your %PATH%.

In addition, please download and compile the following tools: (a precompiled version for Windows users is already part of this repo)

1. Bingo

https://github.com/Nuvoton-Israel/bingo Bingo is a generic tool that can build any header. The Header format and contents are defined on an external xml file. There is nothing Arbel specific on the tool itself (Same Bingo can be used in Poleg) More details and a basic set of examples are available on the link above.

2. OpenSSL

Version: OpenSSL 1.0.2j-fips 26 Sep 2016 Linux users can download it from: https://www.openssl.org/source/

3. UUT - Z1 only

https://github.com/Nuvoton-Israel/uart-update-tool Used for programing the flash using the Arbel ROM UFPP mode.

Download and compile these three tools. The first tools should be placed inside ./ImageGeneration The last tool should be placed inside ./ImageProgramming.

WARNING: Programming with UUT is only supported in NPCM8XX Z1. Tool is obsulete.

Notes about input files

All the files in this package are used for EB\SVB. For other vendors, please contact [email protected].

How to use:

Image generation:

python ./UpdateInputsBinaries_%Chip*_%Board%.py
python ./GenerateAll.py

Chip: A1\A2 device. Note: Z1 support has been removed in IGPS 4.0.6. Board: SVB\EB\DC-SCM are currently supported.

Note: UpdateInputBinaries*.bat resets all the images and xml files inside py_scripts\ImageGeneration\inputs folder. After that users can override the existing files in inputs folder, or use as is. For a signed release there is also an option to use ReplaceComponent.bat to replace a single file inside a signed image.

Signed version of IGPS

Nuvoton provides to customers locked devices. To use those devices Nuvoton use its own private key to sign the images. This means users can generate flash images for these devices. Nuvoton provides a pre-signed IGPS version for locked devices. Update* and Generate* are not possible, only programming. If user wishes to update uboot\bl31\bootblock they may still do so by replaceing the file in inputs folder and executing ReplaceComponent.bat

Signing options

IGPS supports three modes for signing

1. OpenSSL signatures: IGPS contains a list of default OpenSSL keys. If the user deletes a key, IGPS will re-generates a new random key using OpenSSL. Then the keys are used for signing the image.

2. HSM signatures: IGPS can use pkcs11-tool to communicate with an external HSM element, like a NitroKey for example. In this case, the private key is not accessible directly. It is kept on the HSM. IGPS will use the HSM key to sign all images.

3. Remote HSM: This mode is used for HSM that is remote and inaccessible from IGPS. The user is in charge to send the binary files (8 files end with _part_to_sign.bin) for signing in to an HSM. Then user should load the signature files in DER format and public keys back to IGPS. IGPS will embed the signature and the keys provided by the user.

For all modes of signing: Public keys are put in OTP file\KMT\SKMT depending on the key type. Signatures are embedded into the flash image.

If other means of signing are required, please contact [email protected] Nuvoton recommends coordinating a bring-up test for customer HSM needs.

Image programming

Connect a serial port (via COM port or USB to Serial) to Serial Interface 2

python ./Program%File%_%Security%_%Tool%.py

File: All: All FWs except Linux: KMT, TFT, bootblock, BL31, OpTee, uboot. (most common use case). NO_TIP: Users who have an Arbel chip without TIP (no security features) should use the NO_TIP programming scripts. Security: Basic (none-secure device) Secure (locked device). Secure mode is backward compatible and recomended even for none secure devices. Tool: can be EVB: support blue\green EVB board only. Require automation jumpers. Windows only. DediProg: SVB has a headaer for external Flash Programmer DediProg. FUP: using internal UART of the Arbel. This feature is only supported in Z1. Deprecated.

For EVB and FUP: Disable all terminal apps before execution.

Flash format

In order to format all flash use the script:

TOTAL_WIPE_DediProg.bat

or

TOTAL_WIPE_EVB.bat

It will load a dedicated TIP_FW that will erase all the flashes that are detected. Execution time depends on the amount and size of the flashes. typically takes a few minutes.

COM port utilites

For Windows + TeraTerm users can use

Open_all_ports.bat

to automatically detect COM port numbers and open TeraTerm session for each port.