report.h

Go to the documentation of this file.

// Copyright (c) Open Enclave SDK contributors.
// Licensed under the MIT License.

#ifndef _OE_BITS_REPORT_H
#define _OE_BITS_REPORT_H

#include "defs.h"
#include "types.h"

OE_EXTERNC_BEGIN

#define OE_REPORT_FLAGS_REMOTE_ATTESTATION 0x00000001

#define OE_REPORT_DATA_SIZE 64

#define OE_MAX_REPORT_SIZE (10 * 1024)

// Fixed identity property sizes for OEv1
#define OE_UNIQUE_ID_SIZE 32

#define OE_SIGNER_ID_SIZE 32

#define OE_PRODUCT_ID_SIZE 16

#define OE_REPORT_ATTRIBUTES_DEBUG 0x0000000000000001ULL

#define OE_REPORT_ATTRIBUTES_REMOTE 0x0000000000000002ULL

#define OE_REPORT_ATTRIBUTES_RESERVED \
    (~(OE_REPORT_ATTRIBUTES_DEBUG | OE_REPORT_ATTRIBUTES_REMOTE))

typedef struct _oe_identity
{
    uint32_t id_version;

    uint32_t security_version;

    uint64_t attributes;

    uint8_t unique_id[OE_UNIQUE_ID_SIZE];

    uint8_t signer_id[OE_SIGNER_ID_SIZE];

    uint8_t product_id[OE_PRODUCT_ID_SIZE];
} oe_identity_t;
typedef struct _oe_report
{
    size_t size;

    oe_enclave_type_t type;

    size_t report_data_size;

    size_t enclave_report_size;

    uint8_t* report_data;

    uint8_t* enclave_report;

    oe_identity_t identity;
} oe_report_t;
#define OE_UUID_SIZE 16

typedef struct _oe_uuid_t
{
    uint8_t b[OE_UUID_SIZE];
} oe_uuid_t;

typedef struct _oe_claim
{
    char* name;
    uint8_t* value;
    size_t value_size;
} oe_claim_t;

#define OE_CLAIM_ID_VERSION "id_version"
#define OE_CLAIM_SECURITY_VERSION "security_version"
#define OE_CLAIM_ATTRIBUTES "attributes"
#define OE_CLAIM_UNIQUE_ID "unique_id"
#define OE_CLAIM_SIGNER_ID "signer_id"
#define OE_CLAIM_PRODUCT_ID "product_id"
#define OE_CLAIM_PLUGIN_UUID "plugin_uuid"
#define OE_REQUIRED_CLAIMS_COUNT 7
extern const char* OE_REQUIRED_CLAIMS[OE_REQUIRED_CLAIMS_COUNT];

#define OE_CLAIM_VALIDITY_FROM "validity_from"
#define OE_CLAIM_VALIDITY_UNTIL "validity_until"
#define OE_OPTIONAL_CLAIMS_COUNT 2
extern const char* OE_OPTIONAL_CLAIMS[OE_OPTIONAL_CLAIMS_COUNT];

typedef enum _oe_policy_type
{
    OE_POLICY_ENDORSEMENTS_TIME = 1
} oe_policy_type_t;

typedef struct _oe_policy
{
    oe_policy_type_t type;
    void* policy;
    size_t policy_size;
} oe_policy_t;

OE_EXTERNC_END

#endif /* _OE_BITS_REPORT_H */