Security User Guide: Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA

Download PDF
ID 683453
Date 3/06/2020
Public
Document Table of Contents
Document Table of Contents x
1. Overview 2. Intel® FPGA PAC Security Features 3. Intel FPGA PAC Security Flow 4. Using fpgasupdate 5. Document Revision History
1. Overview x
1.1. About This Document 1.2. Prerequisites 1.3. Related Documentation 1.4. Glossary
2. Intel® FPGA PAC Security Features x
2.1. Secure Image Updates 2.2. Anti-Rollback Capability 2.3. Key Management 2.4. Authentication 2.5. Encryption
3. Intel FPGA PAC Security Flow x
3.1. Installing PACSign 3.2. PACSign Tool 3.3. Creating Unsigned Images 3.4. Using an HSM Manager 3.5. Creating Keys 3.6. Root Entry Hash Bitstream Creation 3.7. Signing Images 3.8. Creating a CSK ID Cancellation Bitstream 3.9. PACSign PKCS11 Manager *.json Reference 3.10. Creating a Custom HSM Manager 3.11. PACSign Man Page
3.5. Creating Keys x
3.5.1. OpenSSL Key Creation 3.5.2. HSM Key Creation
3.7. Signing Images x
3.7.1. Creating OpenCL* Bitstreams
3.7.1. Creating OpenCL* Bitstreams x
3.7.1.1. Sourcing the init_env.sh Script 3.7.1.2. Creating the OpenCL* Bitstream 3.7.1.3. Programming the Image File
3.7.1.2. Creating the OpenCL* Bitstream x
3.7.1.2.1. Example: Creating a Signed .aocx File Using OpenSSL Manager 3.7.1.2.2. Example: Creating an Unsigned .aocx File Using OpenSSL Manager 3.7.1.2.3. Example: Creating a Signed .aocx File Using PKCS11 Manager 3.7.1.2.4. Example: Creating an Unsigned .aocx File Using PKCS11 Manager
3.10. Creating a Custom HSM Manager x
3.10.1. HSM_MANAGER.get_public_key(public_key) 3.10.2. HSM_MANAGER.sign(data, key) 3.10.3. Signing Operation Flow
3.10.1. HSM_MANAGER.get_public_key(public_key) x
3.10.1.1. PUBLIC_KEY.get_X_Y() 3.10.1.2. PUBLIC_KEY.get_permission() 3.10.1.3. PUBLIC_KEY.get_ID() 3.10.1.4. PUBLIC_KEY.get_content_type()
4. Using fpgasupdate x
4.1. Troubleshooting
1. Overview
2. Intel® FPGA PAC Security Features
3. Intel FPGA PAC Security Flow
4. Using fpgasupdate
5. Document Revision History

4.1. Troubleshooting

fpgasupdate provides descriptive errors when it cannot complete the requested operation.

When using fpgasupdate to program bitstreams created or signed with PACSign, the tool may reject the bitstream if, for example, there was an error in the signing process or if the signed bitstream is corrupted.

The TCM provides extended error codes to assist in troubleshooting an authentication failure. Error codes are logged in your system messaging log, such as dmesg or /var/syslogs. You may use the following table to decode the authentication status and associated errors.

