Install SGX On-prem API Co-signer

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

1. Setup and configure your on-prem environment: Prepare your on-prem environment by creating and configuring the required resources. Ensure it meets the necessary specifications and security settings.
2. Add a Co-signer to the workspace using an API user: Using the Fireblocks Console or APIs, create an API user and use it to add a Co-signer to the workspace.
3. Install and connect the Co-signer to the workspace: Download the installation script to the SGX-capable machine, then run it to install the Co-signer. Once installation is complete, the workspace owner approves the new MPC key shares for the API user through the Fireblocks mobile app.

​

Step 1: Set up and configure your on-prem environment and SGX server

​

Step 1.1: Allowlist domains

​

Step 1.2: Set up and configure an on-prem SGX server

• CPU processor: Only one of the following Intel® processors
• CPU cores: Minimum 4
• OS: Ubuntu 22.04 LTS or 24.04 LTS (Canonical) with -
  • Latest Linux kernel version
  • Latest Intel microcode (BIOS update)
• RAM: Minimum 16GB
• Storage: Minimum 128GB
• SGX Memory: Minimum 2GB EPC

Fireblocks also supports on-prem SGX servers installed on OVHcloud providers.

• Enable Intel SGX (Software Guard Extension)
• Enable DCAP (FLC)
• Disable hyper threading
• Disable Intel SpeedStep Technology
• Disable Onboard VGA

​

Step 1.3: Verify SGX is enabled on your SGX server

 apt update
 apt upgrade
 apt install cpuid
 cpuid -1 | grep -i sgx

1. SGX: Software Guard Extensions supported is true
2. SGX_LC: SGX launch config supported is true

​

Step 1.4: Install the SGX drivers

1. Subscribe to the Intel PCS for ECDSA Attestation and to obtain the required API keys.
2. Set up Intel’s reference caching service, the Provisioning Certification Caching Service (PCCS):
   1. Redhat/Debian: Installation Guide, page 39
   2. Another Debian approach: Follow the steps in the document above (intel-dcap.pdf), but skip the Verify the empty cache step.
   3. Cache Fill Mode: Intel SGX DCAP Caching Service Design Guide, page 38
3. Provision the Intel SGX-enabled platform for Intel SGX workloads. The goal is to run PCKIDRetrievalTool. Make sure pckid_retrieval.csv is created. This file will be used to register the CPU data with Intel. Without this registration, the remote attestation will fail.
   1. Debian resources: Intel SGX DCAP Quick Install Guide, page 4
   2. Redhat resources: Download the binary file from one of these locations:
      1. https://download.01.org/intel-sgx/sgx-dcap/1.18/linux/distro/rhel8.6-server/
      2. https://github.com/intel/SGXDataCenterAttestationPrimitives/tree/main/tools/PCKRetrievalTool
4. Convert the pckid_retrieval.csv file to JSON format using this Python script and submit it to Intel for registration. You can view a sample JSON here.
   import json
   import sys
   
   if len(sys.argv) != 2 and len(sys.argv) != 3:
       print("usage: pckid2json <pckid file path> <outputfile>")
       exit(0)
   
   f = open(sys.argv[1], 'r')
   data = f.read().split(',')
   f.close()
   
   if len(data) == 5:
       print("WARNING: platform metadata is missing from pckid file")
   elif len(data) != 6:
       print("ERROR: pckid file has invalid format")
       exit(-1)
   
   obj = {}
   obj['enc_ppid'] = data[0]
   obj['pce_id'] = data[1]
   obj['cpu_svn'] = data[2]
   obj['pce_svn'] = data[3]
   obj['qe_id'] = data[4]
   if len(data) == 6:
       obj['platform_manifest'] = data[5]
   
   if len(sys.argv) == 3:
       f = open(sys.argv[2], 'w')
       json.dump(obj, f)
       f.close()
   else:
       print(json.dumps(obj))
   
   1. For more information about the registration process, visit the following references:
      1. Design Guide for Intel SGX PCCS, page 20
      2. Get PCK Certificates, V4
5. When prompted to verify the provisioning data, skip this step.
6. Reimage the Intel SGX-enabled platform.
7. Load the Intel SGX runtime stack onto the reimaged system:
   1. Debian: Refer to the Intel SGX DCAP Quick Install Guide, page 5. Note that steps 5 and 6 are bulked up in the “Runtime configuration” section.
   2. Redhat: Refer to the Intel Confidential Computing Documentation.

​

Step 1.5: Registration with Intel

1. Follow the registration instructions located here. Note that you’ll need the JSON format of the pckid_retrieval.csv file for this step.
2. Verify that your CSV is registered with Intel via Fireblocks:
   curl -L
   "https://mobile-api.fireblocks.io/sgx/certification/v3/pckcert?qeid=FC88E54A32E9BE6455A01CE78A55B85C&encrypted_ppid=635DBA646F13077DC75291B12ABE96D4D69A956D7FF5524D8090290EEB8ACC6450F72CD7539D1578E636911321D96E0CEC15E04FACBC7652DE1775F76DF460D472A7F5C8118B22C37F4590789F46161D99F2758D120C5BD4CD8FD302C444F56E620A98DFAFD156887B73DAEEB04EA6C9007C2EEB9B00DF49FBBD4B9535B8DB61445A28F73CADDADB36B27E35DACE6A4287621D2FF6E01B31C579FC9D73512B631558427370020DAB10DF315D740400ED73D64AACBFC76A0B88975A52086CD656809A58821A9B8516A4571BF33CBA042B76EC4409745635ADF2DE5F62FA8C0F6E4970712209F3D2EF83E5850646105B841F1905CB3E7F5AE21BF8759250C9981F8DEA229265CC619D9990842AC71739BCF155FCBA6AD262EDF04AA8A9E668E2F87A3FA822E7F6F330CA955C9B6244E5C35BFA71DA08655C1244156E598F97B97BAF1DF6CF79B624E5129AF190A24930436BDCC2371BEA322EEF2D733769372D5F763763B937BF680D4245441F234623051FAFCF0DA8FA79D744E3F261FD352275&cpusvn=0C0C0F0EFFFF01000000000000000000&pcesvn=0C00&pceid=0000"
   
3. A certificate will appear in the response if the registration was successful:
   -----BEGIN CERTIFICATE-----
   MIIE8jCCBJigAwIBAgIUUWcKdCIgJwOmz/lT0UrRd9zVUU8wCgYIKoZIzj0EAwIw
   cDEiMCAGA1UEAwwZSW50ZWwgU0dYIFBDSyBQbGF0Zm9ybSBDQTEaMBgGA1UECgwR
   SW50ZWwgQ29ycG9yYXRpb24xFDASBgNVBAcMC1NhbnRhIENsYXJhMQswCQYDVQQI
   DAJDQTELMAkGA1UEBhMCVVMwHhcNMjQxMjAzMDg1MzA2WhcNMzExMjAzMDg1MzA2
   …….
   …….
   …….
   -----END CERTIFICATE-----
   

​

Step 2: Add a Co-signer to the workspace using an API user

• The API user’s pairing token
• The download link of the Co-signer’s installation script

​

Step 3: Install and connect the Co-signer to the workspace

You must have root privileges on the Co-signer server to install the Co-signer Ensure you are logged in as a root user or use sudo to execute the commands.

​

Step 3.1: Download the installation script

curl -o cosigner "URL"

​

Step 3.2: Run the installation script

chmod +x cosigner

./cosigner setup

​

Step 3.3: Approve MPC key shares for the API user

To check the Co-signer’s status and observe the logs, see the SGX Co-signer Maintenance article.