microsoft-azure-attestation/sgx.attest.sample.intel.sdk at master · Azure-Samples/microsoft-azure-attestation

Name	Name	Last commit message	Last commit date
parent directory ..
docs	docs
genquotes	genquotes
validatequotes.core	validatequotes.core
readme.md	readme.md

Sample code for Intel® SGX Attestation using Microsoft Azure Attestation service and Intel® SGX SDK for Linux OS

References

The sample, including code, design and documentation, is derived from the Sample code for Intel® SGX Attestation using Microsoft Azure Attestation and Open Enclave SDK for Linux OS and follows its execution flow
The SGX enclave and host code in this sample is derived from the Intel® Software Guard Extensions Data Center Attestation Primitives (Intel® SGX DCAP) Quote Generation SampleCode
Intel® Software Guard Extensions (Intel® SGX) Data Center Attestation Primitives (Intel® SGX DCAP): https://github.com/intel/SGXDataCenterAttestationPrimitives
Intel® Software Guard Extensions for Linux* OS: https://github.com/intel/linux-sgx

Overview

The Azure Attestation SGX sample code demonstrates how to generate a quote in an SGX enclave and then get it validated by the Microsoft Azure Attestation (MAA) service. The "enclave held data" for the quote for simplicity is populated with sample data represented as uint8_t array.

The execution flow in the sample code are outlined in the following diagram:

The flow is:

genquote_enclave - This application is an SGX enclave created via the Intel® SGX SDK. It exposes one ECALL to retrieve a remote quote for enclave held data.
1. Generate signing key (private.pem)
2. Build enclave (genquote_enclave)
3. Sign enclave with the key
genquote_host - This application is run first and performs the following:
1. Initializes and launches the genquote_enclave SGX enclave instance
2. Invokes the enclave protected method (ECALL) to retrieve a remote quote for hashed (SHA256) enclave held data, which in this case is a uint8_t static array
3. Retrieves important attributes from the SGX report, such as Security Version Number, ProductID, MRSIGNER, MRENCLAVE, etc.
4. Persists the remote quote, enclave held data and parsed report fields to a JSON file on disk
validatequotes.core - This application is built on .NET core and runs on any platform. It consumes the JSON file persisted by the genquote_host application and performs the following:
1. Calls the Azure Attestation service for validation, passing it the remote quote and enclave held data found in the JSON file
2. Validates that the Azure Attestation JWT passes signature validation and is issued by the expected party
3. Validates that the Azure Attestation JWT claim values match the parsed data in the JSON file for the well known fields like Security Version Number, ProductID, MRSIGNER, MRENCLAVE, etc.
4. Produces a report in the console with the results

Quote Generation

Remote quote generation is performed by the following call to the sgx_create_report method in the ecall.cpp file in the genquote_enclave application.

sgx_status_t sgx_create_report(
    const sgx_target_info_t *target_info,
    const sgx_report_data_t *report_data,
    sgx_report_t *report
);

Remote Quote Validation via MAA Attestation

The MAA service is called to perform attestation by the following call in the MaaService.cs file:

    // Send request
    var response = await theHttpClient.SendAsync(request);

The verification that the MAA service JWT passes signature validation and is issued by the expected issuer is in the JwtHelperValidation.cs file:

    public static TokenValidationResult ValidateMaaJwt(string attestDnsName, string serviceJwt)

The verification that the MAA service JWT claims match the initial parsed report data is performed in the EnclaveInfo.cs file:

    public void CompareToMaaServiceJwtToken(string serviceJwtToken, bool includeDetails)

How to Build and Run

Prerequisites/System setup

Create an Azure Confidential Computing Ubuntu 18.04 VM.
Install Intel SGX Driver and SGX SDK. See https://download.01.org/intel-sgx/sgx-dcap (for example, https://download.01.org/intel-sgx/sgx-dcap/1.16/linux/distro/ubuntu18.04-server/) for the latest driver and SDK files.

Configure the Intel and Microsoft APT Repositories:

echo 'deb [arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu bionic main' | sudo tee /etc/apt/sources.list.d/intel-sgx.list
wget -qO - https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key | sudo apt-key add -
echo "deb [arch=amd64] https://packages.microsoft.com/ubuntu/18.04/prod bionic main" | sudo tee /etc/apt/sources.list.d/msprod.list
wget -qO - https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -

Install Intel SGX DCAP Driver:

sudo apt -y update
sudo apt install -y dkms
wget https://download.01.org/intel-sgx/sgx-dcap/1.16/linux/distro/ubuntu18.04-server/sgx_linux_x64_driver_1.41.bin -O sgx_linux_x64_driver.bin
sudo chmod a+x sgx_linux_x64_driver.bin
sudo ./sgx_linux_x64_driver.bin