Table 7.  Authentication Status Register Values and Error Descriptions
Authentication Status Value Error Name Error Description Corrective Action
32'h00000000 Block0 Magic value error Bitstream Format Error: Block 0 bad magic number. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h00000001 Block0 ConLen error Bitstream Format Error: Block 0 content length error. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32’h00000002 Block0 ConType B[7:0] > 2 Bitstream Format Error: Block 0 content type error. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h00000003 Root Entry Magic Number error Bitstream Format Error: Root entry bad magic number. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h00000004 Root Entry Curve Magic value error Bitstream Format Error: Root entry bad magic number. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h00000005 Root Entry Permission error Root entry bad permissions. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h00000006 Root Entry Key ID error Bitstream Format Error: Root entry bad key ID. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h00000007 Root Entry hash mismatch Bitstream Format Error: Root entry does not match root entry stored on card. Ensure bitstream is properly signed with the correct keys.
32'h00000008 CSK Entry Magic value error Bitstream Format Error: CSK bad magic number. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h00000009 CSK Entry Curve Magic value error Bitstream Format Error: CSK bad curve magic number. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h0000000A CSK Key Canceled Authentication Error: CSK canceled. Indicates you are attempting to program an image with a canceled CSK. Ensure bitstream is properly signed with the correct keys.
32'h0000000B CSK Entry Permission error Authentication Error: CSK bad permission. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h0000000C CSK Entry verify ECDSA and SHA failed Authentication Error: CSK signature invalid. Indicates CSK or root entry hash tampering. Ensure bitstream is properly signed with the correct keys.
32'h0000000D Block0 Entry Magic value error Bitstream Format Error: Block 0 entry bad magic number. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h0000000E Block 0 Entry Curve Magic value error Bitstream format error: Block 0 entry bad curve magic number. Indicates bitstream corruption. Ensure bitstream is properly signed with the correct keys.
32'h0000000F Block0 Entry verify ECDSA and SHA failed Authentication Error: Block 0 entry signature invalid. May indicate image tampering. Ensure bitstream is properly signed with the correct keys.
32'h00000010 Block1 Entry Magic Value Error Bitstream Format Error: Block 1 entry bad magic number. Indicates bitstream corruption. Program root entry hash bitstream.
32'h00000011 BIP PR error TCM unable to load BIP. Contact Intel support.
32'h00000012 BIP Block 0/1 error Bitstream format error: BIP does not recognize Block0/Block1 entry Ensure bitstream is properly signed with the correct keys.
32'h00000013 BIP Start error TCM unable to load and start BIP. Contact Intel support.
32'h00000014 Host bitstream download timeout Host loading of bitstream did not complete in time expected by TCM. Retry update operation.
32'h00000015 Host canceled update Update operation canceled by host. Retry update operation.
32'h00000016 Root Entry Hash bitstream not programmed for RSU and Cancellation You attempted to program a key cancellation bitstream without first programming a root entry hash bitstream. Program a root entry hash before attempting to program a key cancellation bitstream.
8'h00000017 KEY hash has been programmed for KEY hash programming certificate Authentication Error: Attempt to program root entry hash when the root entry hash bitstream has already been programmed. You may only program root entry hash bitstream one time.
32'h00000018 Payload SHA Invalid Authentication Error: Payload SHA mismatch. May indicate tampering of the root key. Verify correctness of bitstream; may need to resign.
32'h00000019 Host BMC command blacklisted TCM filtered a disallowed command from the host to the Intel® FPGA PAC BMC. Do not issue the failing command to the BMC.
32'h0000001A Host response timeout on BMC command The host did not respond in time after a BMC command. Retry BMC command operation.
32'h0000001B BMC timeout on request The BMC did not respond in time to acknowledge a command. Retry command.
32’h0000001C BMC timeout sending response The BMC did not respond in time after acknowledging a command. Power-cycle Intel® FPGA PAC and retry command.
32’h0000001d Host BMC response timeout on response acknowledge The Host BMC did not respond in time to the Intel® FPGA PAC BMC. Retry command.
32’h0000001e Flash open error The TCM experienced an error accessing on-board flash. Contact Intel support.
32’h0000001f Flash read error The TCM experienced an error accessing on-board flash. Contact Intel support.
32’h00000020 BIP load error The BIP encountered an error during loading. Retry update operation.
32’h00000021 PR reset timeout The TCM encountered a timeout when attempting to reset the PR region. Power cycle the PAC.
32’h00000022 BMC update prohibited after PR The TCM blocks BMC updates after an AFU has been loaded. Power cycle the PAC and attempt BMC update before loading an AFU.
32’h00000023 Flash update prohibited after PR The TCM blocks a flash update after an AFU has been loaded. Power cycle the PAC and attempt update before loading an AFU.
32’h00000024 BMC update delayed The TCM refused the BMC update operation due to a high update count and a short time since the last update operation. Retry update operation at a later time (up to 120s).
32’h00000025 Flash update delayed The TCM refused the update operation due to a high update count and a short time since the last update operation. Retry update operation at a later time (up to 120s).
32’h00000026 Bad BMC command length The TCM filtered a command to the BMC due to an improper command length. Format the BMC command correctly.
32’h00000027 Bad BMC response length The TCM filtered a BMC response due to an improper length. Format the BMC response correctly.
32’h00000028 PR prohibited from factory image The TCM reverted to factory image and an attempt to load an AFU was made. Update the Intel® FPGA FIM image.
32’h00000029 CSK bad CSK ID Authentication Error: CSK ID is an invalid value. Verify correctness of bitstream; may need to resign.
32’hDD00xxxx BIP internal error code The BIP experienced an error. Contact Intel support.
32’hEE00xxxx PR IP internal error code The AFU experienced an error. Contact AFU vendor support.
32’hFFFFFFFF No Error No Error  
Level Two Title