EREPORT — Create a Cryptographic Report of the Enclave

Instruction Operand Encoding ¶

Description ¶

This leaf function creates a cryptographic REPORT that describes the contents of the enclave. This instruction leaf can only be executed when inside the enclave. The cryptographic report can be used by other enclaves to determine that the enclave is running on the same platform.

RBX contains the effective address of the MRENCLAVE value of the enclave that will authenticate the REPORT output, using the REPORT key delivered by EGETKEY command for that enclave. RCX contains the effective address of a 64-byte REPORTDATA structure, which allows the caller of the instruction to associate data with the enclave from which the instruction is called. RDX contains the address where the REPORT will be output by the instruction.

EREPORT Memory Parameter Semantics ¶

This instruction leaf perform the following:

1. Validate the 3 operands (RBX, RCX, RDX) are inside the enclave.

2. Compute a report key for the target enclave, as indicated by the value located in RBX(TARGETINFO).

3. Assemble the enclave SECS data to complete the REPORT structure (including the data provided using the RCX (REPORTDATA) operand).

4. Computes a cryptographic hash over REPORT structure.

5. Add the computed hash to the REPORT structure.

6. Output the completed REPORT structure to the address in RDX (OUTPUTDATA).

The instruction fails if the operands are not properly aligned.

CR_REPORT_KEYID, used to provide key wearout protection, is populated with a statistically unique value on boot of the platform by a trusted entity within the SGX TCB.

The instruction faults if any of the following:

EREPORT Faulting Conditions ¶

Concurrency Restrictions ¶

Operation ¶

Temp Variables in EREPORT Operational Flow ¶

TMP_MODE64 := ((IA32_EFER.LMA = 1) && (CS.L = 1));

(* Address verification for TARGETINFO (RBX) *)

IF ( (DS:RBX is not 512Byte Aligned) or (DS:RBX is not within CR_ELRANGE) )

THEN #GP(0); FI;

IF (DS:RBX does not resolve within an EPC)

THEN #PF(DS:RBX); FI;

IF (EPCM(DS:RBX).VALID = 0)

THEN #PF(DS:RBX); FI;

IF (EPCM(DS:RBX).BLOCKED = 1)

THEN #PF(DS:RBX); FI;

(* Check page parameters for correctness *)

IF ( (EPCM(DS:RBX).PT ≠ PT_REG) or (EPCM(DS:RBX).ENCLAVESECS ≠ CR_ACTIVE_SECS) or (EPCM(DS:RBX).PENDING = 1) or

(EPCM(DS:RBX).MODIFIED = 1) or (EPCM(DS:RBX).ENCLAVEADDRESS ≠ (DS:RBX & ~0FFFH) ) or (EPCM(DS:RBX).R = 0) )

THEN #PF(DS:RBX);

FI;

(* Verify RESERVED spaces in TARGETINFO are valid *)

IF (DS:RBX.RESERVED != 0)

THEN #GP(0); FI;

(* Address verification for REPORTDATA (RCX) *)

IF ( (DS:RCX is not 128Byte Aligned) or (DS:RCX is not within CR_ELRANGE) )

THEN #GP(0); FI;

IF (DS:RCX does not resolve within an EPC)

THEN #PF(DS:RCX); FI;

IF (EPCM(DS:RCX).VALID = 0)

THEN #PF(DS:RCX); FI;

IF (EPCM(DS:RCX).BLOCKED = 1)

THEN #PF(DS:RCX); FI;

(* Check page parameters for correctness *)

IF ( (EPCM(DS:RCX).PT ≠ PT_REG) or (EPCM(DS:RCX).ENCLAVESECS ≠ CR_ACTIVE_SECS) or (EPCM(DS:RCX).PENDING = 1) or

(EPCM(DS:RCX).MODIFIED = 1) or (EPCM(DS:RCX).ENCLAVEADDRESS ≠ (DS:RCX & ~0FFFH) ) or (EPCM(DS:RCX).R = 0) )

THEN #PF(DS:RCX);

FI;

(* Address verification for OUTPUTDATA (RDX) *)

IF ( (DS:RDX is not 512Byte Aligned) or (DS:RDX is not within CR_ELRANGE) )

THEN #GP(0); FI;

IF (DS:RDX does not resolve within an EPC)

THEN #PF(DS:RDX); FI;

IF (EPCM(DS:RDX).VALID = 0)

THEN #PF(DS:RDX); FI;

IF (EPCM(DS:RDX).BLOCKED = 1)

THEN #PF(DS:RDX); FI;

(* Check page parameters for correctness *)