For more information see: https://github.com/intel/linux-sgx#build-and-install-the-intelr-sgx-driver .

Install Intel SGX SDK:

wget https://download.01.org/intel-sgx/sgx-dcap/1.16/linux/distro/ubuntu18.04-server/sgx_linux_x64_sdk_2.19.100.3.bin -O sgx_linux_x64_sdk.bin
sudo chmod a+x sgx_linux_x64_sdk.bin
sudo ./sgx_linux_x64_sdk.bin

Specify a directory to install the Intel SGX SDK. For example, /opt/intel If the SDK is installed into /opt/intel, run the following command:

echo "source /opt/intel/sgxsdk/environment" >> ~/.bashrc && source ~/.bashrc

For more information see: https://software.intel.com/content/www/us/en/develop/topics/software-guard-extensions/sdk.html

Install SGX libraries:

sudo apt install -y libssl-dev libsgx-quote-ex libsgx-enclave-common libsgx-enclave-common-dev libsgx-dcap-ql libsgx-dcap-ql-dev az-dcap-client

Install the .NET 5.0 SDK on this VM.

wget https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb
sudo apt update
sudo apt install -y apt-transport-https && sudo apt update && sudo apt install -y dotnet-sdk-5.0

Reboot the VM. This is required to complete the SGX DCAP driver installation.

sudo reboot now

Build and Run

Clone MAA samples repo to the VM:

git clone --recursive https://github.com/Azure-Samples/microsoft-azure-attestation.git

git clone --recursive --branch <branch-name> https://github.com/Azure-Samples/microsoft-azure-attestation.git

git clone --recursive git@github.com:Azure-Samples/microsoft-azure-attestation.git

Change the directory:

cd ./microsoft-azure-attestation/sgx.attest.sample.intel.sdk

Build, run and generate the JSON files do the following:

cd genquotes

sudo ./runall.sh

This runs the application in four different enclave configurations to generate four different remote quotes. You should see four new files created in the ./genquotes/out directory.

Build, run and validate the JSON files with the MAA service do the following:

cd validatequotes.core

./runall.sh

These steps build and run the validation application against the four different JSON files produced earlier.

The four different JSON files are:

enclave.info.debug.json - debugging enabled
enclave.info.release.json - debugging disabled
enclave.info.securityversion.json - security version set to 8888
enclave.info.prodid.json - product id set to 9999

Example Output for ./runall.sh

Here is an example of what the output of ./runall.sh should look like:

