enclave.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

#ifndef _OE_ENCLAVE_H
#define _OE_ENCLAVE_H

#ifdef _OE_HOST_H
#error "enclave.h and host.h must not be included in the same compilation unit."
#endif

#include "bits/defs.h"
#include "bits/exception.h"
#include "bits/properties.h"
#include "bits/report.h"
#include "bits/result.h"
#include "bits/types.h"

OE_EXTERNC_BEGIN

oe_result_t oe_add_vectored_exception_handler(
    bool is_first_handler,
    oe_vectored_exception_handler_t vectored_handler);

oe_result_t oe_remove_vectored_exception_handler(
    oe_vectored_exception_handler_t vectored_handler);

oe_result_t oe_call_host(const char* func, void* args);

oe_result_t oe_call_host_by_address(
    void (*func)(void*, oe_enclave_t*),
    void* args);

bool oe_is_within_enclave(const void* ptr, size_t size);

bool oe_is_outside_enclave(const void* ptr, size_t size);

void* oe_host_malloc(size_t size);

void* oe_host_realloc(void* ptr, size_t size);

void* oe_host_calloc(size_t nmemb, size_t size);

void oe_host_free(void* ptr);

char* oe_host_strndup(const char* str, size_t n);

void oe_abort(void);

void __oe_assert_fail(
    const char* expr,
    const char* file,
    int line,
    const char* func);

#ifndef NDEBUG
#define oe_assert(EXPR)                                                \
    do                                                                 \
    {                                                                  \
        if (!(EXPR))                                                   \
            __oe_assert_fail(#EXPR, __FILE__, __LINE__, __FUNCTION__); \
    } while (0)
#else
#define oe_assert(EXPR)
#endif

oe_result_t oe_get_report(
    uint32_t flags,
    const uint8_t* report_data,
    size_t report_data_size,
    const void* opt_params,
    size_t opt_params_size,
    uint8_t* report_buffer,
    size_t* report_buffer_size);

oe_result_t oe_get_target_info(
    const uint8_t* report,
    size_t report_size,
    void* target_info_buffer,
    size_t* target_info_size);

oe_result_t oe_parse_report(
    const uint8_t* report,
    size_t report_size,
    oe_report_t* parsed_report);

oe_result_t oe_verify_report(
    const uint8_t* report,
    size_t report_size,
    oe_report_t* parsed_report);

typedef enum _oe_seal_policy {
    OE_SEAL_POLICY_UNIQUE = 1,
    OE_SEAL_POLICY_PRODUCT = 2,
    _OE_SEAL_POLICY_MAX = OE_ENUM_MAX,
} oe_seal_policy_t;
oe_result_t oe_get_seal_key_by_policy(
    oe_seal_policy_t seal_policy,
    uint8_t* key_buffer,
    size_t* key_buffer_size,
    uint8_t* key_info,
    size_t* key_info_size);

oe_result_t oe_get_seal_key(
    const uint8_t* key_info,
    size_t key_info_size,
    uint8_t* key_buffer,
    size_t* key_buffer_size);

oe_enclave_t* oe_get_enclave(void);

OE_EXTERNC_END

#endif /* _OE_ENCLAVE_H */