IF ( (EPCM(DS:RDX).PT ≠ PT_REG) or (EPCM(DS:RDX).ENCLAVESECS ≠ CR_ACTIVE_SECS) or (EPCM(DS:RCX).PENDING = 1) or

(EPCM(DS:RCX).MODIFIED = 1) or (EPCM(DS:RDX).ENCLAVEADDRESS ≠ (DS:RDX & ~0FFFH) ) or (EPCM(DS:RDX).W = 0) )

THEN #PF(DS:RDX);

FI;

(* REPORT MAC needs to be computed over data which cannot be modified *)

TMP_REPORT.CPUSVN := CR_CPUSVN;

TMP_REPORT.ISVFAMILYID := TMP_CURRENTSECS.ISVFAMILYID;

TMP_REPORT.ISVEXTPRODID := TMP_CURRENTSECS.ISVEXTPRODID;

TMP_REPORT.ISVPRODID := TMP_CURRENTSECS.ISVPRODID;

TMP_REPORT.ISVSVN := TMP_CURRENTSECS.ISVSVN;

TMP_REPORT.ATTRIBUTES := TMP_CURRENTSECS.ATTRIBUTES;

TMP_REPORT.REPORTDATA := DS:RCX[511:0];

TMP_REPORT.MRENCLAVE := TMP_CURRENTSECS.MRENCLAVE;

TMP_REPORT.MRSIGNER := TMP_CURRENTSECS.MRSIGNER;

TMP_REPORT.MRRESERVED := 0;

TMP_REPORT.KEYID[255:0] := CR_REPORT_KEYID;

TMP_REPORT.MISCSELECT := TMP_CURRENTSECS.MISCSELECT;

TMP_REPORT.CONFIGID := TMP_CURRENTSECS.CONFIGID;

TMP_REPORT.CONFIGSVN := TMP_CURRENTSECS.CONFIGSVN;

IF (CPUID.(EAX=12H, ECX=1):EAX[6] = 1)

THEN TMP_REPORT.CET_ATTRIBUTES := TMP_CURRENTSECS.CET_ATTRIBUTES; FI;

(* Derive the report key *)

TMP_KEYDEPENDENCIES.KEYNAME := REPORT_KEY;

TMP_KEYDEPENDENCIES.ISVFAMILYID := 0;

TMP_KEYDEPENDENCIES.ISVEXTPRODID := 0;

TMP_KEYDEPENDENCIES.ISVPRODID := 0;

TMP_KEYDEPENDENCIES.ISVSVN := 0;

TMP_KEYDEPENDENCIES.SGXOWNEREPOCH := CR_SGXOWNEREPOCH;

TMP_KEYDEPENDENCIES.ATTRIBUTES := DS:RBX.ATTRIBUTES;

TMP_KEYDEPENDENCIES.ATTRIBUTESMASK := 0;

TMP_KEYDEPENDENCIES.MRENCLAVE := DS:RBX.MEASUREMENT;

TMP_KEYDEPENDENCIES.MRSIGNER := 0;

TMP_KEYDEPENDENCIES.KEYID := TMP_REPORT.KEYID;

TMP_KEYDEPENDENCIES.SEAL_KEY_FUSES := CR_SEAL_FUSES;

TMP_KEYDEPENDENCIES.CPUSVN := CR_CPUSVN;

TMP_KEYDEPENDENCIES.PADDING := TMP_CURRENTSECS.PADDING;

TMP_KEYDEPENDENCIES.MISCSELECT := DS:RBX.MISCSELECT;

TMP_KEYDEPENDENCIES.MISCMASK := 0;

TMP_KEYDEPENDENCIES.KEYPOLICY := 0;

TMP_KEYDEPENDENCIES.CONFIGID := DS:RBX.CONFIGID;

TMP_KEYDEPENDENCIES.CONFIGSVN := DS:RBX.CONFIGSVN;

IF (CPUID.(EAX=12H, ECX=1):EAX[6] = 1)

THEN

TMP_KEYDEPENDENCIES.CET_ATTRIBUTES := DS:RBX.CET_ATTRIBUTES;

TMP_KEYDEPENDENCIES.CET_ATTRIBUTES _MASK := 0;

FI;

(* Calculate the derived key*)

TMP_REPORTKEY := derivekey(TMP_KEYDEPENDENCIES);

(* call cryptographic CMAC function, CMAC data are not including MAC&KEYID *)

TMP_REPORT.MAC := cmac(TMP_REPORTKEY, TMP_REPORT[3071:0] );

DS:RDX[3455: 0] := TMP_REPORT;

Flags Affected ¶

None

Protected Mode Exceptions ¶

64-Bit Mode Exceptions ¶