[20:36:32.692] : 
[20:36:32.712] : ************************************************************************************************************************
[20:36:32.712] : *      PARAMETERS FOR THIS RUN
[20:36:32.712] : ************************************************************************************************************************
[20:36:32.712] : Validating filename                : ../genquotes/out/enclave.info.debug.json
[20:36:32.712] : Using attestation provider         : sharedcus.cus.attest.azure.net
[20:36:32.712] : Including details                  : False
[20:36:33.096] : 
[20:36:33.096] : ************************************************************************************************************************
[20:36:33.096] : *      IN VALIDATION CALLBACK, VALIDATING MAA JWT TOKEN - BASICS
[20:36:33.096] : ************************************************************************************************************************
[20:36:33.108] : JWT issuer claim validation        : True
[20:36:33.108] : JWT signing cert issuer validation : True
[20:36:33.509] : 
[20:36:33.509] : ************************************************************************************************************************
[20:36:33.509] : *      VALIDATING MAA JWT TOKEN - MATCHES CLIENT ENCLAVE INFO
[20:36:33.509] : ************************************************************************************************************************
[20:36:33.509] : IsDebuggable match                 : True
[20:36:33.509] : MRENCLAVE match                    : True
[20:36:33.509] : MRSIGNER match                     : True
[20:36:33.509] : ProductID match                    : True
[20:36:33.510] : Security Version match             : True
[20:36:33.510] : Enclave Held Data match            : True
[20:36:33.510] : 
[20:36:34.607] : 
[20:36:34.644] : ************************************************************************************************************************
[20:36:34.644] : *      PARAMETERS FOR THIS RUN
[20:36:34.644] : ************************************************************************************************************************
[20:36:34.644] : Validating filename                : ../genquotes/out/enclave.info.release.json
[20:36:34.644] : Using attestation provider         : sharedcus.cus.attest.azure.net
[20:36:34.644] : Including details                  : False
[20:36:35.127] : 
[20:36:35.127] : ************************************************************************************************************************
[20:36:35.127] : *      IN VALIDATION CALLBACK, VALIDATING MAA JWT TOKEN - BASICS
[20:36:35.127] : ************************************************************************************************************************
[20:36:35.137] : JWT issuer claim validation        : True
[20:36:35.137] : JWT signing cert issuer validation : True
[20:36:35.147] : 
[20:36:35.147] : ************************************************************************************************************************
[20:36:35.147] : *      VALIDATING MAA JWT TOKEN - MATCHES CLIENT ENCLAVE INFO
[20:36:35.147] : ************************************************************************************************************************
[20:36:35.148] : IsDebuggable match                 : True
[20:36:35.148] : MRENCLAVE match                    : True
[20:36:35.148] : MRSIGNER match                     : True
[20:36:35.148] : ProductID match                    : True
[20:36:35.148] : Security Version match             : True
[20:36:35.149] : Enclave Held Data match            : True
[20:36:35.149] : 
[20:36:36.283] : 
[20:36:36.301] : ************************************************************************************************************************
[20:36:36.301] : *      PARAMETERS FOR THIS RUN
[20:36:36.301] : ************************************************************************************************************************
[20:36:36.301] : Validating filename                : ../genquotes/out/enclave.info.prodid.json
[20:36:36.301] : Using attestation provider         : sharedcus.cus.attest.azure.net
[20:36:36.301] : Including details                  : False
[20:36:36.681] : 
[20:36:36.681] : ************************************************************************************************************************
[20:36:36.681] : *      IN VALIDATION CALLBACK, VALIDATING MAA JWT TOKEN - BASICS
[20:36:36.681] : ************************************************************************************************************************
[20:36:36.691] : JWT issuer claim validation        : True
[20:36:36.691] : JWT signing cert issuer validation : True
[20:36:36.701] : 
[20:36:36.701] : ************************************************************************************************************************
[20:36:36.701] : *      VALIDATING MAA JWT TOKEN - MATCHES CLIENT ENCLAVE INFO
[20:36:36.701] : ************************************************************************************************************************
[20:36:36.702] : IsDebuggable match                 : True
[20:36:36.702] : MRENCLAVE match                    : True
[20:36:36.702] : MRSIGNER match                     : True
[20:36:36.702] : ProductID match                    : True
[20:36:36.702] : Security Version match             : True
[20:36:36.703] : Enclave Held Data match            : True
[20:36:36.703] : 
[20:36:37.836] : 
[20:36:37.889] : ************************************************************************************************************************
[20:36:37.889] : *      PARAMETERS FOR THIS RUN
[20:36:37.889] : ************************************************************************************************************************
[20:36:37.889] : Validating filename                : ../genquotes/out/enclave.info.securityversion.json
[20:36:37.889] : Using attestation provider         : sharedcus.cus.attest.azure.net
[20:36:37.889] : Including details                  : False
[20:36:38.349] : 
[20:36:38.350] : ************************************************************************************************************************
[20:36:38.350] : *      IN VALIDATION CALLBACK, VALIDATING MAA JWT TOKEN - BASICS
[20:36:38.350] : ************************************************************************************************************************
[20:36:38.360] : JWT issuer claim validation        : True
[20:36:38.360] : JWT signing cert issuer validation : True
[20:36:38.371] : 
[20:36:38.371] : ************************************************************************************************************************
[20:36:38.371] : *      VALIDATING MAA JWT TOKEN - MATCHES CLIENT ENCLAVE INFO
[20:36:38.371] : ************************************************************************************************************************
[20:36:38.372] : IsDebuggable match                 : True
[20:36:38.372] : MRENCLAVE match                    : True
[20:36:38.372] : MRSIGNER match                     : True
[20:36:38.372] : ProductID match                    : True
[20:36:38.372] : Security Version match             : True
[20:36:38.373] : Enclave Held Data match            : True
[20:36:38.373] :

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sgx.attest.sample.intel.sdk

sgx.attest.sample.intel.sdk

docs

docs

genquotes

genquotes

validatequotes.core

validatequotes.core

readme.md

readme.md

readme.md

Sample code for Intel® SGX Attestation using Microsoft Azure Attestation service and Intel® SGX SDK for Linux OS

References

Overview

Quote Generation

Remote Quote Validation via MAA Attestation

How to Build and Run

Prerequisites/System setup

Build and Run

The four different JSON files are:

Example Output for ./runall.sh

Files

sgx.attest.sample.intel.sdk

Directory actions

More options

Directory actions

More options

Latest commit

History

sgx.attest.sample.intel.sdk

Folders and files

parent directory

Sample code for Intel® SGX Attestation using Microsoft Azure Attestation service and Intel® SGX SDK for Linux OS

References

Overview

Quote Generation

Remote Quote Validation via MAA Attestation

How to Build and Run

Prerequisites/System setup

Build and Run

The four different JSON files are:

Example Output for ./runall.sh